@rinse-dental/open-dental 0.1.1 → 0.1.3

package/dist/api/treatplans.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TreatmentPlans {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Get a list of TreatPlans that meet a set of search criteria.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {string} [params.PatNum] - patient.PatNum.
+     * @param {string} [params.SecDateTEdit] - Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {"Saved" | "Active" | "Inactive"} [params.TPStatus] - Either "Saved", "Active", or "Inactive". Default all.
+     * @returns {Promise<TreatmentPlan[]>} - An array of recall list objects.
+     */
+    async getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, } = {}) {
+        const params = {
+            PatNum,
+            SecDateTEdit,
+            TPStatus,
+        };
+        return this.httpClient.get("/treatplans", params);
+    }
+    /**
+    * Create a new TreatPlan.
+    * @param {Object} data - Data for the new appointment.
+    * @param {number} data.PatNum - Required. FK to patient.PatNum.
+    * @param {string} [data.Heading] - Optional. Defaults to the heading of the supplied Treatment Plan.
+    * @param {string} [data.Note] - Optional: An administrative note for staff use.
+    * @param {"Insurance" | "Discount"} [params.TPType] - Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
+    * @returns {Promise<TreatmentPlan>} - The created recall object.
+    * @throws {Error} - If required fields are missing.
+    */
+    async createTreatmentPlan(data) {
+        if (!data.PatNum) {
+            throw new Error("PatNum is required.");
+        }
+        return this.httpClient.post("/treatplans", data);
+    }
+    /**
+     * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.TreatPlanNum - Required.
+     * @param {string} [data.Heading] - Optional. Defaults to the heading of the supplied Treatment Plan.
+     * @param {string} [data.UserNumPresenter=0] - Optional. FK to userod.UserNum. Default 0.
+     * @returns {Promise<TreatmentPlan>} - The created recall object.
+     * @throws {Error} - If required fields are missing.
+     */
+    async saveTreatmentPlan(data) {
+        if (!data.TreatPlanNum) {
+            throw new Error("TreatPlanNum is required.");
+        }
+        return this.httpClient.post("/treatplans/Saved", data);
+    }
+    /**
+    * Create a new TreatPlan.
+    * @param {Object} data - Data for the new appointment.
+    * @param {number} data.TreatPlanNum - Required.
+    * @param {string} [data.Heading] - The heading that shows at the top of the treatment plan.
+    * @param {string} [data.Note] - Optional: An administrative note for staff use.
+    * @param {number} [data.ResponsParty] - FK to patient.PatNum. The patient responsible for approving the treatment.
+    * @param {"Insurance" | "Discount"} [params.TPType] - Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
+    * @param {string} [data.SignatureText] - The typed name of the person who signed the patient signature.
+    * @param {string} [data.SignaturePracticeText] - The typed name of the person who signed the patient signature.
+    * @param {"true" | "false"} [data.isSigned] - The typed name of the person who signed the patient signature.
+    * @param {"true" | "false"} [data.isSignedPractice] - Either "true" or "false". True updates the treatplan SignaturePractice, digitally signs for the practice, and overwrites existing signature. False clears the exisiting treatplan SignaturePractice.
+    * @returns {Promise<TreatmentPlan>} - The created recall object.
+    * @throws {Error} - If required fields are missing.
+     */
+    async updateTreatmentPlan(data) {
+        if (!data.TreatPlanNum) {
+            throw new Error("TreatPlanNum is required.");
+        }
+        return this.httpClient.put(`/treatplans/${data.TreatPlanNum}`, data);
+    }
+}
+exports.default = TreatmentPlans;

package/dist/openDental.d.ts

@@ -1,19 +1,49 @@
-import Patients from "./api/patients";
 import Appointments from "./api/appointments";
+import ChartModules from "./api/chartModules";
+import CommLogs from "./api/commlogs";
+import PatFields from "./api/patFields";
+import Patients from "./api/patients";
+import ProcedureLogs from "./api/procedureLog";
+import Recalls from "./api/recalls";
+import TreatmentPlans from "./api/treatplans";
 declare class OpenDental {
     private static httpClient;
     /**
      * Initialize the OpenDental library with the base URL and auth token.
      */
     static initialize(baseURL: string, authToken: string): void;
+    /**
+     * Create a new instance of the Appointments API.
+     */
+    static Appointments(): Appointments;
+    /**
+     * Create a new instance of the ChartModule API endpoint.
+     */
+    static CommLogs(): CommLogs;
+    /**
+     * Create a new instance of the ChartModule API endpoint.
+     */
+    static ChartModules(): ChartModules;
+    /**
+       * Create a new instance of the Patients API.
+       */
+    static PatFields(): PatFields;
     /**
      * Create a new instance of the Patients API.
      */
     static Patients(): Patients;
     /**
-     * Create a new instance of the Appointments API.
+     * Create a new instance of the ProcedureLogs API endpoint.
      */
-    static Appointments(): Appointments;
+    static ProcedureLogs(): ProcedureLogs;
+    /**
+     * Create a new instance of the Patients API.
+     */
+    static Recalls(): Recalls;
+    /**
+     * Create a new instance of the Patients API.
+     */
+    static TreatmentPlans(): TreatmentPlans;
 }
 export { OpenDental };
 //# sourceMappingURL=openDental.d.ts.map

