@rinse-dental/open-dental 1.0.9 → 1.1.0

package/deploy_notes.txt

@@ -10,7 +10,7 @@ git tag //confirm tag
 git push origin vX.Y.Z
 gh release create vX.Y.Z --title "Release vX.Y.Z" --notes ""
 
-gh release create v1.0.0 --title "Release v1.0.0" --notes "first major release"
+gh release create v1.0.4 --title "Release v1.0.4" --notes "addition of patplan, insplan, familymodule apis"
 
 if the tag doesn't exist locally: 
 git tag vX.Y.Z

package/dist/api/labCases.d.ts

@@ -0,0 +1,66 @@
+import HttpClient from "../utils/httpClient";
+import { LabCase, GetLabCasesParams, CreateLabCaseParams, UpdateLabCaseParams } from "../types/labCaseTypes";
+export default class LabCases {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single lab case by its ID.
+     * @param {number} LabCaseNum - The unique identifier for the LabCase.
+     * @returns {Promise<LabCase>} - The LabCase object.
+     * @throws {Error} - If `LabCaseNum` is not provided.
+     */
+    getLabCase(LabCaseNum: number): Promise<LabCase>;
+    /**
+      * Fetch multiple lab cases with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - FK to patient.PatNum.
+      * @param {number} [params.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+      * @param {number} [params.AptNum] - FK to appointment.AptNum.
+      * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum.
+      * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<LabCase[]>} - A list of lab cases.
+      */
+    getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum }?: GetLabCasesParams): Promise<LabCase[]>;
+    /**
+     * Create a new inssub.
+     * @param {Object} data - The details of InsSub to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} data.ProvNum - Required. FK to provider.ProvNum.
+     * @param {number} [data.AptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - Optional. The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - Optional. The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - Optional. The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - Optional. The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
+     * @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The created lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createLabCase({ PatNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }: CreateLabCaseParams): Promise<LabCase>;
+    /**
+     * Update an inssub.
+     * @param {Object} data - The details of lab case to update.
+     * @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
+     * @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} [data.AptNum] - FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} [data.ProvNum] - FK to provider.ProvNum.
+     * @param {string} [data.Instructions] - The text instructions for this labcase.
+     * @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The updated lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateLabCase({ LabCaseNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }: UpdateLabCaseParams): Promise<LabCase>;
+}
+//# sourceMappingURL=labCases.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"labCases.d.ts","sourceRoot":"","sources":["../../src/api/labCases.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,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,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;;;QAUI;IACS,WAAW,CAAC,EACvB,MAAM,EACN,aAAa,EACb,MAAM,EACN,aAAa,EACb,OAAO,EACR,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAY9C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,aAAa,EACb,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,MAAM,EACN,UAAU,GACX,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,MAAM,EACN,UAAU,GACX,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAqC3C"}

package/dist/api/labCases.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class LabCases {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single lab case by its ID.
+     * @param {number} LabCaseNum - The unique identifier for the LabCase.
+     * @returns {Promise<LabCase>} - The LabCase object.
+     * @throws {Error} - If `LabCaseNum` is not provided.
+     */
+    async getLabCase(LabCaseNum) {
+        if (!LabCaseNum) {
+            throw new Error("LabCaseNum is required.");
+        }
+        return this.httpClient.get(`/labcases/${LabCaseNum}`);
+    }
+    /**
+      * Fetch multiple lab cases with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - FK to patient.PatNum.
+      * @param {number} [params.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+      * @param {number} [params.AptNum] - FK to appointment.AptNum.
+      * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum.
+      * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<LabCase[]>} - A list of lab cases.
+      */
+    async getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum } = {}) {
+        const params = {
+            PatNum,
+            LaboratoryNum,
+            AptNum,
+            PlannedAptNum,
+            ProvNum
+        };
+        return this.httpClient.get("/labcases", params);
+    }
+    /**
+     * Create a new inssub.
+     * @param {Object} data - The details of InsSub to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} data.ProvNum - Required. FK to provider.ProvNum.
+     * @param {number} [data.AptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - Optional. The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - Optional. The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - Optional. The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - Optional. The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
+     * @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The created lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createLabCase({ PatNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }) {
+        if (!PatNum || !LaboratoryNum || !ProvNum) {
+            throw new Error("Invalid data: PatNum, LaboratoryNum, and ProvNum are required.");
+        }
+        return this.httpClient.post("/labcases", {
+            PatNum,
+            LaboratoryNum,
+            ProvNum,
+            AptNum,
+            PlannedAptNum,
+            DateTimeDue,
+            DateTimeCreated,
+            DateTimeSent,
+            DateTimeRecd,
+            DateTimeChecked,
+            Instructions,
+            LabFee,
+            InvoiceNum,
+        });
+    }
+    /**
+     * Update an inssub.
+     * @param {Object} data - The details of lab case to update.
+     * @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
+     * @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} [data.AptNum] - FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} [data.ProvNum] - FK to provider.ProvNum.
+     * @param {string} [data.Instructions] - The text instructions for this labcase.
+     * @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The updated lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateLabCase({ LabCaseNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }) {
+        if (!LabCaseNum || typeof LabCaseNum !== "number") {
+            throw new Error("Invalid data: A Valid LabCaseNum is required.");
+        }
+        return this.httpClient.put(`/labcases/${LabCaseNum}`, {
+            LaboratoryNum,
+            ProvNum,
+            AptNum,
+            PlannedAptNum,
+            DateTimeDue,
+            DateTimeCreated,
+            DateTimeSent,
+            DateTimeRecd,
+            DateTimeChecked,
+            Instructions,
+            LabFee,
+            InvoiceNum,
+        });
+    }
+}
+exports.default = LabCases;

package/dist/openDental.d.ts

@@ -89,6 +89,10 @@ declare class OpenDental {
      * Create a new instance of the PatPlan API.
      */
     static PatPlans(): PatPlans;
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static LabCases(): PatPlans;
 }
 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,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;AAC9C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAEtC,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;IAO5B;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;CAMvB;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;AAC9C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,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;IAO5B;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;CAMvB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -188,5 +188,14 @@ class OpenDental {
         }
         return new patPlans_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static LabCases() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new patPlans_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/labCaseTypes.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Represents an InsSub in the Open Dental system. Links an InsPlan to a Subscriber (patient.PatNum). Also, see PatPlans to indicate coverage.
