@rinse-dental/open-dental 1.0.9 → 1.2.0

package/dist/openDental.d.ts

@@ -15,6 +15,9 @@ 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";
+import Referrals from "./api/referrals";
+import RefAttaches from "./api/refAttaches";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -89,6 +92,18 @@ declare class OpenDental {
      * Create a new instance of the PatPlan API.
      */
     static PatPlans(): PatPlans;
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static LabCases(): LabCases;
+    /**
+     * Create a new instance of the Referrals API.
+     */
+    static Referrals(): Referrals;
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static RefAttaches(): RefAttaches;
 }
 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;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,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;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;CAM1B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -22,6 +22,9 @@ const discountPlanSubs_1 = __importDefault(require("./api/discountPlanSubs"));
 const familyModules_1 = __importDefault(require("./api/familyModules"));
 const insSubs_1 = __importDefault(require("./api/insSubs"));
 const patPlans_1 = __importDefault(require("./api/patPlans"));
+const labCases_1 = __importDefault(require("./api/labCases"));
+const referrals_1 = __importDefault(require("./api/referrals"));
+const refAttaches_1 = __importDefault(require("./api/refAttaches"));
 class OpenDental {
     static httpClient;
     /**
@@ -188,5 +191,32 @@ 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 labCases_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Referrals API.
+     */
+    static Referrals() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new referrals_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static RefAttaches() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new refAttaches_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/dist/types/refAttachTypes.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Represents an RefAttaches in the Open Dental system. Attaches a patient to a referral source.
+ * @see https://www.opendental.com/site/apirefattaches.html
+ */
+export interface RefAttach {
+    RefAttachNum?: number;
+    ReferralNum?: number;
+    referralName?: string;
+    PatNum?: number;
+    ItemOrder?: number;
+    RefDate?: string;
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom";
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete";
+    Note?: string;
+    IsTransitionOfCare?: "true" | "false";
+    ProcNum?: number;
+    DateProcComplete?: string;
+    ProvNum?: number;
+    DateTStamp?: string;
+}
+export interface GetRefAttachesParams {
+    PatNum?: number;
+    Offset?: number;
+}
+/**
+ * Attaches a patient to a referral source. The referral source must be specified by either ReferralNum or referralName.
+ * Before calling this method, use Referrals GET to find the ReferralNum of an existing referral source.
+ * Alternatively, specify a referralName to search the LName of existing referrals for an exact match.
+ * If a match is not found, a new referral with that name is created and used.
+ */
+export interface CreateRefAttachParams {
+    PatNum: number;
+    ReferralNum?: number;
+    referralName?: string;
+    RefDate?: string;
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom";
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete";
+    Note?: string;
+    IsTransitionOfCare?: "true" | "false";
+    ProcNum?: number;
+    DateProcComplete?: string;
+    ProvNum?: number;
+}
+/**
+ * Updates an existing refattach.
+ */
+export interface UpdateRefAttachParams {
+    RefAttachNum: number;
+    ReferralNum?: number;
+    RefDate?: string;
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom";
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete";
+    Note?: string;
+    IsTransitionOfCare?: "true" | "false";
+    ProcNum?: number;
+    DateProcComplete?: string;
+    ProvNum?: number;
+}
+//# sourceMappingURL=refAttachTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refAttachTypes.d.ts","sourceRoot":"","sources":["../../src/types/refAttachTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/refAttachTypes.js

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

package/dist/types/referralTypes.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Represents an Referral in the Open Dental system. These can be either a provider, patient, or non-person. The description of non-patient sources is stored in the LName field.
+ * @see https://www.opendental.com/site/apireferrals.html
+ */
+export interface Referral {
+    ReferralNum?: number;
+    LName?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    specialty?: string;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: number;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    IsHidden?: "true" | "false";
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    PatNum?: string;
+    IsDoctor?: "true" | "false";
+    DateTStamp?: string;
+    IsPreferred?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+    isPatient?: "true" | "false";
+}
+export interface GetReferralsParams {
+    IsHidden?: "true" | "false";
+    NotPerson?: "true" | "false";
+    IsDoctor?: "true" | "false";
+    IsPreferred?: "true" | "false";
+    isPatient?: "true" | "false";
+    BusinessName?: string;
+    Offset?: number;
+}
+/**
+ * Creates a new Referral. Referrals can be for patients (provide PatNum), providers (provide specialty) or non-persons (provide neither PatNum or specialty).
+ * In the last case, isPatient and IsDoctor will be set false automatically while NotPerson will be set to true.
+ * If you wish to create an associated RefAttach please see RefAttaches POST.
+ */
+export interface CreateReferralParams {
+    LName?: string;
+    PatNum?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    specialty?: string;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    IsDoctor?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+}
+/**
+ * Updates an existing Referral. All fields are optional. Referrals for a patient can only have the Note and DisplayNote fields modified.
+ */
+export interface UpdateReferralParams {
+    ReferralNum?: number;
+    LName?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: number;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    IsDoctor?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+}
+//# sourceMappingURL=referralTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"referralTypes.d.ts","sourceRoot":"","sources":["../../src/types/referralTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B;AAGD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/types/referralTypes.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.2.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/api/refAttaches.ts

@@ -0,0 +1,142 @@
+import HttpClient from "../utils/httpClient";
+import {
+  RefAttach,
+  GetRefAttachesParams,
+  CreateRefAttachParams,
+  UpdateRefAttachParams,
+} from "../types/refAttachTypes"
+
+export default class RefAttaches {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+    * Fetch multiple refattaches with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PatNum] - The PatNum of the RefAttaches.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<RefAttach[]>} - A list of inssubs.
+    */
+  public async getRefAttaches({
+    PatNum,
+    Offset,
+  }: GetRefAttachesParams = {}): Promise<RefAttach[]> {
+    const params = {
+      PatNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<RefAttach[]>("/refattaches", params);
+  }
+
+  /**
+   * Attach a referral to a patient.
+   * @param {Object} data - The details of RefAttach to create.
+   * @param {number} data.PatNum - Required. FK to patient.PatNum.
+   * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+   * @param {string} [data.referralName] - Required. Number assigned by insurance company.
+   * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+   * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+   * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+   * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+   * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+   * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+   * @returns {Promise<RefAttach>} - The created refattaches.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createRefAttach({
+    PatNum,
+    ReferralNum,
+    referralName,
+    RefDate,
+    ReferralType,
+    RefToStatus,
+    Note,
+    IsTransitionOfCare,
+    ProcNum,
+    DateProcComplete,
+    ProvNum,
+  } : CreateRefAttachParams): Promise<RefAttach> {
+    if (!PatNum || (!ReferralNum && !referralName)) {
+      throw new Error("Invalid data: PatNum and either ReferralNum or referralName are required.");
+    }
+
+    return this.httpClient.post<RefAttach>("/refattaches", {
+      PatNum,
+      ReferralNum,
+      referralName,
+      RefDate,
+      ReferralType,
+      RefToStatus,
+      Note,
+      IsTransitionOfCare,
+      ProcNum,
+      DateProcComplete,
+      ProvNum,
+    });
+  }
+
+  /**
+   * Update a refattach.
+   * @param {Object} data - The details of RefAttach to create.
+   * @param {number} data.RefAttachNum - Required. FK to patient.PatNum.
+   * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+   * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+   * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+   * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+   * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+   * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+   * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+   * @returns {Promise<RefAttach>} - The created refattaches.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateRefAttach({
+    RefAttachNum,
+    ReferralNum,
+    RefDate,
+    ReferralType,
+    RefToStatus,
+    Note,
+    IsTransitionOfCare,
+    ProcNum,
+    DateProcComplete,
+    ProvNum,
+  } : UpdateRefAttachParams): Promise<RefAttach> {
+    if (!RefAttachNum) {
+      throw new Error("Invalid data: RefAttachNum is required.");
+    }
+
+    return this.httpClient.put<RefAttach>(`/refattaches/${RefAttachNum}`, {
+      ReferralNum,
+      RefDate,
+      ReferralType,
+      RefToStatus,
+      Note,
+      IsTransitionOfCare,
+      ProcNum,
+      DateProcComplete,
+      ProvNum,
+    });
+  }
+
+  /**
+   * Delete a refattach.
+   * @param {number} RefAttachNum - Required: The unique identifier of the RefAttach to delete.
+   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @throws {Error} - If `RefAttachNum` is not valid or the API returns an error.
+   */
+  public async deleteInsSub(RefAttachNum: number): Promise<void> {
+    if (!RefAttachNum || typeof RefAttachNum !== "number") {
+      throw new Error("Invalid parameter: RefAttachNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/refattaches/${RefAttachNum}`);
+  }
+}