package/dist/openDental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,YAAY;CAM3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;CAQ7B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -5,8 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenDental = void 0;
 const httpClient_1 = __importDefault(require("./utils/httpClient"));
-const patients_1 = __importDefault(require("./api/patients"));
 const appointments_1 = __importDefault(require("./api/appointments"));
+const chartModules_1 = __importDefault(require("./api/chartModules"));
+const commlogs_1 = __importDefault(require("./api/commlogs"));
+const patFields_1 = __importDefault(require("./api/patFields"));
+const patients_1 = __importDefault(require("./api/patients"));
+const procedureLog_1 = __importDefault(require("./api/procedureLog"));
+const recalls_1 = __importDefault(require("./api/recalls"));
+const treatplans_1 = __importDefault(require("./api/treatplans"));
 class OpenDental {
     static httpClient;
     /**
@@ -20,6 +26,42 @@ class OpenDental {
         baseURL = baseURL + "/api/v1";
         this.httpClient = new httpClient_1.default(baseURL, authToken);
     }
+    /**
+     * Create a new instance of the Appointments API.
+     */
+    static Appointments() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new appointments_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the ChartModule API endpoint.
+     */
+    static CommLogs() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new commlogs_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the ChartModule API endpoint.
+     */
+    static ChartModules() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new chartModules_1.default(this.httpClient);
+    }
+    /**
+       * Create a new instance of the Patients API.
+       */
+    static PatFields() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new patFields_1.default(this.httpClient);
+    }
     /**
      * Create a new instance of the Patients API.
      */
@@ -30,13 +72,31 @@ class OpenDental {
         return new patients_1.default(this.httpClient);
     }
     /**
-     * Create a new instance of the Appointments API.
+     * Create a new instance of the ProcedureLogs API endpoint.
      */
-    static Appointments() {
+    static ProcedureLogs() {
         if (!this.httpClient) {
             throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
         }
-        return new appointments_1.default(this.httpClient);
+        return new procedureLog_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Patients API.
+     */
+    static Recalls() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new recalls_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Patients API.
+     */
+    static TreatmentPlans() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new treatplans_1.default(this.httpClient);
     }
 }
 exports.OpenDental = OpenDental;

package/dist/types/{appointmentType.d.ts → appointmentTypes.d.ts}

@@ -223,4 +223,4 @@ export type AptStatus = "Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Bro
  * Appointment priority options.
  */
 export type Priority = "Normal" | "ASAP";
-//# sourceMappingURL=appointmentType.d.ts.map
+//# sourceMappingURL=appointmentTypes.d.ts.map

package/dist/types/appointmentTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appointmentTypes.d.ts","sourceRoot":"","sources":["../../src/types/appointmentTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACD,MAAM,WAAW,aAAa;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAEL;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,SAAS,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,cAAc,GAAG,QAAQ,CAAC;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,UAAU,GACV,aAAa,GACb,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,iBAAiB,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC"}

