@rinse-dental/open-dental 0.1.0 → 0.1.3

package/dist/api/appointments.d.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { Appointment, AppointmentSlot, GetAppointmentParams, GetASAPParams, GetSlotsParams, GetSlotsWebSchedParams, GetWebSchedAppointmentsParams, CreateNewAppointmentParams, CreatePlannedAppointmentParams, SchedulePlannedAppointmentParams, ScheduleWebSchedAppointmentParams, UpdateAppointmentParams, BreakAppointmentParams, ConfirmAppointmentParams } from "../types/appointmentType";
+import { Appointment, AppointmentSlot, GetAppointmentParams, GetASAPParams, GetSlotsParams, GetSlotsWebSchedParams, GetWebSchedAppointmentsParams, CreateNewAppointmentParams, CreatePlannedAppointmentParams, SchedulePlannedAppointmentParams, ScheduleWebSchedAppointmentParams, UpdateAppointmentParams, BreakAppointmentParams, ConfirmAppointmentParams } from "../types/appointmentTypes";
 export default class Appointments {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -193,3 +193,4 @@ export default class Appointments {
      */
     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,2BAA2B,CAAC;AAEnC,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;CAO/E"}

package/dist/api/chartModules.d.ts

@@ -0,0 +1,14 @@
+import HttpClient from "../utils/httpClient";
+import { PlannedAppointment } from "../types/chartModuleTypes";
+export default class ChartModules {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
+     * @param {number} PatNum - The unique identifier for the patient.
+     * @returns {Promise<PlannedAppointment>} - The planned appts object.
+     * @throws {Error} - If `PatNum` is not provided.
+     */
+    getPlannedAppts(PatNum: number): Promise<PlannedAppointment>;
+}
+//# sourceMappingURL=chartModules.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"chartModules.d.ts","sourceRoot":"","sources":["../../src/api/chartModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,kBAAkB,EACnB,MAAM,2BAA2B,CAAA;AAElC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAM1E"}

package/dist/api/chartModules.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ChartModules {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
+     * @param {number} PatNum - The unique identifier for the patient.
+     * @returns {Promise<PlannedAppointment>} - The planned appts object.
+     * @throws {Error} - If `PatNum` is not provided.
+     */
+    async getPlannedAppts(PatNum) {
+        if (!PatNum) {
+            throw new Error("PatNum is required.");
+        }
+        return this.httpClient.get(`/chartmodules/${PatNum}/PlannedAppts`);
+    }
+}
+exports.default = ChartModules;

package/dist/api/commlogs.d.ts

@@ -0,0 +1,28 @@
+import HttpClient from "../utils/httpClient";
+import { CommLog, CreateCommLogParams } from "../types/commlogTypes";
+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,uBAAuB,CAAC;AAErE,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

@@ -1,2 +1,9 @@
-export { default as Patients } from "./patients";
 export { default as Appointments } from "./appointments";
+export { default as ChartModules } from "./chartModules";
+export { default as CommLogs } from "./commlogs";
+export { default as PatFields } from "./patFields";
+export { default as Patients } from "./patients";
+export { default as ProcedureLogs } from "./procedureLog";
+export { default as Recalls } from "./recalls";
+export { default as TreatmentPlans } from "./treatplans";
+//# 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,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC"}

package/dist/api/index.js

@@ -3,10 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Appointments = exports.Patients = void 0;
-var patients_1 = require("./patients");
-Object.defineProperty(exports, "Patients", { enumerable: true, get: function () { return __importDefault(patients_1).default; } });
+exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
 var appointments_1 = require("./appointments");
 Object.defineProperty(exports, "Appointments", { enumerable: true, get: function () { return __importDefault(appointments_1).default; } });
-//export { default as ProcedureLogs } from "./procedureLogs";
+var chartModules_1 = require("./chartModules");
+Object.defineProperty(exports, "ChartModules", { enumerable: true, get: function () { return __importDefault(chartModules_1).default; } });
+var commlogs_1 = require("./commlogs");
+Object.defineProperty(exports, "CommLogs", { enumerable: true, get: function () { return __importDefault(commlogs_1).default; } });
+var patFields_1 = require("./patFields");
+Object.defineProperty(exports, "PatFields", { enumerable: true, get: function () { return __importDefault(patFields_1).default; } });
+var patients_1 = require("./patients");
+Object.defineProperty(exports, "Patients", { enumerable: true, get: function () { return __importDefault(patients_1).default; } });
+var procedureLog_1 = require("./procedureLog");
+Object.defineProperty(exports, "ProcedureLogs", { enumerable: true, get: function () { return __importDefault(procedureLog_1).default; } });
+var recalls_1 = require("./recalls");
+Object.defineProperty(exports, "Recalls", { enumerable: true, get: function () { return __importDefault(recalls_1).default; } });
+var treatplans_1 = require("./treatplans");
+Object.defineProperty(exports, "TreatmentPlans", { enumerable: true, get: function () { return __importDefault(treatplans_1).default; } });
 // Add other APIs as needed

package/dist/api/patFields.d.ts

@@ -0,0 +1,53 @@
+import HttpClient from "../utils/httpClient";
+import { PatField, GetPatFieldsParams, AddUpdatePatFieldParams } from "../types/patFieldTypes";
+export default class PatFields {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single patfield by its ID.
+     * @param {number} PatFieldNum - The ID of the patfield.
+     * @returns {Promise<PatField>} - The patient data.
+     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     */
+    getPatField(PatFieldNum: number): Promise<PatField>;
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.PatNum] - Filter by last name (case-insensitive, partial match).
+     * @param {string} [params.FieldName] - Filter by last name (case-insensitive, partial match).
+     * @param {string} [params.SecDateTEdit] - Filter by last name (case-insensitive, partial match).
+     * @returns {Promise<PatField[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    getPatFields({ PatNum, FieldName, SecDateTEdit, }?: GetPatFieldsParams): Promise<PatField[]>;
+    /**
+     * Creates a patfield. Cannot create PatFields associated with hidden PatFieldDefs.
+     * @param {Object} data - The data for the new patfield.
+     * @param {number} data.PatNum - Required: The patient's PatNum.
+     * @param {string} data.FieldName - Required: FK to PatFieldDef.FieldName. Case sensitive.
+     * @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
+     * @returns {Promise<PatField>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    createPatField({ PatNum, FieldName, FieldValue, }: AddUpdatePatFieldParams): Promise<PatField>;
+    /**
+     * Updates an existing patfield.
+     * @param {Object} data - The data for the updated patfield.
+     * @param {number} data.PatNum - Required: The patient's PatNum.
+     * @param {string} data.FieldName - Required: FK to PatFieldDef.FieldName. Case sensitive.
+     * @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
+     * @returns {Promise<PatField>} - The updated PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    editPatField({ PatNum, FieldName, FieldValue, }: AddUpdatePatFieldParams): Promise<PatField>;
+    /**
+     * Delete a single patfield by its ID.
+     * @param {number} PatFieldNum - The ID of the patField.
+     * @returns {Promise<{ status: number }>} - The API response containing the status code.
+     * @throws {Error} - If `PatFieldNum` is not valid or the API returns an error.
+     */
+    deletePatField(PatFieldNum: number): Promise<{
+        status: number;
+    }>;
+}
+//# sourceMappingURL=patFields.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"patFields.d.ts","sourceRoot":"","sources":["../../src/api/patFields.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,QAAQ,EACR,kBAAkB,EAClB,uBAAuB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQhE;;;;;;;;OAQG;IACY,YAAY,CAAC,EACxB,MAAM,EACN,SAAS,EACT,YAAY,GACb,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAShD;;;;;;;;OAQG;IACU,cAAc,CAAC,EACxB,MAAM,EACN,SAAS,EACT,UAAU,GACX,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWhD;;;;;;;;OAQG;IACU,YAAY,CAAC,EACtB,MAAM,EACN,SAAS,EACT,UAAU,GACX,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWhD;;;;;OAKG;IACU,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAOhF"}

package/dist/api/patFields.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PatFields {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single patfield by its ID.
+     * @param {number} PatFieldNum - The ID of the patfield.
+     * @returns {Promise<PatField>} - The patient data.
+     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     */
+    async getPatField(PatFieldNum) {
+        if (!PatFieldNum || typeof PatFieldNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+        return await this.httpClient.get(`/patfields/${PatFieldNum}`);
+    }
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.PatNum] - Filter by last name (case-insensitive, partial match).
+     * @param {string} [params.FieldName] - Filter by last name (case-insensitive, partial match).
+     * @param {string} [params.SecDateTEdit] - Filter by last name (case-insensitive, partial match).
+     * @returns {Promise<PatField[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    async getPatFields({ PatNum, FieldName, SecDateTEdit, } = {}) {
+        return await this.httpClient.get("/patfields", {
+            PatNum,
+            FieldName,
+            SecDateTEdit,
+        });
+    }
+    /**
+     * Creates a patfield. Cannot create PatFields associated with hidden PatFieldDefs.
+     * @param {Object} data - The data for the new patfield.
+     * @param {number} data.PatNum - Required: The patient's PatNum.
+     * @param {string} data.FieldName - Required: FK to PatFieldDef.FieldName. Case sensitive.
+     * @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
+     * @returns {Promise<PatField>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    async createPatField({ PatNum, FieldName, FieldValue, }) {
+        if (!PatNum || !FieldName || !FieldValue) {
+            throw new Error("Invalid data: All fields are required.");
+        }
+        return await this.httpClient.post("/patfields", {
+            PatNum,
+            FieldName,
+            FieldValue,
+        });
+    }
+    /**
+     * Updates an existing patfield.
+     * @param {Object} data - The data for the updated patfield.
+     * @param {number} data.PatNum - Required: The patient's PatNum.
+     * @param {string} data.FieldName - Required: FK to PatFieldDef.FieldName. Case sensitive.
+     * @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
+     * @returns {Promise<PatField>} - The updated PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    async editPatField({ PatNum, FieldName, FieldValue, }) {
+        if (!PatNum || !FieldName || !FieldValue) {
+            throw new Error("Invalid data: All fields are required.");
+        }
+        return await this.httpClient.put("/patfields", {
+            PatNum,
+            FieldName,
+            FieldValue,
+        });
+    }
+    /**
+     * Delete a single patfield by its ID.
+     * @param {number} PatFieldNum - The ID of the patField.
+     * @returns {Promise<{ status: number }>} - The API response containing the status code.
+     * @throws {Error} - If `PatFieldNum` is not valid or the API returns an error.
+     */
+    async deletePatField(PatFieldNum) {
+        if (!PatFieldNum || typeof PatFieldNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+        return await this.httpClient.delete(`/patfields/${PatFieldNum}`);
+    }
+}
+exports.default = PatFields;

package/dist/api/patients.d.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { Patient, PatientSummary, GetPatientsParams, CreatePatientParams, UpdatePatientParams } from "../types/patientTypes";
+import { Patient, PatientSummary, GetPatientsParams, GetPatientsSimpleParams, CreatePatientParams, UpdatePatientParams } from "../types/patientTypes";
 export default class Patients {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -37,6 +37,25 @@ export default class Patients {
      * @throws {Error} - If the API returns an error.
      */
     getPatients({ LName, FName, Phone, Address, hideInactive, City, State, SSN, ChartNumber, guarOnly, showArchived, Birthdate, SiteNum, SubscriberId, Email, Country, ClinicNum, clinicAbbr, invoiceNumber, Offset, }?: GetPatientsParams): Promise<PatientSummary[]>;
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.LName] - Filter by last name (case-insensitive, partial match).
+     * @param {string} [params.FName] - Filter by first name (case-insensitive, partial match).
+     * @param {string} [params.Birthdate] - Filter by birthdate in "yyyy-MM-dd" format.
+     * @param {number} [params.ClinicNum] - Filter by clinic number (comma-separated list).
+     * @param {"Patient" | "NonPatient" | "Inactive" | "Archived" | "Deceased" | "Prospective".} [params.PatStatus] - Filter by Patient Status.
+     * @param {string} [params.DateTStamp] - In "yyyy-mm-dd HH:mm:ss" format.
+     * @param {number} [params.PriProv] - A single ProvNum. Leave blank if you want results for all primary providers.
+     * @param {"Male" | "Female" | "Unknown" | "Other"} [params.Gender] - Either "Male", "Female", "Unknown", or "Other".
+     * @param {"Single" | "Married" | "Child" | "Widowed" | "Divorced"} [params.Position] - Either "Single", "Married", "Child", "Widowed", or "Divorced".
+     * @param {number} [params.Guarantor] - A single PatNum. The person responsible for the account.
+     * @param {number} [params.SuperFamily] - A single PatNum. The head of a SuperFamily.
+     * @param {number} [params.Offset] - Pagination offset.
+     * @returns {Promise<Patient[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    getPatientsSimple({ LName, FName, Birthdate, ClinicNum, PatStatus, DateTStamp, PriProv, Gender, Position, Guarantor, SuperFamily, Offset, }?: GetPatientsSimpleParams): Promise<Patient[]>;
     /**
      * Create a new patient.
      * @param {Object} data - The data for the new patient.
@@ -110,3 +129,4 @@ export default class Patients {
     */
     updatePatient(PatNum: number, data: UpdatePatientParams): Promise<Patient>;
 }
+//# sourceMappingURL=patients.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"patients.d.ts","sourceRoot":"","sources":["../../src/api/patients.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACY,WAAW,CAAC,EACvB,KAAK,EACL,KAAK,EACL,KAAK,EACL,OAAO,EACP,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,GAAG,EACH,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,EACL,OAAO,EACP,SAAS,EACT,UAAU,EACV,aAAa,EACb,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IA2BvD;;;;;;;;;;;;;;;;;OAiBG;IACU,iBAAiB,CAAC,EAC7B,KAAK,EACL,KAAK,EACL,SAAS,EACT,SAAS,EACT,SAAS,EACT,UAAU,EACV,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,EACT,WAAW,EACX,MAAM,GACP,GAAE,uBAA4B,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,aAAa,CAAC,EACzB,KAAK,EACL,KAAK,EACL,GAAG,YAAY,EAChB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAwCE;IACY,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAcxF"}

package/dist/api/patients.js

@@ -67,6 +67,40 @@ class Patients {
             Offset,
         });
     }
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.LName] - Filter by last name (case-insensitive, partial match).
+     * @param {string} [params.FName] - Filter by first name (case-insensitive, partial match).
+     * @param {string} [params.Birthdate] - Filter by birthdate in "yyyy-MM-dd" format.
+     * @param {number} [params.ClinicNum] - Filter by clinic number (comma-separated list).
+     * @param {"Patient" | "NonPatient" | "Inactive" | "Archived" | "Deceased" | "Prospective".} [params.PatStatus] - Filter by Patient Status.
+     * @param {string} [params.DateTStamp] - In "yyyy-mm-dd HH:mm:ss" format.
+     * @param {number} [params.PriProv] - A single ProvNum. Leave blank if you want results for all primary providers.
+     * @param {"Male" | "Female" | "Unknown" | "Other"} [params.Gender] - Either "Male", "Female", "Unknown", or "Other".
+     * @param {"Single" | "Married" | "Child" | "Widowed" | "Divorced"} [params.Position] - Either "Single", "Married", "Child", "Widowed", or "Divorced".
+     * @param {number} [params.Guarantor] - A single PatNum. The person responsible for the account.
+     * @param {number} [params.SuperFamily] - A single PatNum. The head of a SuperFamily.
+     * @param {number} [params.Offset] - Pagination offset.
+     * @returns {Promise<Patient[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    async getPatientsSimple({ LName, FName, Birthdate, ClinicNum, PatStatus, DateTStamp, PriProv, Gender, Position, Guarantor, SuperFamily, Offset, } = {}) {
+        return await this.httpClient.get("/patients/Simple", {
+            LName,
+            FName,
+            Birthdate,
+            ClinicNum,
+            PatStatus,
+            DateTStamp,
+            PriProv,
+            Gender,
+            Position,
+            Guarantor,
+            SuperFamily,
+            Offset,
+        });
+    }
     /**
      * Create a new patient.
      * @param {Object} data - The data for the new patient.

package/dist/api/procedureLog.d.ts

@@ -114,3 +114,4 @@ export default class ProcedureLogs {
      */
     postInsuranceHistory({ PatNum, InsSubNum, insHistPrefName, ProcDate, }: postInsuranceHistoryParams): Promise<InsuranceHistory>;
 }
+//# sourceMappingURL=procedureLog.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"procedureLog.d.ts","sourceRoot":"","sources":["../../src/api/procedureLog.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAQpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,kBAAkB,CAAC,EAC9B,MAAM,EACN,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,GAAG,YAAY,EAChB,EAAE,wBAAwB,GAAG,OAAO,CAAC,YAAY,CAAC;IAcnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,kBAAkB,CAC7B,OAAO,EAAE,MAAM,EACf,EACE,QAAQ,EACR,MAAM,EACN,OAAO,EACP,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,OAAO,EACP,EAAE,EACF,aAAa,EACb,SAAS,GACV,EAAE,wBAAwB,GAC1B,OAAO,CAAC,YAAY,CAAC;IAsBxB;;;;;OAKG;IACU,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;;;OAMG;IACU,mBAAmB,CAAC,EAC/B,MAAM,EACN,SAAS,GACV,EAAE,yBAAyB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAW1D;;;;;;;;OAQG;IACU,oBAAoB,CAAC,EAChC,MAAM,EACN,SAAS,EACT,eAAe,EACf,QAAQ,GACT,EAAE,0BAA0B,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAc1D"}

package/dist/api/recalls.d.ts

@@ -0,0 +1,84 @@
+import HttpClient from "../utils/httpClient";
+import { Recall, RecallListParams, RecallList, CreateRecallParams, UpdateRecallParams, UpdateRecallStatusParams } from "../types/recallTypes";
+export default class Recalls {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Gets a list of recalls.
+     * @param {number} PatNum - Optional search by PatNum.
+     * @returns {Promise<Recall>} - An array of recall objects.
+     */
+    getRecalls(PatNum: number): Promise<Recall>;
+    /**
+     * Gets the Recall List similar to how it's shown in the Appointment Module when you click on Lists and select Recall List.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {string} [params.DateStart] - Due date range. String in "yyyy-mm-dd" format. Default is based on RecallDaysPast preference.
+     * @param {string} [params.DateEnd] - Due date range. String in "yyyy-mm-dd" format. Default is based on RecallDaysFuture preference.
+     * @param {number} [params.ProvNum] - Provider. Default is all providers. Will consider PriProv and SecProv.
+     * @param {number} [params.ClinicNum] - Clinic. Default is all clinics. Use 0 for "Unassigned".
+     * @param {string} [params.RecallType] - Typically either "Prophy" or "Perio". Default is all RecallTypes stored in the preference.
+     * @param {"true" | "false"} [params.IncludeReminded] - Show patients that have already received reminders. Either "true" or "false". Default is false.
+     * @returns {Promise<RecallList[]>} - An array of recall list objects.
+     */
+    getRecallList({ DateStart, DateEnd, ProvNum, ClinicNum, RecallType, IncludeReminded, Offset, }?: RecallListParams): Promise<RecallList[]>;
+    /**
+     * Create a new recall.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} data.RecallTypeNum -  Required. FK to recalltype.RecallTypeNum. A patient may only have one recall for each RecallType.
+     * @param {string} [data.DateDue] - Optional. This is the date that is actually used when doing reports for recall. String in "yyyy-MM-dd" format.
+     * @param {string} [data.RecallInterval] - Optional.The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for
+     * @param {number} [data.RecallStatus=0] - Optional. FK to definition.DefNum where definition.Category=13. Default 0.
+     * @param {string} [data.Note] - Optional: An administrative note for staff use.
+     * @param {"true" | "false"} [params.IsDisabled="false"] - Optional. Either "true" or "false". Default "false".
+     * @param {number} [data.DisableUntilBalance] - Optional: Hygienist provider number. Default is 0.
+     * @param {string} [data.DisableUntilDate] - Optional. Recall will be disabled until this date. String in "yyyy-MM-dd" format.
+     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional. Either "Normal" or "ASAP". Default "Normal".
+     * @param {string} [data.TimePatternOverride] - Optional. Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
+     * @returns {Promise<Recall>} - The created recall object.
+     * @throws {Error} - If required fields are missing.
+     */
+    createRecall(data: CreateRecallParams): Promise<Recall>;
+    /**
+     * Edit a recall.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.RecallNum - Required. Primary key of recall to edit.
+     * @param {string} [data.DateDue] - Optional. This is the date that is actually used when doing reports for recall. String in "yyyy-MM-dd" format.
+     * @param {string} [data.RecallInterval] - Optional.The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for
+     * @param {number} [data.RecallStatus=0] - Optional. FK to definition.DefNum where definition.Category=13. Default 0.
+     * @param {string} [data.Note] - Optional: An administrative note for staff use.
+     * @param {"true" | "false"} [params.IsDisabled="false"] - Optional. Either "true" or "false". Default "false".
+     * @param {number} [data.DisableUntilBalance] - Optional: Hygienist provider number. Default is 0.
+     * @param {string} [data.DisableUntilDate] - Optional. Recall will be disabled until this date. String in "yyyy-MM-dd" format.
+     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional. Either "Normal" or "ASAP". Default "Normal".
+     * @param {string} [data.TimePatternOverride] - Optional. Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
+     * @returns {Promise<Recall>} - The created recall object.
+     * @throws {Error} - If required fields are missing.
+     */
+    updateRecall(data: UpdateRecallParams): Promise<Recall>;
+    /**
+    * Update recall status.
+    * @param {Object} data - Data for the new appointment.
+    * @param {number} data.PatNum - Required. FK to patient.PatNum.
+    * @param {string} data.recallType - Required. Typically either "Prophy" or "Perio". RecallType is dependent upon Setup Recall and Recall Types.
+    * @param {number} [data.RecallStatus=0] - Optional. FK to definition.DefNum where definition.Category=13. Default 0.
+    * @param {"None" | "Email" | "Mail" | "Phone" | "InPerson" | "Text" | "EmailAndText" | "PhoneAndText"} [data.commlogMode] - Optional: An administrative note for staff use.
+    * @param {string} [data.commlogNote] - Optional. This text will be used instead of the default commlog.Note.
+    * @returns {Promise<EditRecallStatusParams>} - The created recall object.
+    * @throws {Error} - If required fields are missing.
+    */
+    updateRecallStatus(data: UpdateRecallStatusParams): Promise<UpdateRecallStatusParams>;
+    /**
+    * Switches a Recall's type similiar to clicking the 'Set Perio' or 'Set Prophy' button found in the Recall window.
+    * @param {Object} data - Data for the new appointment.
+    * @param {number} data.PatNum - Patient to switch recall type.
+    * @returns {Promise<{ status: number }>} - The API response containing the status code.
+    * @throws {Error} - If required fields are missing.
+    */
+    switchRecallType(data: {
+        PatNum: number;
+    }): Promise<{
+        status: number;
+    }>;
+}
+//# sourceMappingURL=recalls.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recalls.d.ts","sourceRoot":"","sources":["../../src/api/recalls.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,MAAM,EACN,gBAAgB,EAChB,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,wBAAwB,EAC3B,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;OAIG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQxD;;;;;;;;;;OAUG;IACU,aAAa,CAAC,EACvB,SAAS,EACT,OAAO,EACP,OAAO,EACP,SAAS,EACT,UAAU,EACV,eAAe,EACf,MAAM,GACT,GAAE,gBAAqB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAchD;;;;;;;;;;;;;;;;OAgBG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQpE;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQpE;;;;;;;;;;MAUE;IACW,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAQlG;;;;;;MAME;IACW,gBAAgB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CASvF"}