@rinse-dental/open-dental 1.0.3 → 1.0.4

package/dist/api/procedureLog.js

@@ -17,16 +17,38 @@ class ProcedureLogs {
         }
         return this.httpClient.get(`/procedurelogs/${ProcNum}`);
     }
+    /**
+      * Fetch multiple procedurelogs with optional filtering and pagination.
+      * @param {Object} params - Filtering and pagination parameters.
+      * @param {number} [params.PatNum] - Get procedurelogs by PatNum
+      * @param {number} [params.AptNum] - Get procedurelogs by AptNum
+      * @param {number} [params.PlannedAptNum] - Get procedurelogs by PlannedAptNum
+      * @param {number} [params.ClinicNum] - Get procedurelogs by ClinicNum
+      * @param {string} [params.DateTStamp] - Get procedurelogs altered after the specified date and time
+      * @param {string} [params.Offset] - Pagination
+      * @returns {Promise<ProcedureLog[]>} - A list of procedurelogs.
+      * @throws {Error} - If the API returns an error.
+      */
+    async getProcedureLogs({ PatNum, AptNum, PlannedAptNum, ClinicNum, DateTStamp, Offset, } = {}) {
+        return await this.httpClient.get("/procedurelogs", {
+            PatNum,
+            AptNum,
+            PlannedAptNum,
+            ClinicNum,
+            DateTStamp,
+            Offset,
+        });
+    }
     /**
      * Create a new procedure log entry.
-     * @param {Object} params - The details of the procedure log to create.
-     * @param {number} params.PatNum - Required: Patient number.
-     * @param {string} params.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
-     * @param {'TP' | 'C' | 'EO'} params.ProcStatus - Required: Procedure status.
-     * @param {string} params.procCode - Required: Procedure code (D code).
-     * @param {number} [params.AptNum] - Optional: Associated appointment number.
-     * @param {number} [params.ProcFee] - Optional: Fee for the procedure.
-     * @param {Surf} [Surf] - Optional: Tooth surface or treatment area. Options include:
+     * @param {Object} data - The details of the procedure log to create.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
+     * @param {'TP' | 'C' | 'EO'} data.ProcStatus - Required: Procedure status.
+     * @param {string} data.procCode - Required: Procedure code (D code).
+     * @param {number} [data.AptNum] - Optional: Associated appointment number.
+     * @param {number} [data.ProcFee] - Optional: Fee for the procedure.
+     * @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
       * - "B/F" (Buccal/Facial)
       * - "V" (Vestibular)
       * - "M" (Mesial)
@@ -45,17 +67,19 @@ class ProcedureLogs {
       * - "6" (Sextant 6)
       * - "U" (Upper Arch)
       * - "L" (Lower Arch)
-     * @param {string} [params.ToothNum] - Optional: Tooth number.
-     * @param {string} [params.ToothRange] - Optional: Tooth range.
-     * @param {number} [params.Priority] - Optional: Priority code.
-     * @param {number} [params.ProvNum] - Optional: Provider number.
-     * @param {string} [params.Dx] - Optional: Diagnosis code.
-     * @param {number} [params.PlannedAptNum] - Optional: Planned appointment number.
-     * @param {number} [params.ClinicNum] - Optional: Clinic number.
+     * @param {string} [data.ToothNum] - Optional: Tooth number.
+     * @param {string} [data.ToothRange] - Optional: Tooth range.
+     * @param {number} [data.Priority] - Optional: Priority code.
+     * @param {number} [data.ProvNum] - Optional: Provider number.
+     * @param {string} [data.Dx] - Optional: Diagnosis code.
+     * @param {number} [data.PlannedAptNum] - Optional: Planned appointment number.
+     * @param {number} [data.ClinicNum] - Optional: Clinic number.
      * @returns {Promise<ProcedureLog>} - The created procedure log.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
-    async createProcedureLog({ PatNum, ProcDate, ProcStatus, procCode, ...optionalData }) {
+    async createProcedureLog({ PatNum, ProcDate, ProcStatus, procCode, AptNum, ProcFee, Surf, ToothNum, ToothRange, Priority, priority, ProvNum, Dx, dxName, PlannedAptNum, ClinicNum,
+    //...optionalData
+     }) {
         if (!PatNum || !ProcDate || !ProcStatus || !procCode) {
             throw new Error("Invalid data: PatNum, ProcDate, ProcStatus, and procCode are required.");
         }
@@ -64,20 +88,31 @@ class ProcedureLogs {
             ProcDate,
             ProcStatus,
             procCode,
-            ...optionalData,
+            AptNum,
+            ProcFee,
+            Surf,
+            ToothNum,
+            ToothRange,
+            Priority,
+            priority,
+            ProvNum,
+            Dx,
+            dxName,
+            PlannedAptNum,
+            ClinicNum,
         });
     }
     /**
      * Update an existing procedure log entry.
-     * @param {number} ProcNum - Required: The unique identifier of the procedure log to update.
-     * @param {Object} params - The updated details of the procedure log.
-     * @param {string} [params.ProcDate] - Optional: Updated procedure date in "yyyy-MM-dd" format.
-     * @param {number} [params.AptNum] - Optional: Updated associated appointment number.
-     * @param {number} [params.ProcFee] - Optional: Updated fee for the procedure.
-     * @param {number} [params.Priority] - Optional: Updated priority code.
-     * @param {'TP' | 'C' | 'EO'} [params.ProcStatus] - Optional: Updated procedure status.
-     * @param {string} [params.procCode] - Optional: Updated procedure code (D code).
-     * @param {Surf} [Surf] - Optional: Tooth surface or treatment area. Options include:
+     * @param {Object} data - The updated details of the procedure log.
+     * @param {number} data.ProcNum - Required: The unique identifier of the procedure log to update.
+     * @param {string} [data.ProcDate] - Optional: Updated procedure date in "yyyy-MM-dd" format.
+     * @param {number} [data.AptNum] - Optional: Updated associated appointment number.
+     * @param {number} [data.ProcFee] - Optional: Updated fee for the procedure.
+     * @param {number} [data.Priority] - Optional: Updated priority code.
+     * @param {'TP' | 'C' | 'EO'} [data.ProcStatus] - Optional: Updated procedure status.
+     * @param {string} [data.procCode] - Optional: Updated procedure code (D code).
+     * @param {Surf} [data.Surf] - Optional: Tooth surface or treatment area. Options include:
       * - "B/F" (Buccal/Facial)
       * - "V" (Vestibular)
       * - "M" (Mesial)
@@ -96,16 +131,16 @@ class ProcedureLogs {
       * - "6" (Sextant 6)
       * - "U" (Upper Arch)
       * - "L" (Lower Arch)
-     * @param {string} [params.ToothNum] - Optional: Updated tooth number.
-     * @param {string} [params.ToothRange] - Optional: Updated tooth range.
-     * @param {number} [params.ProvNum] - Optional: Updated provider number.
-     * @param {string} [params.Dx] - Optional: Updated diagnosis code.
-     * @param {number} [params.PlannedAptNum] - Optional: Updated planned appointment number.
-     * @param {number} [params.ClinicNum] - Optional: Updated clinic number.
+     * @param {string} [data.ToothNum] - Optional: Updated tooth number.
+     * @param {string} [data.ToothRange] - Optional: Updated tooth range.
+     * @param {number} [data.ProvNum] - Optional: Updated provider number.
+     * @param {string} [data.Dx] - Optional: Updated diagnosis code.
+     * @param {number} [data.PlannedAptNum] - Optional: Updated planned appointment number.
+     * @param {number} [data.ClinicNum] - Optional: Updated clinic number.
      * @returns {Promise<ProcedureLog>} - The updated procedure log.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
-    async updateProcedureLog(ProcNum, { ProcDate, AptNum, ProcFee, Priority, ProcStatus, procCode, Surf, ToothNum, ToothRange, ProvNum, Dx, PlannedAptNum, ClinicNum, }) {
+    async updateProcedureLog({ ProcNum, ProcDate, AptNum, ProcFee, Priority, ProcStatus, procCode, Surf, ToothNum, ToothRange, ProvNum, Dx, PlannedAptNum, ClinicNum, }) {
         if (!ProcNum || typeof ProcNum !== "number") {
             throw new Error("Invalid parameter: ProcNum must be a valid number.");
         }
@@ -139,8 +174,9 @@ class ProcedureLogs {
     }
     /**
      * Fetch insurance history for a patient.
-     * @param {number} PatNum - Required: The patient number.
-     * @param {number} InsSubNum - Required: The insurance subscription number.
+     * @param {Object} params - the params to filter
+     * @param {number} params.PatNum - Required: The patient number.
+     * @param {number} params.InsSubNum - Required: The insurance subscription number.
      * @returns {Promise<InsuranceHistory[]>} - The insurance history details.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
@@ -155,10 +191,11 @@ class ProcedureLogs {
     }
     /**
      * Add an insurance history entry.
-     * @param {number} PatNum - Required: The patient number.
-     * @param {number} InsSubNum - Required: The insurance subscription number.
-     * @param {"InsHistBWCodes" | "InsHistPanoCodes" | "InsHistExamCodes" | "InsHistProphyCodes" | "InsHistPerioURCodes" | "InsHistPerioULCodes" | "InsHistPerioLRCodes" | "InsHistPerioLLCodes" | "InsHistPerioMaintCodes" | "InsHistDebridementCodes"} insHistPrefName - Required: The insurance history category name.
-     * @param {string} ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
+     * @param {Object} data - the insurance history object to create.
+     * @param {number} data.PatNum - Required: The patient number.
+     * @param {number} data.InsSubNum - Required: The insurance subscription number.
+     * @param {"InsHistBWCodes" | "InsHistPanoCodes" | "InsHistExamCodes" | "InsHistProphyCodes" | "InsHistPerioURCodes" | "InsHistPerioULCodes" | "InsHistPerioLRCodes" | "InsHistPerioLLCodes" | "InsHistPerioMaintCodes" | "InsHistDebridementCodes"} data.insHistPrefName - Required: The insurance history category name.
+     * @param {string} data.ProcDate - Required: Procedure date in "yyyy-MM-dd" format.
      * @returns {Promise<InsuranceHistory>} - The created insurance history entry.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */

