@rinse-dental/open-dental 0.0.6 → 0.1.1

package/dist/api/appointments.d.ts

@@ -0,0 +1,196 @@
+import HttpClient from "../utils/httpClient";
+import { Appointment, AppointmentSlot, GetAppointmentParams, GetASAPParams, GetSlotsParams, GetSlotsWebSchedParams, GetWebSchedAppointmentsParams, CreateNewAppointmentParams, CreatePlannedAppointmentParams, SchedulePlannedAppointmentParams, ScheduleWebSchedAppointmentParams, UpdateAppointmentParams, BreakAppointmentParams, ConfirmAppointmentParams } from "../types/appointmentType";
+export default class Appointments {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single appointment by its ID.
+     * @param {number} AptNum - The unique identifier for the appointment.
+     * @returns {Promise<Appointment>} - The appointment object.
+     * @throws {Error} - If `AptNum` is not provided.
+     */
+    getAppointment(AptNum: number): Promise<Appointment>;
+    /**
+     * Fetch multiple appointments with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PatNum] - Filter by patient number.
+     * @param {"Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted"} [params.AptStatus] - Filter by appointment status.
+     * @param {number} [params.Op] - Filter by operatory number.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {number} [params.ClinicNum] - Filter by clinic number.
+     * @param {string} [params.DateTStamp] - Return only appointments updated after this timestamp.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Appointment[]>} - A list of appointments.
+     */
+    getAppointments({ PatNum, AptStatus, Op, date, dateStart, dateEnd, ClinicNum, DateTStamp, Offset, }?: GetAppointmentParams): Promise<Appointment[]>;
+    /**
+     * Fetch ASAP appointments.
+     * @param {Object} params - Parameters for fetching ASAP appointments.
+     * @param {number} params.ClinicNum - Required: Clinic number. Use 0 for appointments not attached to clinics.
+     * @param {number} [params.ProvNum] - Optional: Provider number.
+     * @returns {Promise<Appointment[]>} - A list of ASAP appointments.
+     * @throws {Error} - If `ClinicNum` is not provided.
+     */
+    getASAPappointments(params: GetASAPParams): Promise<Appointment[]>;
+    /**
+     * Fetch available appointment slots.
+     * @param {Object} params - Parameters for filtering slots.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {number} [params.lengthMinutes] - Ignore slots shorter than this length.
+     * @param {number} [params.ProvNum] - Provider number.
+     * @param {number} [params.OpNum] - Operatory number.
+     * @returns {Promise<AppointmentSlot[]>} - A list of available slots.
+     */
+    getSlots(params?: GetSlotsParams): Promise<AppointmentSlot[]>;
+    /**
+     * Fetch WebSched appointment slots.
+     * @param {Object} params - Parameters for filtering WebSched slots.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {number} params.ClinicNum - Required: Clinic number.
+     * @param {number} [params.defNumApptType] - Appointment type definition number.
+     * @param {"true" | "false"} [params.isNewPatient] - Indicates if the slot is for a new patient.
+     * @returns {Promise<AppointmentSlot[]>} - A list of WebSched slots.
+     * @throws {Error} - If `ClinicNum` is not provided.
+     */
+    getSlotsWebSched(params: GetSlotsWebSchedParams): Promise<AppointmentSlot[]>;
+    /**
+     * Fetch WebSched appointments.
+     * @param {Object} params - Parameters for fetching WebSched appointments.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.DateTStamp] - Return only appointments updated after this timestamp.
+     * @param {number} [params.ClinicNum] - Clinic number.
+     * @returns {Promise<Appointment[]>} - A list of WebSched appointments.
+     */
+    getWebSchedAppointments(params?: GetWebSchedAppointmentsParams): Promise<Appointment[]>;
+    /**
+     * Create a new appointment.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} data.Op - Required: Operatory number.
+     * @param {string} data.AptDateTime - Required: Appointment start time in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {"Scheduled" | "Complete" | "UnschedList" | "PtNote" | "PtNoteCompleted"} [data.AptStatus="Scheduled"] - Optional: Appointment status. Default is "Scheduled".
+     * @param {string} [data.Pattern="/XX/"] - Optional: Time pattern in 5-minute increments. Default is "/XX/" (20 minutes).
+     * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
+     * @param {string} [data.Note] - Optional: Appointment notes.
+     * @param {number} [data.ProvNum] - Optional: Provider number.
+     * @param {number} [data.ProvHyg=0] - Optional: Hygienist provider number. Default is 0.
+     * @param {number} [data.ClinicNum] - Optional: Clinic number.
+     * @param {"true" | "false"} [data.IsHygiene="false"] - Optional: Indicates if the appointment is for hygiene. Default is "false".
+     * @param {"true" | "false"} [data.IsNewPatient="false"] - Optional: Indicates if the patient is new. Default is "false".
+     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional: Appointment priority. Default is "Normal".
+     * @param {number} [data.AppointmentTypeNum=0] - Optional: Appointment type number. Default is 0.
+     * @param {string} [data.colorOverride] - Optional: Custom color in "R,G,B" format.
+     * @param {string} [data.PatternSecondary] - Optional: Secondary time pattern.
+     * @returns {Promise<Appointment>} - The created appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    createNewAppointment(data: CreateNewAppointmentParams): Promise<Appointment>;
+    /**
+     * Create a planned appointment.
+     * @param {Object} data - Data for the planned appointment.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} [data.AppointmentTypeNum] - Optional: Appointment type number.
+     * @param {number[]} [data.procNums] - Optional: Array of procedure numbers. At least one of `AppointmentTypeNum` or `procNums` is required.
+     * @param {string} [data.Pattern="/XX/"] - Optional: Time pattern in 5-minute increments. Default is "/XX/" (20 minutes).
+     * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
+     * @param {string} [data.Note] - Optional: Appointment notes.
+     * @param {number} [data.ProvNum] - Optional: Provider number.
+     * @param {number} [data.ProvHyg=0] - Optional: Hygienist provider number. Default is 0.
+     * @param {number} [data.ClinicNum] - Optional: Clinic number.
+     * @param {"true" | "false"} [data.IsHygiene="false"] - Optional: Indicates if the appointment is for hygiene. Default is "false".
+     * @param {"true" | "false"} [data.IsNewPatient="false"] - Optional: Indicates if the patient is new. Default is "false".
+     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional: Appointment priority. Default is "Normal".
+     * @param {string} [data.PatternSecondary] - Optional: Secondary time pattern.
+     * @returns {Promise<Appointment>} - The created planned appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    createPlannedAppointment(data: CreatePlannedAppointmentParams): Promise<Appointment>;
+    /**
+     * Schedule a planned appointment.
+     * @param {Object} data - Data for scheduling the planned appointment.
+     * @param {number} data.AptNum - Required: The appointment number with Planned status.
+     * @param {string} data.AptDateTime - Required: Start time for the appointment in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} data.ProvNum - Required: The provider number for the appointment.
+     * @param {number} data.Op - Required: The operatory number for the appointment.
+     * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
+     * @param {string} [data.Note] - Optional: Notes for the appointment. Will overwrite any existing note.
+     * @returns {Promise<Appointment>} - The scheduled appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    schedulePlannedAppointment(data: SchedulePlannedAppointmentParams): Promise<Appointment>;
+    /**
+     * Schedule a WebSched appointment.
+     * @param {Object} data - Data for scheduling the WebSched appointment.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {string} data.DateTimeStart - Required: The start time of the appointment in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} data.DateTimeEnd - Required: The end time of the appointment in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} data.ProvNum - Required: Provider number associated with the appointment slot.
+     * @param {number} data.OpNum - Required: Operatory number associated with the appointment slot.
+     * @param {number} data.defNumApptType - Required: Appointment type definition number.
+     * @returns {Promise<Appointment>} - The scheduled WebSched appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    scheduleWebSchedAppointment(data: ScheduleWebSchedAppointmentParams): Promise<Appointment>;
+    /**
+     * Update an existing appointment.
+     * @param {Object} data - Data for updating the appointment.
+     * @param {number} data.AptNum - Required: The unique identifier of the appointment to update.
+     * @param {"Scheduled" | "Complete" | "UnschedList" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted"} [data.AptStatus] - Optional: Updated status of the appointment.
+     * @param {string} [data.Pattern] - Optional: Updated time pattern in 5-minute increments.
+     * @param {number} [data.Confirmed] - Optional: Updated confirmation status definition number.
+     * @param {number} [data.Op] - Optional: Updated operatory number.
+     * @param {string} [data.Note] - Optional: Updated notes for the appointment. Will overwrite existing notes.
+     * @param {number} [data.ProvNum] - Optional: Updated provider number.
+     * @param {number} [data.ProvHyg] - Optional: Updated hygienist provider number.
+     * @param {string} [data.AptDateTime] - Optional: Updated appointment start time in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} [data.ClinicNum] - Optional: Updated clinic number.
+     * @param {"true" | "false"} [data.IsHygiene] - Optional: Indicates if the appointment is for hygiene.
+     * @param {"true" | "false"} [data.IsNewPatient] - Optional: Indicates if the appointment is for a new patient.
+     * @param {"Normal" | "ASAP"} [data.Priority] - Optional: Updated priority of the appointment.
+     * @param {number} [data.AppointmentTypeNum] - Optional: Updated appointment type number.
+     * @param {number} [data.UnschedStatus] - Optional: Updated unscheduled status definition number.
+     * @param {string} [data.colorOverride] - Optional: Updated custom color in "R,G,B" format.
+     * @param {string} [data.PatternSecondary] - Optional: Updated secondary time pattern.
+     * @returns {Promise<Appointment>} - The updated appointment.
+     * @throws {Error} - If `AptNum` is missing.
+     */
+    updateAppointment(data: UpdateAppointmentParams): Promise<Appointment>;
+    /**
+     * Break an existing appointment.
+     * Only appointments with an AptStatus of "Scheduled" can be broken.
+     * @param {Object} data - Data for breaking the appointment.
+     * @param {number} data.AptNum - Required: The unique identifier of the appointment to break.
+     * @param {"true" | "false"} data.sendToUnscheduledList - Required: Indicates if the appointment should be added to the Unscheduled List.
+     * @param {"Missed" | "Cancelled"} [data.breakType] - Optional: Reason for breaking the appointment.
+     * @returns {Promise<void>} - Resolves when the appointment is successfully broken.
+     * @throws {Error} - If required fields are missing.
+     */
+    breakAppointment(data: BreakAppointmentParams): Promise<void>;
+    /**
+     * Update the note for an existing appointment.
+     * @param {number} AptNum - Required: The unique identifier of the appointment to update.
+     * @param {string} Note - Required: The new note content for the appointment.
+     * @returns {Promise<void>} - Resolves when the note is successfully updated.
+     * @throws {Error} - If required fields are missing.
+     */
+    updateAppointmentNote(AptNum: number, Note: string): Promise<void>;
+    /**
+     * Confirm an existing appointment.
+     * @param {Object} data - Data for confirming the appointment.
+     * @param {number} data.AptNum - Required: The unique identifier of the appointment to confirm.
+     * @param {string} [data.confirmVal] - Optional: Confirmation value, e.g., "Sent", "Confirmed".
+     * @param {number} [data.defNum] - Optional: Confirmation definition number.
+     * @returns {Promise<void>} - Resolves when the appointment is successfully confirmed.
+     * @throws {Error} - If required fields are missing.
+     */
+    confirmAppointment(data: ConfirmAppointmentParams): Promise<void>;
+}
+//# sourceMappingURL=appointments.d.ts.map