package/dist/types/chartModuleTypes.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface PlannedAppointment {
+    AptNum?: number;
+    ProvNum?: number;
+    ItemOrder?: string;
+    minutes?: string;
+    ProcDescript?: string;
+    Note?: string;
+    dateSched?: string;
+    AptStatus?: AptStatus;
+}
+/**
+ * Appointment status options.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export type AptStatus = "Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted";
+//# sourceMappingURL=chartModuleTypes.d.ts.map

package/dist/types/chartModuleTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chartModuleTypes.d.ts","sourceRoot":"","sources":["../../src/types/chartModuleTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACnB,WAAW,GACX,UAAU,GACV,aAAa,GACb,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,iBAAiB,CAAC"}

package/dist/types/{commlogType.d.ts → commlogTypes.d.ts}

@@ -25,4 +25,4 @@ export interface CreateCommLogParams {
     commType?: string;
     SentOrReceived?: "Sent" | "Received" | "Neither";
 }
-//# sourceMappingURL=commlogType.d.ts.map
+//# sourceMappingURL=commlogTypes.d.ts.map

package/dist/types/commlogTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commlogTypes.d.ts","sourceRoot":"","sources":["../../src/types/commlogTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IACzG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CAClD;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IACxG,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CACpD"}

package/dist/types/commlogTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/patFieldTypes.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apipatfields.html
+ */
+export interface PatField {
+    PatFieldNum?: number;
+    PatNum?: number;
+    FieldName?: string;
+    FieldValue?: string;
+    SecDateTEdit?: string;
+    SecDateEntry?: string;
+}
+export interface GetPatFieldsParams {
+    PatNum?: number;
+    FieldName?: string;
+    SecDateTEdit?: string;
+}
+export interface AddUpdatePatFieldParams {
+    PatNum: number;
+    FieldName: string;
+    FieldValue: string;
+}
+//# sourceMappingURL=patFieldTypes.d.ts.map

package/dist/types/patFieldTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patFieldTypes.d.ts","sourceRoot":"","sources":["../../src/types/patFieldTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/patFieldTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/recallTypes.d.ts

@@ -0,0 +1,98 @@
+/**
+   * GET Recalls object.
+   * @see https://www.opendental.com/site/apirecalls.html
+   */
+export interface Recall {
+    RecallNum?: number;
+    PatNum?: number;
+    DateDue?: string;
+    DatePrevious?: string;
+    RecallInterval?: string;
+    RecallStatus?: number;
+    recallStatus?: string;
+    Note?: string;
+    IsDisabled?: "true" | "false";
+    DateTStamp?: string;
+    RecallTypeNum?: number;
+    DisableUntilBalance?: number;
+    DisableUntilDate?: string;
+    DateScheduled?: string;
+    Priority?: "Normal" | "ASAP";
+    TimePatternOverride?: string;
+}
+/**
+ * GET Recall List params.
+ * @see https://www.opendental.com/site/apirecalls.html
+ */
+export interface RecallListParams {
+    DateStart?: string;
+    DateEnd?: number;
+    ProvNum?: string;
+    ClinicNum?: string;
+    RecallType?: string;
+    IncludeReminded?: string;
+    Offset?: number;
+}
+/**
+ * GET Recall List object.
+ * @see https://www.opendental.com/site/apirecalls.html
+ */
+export interface RecallList {
+    DueDate?: string;
+    PatNum?: number;
+    Patient?: string;
+    Age?: string;
+    Type?: string;
+    Interval?: string;
+    NumRemind?: string;
+    LastReminder?: string;
+    Contact?: string;
+    Status?: string;
+    ClinicNum?: number;
+    Note?: string;
+}
+/**
+ * CREATE Recall params. Creates a recall object.
+ * @see https://www.opendental.com/site/apirecalls.html
+ */
+export interface CreateRecallParams {
+    PatNum: number;
+    RecallTypeNum: number;
+    DateDue?: string;
+    RecallInterval?: string;
+    RecallStatus?: number;
+    Note?: string;
+    IsDisabled?: "true" | "false";
+    DisableUntilBalance?: number;
+    DisableUntilDate?: string;
+    Priority?: "Normal" | "ASAP";
+    TimePatternOverride?: string;
+}
+/**
+  * EDIT Recall params. Updates a recall object.
+  * @see https://www.opendental.com/site/apirecalls.html
+  */
+export interface UpdateRecallParams {
+    RecallNum: number;
+    DateDue?: string;
+    RecallInterval?: string;
+    RecallStatus?: number;
+    Note?: string;
+    IsDisabled?: "true" | "false";
+    DisableUntilBalance?: number;
+    DisableUntilDate?: string;
+    Priority?: "Normal" | "ASAP";
+    TimePatternOverride?: string;
+}
+/**
+  * EDIT Recall Status params and object.
+  * @see https://www.opendental.com/site/apirecalls.html
+  */
+export interface UpdateRecallStatusParams {
+    PatNum: number;
+    recallType: string;
+    RecallStatus?: number;
+    commlogMode?: "None" | "Email" | "Mail" | "Phone" | "InPerson" | "Text" | "EmailAndText" | "PhoneAndText";
+    commlogNote?: string;
+}
+//# sourceMappingURL=recallTypes.d.ts.map

package/dist/types/recallTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recallTypes.d.ts","sourceRoot":"","sources":["../../src/types/recallTypes.ts"],"names":[],"mappings":"AAAA;;;KAGK;AACH,MAAM,WAAW,MAAM;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAEF;;;IAGI;AACD,MAAM,WAAW,kBAAkB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAEN;;;IAGI;AACD,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,cAAc,GAAG,cAAc,CAAC;IAC1G,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/types/recallTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/treatPlanTypes.d.ts

