@rinse-dental/open-dental 1.0.2 → 1.0.4

package/dist/api/discountPlanSubs.d.ts

@@ -4,11 +4,11 @@ export default class DiscountPlanSubs {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
-     * 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.
      */
     getDiscountPlanSubs({ PatNum, Offset, }?: GetDiscountPlanSubsParams): Promise<DiscountPlanSub[]>;
     /**
@@ -22,7 +22,7 @@ export default class DiscountPlanSubs {
      * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
-    createDiscountPlanSub(data: CreateDiscountPlanSubParams): Promise<DiscountPlanSub>;
+    createDiscountPlanSub({ DiscountPlanNum, PatNum, DateEffective, DateTerm, SubNote, }: CreateDiscountPlanSubParams): Promise<DiscountPlanSub>;
     /**
      * Update a discount plan sub.
      * @param {Object} data - The details of the discount sub to update.
@@ -34,10 +34,10 @@ 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.
      */
-    updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub>;
+    updateDiscountPlanSub({ DiscountSubNum, PatNum, DateEffective, DateTerm, SubNote, }: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub>;
     /**
      * 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/dist/api/discountPlanSubs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"discountPlanSubs.d.ts","sourceRoot":"","sources":["../../src/api/discountPlanSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,mBAAmB,CAAC,EAC/B,MAAM,EACN,MAAM,GACP,GAAE,yBAA8B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS9D;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;OAKG;IACU,qBAAqB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}
+{"version":3,"file":"discountPlanSubs.d.ts","sourceRoot":"","sources":["../../src/api/discountPlanSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,+BAA+B,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,mBAAmB,CAAC,EAC/B,MAAM,EACN,MAAM,GACP,GAAE,yBAA8B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS9D;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,EACjC,eAAe,EACf,MAAM,EACN,aAAa,EACb,QAAQ,EACR,OAAO,GACR,EAAG,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAc1D;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,EACjC,cAAc,EACd,MAAM,EACN,aAAa,EACb,QAAQ,EACR,OAAO,GACR,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAazD;;;;;OAKG;IACU,qBAAqB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}

package/dist/api/discountPlanSubs.js

@@ -6,11 +6,11 @@ class DiscountPlanSubs {
         this.httpClient = httpClient;
     }
     /**
-     * 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.
      */
     async getDiscountPlanSubs({ PatNum, Offset, } = {}) {
         const params = {
@@ -30,11 +30,17 @@ class DiscountPlanSubs {
      * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
-    async createDiscountPlanSub(data) {
-        if (!data.DiscountPlanNum || !data.PatNum) {
+    async createDiscountPlanSub({ DiscountPlanNum, PatNum, DateEffective, DateTerm, SubNote, }) {
+        if (!DiscountPlanNum || !PatNum) {
             throw new Error("Invalid data: DiscountPlanNum and PatNum are required.");
         }
-        return this.httpClient.post("/discountplansubs", data);
+        return this.httpClient.post("/discountplansubs", {
+            DiscountPlanNum,
+            PatNum,
+            DateEffective,
+            DateTerm,
+            SubNote,
+        });
     }
     /**
      * Update a discount plan sub.
@@ -47,15 +53,20 @@ class DiscountPlanSubs {
      * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
-    async updateDiscountPlanSub(data) {
-        if (!data.DiscountSubNum || !data.PatNum) {
+    async updateDiscountPlanSub({ DiscountSubNum, PatNum, DateEffective, DateTerm, SubNote, }) {
+        if (!DiscountSubNum || !PatNum) {
             throw new Error("Invalid data: DiscountSubNum and PatNum are required.");
         }
-        return this.httpClient.put(`/discountplansubs/${data.DiscountSubNum}`, data);
+        return this.httpClient.put(`/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/dist/api/familyModules.d.ts

@@ -0,0 +1,17 @@
+import HttpClient from "../utils/httpClient";
+import { Insurance } from "../types/familyModuleTypes";
+export default class FamilyModules {
+    private httpClient;
+    constructor(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.
+     */
+    getInsurance(PatNum: number): Promise<Insurance>;
+}
+//# sourceMappingURL=familyModules.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"familyModules.d.ts","sourceRoot":"","sources":["../../src/api/familyModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACV,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;OAQG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAM9D"}

package/dist/api/familyModules.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class FamilyModules {
+    httpClient;
+    constructor(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.
+     */
+    async getInsurance(PatNum) {
+        if (!PatNum) {
+            throw new Error("PatNum is required.");
+        }
+        return this.httpClient.get(`/familymodules/${PatNum}/Insurance`);
+    }
+}
+exports.default = FamilyModules;

package/dist/api/insSubs.d.ts

@@ -0,0 +1,64 @@
+import HttpClient from "../utils/httpClient";
+import { InsSub, GetInsSubsParams, CreateInsSubParams, UpdateInsSubParams } from "../types/insSubTypes";
+export default class InsSubs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single inssub by its ID.
+     * @param {number} InsSubNum - The unique identifier for the inssub.
+     * @returns {Promise<InsSub>} - The inssub object.
+     * @throws {Error} - If `InsSubNum` is not provided.
+     */
+    getInsSub(InsSubNum: number): Promise<InsSub>;
+    /**
+      * Fetch multiple inssubs with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PlanNum] - The PlanNum of the InsPlan.
+      * @param {number} [params.Subscriber] - The PatNum of the patient who is subscribed to this plan.
+      * @param {string} [params.SecDateTEdit] - The last date the InsPlan was edited. Returns all InsSubs on or after this date.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<InsSub[]>} - A list of inssubs.
+      */
+    getInsSubs({ PlanNum, Subscriber, SecDateTEdit, Offset, }?: GetInsSubsParams): Promise<InsSub[]>;
+    /**
+     * Create a new inssub.
+     * @param {Object} data - The details of InsSub to create.
+     * @param {number} data.PlanNum - Required. The PlanNum of the InsPlan.
+     * @param {number} data.Subscriber - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} data.SubscriberID - Required. Number assigned by insurance company.
+     * @param {string} [data.DateEffective] - Optional. The date this InsPlan became effective.
+     * @param {string} [data.DateTerm] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {string} [data.BenefitNotes] - 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 {"true" | "false"} [data.ReleaseInfo] - 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.AssignBen] - 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 {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
+    * @returns {Promise<InsSub>} - The created inssub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createInsSub({ PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }: CreateInsSubParams): Promise<InsSub>;
+    /**
+     * Update an inssub.
+     * @param {Object} data - The details of InsSub to update.
+     * @param {number} data.InsSubNum - Required in the URL. The PK of the InsSub.
+     * @param {number} [data.PlanNum] - Optional. The PlanNum of the InsPlan.
+     * @param {number} [data.Subscriber] - Optional. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.SubscriberID] - Optional. Number assigned by insurance company.
+     * @param {string} [data.DateEffective] - Optional. The date this InsPlan became effective.
+     * @param {string} [data.DateTerm] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {string} [data.BenefitNotes] - 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 {"true" | "false"} [data.ReleaseInfo] - 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.AssignBen] - 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 {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
+    * @returns {Promise<InsSub>} - The updated inssub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateInsSub({ InsSubNum, PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }: UpdateInsSubParams): Promise<InsSub>;
+    /**
+     * Delete an inssub entry. Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.
+     * @param {number} InsSubNum - Required: The unique identifier of the inssub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `InsSubNum` is not valid or the API returns an error.
+     */
+    deleteInsSub(InsSubNum: number): Promise<void>;
+}
+//# sourceMappingURL=insSubs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"insSubs.d.ts","sourceRoot":"","sources":["../../src/api/insSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO1D;;;;;;;;QAQI;IACS,UAAU,CAAC,EACtB,OAAO,EACP,UAAU,EACV,YAAY,EACZ,MAAM,GACP,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAW5C;;;;;;;;;;;;;;OAcG;IACU,YAAY,CAAC,EACxB,OAAO,EACP,UAAU,EACV,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,EACT,SAAS,GACV,EAAG,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxC;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,EACxB,SAAS,EACT,OAAO,EACP,UAAU,EACV,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,EACT,SAAS,GACV,EAAG,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxC;;;;;OAKG;IACU,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO5D"}

package/dist/api/insSubs.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class InsSubs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single inssub by its ID.
+     * @param {number} InsSubNum - The unique identifier for the inssub.
+     * @returns {Promise<InsSub>} - The inssub object.
+     * @throws {Error} - If `InsSubNum` is not provided.
+     */
+    async getInsSub(InsSubNum) {
+        if (!InsSubNum) {
+            throw new Error("InsSubNum is required.");
+        }
+        return this.httpClient.get(`/inssubs/${InsSubNum}`);
+    }
+    /**
+      * Fetch multiple inssubs with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PlanNum] - The PlanNum of the InsPlan.
+      * @param {number} [params.Subscriber] - The PatNum of the patient who is subscribed to this plan.
+      * @param {string} [params.SecDateTEdit] - The last date the InsPlan was edited. Returns all InsSubs on or after this date.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<InsSub[]>} - A list of inssubs.
+      */
+    async getInsSubs({ PlanNum, Subscriber, SecDateTEdit, Offset, } = {}) {
+        const params = {
+            PlanNum,
+            Subscriber,
+            SecDateTEdit,
+            Offset,
+        };
+        return this.httpClient.get("/inssubs", params);
+    }
+    /**
+     * Create a new inssub.
+     * @param {Object} data - The details of InsSub to create.
+     * @param {number} data.PlanNum - Required. The PlanNum of the InsPlan.
+     * @param {number} data.Subscriber - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} data.SubscriberID - Required. Number assigned by insurance company.
+     * @param {string} [data.DateEffective] - Optional. The date this InsPlan became effective.
+     * @param {string} [data.DateTerm] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {string} [data.BenefitNotes] - 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 {"true" | "false"} [data.ReleaseInfo] - 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.AssignBen] - 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 {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
+    * @returns {Promise<InsSub>} - The created inssub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createInsSub({ PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }) {
+        if (!PlanNum || !Subscriber || !SubscriberID) {
+            throw new Error("Invalid data: PlanNum, Subscriber, and SubscriberID are required.");
+        }
+        return this.httpClient.post("/inssubs", {
+            PlanNum,
+            Subscriber,
+            SubscriberID,
+            DateEffective,
+            DateTerm,
+            BenefitNotes,
+            ReleaseInfo,
+            AssignBen,
+            SubscNote,
+        });
+    }
+    /**
+     * Update an inssub.
+     * @param {Object} data - The details of InsSub to update.
+     * @param {number} data.InsSubNum - Required in the URL. The PK of the InsSub.
+     * @param {number} [data.PlanNum] - Optional. The PlanNum of the InsPlan.
+     * @param {number} [data.Subscriber] - Optional. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.SubscriberID] - Optional. Number assigned by insurance company.
+     * @param {string} [data.DateEffective] - Optional. The date this InsPlan became effective.
+     * @param {string} [data.DateTerm] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {string} [data.BenefitNotes] - 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 {"true" | "false"} [data.ReleaseInfo] - 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.AssignBen] - 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 {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
+    * @returns {Promise<InsSub>} - The updated inssub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateInsSub({ InsSubNum, PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }) {
+        if (!InsSubNum || typeof InsSubNum !== "number") {
+            throw new Error("Invalid data: A Valid InsSubNum is required.");
+        }
+        return this.httpClient.put(`/inssubs/${InsSubNum}`, {
+            PlanNum,
+            Subscriber,
+            SubscriberID,
+            DateEffective,
+            DateTerm,
+            BenefitNotes,
+            ReleaseInfo,
+            AssignBen,
+            SubscNote,
+        });
+    }
+    /**
+     * Delete an inssub entry. Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.
+     * @param {number} InsSubNum - Required: The unique identifier of the inssub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `InsSubNum` is not valid or the API returns an error.
+     */
+    async deleteInsSub(InsSubNum) {
+        if (!InsSubNum || typeof InsSubNum !== "number") {
+            throw new Error("Invalid parameter: InsSubNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/inssubs/${InsSubNum}`);
+    }
+}
+exports.default = InsSubs;

package/dist/api/patFields.js

@@ -79,7 +79,7 @@ class PatFields {
      */
     async deletePatField(PatFieldNum) {
         if (!PatFieldNum || typeof PatFieldNum !== "number") {
-            throw new Error("Invalid parameter: PatNum must be a valid number.");
+            throw new Error("Invalid parameter: PatFieldNum must be a valid number.");
         }
         return await this.httpClient.delete(`/patfields/${PatFieldNum}`);
     }

package/dist/api/patPlans.d.ts

@@ -0,0 +1,48 @@
+import HttpClient from "../utils/httpClient";
+import { PatPlan, GetPatPlansParams, CreatePatPlanParams, UpdatePatPlanParams } from "../types/patPlanTypes";
+export default class PatPlans {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+      * Fetch multiple patplans 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.InsSubNum] - FK to inssub.InsSubNum
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<PatPlan[]>} - A list of patplans.
+      */
+    getPatPlans({ PatNum, InsSubNum, Offset, }?: GetPatPlansParams): Promise<PatPlan[]>;
+    /**
+     * This adds a PatPlan row to the database.
+     * @param {Object} data - The details of the patplan to create.
+     * @param {number} data.PatNum - Required. FK of patient
+     * @param {number} data.InsSubNum - Required. This requires that a valid InsSub is already in place. You can obtain the InsSubNum from FamilyModules GET Insurance, or you can obtain it from an InsSubs POST. If this plan is already linked to this InsSub, then response will be BadRequest.
+     * @param {string} [data.Ordinal] - Optional with a default of 1. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
+     * @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+     * @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    * @returns {Promise<PatPlan>} - The created patplan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createPatPlan({ PatNum, InsSubNum, Ordinal, Relationship, PatID, }: CreatePatPlanParams): Promise<PatPlan>;
+    /**
+     * Update a PatPlan.
+     * @param {Object} data - The details of PatPlan to update.
+     * @param {number} data.PatPlanNum - Required. PK
+     * @param {number} [data.InsSubNum] - Optional. This corresponds to the Change button in the Subscriber Information section of the Insurance Plan window.
+     * @param {string} [data.Ordinal] - Optional. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
+     * @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+     * @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    * @returns {Promise<PatPlan>} - The updated patplan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updatePatPlan({ PatPlanNum, InsSubNum, Ordinal, Relationship, PatID, }: UpdatePatPlanParams): Promise<PatPlan>;
+    /**
+     * Delete an PatPlan entry.
+     * This is called "Drop" in the Open Dental UI. This removes a PatPlan row from the database, indicating no coverage, but does not affect the InsPlan itself.
+     * @param {number} PatPlanNum - Required: The unique identifier of the inssub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
+     */
+    deletePatPlan(PatPlanNum: number): Promise<void>;
+}
+//# sourceMappingURL=patPlans.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"patPlans.d.ts","sourceRoot":"","sources":["../../src/api/patPlans.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;;;;;;;QAOI;IACS,WAAW,CAAC,EACvB,MAAM,EACN,SAAS,EACT,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAU9C;;;;;;;;;;OAUG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,GACN,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAc1C;;;;;;;;;;OAUG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,GACN,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAa1C;;;;;;OAMG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO9D"}

package/dist/api/patPlans.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PatPlans {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+      * Fetch multiple patplans 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.InsSubNum] - FK to inssub.InsSubNum
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<PatPlan[]>} - A list of patplans.
+      */
+    async getPatPlans({ PatNum, InsSubNum, Offset, } = {}) {
+        const params = {
+            PatNum,
+            InsSubNum,
+            Offset,
+        };
+        return this.httpClient.get("/patplans", params);
+    }
+    /**
+     * This adds a PatPlan row to the database.
+     * @param {Object} data - The details of the patplan to create.
+     * @param {number} data.PatNum - Required. FK of patient
+     * @param {number} data.InsSubNum - Required. This requires that a valid InsSub is already in place. You can obtain the InsSubNum from FamilyModules GET Insurance, or you can obtain it from an InsSubs POST. If this plan is already linked to this InsSub, then response will be BadRequest.
+     * @param {string} [data.Ordinal] - Optional with a default of 1. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
+     * @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+     * @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    * @returns {Promise<PatPlan>} - The created patplan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createPatPlan({ PatNum, InsSubNum, Ordinal, Relationship, PatID, }) {
+        if (!PatNum || !InsSubNum) {
+            throw new Error("Invalid data: PatNum and InsSubNum are required.");
+        }
+        return this.httpClient.post("/patplans", {
+            PatNum,
+            InsSubNum,
+            Ordinal,
+            Relationship,
+            PatID,
+        });
+    }
+    /**
+     * Update a PatPlan.
+     * @param {Object} data - The details of PatPlan to update.
+     * @param {number} data.PatPlanNum - Required. PK
+     * @param {number} [data.InsSubNum] - Optional. This corresponds to the Change button in the Subscriber Information section of the Insurance Plan window.
+     * @param {string} [data.Ordinal] - Optional. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
+     * @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
+     * @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    * @returns {Promise<PatPlan>} - The updated patplan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updatePatPlan({ PatPlanNum, InsSubNum, Ordinal, Relationship, PatID, }) {
+        if (!PatPlanNum || typeof PatPlanNum !== "number") {
+            throw new Error("Invalid data: A Valid PatPlanNum is required.");
+        }
+        return this.httpClient.put(`/patplans/${PatPlanNum}`, {
+            InsSubNum,
+            Ordinal,
+            Relationship,
+            PatID,
+        });
+    }
+    /**
+     * Delete an PatPlan entry.
+     * This is called "Drop" in the Open Dental UI. This removes a PatPlan row from the database, indicating no coverage, but does not affect the InsPlan itself.
+     * @param {number} PatPlanNum - Required: The unique identifier of the inssub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
+     */
+    async deletePatPlan(PatPlanNum) {
+        if (!PatPlanNum || typeof PatPlanNum !== "number") {
+            throw new Error("Invalid parameter: PatPlanNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/patplans/${PatPlanNum}`);
+    }
+}
+exports.default = PatPlans;

package/dist/api/procedureLog.d.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { ProcedureLog, createProcedureLogParams, updateProcedureLogParams, InsuranceHistory, getInsuranceHistoryParams, postInsuranceHistoryParams } from "../types/procedurelogTypes";
+import { ProcedureLog, GetProcedureLogParams, createProcedureLogParams, updateProcedureLogParams, InsuranceHistory, getInsuranceHistoryParams, postInsuranceHistoryParams } from "../types/procedurelogTypes";
 export default class ProcedureLogs {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -10,16 +10,29 @@ export default class ProcedureLogs {
      * @throws {Error} - If `ProcNum` is not valid or the API returns an error.
      */
     getProcedureLog(ProcNum: number): Promise<ProcedureLog>;
+    /**
+      * 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.
+      */
+    getProcedureLogs({ PatNum, AptNum, PlannedAptNum, ClinicNum, DateTStamp, Offset, }?: GetProcedureLogParams): Promise<ProcedureLog[]>;
     /**
      * 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)
@@ -38,28 +51,28 @@ export default 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.
      */
-    createProcedureLog({ PatNum, ProcDate, ProcStatus, procCode, ...optionalData }: createProcedureLogParams): Promise<ProcedureLog>;
+    createProcedureLog({ PatNum, ProcDate, ProcStatus, procCode, AptNum, ProcFee, Surf, ToothNum, ToothRange, Priority, priority, ProvNum, Dx, dxName, PlannedAptNum, ClinicNum, }: createProcedureLogParams): Promise<ProcedureLog>;
     /**
      * 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)
@@ -78,16 +91,16 @@ export default 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.
      */
-    updateProcedureLog(ProcNum: number, { ProcDate, AptNum, ProcFee, Priority, ProcStatus, procCode, Surf, ToothNum, ToothRange, ProvNum, Dx, PlannedAptNum, ClinicNum, }: updateProcedureLogParams): Promise<ProcedureLog>;
+    updateProcedureLog({ ProcNum, ProcDate, AptNum, ProcFee, Priority, ProcStatus, procCode, Surf, ToothNum, ToothRange, ProvNum, Dx, PlannedAptNum, ClinicNum, }: updateProcedureLogParams): Promise<ProcedureLog>;
     /**
      * Delete a procedure log entry.
      * @param {number} ProcNum - Required: The unique identifier of the procedure log to delete.
@@ -97,18 +110,20 @@ export default class ProcedureLogs {
     deleteProcedureLog(ProcNum: number): Promise<void>;
     /**
      * 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.
      */
     getInsuranceHistory({ PatNum, InsSubNum, }: getInsuranceHistoryParams): Promise<InsuranceHistory[]>;
     /**
      * 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.
      */