package/dist/api/appointments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appointments.d.ts","sourceRoot":"","sources":["../../src/api/appointments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,WAAW,EACX,eAAe,EACf,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,sBAAsB,EACtB,6BAA6B,EAC7B,0BAA0B,EAC1B,8BAA8B,EAC9B,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOnE;;;;;;;;;;;;;OAaG;IACU,eAAe,CAAC,EACzB,MAAM,EACN,SAAS,EACT,EAAE,EACF,IAAI,EACJ,SAAS,EACT,OAAO,EACP,SAAS,EACT,UAAU,EACV,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAgBrD;;;;;;;OAOG;IACU,mBAAmB,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAO/E;;;;;;;;;;OAUG;IACU,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAI1E;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAOzF;;;;;;;;;OASG;IACU,uBAAuB,CAClC,MAAM,CAAC,EAAE,6BAA6B,GACrC,OAAO,CAAC,WAAW,EAAE,CAAC;IAIzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,oBAAoB,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3F;;;;;;;;;;;;;;;;;;OAkBG;IACU,wBAAwB,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,WAAW,CAAC;IASjG;;;;;;;;;;;OAWG;IACU,0BAA0B,CACrC,IAAI,EAAE,gCAAgC,GACrC,OAAO,CAAC,WAAW,CAAC;IAQvB;;;;;;;;;;;OAWG;IACU,2BAA2B,CACtC,IAAI,EAAE,iCAAiC,GACtC,OAAO,CAAC,WAAW,CAAC;IAiBvB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IAQnF;;;;;;;;;OASG;IACU,gBAAgB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ1E;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/E;;;;;;;;OAQG;IACU,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ/E"}