@@ -0,0 +1,72 @@
+/**
+* GET TreatPlans object.
+* @see https://www.opendental.com/site/apitreatplans.html
+*/
+export interface TreatmentPlan {
+    TreatPlanNum?: number;
+    PatNum?: number;
+    DateTP?: string;
+    Heading?: string;
+    Note?: string;
+    SigIsTopaz?: "true" | "false";
+    ResponsParty?: number;
+    DocNum?: number;
+    TPStatus?: string;
+    SecUserNumEntry?: number;
+    SecDateEntry?: string;
+    SecDateTEdit?: string;
+    UserNumPresenter?: number;
+    TPType?: "Insurance" | "Discount";
+    DateTSigned?: string;
+    DateTPracticeSigned?: string;
+    SignatureText?: string;
+    SignaturePracticeText?: string;
+    isSigned?: "true" | "false";
+    isSignedPractice?: "true" | "false";
+}
+/**
+ * Get TreatPlans Params. Returns TreatPlan object
+ * @see https://www.opendental.com/site/apitreatplans.html
+ */
+export interface GetTreatmentPlanParams {
+    PatNum?: number;
+    SecDateTEdit?: string;
+    TPStatus?: "Saved" | "Active" | "Inactive";
+}
+/**
+ * POST TreatPlans Params. Returns TreatPlan object
+ * @see https://www.opendental.com/site/apitreatplans.html
+ */
+export interface CreateTreatmentPlanParams {
+    PatNum: number;
+    Heading?: string;
+    Note?: string;
+    TPType?: "Insurance" | "Discount";
+}
+/**
+ * POST Save TreatPlans Params. Returns TreatPlan object.
+ * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
+ * @see https://www.opendental.com/site/apitreatplans.html
+ */
+export interface SaveTreatmentPlanParams {
+    TreatPlanNum: number;
+    Heading?: string;
+    UserNumPresenter?: number;
+}
+/**
+* PUT TreatPlans object.
+* @see https://www.opendental.com/site/apitreatplans.html
+*/
+export interface UpdateTreatmentPlanParams {
+    TreatPlanNum: number;
+    DateTP?: string;
+    Heading?: string;
+    Note?: string;
+    ResponsParty?: number;
+    TPType?: "Insurance" | "Discount";
+    SignatureText?: string;
+    SignaturePracticeText?: string;
+    isSigned?: "true" | "false";
+    isSignedPractice?: "true" | "false";
+}
+//# sourceMappingURL=treatPlanTypes.d.ts.map

package/dist/types/treatPlanTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treatPlanTypes.d.ts","sourceRoot":"","sources":["../../src/types/treatPlanTypes.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,MAAM,WAAW,aAAa;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;EAGE;AACF,MAAM,WAAW,yBAAyB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC"}

package/dist/types/treatPlanTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/appointments.ts

@@ -14,7 +14,7 @@ import {
   UpdateAppointmentParams,
   BreakAppointmentParams,
   ConfirmAppointmentParams,
-} from "../types/appointmentType";
+} from "../types/appointmentTypes";
 
 export default class Appointments {
   private httpClient: HttpClient;
@@ -333,5 +333,4 @@ public async getAppointments({
 
     return this.httpClient.put<void>(`/appointments/${data.AptNum}/confirm`, data);
   }
-
 }

package/src/api/chartModules.ts

@@ -0,0 +1,25 @@
+import HttpClient from "../utils/httpClient";
+import {
+  PlannedAppointment,
+} from "../types/chartModuleTypes"
+
+export default class ChartModules {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: 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.
+   */
+  public async getPlannedAppts(PatNum: number): Promise<PlannedAppointment> {
+    if (!PatNum) {
+      throw new Error("PatNum is required.");
+    }
+    return this.httpClient.get<PlannedAppointment>(`/chartmodules/${PatNum}/PlannedAppts`);
+  }
+}

package/src/api/commlogs.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { CommLog, CreateCommLogParams } from "../types/commlogType";
+import { CommLog, CreateCommLogParams } from "../types/commlogTypes";
 
 export default class CommLogs {
   private httpClient: HttpClient;

package/src/api/index.ts

@@ -1,4 +1,9 @@
-export { default as Patients } from "./patients";
 export { default as Appointments } from "./appointments";
-//export { default as ProcedureLogs } from "./procedureLogs";
+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";
 // Add other APIs as needed