+ * @see https://www.opendental.com/site/apilabcases.html
+ */
+export interface LabCase {
+    LabCaseNum?: number;
+    PatNum?: number;
+    LaboratoryNum?: number;
+    AptNum?: number;
+    PlannedAptNum?: number;
+    DateTimeDue?: string;
+    DateTimeCreated?: string;
+    DateTimeSent?: string;
+    DateTimeRecd?: string;
+    DateTimeChecked?: string;
+    ProvNum?: number;
+    Instructions?: string;
+    LabFee?: number;
+    DateTStamp?: string;
+    InvoiceNum?: string;
+}
+/**
+ * Gets a list of labcases.
+ */
+export interface GetLabCasesParams {
+    PatNum?: number;
+    LaboratoryNum?: number;
+    AptNum?: number;
+    PlannedAptNum?: number;
+    ProvNum?: number;
+}
+/**
+ * Creates a labcase.
+ */
+export interface CreateLabCaseParams {
+    PatNum?: number;
+    LaboratoryNum?: number;
+    ProvNum?: number;
+    AptNum?: number;
+    PlannedAptNum?: number;
+    DateTimeDue?: string;
+    DateTimeCreated?: string;
+    DateTimeSent?: string;
+    DateTimeRecd?: string;
+    DateTimeChecked?: string;
+    Instructions?: string;
+    LabFee?: number;
+    InvoiceNum?: string;
+}
+/**
+ * Updates a labcase.
+ */
+export interface UpdateLabCaseParams {
+    LabCaseNum?: number;
+    LaboratoryNum?: number;
+    ProvNum?: number;
+    AptNum?: number;
+    PlannedAptNum?: number;
+    DateTimeDue?: string;
+    DateTimeCreated?: string;
+    DateTimeSent?: string;
+    DateTimeRecd?: string;
+    DateTimeChecked?: string;
+    Instructions?: string;
+    LabFee?: number;
+    InvoiceNum?: string;
+}
+//# sourceMappingURL=labCaseTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"labCaseTypes.d.ts","sourceRoot":"","sources":["../../src/types/labCaseTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/types/labCaseTypes.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": "1.0.9",
+    "version": "1.1.0",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/labCases.ts