package/dist/openDental.d.ts

@@ -12,6 +12,8 @@ import Operatories from "./api/operatories";
 import Payments from "./api/payments";
 import Definitions from "./api/definitions";
 import DiscountPlanSubs from "./api/discountPlanSubs";
+import FamilyModules from "./api/familyModules";
+import InsSubs from "./api/insSubs";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -74,6 +76,14 @@ declare class OpenDental {
      * Create a new instance of the DiscountPlanSubs API.
      */
     static DiscountPlanSubs(): DiscountPlanSubs;
+    /**
+     * Create a new instance of the FamilyModules API.
+     */
+    static FamilyModules(): FamilyModules;
+    /**
+     * Create a new instance of the InsSub API.
+     */
+    static InsSubs(): InsSubs;
 }
 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;AAEtD,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;IAMzB;;OAEG;WACW,gBAAgB;CAM/B;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;AAEpC,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;CAMtB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -19,6 +19,8 @@ const operatories_1 = __importDefault(require("./api/operatories"));
 const payments_1 = __importDefault(require("./api/payments"));
 const definitions_1 = __importDefault(require("./api/definitions"));
 const discountPlanSubs_1 = __importDefault(require("./api/discountPlanSubs"));
+const familyModules_1 = __importDefault(require("./api/familyModules"));
+const insSubs_1 = __importDefault(require("./api/insSubs"));
 class OpenDental {
     static httpClient;
     /**
@@ -158,5 +160,23 @@ class OpenDental {
         }
         return new discountPlanSubs_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the FamilyModules API.
+     */
+    static FamilyModules() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new familyModules_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the InsSub API.
+     */
+    static InsSubs() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new insSubs_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/familyModuleTypes.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Represents the insurance information for a patient similar to how it shows in the Family Module in Open Dental.
+ * @see https://www.opendental.com/site/apifamilymodules.html
+ */
+export interface Insurance {
+    PatNum?: number;
+    InsSubNum?: number;
+    Subscriber?: number;
+    subscriber?: string;
+    SubscriberID?: string;
+    SubscNote?: string;
+    PatPlanNum?: number;
+    Ordinal?: number;
+    ordinal?: string;
+    IsPending?: 'true' | 'false';
+    Relationship?: string;
+    PatID?: string;
+    CarrierNum?: number;
+    CarrierName?: string;
+    PlanNum?: number;
+    GroupName?: string;
+    GroupNum?: string;
+    PlanNote?: string;
+    FeeSched?: number;
+    feeSchedule?: string;
+    PlanType?: string;
+    planType?: string;
+    CopayFeeSched?: number;
+    EmployerNum?: number;
+    employer?: string;
+    IsMedical?: 'true' | 'false';
+}
+//# sourceMappingURL=familyModuleTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"familyModuleTypes.d.ts","sourceRoot":"","sources":["../../src/types/familyModuleTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B"}

package/dist/types/familyModuleTypes.js

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

package/dist/types/insSubTypes.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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/apiinssubs.html
+ */
+export interface InsSub {
+    InsSubNum?: number;
+    PlanNum?: number;
+    Subscriber?: number;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubscriberID?: string;
+    BenefitNotes?: string;
+    ReleaseInfo?: "true" | "false";
+    AssignBen?: "true" | "false";
+    SubscNote?: string;
+    SecDateTEdit?: string;
+}
+/**
+ * Gets all InsSubs based on provided parameters. If no parameter is given, it will get all InsSubs ordered by InsSubNum.
+ * @see https://www.opendental.com/site/apiinssubs.html
+ */
+export interface GetInsSubsParams {
+    PlanNum?: number;
+    Subscriber?: number;
+    SecDateTEdit?: string;
+    Offset?: number;
+}
+/**
+ * Parameters for creating an InsSub. This does not create a new insurance plan or change benefits.
+ * @see https://www.opendental.com/site/apiinssubs.html
+ */
+export interface CreateInsSubParams {
+    PlanNum: number;
+    Subscriber: number;
+    SubscriberID: string;
+    DateEffective?: string;
+    DateTerm?: string;
+    BenefitNotes?: string;
+    ReleaseInfo?: "true" | "false";
+    AssignBen?: "true" | "false";
+    SubscNote?: string;
+}
+/**
+ * Parameters for updating an InsSub. This can be used to assign a different PlanNum or Subscriber to this InsSub.
+ * None of these changes affect the InsSubNum, so all the PatPlans (coverage) for family members will continue to point to this InsSub and will be untouched.
+ * You can obtain the InsSubNum from FamilyModules GET Insurance.
+ * SecDateTEdit is updated automatically and cannot be set by developers.
+ * @see https://www.opendental.com/site/apiinssubs.html
+ */
+export interface UpdateInsSubParams {
+    InsSubNum: number;
+    PlanNum?: number;
+    Subscriber?: number;
+    SubscriberID: string;
+    DateEffective?: string;
+    DateTerm?: string;
+    BenefitNotes?: string;
+    ReleaseInfo?: "true" | "false";
+    AssignBen?: "true" | "false";
+    SubscNote?: string;
+}
+//# sourceMappingURL=insSubTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"insSubTypes.d.ts","sourceRoot":"","sources":["../../src/types/insSubTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,MAAM;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/insSubTypes.js

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

package/dist/types/patPlanTypes.d.ts

@@ -0,0 +1,52 @@
+/**
+ * A PatPlan row in the database indicates coverage aka eligibility.
+ * If there is no patplan row, then the patient does not have coverage.
+ * So eligibility can be set by adding or removing PatPlan rows.
+ * @see https://www.opendental.com/site/apipatplans.html
+ */
+export interface PatPlan {
+    PatPlanNum?: number;
+    PatNum?: number;
+    Ordinal?: number;
+    IsPending?: "true" | "false";
+    Relationship?: "Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent";
+    PatID?: string;
+    InsSubNum?: number;
+    OrthoAutoFeeBilledOverride?: string;
+    OrthoAutoNextClaimDate?: string;
+    SecDateTEntry?: string;
+    SecDateTEdit?: string;
+}
+/**
+ * Gets a list of PatPlans that meet a set of search criteria.
+ * @see https://www.opendental.com/site/apipatplans.html
+ */
+export interface GetPatPlansParams {
+    PatNum?: number;
+    InsSubNum?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating an PatPlan. This adds a PatPlan row to the database.
+ * @see https://www.opendental.com/site/apipatplans.html
+ */
+export interface CreatePatPlanParams {
+    PatNum: number;
+    InsSubNum: number;
+    Ordinal?: number;
+    Relationship?: "Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent";
+    PatID?: string;
+}
+/**
+ * Parameters for updating an PatPlan.
+ * This updates an existing PatPlan row in the database. PatNum cannot be updated. Instead, drop the PatPlan and then recreate it.
+ * @see https://www.opendental.com/site/apipatplans.html
+ */
+export interface UpdatePatPlanParams {
+    PatPlanNum: number;
+    InsSubNum?: number;
+    Ordinal?: number;
+    Relationship?: "Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent";
+    PatID?: string;
+}
+//# sourceMappingURL=patPlanTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"patPlanTypes.d.ts","sourceRoot":"","sources":["../../src/types/patPlanTypes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,WAAW,CAAC;IAC1I,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,WAAW,CAAC;IAC1I,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,WAAW,CAAC;IAC1I,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/dist/types/patPlanTypes.js

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

package/dist/types/procedurelogTypes.d.ts

@@ -31,6 +31,18 @@ export interface ProcedureLog {
     IsDateProsthEst?: 'true' | 'false';
     serverDateTime?: string;
 }
+/**
+   * Parameters for GET Multiple ProcedureLogs.
+   * @see https://www.opendental.com/site/apiprocedurelogs.html
+   */
+export interface GetProcedureLogParams {
+    PatNum?: number;
+    AptNum?: number;
+    PlannedAptNum?: number;
+    ClinicNum?: number;
+    DateTStamp?: string;
+    Offset?: number;
+}
 /**
  * Create procedure log parameters.
  * @see https://www.opendental.com/site/apiprocedurelogs.html

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

@@ -1 +1 @@
-{"version":3,"file":"procedurelogTypes.d.ts","sourceRoot":"","sources":["../../src/types/procedurelogTypes.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAE;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAEH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAEH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAEH;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,wBAAwB,GAAG,yBAAyB,CAAC;IAC1P,QAAQ,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACD,MAAM,MAAM,IAAI,GAChB,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GACrC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GACzB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GACjC,GAAG,GAAG,GAAG,CAAC"}
+{"version":3,"file":"procedurelogTypes.d.ts","sourceRoot":"","sources":["../../src/types/procedurelogTypes.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAE;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;KAGK;AACL,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAEH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAEH;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAEH;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,wBAAwB,GAAG,yBAAyB,CAAC;IAC1P,QAAQ,EAAE,MAAM,CAAC;CAClB;AAEH;;;GAGG;AACD,MAAM,MAAM,IAAI,GAChB,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GACrC,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GACzB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GACjC,GAAG,GAAG,GAAG,CAAC"}

package/package.json

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

package/src/api/discountPlanSubs.ts

@@ -15,11 +15,11 @@ export default class DiscountPlanSubs {
   }
 
   /**
-   * Fetch multiple definitinos with optional filtering and pagination.
+   * Fetch multiple discountplansubs with optional filtering and pagination.
    * @param {Object} params - The parameters for filtering and pagination.
    * @param {number} [params.PatNum] - Filter by patient.
    * @param {number} [params.Offset] - Pagination offset for results.
-   * @returns {Promise<DiscountPlanSub[]>} - A list of appointments.
+   * @returns {Promise<DiscountPlanSub[]>} - A list of discountplansubs.
    */
   public async getDiscountPlanSubs({
     PatNum,
@@ -75,17 +75,28 @@ export default class DiscountPlanSubs {
    * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
-  public async updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub> {
-    if (!data.DiscountSubNum || !data.PatNum) {
+  public async updateDiscountPlanSub({
+    DiscountSubNum,
+    PatNum,
+    DateEffective,
+    DateTerm,
+    SubNote,
+  }: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub> {
+    if (!DiscountSubNum || !PatNum) {
       throw new Error("Invalid data: DiscountSubNum and PatNum are required.");
     }
 
-    return this.httpClient.put<DiscountPlanSub>(`/discountplansubs/${data.DiscountSubNum}`, data);
+    return this.httpClient.put<DiscountPlanSub>(`/discountplansubs/${DiscountSubNum}`, {
+      PatNum,
+      DateEffective,
+      DateTerm,
+      SubNote,
+    });
   }
 
   /**
    * Delete a discount plan sub entry.
-   * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
+   * @param {number} DiscountSubNum - Required: The unique identifier of the discount plan sub to delete.
    * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
    * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
    */

package/src/api/familyModules.ts

@@ -0,0 +1,28 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Insurance
+} from "../types/familyModuleTypes";
+
+export default class FamilyModules {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Gets the insurance information for a patient similarly to how it shows in the Family Module. 
+   * Will typically return between 0 and 2 rows, one row for each insurance for the patient. 
+   * Use another API method or a query to get additional details in each table. 
+   * This area of the Family Module UI also shows discount plans, which are obtained through DiscountPlanSubs GET.
+   * @param {number} PatNum - FK to patient.PatNum
+   * @returns {Promise<Insurance>} - The appointment object.
+   * @throws {Error} - If `AptNum` is not provided.
+   */
+  public async getInsurance(PatNum: number): Promise<Insurance> {
+    if (!PatNum) {
+      throw new Error("PatNum is required.");
+    }
+    return this.httpClient.get<Insurance>(`/familymodules/${PatNum}/Insurance`);
+  }
+}