package/dist/api/appointments.js

@@ -6,25 +6,270 @@ class Appointments {
         this.httpClient = httpClient;
     }
     /**
-     * Fetch a specific appointment by its ID.
-     * @param {number} AptNum - The ID of the appointment.
-     * @returns {Promise<Appointment>} - The appointment data.
+     * Fetch a single appointment by its ID.
+     * @param {number} AptNum - The unique identifier for the appointment.
+     * @returns {Promise<Appointment>} - The appointment object.
      * @throws {Error} - If `AptNum` is not provided.
-    */
+     */
     async getAppointment(AptNum) {
         if (!AptNum) {
             throw new Error("AptNum is required.");
         }
         return this.httpClient.get(`/appointments/${AptNum}`);
     }
-    async getAppointments(params) {
+    /**
+     * Fetch multiple appointments with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PatNum] - Filter by patient number.
+     * @param {"Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted"} [params.AptStatus] - Filter by appointment status.
+     * @param {number} [params.Op] - Filter by operatory number.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {number} [params.ClinicNum] - Filter by clinic number.
+     * @param {string} [params.DateTStamp] - Return only appointments updated after this timestamp.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Appointment[]>} - A list of appointments.
+     */
+    async getAppointments({ PatNum, AptStatus, Op, date, dateStart, dateEnd, ClinicNum, DateTStamp, Offset, } = {}) {
+        const params = {
+            PatNum,
+            AptStatus,
+            Op,
+            date,
+            dateStart,
+            dateEnd,
+            ClinicNum,
+            DateTStamp,
+            Offset,
+        };
         return this.httpClient.get("/appointments", params);
     }
-    async createAppointment(data) {
-        if (!data) {
-            throw new Error("Appointment data is required.");
+    /**
+     * Fetch ASAP appointments.
+     * @param {Object} params - Parameters for fetching ASAP appointments.
+     * @param {number} params.ClinicNum - Required: Clinic number. Use 0 for appointments not attached to clinics.
+     * @param {number} [params.ProvNum] - Optional: Provider number.
+     * @returns {Promise<Appointment[]>} - A list of ASAP appointments.
+     * @throws {Error} - If `ClinicNum` is not provided.
+     */
+    async getASAPappointments(params) {
+        if (!params.ClinicNum) {
+            throw new Error("ClinicNum is required when Clinics are enabled.");
+        }
+        return this.httpClient.get("/appointments/asap", params);
+    }
+    /**
+     * Fetch available appointment slots.
+     * @param {Object} params - Parameters for filtering slots.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {number} [params.lengthMinutes] - Ignore slots shorter than this length.
+     * @param {number} [params.ProvNum] - Provider number.
+     * @param {number} [params.OpNum] - Operatory number.
+     * @returns {Promise<AppointmentSlot[]>} - A list of available slots.
+     */
+    async getSlots(params) {
+        return this.httpClient.get("/appointments/slots", params);
+    }
+    /**
+     * Fetch WebSched appointment slots.
+     * @param {Object} params - Parameters for filtering WebSched slots.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {number} params.ClinicNum - Required: Clinic number.
+     * @param {number} [params.defNumApptType] - Appointment type definition number.
+     * @param {"true" | "false"} [params.isNewPatient] - Indicates if the slot is for a new patient.
+     * @returns {Promise<AppointmentSlot[]>} - A list of WebSched slots.
+     * @throws {Error} - If `ClinicNum` is not provided.
+     */
+    async getSlotsWebSched(params) {
+        if (!params.ClinicNum) {
+            throw new Error("ClinicNum is required when Clinics are enabled.");
+        }
+        return this.httpClient.get("/appointments/slotswebsched", params);
+    }
+    /**
+     * Fetch WebSched appointments.
+     * @param {Object} params - Parameters for fetching WebSched appointments.
+     * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
+     * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
+     * @param {string} [params.DateTStamp] - Return only appointments updated after this timestamp.
+     * @param {number} [params.ClinicNum] - Clinic number.
+     * @returns {Promise<Appointment[]>} - A list of WebSched appointments.
+     */
+    async getWebSchedAppointments(params) {
+        return this.httpClient.get("/appointments/websched", params);
+    }
+    /**
+     * Create a new appointment.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} data.Op - Required: Operatory number.
+     * @param {string} data.AptDateTime - Required: Appointment start time in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {"Scheduled" | "Complete" | "UnschedList" | "PtNote" | "PtNoteCompleted"} [data.AptStatus="Scheduled"] - Optional: Appointment status. Default is "Scheduled".
+     * @param {string} [data.Pattern="/XX/"] - Optional: Time pattern in 5-minute increments. Default is "/XX/" (20 minutes).
+     * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
+     * @param {string} [data.Note] - Optional: Appointment notes.
+     * @param {number} [data.ProvNum] - Optional: Provider number.
+     * @param {number} [data.ProvHyg=0] - Optional: Hygienist provider number. Default is 0.
+     * @param {number} [data.ClinicNum] - Optional: Clinic number.
+     * @param {"true" | "false"} [data.IsHygiene="false"] - Optional: Indicates if the appointment is for hygiene. Default is "false".
+     * @param {"true" | "false"} [data.IsNewPatient="false"] - Optional: Indicates if the patient is new. Default is "false".
+     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional: Appointment priority. Default is "Normal".
+     * @param {number} [data.AppointmentTypeNum=0] - Optional: Appointment type number. Default is 0.
+     * @param {string} [data.colorOverride] - Optional: Custom color in "R,G,B" format.
+     * @param {string} [data.PatternSecondary] - Optional: Secondary time pattern.
+     * @returns {Promise<Appointment>} - The created appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async createNewAppointment(data) {
+        if (!data.PatNum || !data.Op || !data.AptDateTime) {
+            throw new Error("PatNum, Op, and AptDateTime are required.");
         }
         return this.httpClient.post("/appointments", data);
     }
+    /**
+     * Create a planned appointment.
+     * @param {Object} data - Data for the planned appointment.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} [data.AppointmentTypeNum] - Optional: Appointment type number.
+     * @param {number[]} [data.procNums] - Optional: Array of procedure numbers. At least one of `AppointmentTypeNum` or `procNums` is required.
+     * @param {string} [data.Pattern="/XX/"] - Optional: Time pattern in 5-minute increments. Default is "/XX/" (20 minutes).
+     * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
+     * @param {string} [data.Note] - Optional: Appointment notes.
+     * @param {number} [data.ProvNum] - Optional: Provider number.
+     * @param {number} [data.ProvHyg=0] - Optional: Hygienist provider number. Default is 0.
+     * @param {number} [data.ClinicNum] - Optional: Clinic number.
+     * @param {"true" | "false"} [data.IsHygiene="false"] - Optional: Indicates if the appointment is for hygiene. Default is "false".
+     * @param {"true" | "false"} [data.IsNewPatient="false"] - Optional: Indicates if the patient is new. Default is "false".
+     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional: Appointment priority. Default is "Normal".
+     * @param {string} [data.PatternSecondary] - Optional: Secondary time pattern.
+     * @returns {Promise<Appointment>} - The created planned appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async createPlannedAppointment(data) {
+        if (!data.PatNum || (!data.AppointmentTypeNum && (!data.procNums || data.procNums.length === 0))) {
+            throw new Error("PatNum and either AppointmentTypeNum or procNums are required.");
+        }
+        return this.httpClient.post("/appointments/planned", data);
+    }
+    /**
+     * Schedule a planned appointment.
+     * @param {Object} data - Data for scheduling the planned appointment.
+     * @param {number} data.AptNum - Required: The appointment number with Planned status.
+     * @param {string} data.AptDateTime - Required: Start time for the appointment in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} data.ProvNum - Required: The provider number for the appointment.
+     * @param {number} data.Op - Required: The operatory number for the appointment.
+     * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
+     * @param {string} [data.Note] - Optional: Notes for the appointment. Will overwrite any existing note.
+     * @returns {Promise<Appointment>} - The scheduled appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async schedulePlannedAppointment(data) {
+        if (!data.AptNum || !data.AptDateTime || !data.ProvNum || !data.Op) {
+            throw new Error("AptNum, AptDateTime, ProvNum, and Op are required.");
+        }
+        return this.httpClient.post("/appointments/scheduleplanned", data);
+    }
+    /**
+     * Schedule a WebSched appointment.
+     * @param {Object} data - Data for scheduling the WebSched appointment.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {string} data.DateTimeStart - Required: The start time of the appointment in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} data.DateTimeEnd - Required: The end time of the appointment in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} data.ProvNum - Required: Provider number associated with the appointment slot.
+     * @param {number} data.OpNum - Required: Operatory number associated with the appointment slot.
+     * @param {number} data.defNumApptType - Required: Appointment type definition number.
+     * @returns {Promise<Appointment>} - The scheduled WebSched appointment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async scheduleWebSchedAppointment(data) {
+        if (!data.PatNum ||
+            !data.DateTimeStart ||
+            !data.DateTimeEnd ||
+            !data.ProvNum ||
+            !data.OpNum ||
+            !data.defNumApptType) {
+            throw new Error("PatNum, DateTimeStart, DateTimeEnd, ProvNum, OpNum, and defNumApptType are required.");
+        }
+        return this.httpClient.post("/appointments/websched", data);
+    }
+    /**
+     * Update an existing appointment.
+     * @param {Object} data - Data for updating the appointment.
+     * @param {number} data.AptNum - Required: The unique identifier of the appointment to update.
+     * @param {"Scheduled" | "Complete" | "UnschedList" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted"} [data.AptStatus] - Optional: Updated status of the appointment.
+     * @param {string} [data.Pattern] - Optional: Updated time pattern in 5-minute increments.
+     * @param {number} [data.Confirmed] - Optional: Updated confirmation status definition number.
+     * @param {number} [data.Op] - Optional: Updated operatory number.
+     * @param {string} [data.Note] - Optional: Updated notes for the appointment. Will overwrite existing notes.
+     * @param {number} [data.ProvNum] - Optional: Updated provider number.
+     * @param {number} [data.ProvHyg] - Optional: Updated hygienist provider number.
+     * @param {string} [data.AptDateTime] - Optional: Updated appointment start time in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} [data.ClinicNum] - Optional: Updated clinic number.
+     * @param {"true" | "false"} [data.IsHygiene] - Optional: Indicates if the appointment is for hygiene.
+     * @param {"true" | "false"} [data.IsNewPatient] - Optional: Indicates if the appointment is for a new patient.
+     * @param {"Normal" | "ASAP"} [data.Priority] - Optional: Updated priority of the appointment.
+     * @param {number} [data.AppointmentTypeNum] - Optional: Updated appointment type number.
+     * @param {number} [data.UnschedStatus] - Optional: Updated unscheduled status definition number.
+     * @param {string} [data.colorOverride] - Optional: Updated custom color in "R,G,B" format.
+     * @param {string} [data.PatternSecondary] - Optional: Updated secondary time pattern.
+     * @returns {Promise<Appointment>} - The updated appointment.
+     * @throws {Error} - If `AptNum` is missing.
+     */
+    async updateAppointment(data) {
+        if (!data.AptNum) {
+            throw new Error("AptNum is required.");
+        }
+        return this.httpClient.put(`/appointments/${data.AptNum}`, data);
+    }
+    /**
+     * Break an existing appointment.
+     * Only appointments with an AptStatus of "Scheduled" can be broken.
+     * @param {Object} data - Data for breaking the appointment.
+     * @param {number} data.AptNum - Required: The unique identifier of the appointment to break.
+     * @param {"true" | "false"} data.sendToUnscheduledList - Required: Indicates if the appointment should be added to the Unscheduled List.
+     * @param {"Missed" | "Cancelled"} [data.breakType] - Optional: Reason for breaking the appointment.
+     * @returns {Promise<void>} - Resolves when the appointment is successfully broken.
+     * @throws {Error} - If required fields are missing.
+     */
+    async breakAppointment(data) {
+        if (!data.AptNum || !data.sendToUnscheduledList) {
+            throw new Error("AptNum and sendToUnscheduledList are required.");
+        }
+        return this.httpClient.put(`/appointments/${data.AptNum}/break`, data);
+    }
+    /**
+     * Update the note for an existing appointment.
+     * @param {number} AptNum - Required: The unique identifier of the appointment to update.
+     * @param {string} Note - Required: The new note content for the appointment.
+     * @returns {Promise<void>} - Resolves when the note is successfully updated.
+     * @throws {Error} - If required fields are missing.
+     */
+    async updateAppointmentNote(AptNum, Note) {
+        if (!AptNum || !Note) {
+            throw new Error("AptNum and Note are required.");
+        }
+        return this.httpClient.put(`/appointments/${AptNum}/note`, { Note });
+    }
+    /**
+     * Confirm an existing appointment.
+     * @param {Object} data - Data for confirming the appointment.
+     * @param {number} data.AptNum - Required: The unique identifier of the appointment to confirm.
+     * @param {string} [data.confirmVal] - Optional: Confirmation value, e.g., "Sent", "Confirmed".
+     * @param {number} [data.defNum] - Optional: Confirmation definition number.
+     * @returns {Promise<void>} - Resolves when the appointment is successfully confirmed.
+     * @throws {Error} - If required fields are missing.
+     */
+    async confirmAppointment(data) {
+        if (!data.AptNum || (!data.confirmVal && !data.defNum)) {
+            throw new Error("AptNum and either confirmVal or defNum are required.");
+        }
+        return this.httpClient.put(`/appointments/${data.AptNum}/confirm`, data);
+    }
 }
 exports.default = Appointments;

package/dist/api/commlogs.d.ts

@@ -0,0 +1,28 @@
+import HttpClient from "../utils/httpClient";
+import { CommLog, CreateCommLogParams } from "../types/commlogType";
+export default class CommLogs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch communication logs for a specific patient.
+     * @param {number} PatNum - Required: The unique identifier for the patient.
+     * @returns {Promise<CommLog[]>} - A list of communication logs for the patient.
+     * @throws {Error} - If `PatNum` is not provided or the API returns an error.
+     */
+    getCommLogs(PatNum: number): Promise<CommLog[]>;
+    /**
+     * Create a new communication log.
+     * @param {CreateCommLogParams} params - The details of the communication log to create.
+     * @param {number} params.PatNum - Required: The unique identifier for the patient.
+     * @param {string} params.CommDateTime - Required: Date and time of the communication in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {"None" | "Email" | "Mail" | "Phone" | "In Person" | "Text" | "Email and Text" | "Phone and Text"} params.Mode_ - Required: Mode of communication.
+     * @param {string} params.Note - Required: Detailed note about the communication.
+     * @param {number} [params.CommType] - Optional: Type of communication: definition.DefNum where definition.Category=25.
+     * @param {string} [params.commType] - Optional: Human-readable description of the communication type.
+     * @param {"Sent" | "Received" | "Neither"} [params.SentOrReceived] - Optional: Direction of communication.
+     * @returns {Promise<CommLog>} - The created communication log.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createCommLog({ PatNum, CommDateTime, Mode_, Note, CommType, commType, SentOrReceived, }: CreateCommLogParams): Promise<CommLog>;
+}
+//# sourceMappingURL=commlogs.d.ts.map

package/dist/api/commlogs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commlogs.d.ts","sourceRoot":"","sources":["../../src/api/commlogs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEpE,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQ5D;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,cAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAiB1C"}

package/dist/api/commlogs.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class CommLogs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch communication logs for a specific patient.
+     * @param {number} PatNum - Required: The unique identifier for the patient.
+     * @returns {Promise<CommLog[]>} - A list of communication logs for the patient.
+     * @throws {Error} - If `PatNum` is not provided or the API returns an error.
+     */
+    async getCommLogs(PatNum) {
+        if (!PatNum || typeof PatNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+        return this.httpClient.get("/commlogs", { PatNum });
+    }
+    /**
+     * Create a new communication log.
+     * @param {CreateCommLogParams} params - The details of the communication log to create.
+     * @param {number} params.PatNum - Required: The unique identifier for the patient.
+     * @param {string} params.CommDateTime - Required: Date and time of the communication in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {"None" | "Email" | "Mail" | "Phone" | "In Person" | "Text" | "Email and Text" | "Phone and Text"} params.Mode_ - Required: Mode of communication.
+     * @param {string} params.Note - Required: Detailed note about the communication.
+     * @param {number} [params.CommType] - Optional: Type of communication: definition.DefNum where definition.Category=25.
+     * @param {string} [params.commType] - Optional: Human-readable description of the communication type.
+     * @param {"Sent" | "Received" | "Neither"} [params.SentOrReceived] - Optional: Direction of communication.
+     * @returns {Promise<CommLog>} - The created communication log.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createCommLog({ PatNum, CommDateTime, Mode_, Note, CommType, commType, SentOrReceived, }) {
+        if (!PatNum || !CommDateTime || !Mode_ || !Note) {
+            throw new Error("Invalid data: PatNum, CommDateTime, Mode_, and Note are required.");
+        }
+        return this.httpClient.post("/commlogs", {
+            PatNum,
+            CommDateTime,
+            Mode_,
+            Note,
+            CommType,
+            commType,
+            SentOrReceived,
+        });
+    }
+}
+exports.default = CommLogs;

package/dist/api/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Patients } from "./patients";
+export { default as Appointments } from "./appointments";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}