@@ -0,0 +1,183 @@
+import HttpClient from "../utils/httpClient";
+import {
+  LabCase,
+  GetLabCasesParams,
+  CreateLabCaseParams,
+  UpdateLabCaseParams,
+} from "../types/labCaseTypes";
+
+export default class LabCases {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single lab case by its ID.
+   * @param {number} LabCaseNum - The unique identifier for the LabCase.
+   * @returns {Promise<LabCase>} - The LabCase object.
+   * @throws {Error} - If `LabCaseNum` is not provided.
+   */
+  public async getLabCase(LabCaseNum: number): Promise<LabCase> {
+    if (!LabCaseNum) {
+      throw new Error("LabCaseNum is required.");
+    }
+    return this.httpClient.get<LabCase>(`/labcases/${LabCaseNum}`);
+  }
+
+  /**
+    * Fetch multiple lab cases with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PatNum] - FK to patient.PatNum.
+    * @param {number} [params.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+    * @param {number} [params.AptNum] - FK to appointment.AptNum.
+    * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum.
+    * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<LabCase[]>} - A list of lab cases.
+    */
+  public async getLabCases({
+    PatNum,
+    LaboratoryNum,
+    AptNum,
+    PlannedAptNum,
+    ProvNum
+  }: GetLabCasesParams = {}): Promise<LabCase[]> {
+    const params = {
+      PatNum,
+      LaboratoryNum,
+      AptNum,
+      PlannedAptNum,
+      ProvNum
+    };
+  
+    return this.httpClient.get<LabCase[]>("/labcases", params);
+  }
+
+  /**
+   * Create a new inssub.
+   * @param {Object} data - The details of InsSub to create.
+   * @param {number} data.PatNum - Required. FK to patient.PatNum.
+   * @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+   * @param {number} data.ProvNum - Required. FK to provider.ProvNum.
+   * @param {number} [data.AptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+   * @param {number} [data.PlannedAptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Planned.
+   * @param {string} [data.DateTimeDue] - Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeCreated] - Optional. The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeSent] - Optional. The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeRecd] - Optional. The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeChecked] - Optional. The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
+   * @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+   * @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
+  * @returns {Promise<LabCase>} - The created lab case.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createLabCase({
+    PatNum,
+    LaboratoryNum,
+    ProvNum,
+    AptNum,
+    PlannedAptNum,
+    DateTimeDue,
+    DateTimeCreated,
+    DateTimeSent,
+    DateTimeRecd,
+    DateTimeChecked,
+    Instructions,
+    LabFee,
+    InvoiceNum,
+  } : CreateLabCaseParams): Promise<LabCase> {
+    if (!PatNum || !LaboratoryNum || !ProvNum) {
+      throw new Error("Invalid data: PatNum, LaboratoryNum, and ProvNum are required.");
+    }
+
+    return this.httpClient.post<LabCase>("/labcases", {
+      PatNum,
+      LaboratoryNum,
+      ProvNum,
+      AptNum,
+      PlannedAptNum,
+      DateTimeDue,
+      DateTimeCreated,
+      DateTimeSent,
+      DateTimeRecd,
+      DateTimeChecked,
+      Instructions,
+      LabFee,
+      InvoiceNum,
+    });
+  }
+
+  /**
+   * Update an inssub.
+   * @param {Object} data - The details of lab case to update.
+   * @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
+   * @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+   * @param {number} [data.AptNum] - FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+   * @param {number} [data.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
+   * @param {string} [data.DateTimeDue] - The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeCreated] - The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeSent] - The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeRecd] - The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {string} [data.DateTimeChecked] - The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+   * @param {number} [data.ProvNum] - FK to provider.ProvNum.
+   * @param {string} [data.Instructions] - The text instructions for this labcase.
+   * @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
+   * @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
+  * @returns {Promise<LabCase>} - The updated lab case.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateLabCase({
+    LabCaseNum,
+    LaboratoryNum,
+    ProvNum,
+    AptNum,
+    PlannedAptNum,
+    DateTimeDue,
+    DateTimeCreated,
+    DateTimeSent,
+    DateTimeRecd,
+    DateTimeChecked,
+    Instructions,
+    LabFee,
+    InvoiceNum,
+  } : UpdateLabCaseParams): Promise<LabCase> {
+    if (!LabCaseNum || typeof LabCaseNum !== "number") {
+      throw new Error("Invalid data: A Valid LabCaseNum is required.");
+    }
+
+    return this.httpClient.put<LabCase>(`/labcases/${LabCaseNum}`, {
+      LaboratoryNum,
+      ProvNum,
+      AptNum,
+      PlannedAptNum,
+      DateTimeDue,
+      DateTimeCreated,
+      DateTimeSent,
+      DateTimeRecd,
+      DateTimeChecked,
+      Instructions,
+      LabFee,
+      InvoiceNum,
+    });
+  }
+
+  
+  /**
+   * Delete an inssub entry. Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.
+   * @param {number} LabCaseNum - Required: The unique identifier of the inssub to delete.
+   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @throws {Error} - If `LabCaseNum` is not valid or the API returns an error.
+   */
+  /*
+  public async deleteLabCase(LabCaseNum: number): Promise<void> {
+    if (!LabCaseNum || typeof LabCaseNum !== "number") {
+      throw new Error("Invalid parameter: LabCaseNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/labcases/${LabCaseNum}`);
+  }
+  */
+}

package/src/openDental.ts

@@ -16,6 +16,7 @@ import DiscountPlanSubs from "./api/discountPlanSubs";
 import FamilyModules from "./api/familyModules";
 import InsSubs from "./api/insSubs";
 import PatPlans from "./api/patPlans";
+import LabCases from "./api/labCases";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -204,6 +205,16 @@ class OpenDental {
     }
     return new PatPlans(this.httpClient);
   }
+
+  /**
+   * Create a new instance of the LabCases API.
+   */
+  public static LabCases() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new PatPlans(this.httpClient);
+  }
 }
 
 export { OpenDental };

package/src/types/labCaseTypes.ts

@@ -0,0 +1,71 @@
+/**
+ * Represents an InsSub in the Open Dental system. Links an InsPlan to a Subscriber (patient.PatNum). Also, see PatPlans to indicate coverage.
+ * @see https://www.opendental.com/site/apilabcases.html 
+ */
+export interface LabCase {
+    LabCaseNum?: number; //PK
+    PatNum?: number; //FK to patient.PatNum.
+    LaboratoryNum?: number; //FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+    AptNum?: number; //FK to appointment.AptNum.
+    PlannedAptNum?: number; //FK to appointment.AptNum.
+    DateTimeDue?: string; //The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeCreated?: string; // When the labcase was created. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeSent?: string; //The time that the labcase actually went out to the lab. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeRecd?: string; //Date/time received back from the lab. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeChecked?: string; //Date/time that quality was checked. String in "yyyy-MM-dd HH:mm:ss" format.
+    ProvNum?: number; //FK to provider.ProvNum.
+    Instructions?: string; //The text instructions for this labcase.
+    LabFee?: number; //This is used for tracking and informational purposes only. The fee is not used in any calculation.
+    DateTStamp?: string; //String in "yyyy-MM-dd HH:mm:ss" format
+    InvoiceNum?: string; //This is an optional invoice number used for tracking and informational purposes only.
+  }
+
+  /**
+   * Gets a list of labcases.
+   */
+  export interface GetLabCasesParams {
+    PatNum?: number; //FK to patient.PatNum.
+    LaboratoryNum?: number; //FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+    AptNum?: number; //FK to appointment.AptNum.
+    PlannedAptNum?: number; //FK to appointment.AptNum.
+    ProvNum?: number; //FK to provider.ProvNum.
+  }
+
+  /**
+   * Creates a labcase.
+   */
+  export interface CreateLabCaseParams {
+    PatNum?: number; //Required. FK to patient.PatNum.
+    LaboratoryNum?: number; //Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+    ProvNum?: number; //Required. FK to provider.ProvNum.
+    AptNum?: number; //Optional. FK to appointment.AptNum.
+    PlannedAptNum?: number; //Optional. FK to appointment.AptNum.
+    DateTimeDue?: string; //Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeCreated?: string; //Optional. When the labcase was created. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeSent?: string; //Optional. The time that the labcase actually went out to the lab. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeRecd?: string; //Optional. Date/time received back from the lab. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeChecked?: string; //Optional. Date/time that quality was checked. String in "yyyy-MM-dd HH:mm:ss" format.
+    Instructions?: string; //Optional. The text instructions for this labcase.
+    LabFee?: number; //Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+    InvoiceNum?: string; //Optional. This is an optional invoice number used for tracking and informational purposes only.
+  }
+  
+  /**
+   * Updates a labcase.
+   */
+  export interface UpdateLabCaseParams {
+    LabCaseNum?: number; //Required in the URL.
+    LaboratoryNum?: number; //Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+    ProvNum?: number; //Required. FK to provider.ProvNum.
+    AptNum?: number; //Optional. FK to appointment.AptNum.
+    PlannedAptNum?: number; //Optional. FK to appointment.AptNum.
+    DateTimeDue?: string; //Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeCreated?: string; //Optional. When the labcase was created. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeSent?: string; //Optional. The time that the labcase actually went out to the lab. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeRecd?: string; //Optional. Date/time received back from the lab. String in "yyyy-MM-dd HH:mm:ss" format.
+    DateTimeChecked?: string; //Optional. Date/time that quality was checked. String in "yyyy-MM-dd HH:mm:ss" format.
+    Instructions?: string; //Optional. The text instructions for this labcase.
+    LabFee?: number; //Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+    InvoiceNum?: string; //Optional. This is an optional invoice number used for tracking and informational purposes only.
+  }
+