@rinse-dental/open-dental 1.2.0 → 1.3.0

package/dist/api/benefits.d.ts

@@ -0,0 +1,62 @@
+import HttpClient from "../utils/httpClient";
+import { Benefit, GetBenefitsParams, CreateBenefitParams, UpdateBenefitParams } from "../types/benefitTypes";
+export default class Benefits {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+      * Fetch multiple benefits with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PlanNum] - FK to InsPlan.PlanNum.
+      * @param {number} [params.PatPlanNum] - FK to PatPlan.PatPlanNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<Benefit[]>} - A list of benefits.
+      */
+    getBenefits({ PlanNum, PatPlanNum, Offset, }?: GetBenefitsParams): Promise<Benefit[]>;
+    /**
+     * This adds a Benefit row to the database.
+     * @param {Object} data - The details of the Benefit to create.
+     * @param {number} data.PlanNum - This or PatPlanNum is required. FK to InsPlan.PlanNum.
+     * @param {number} data.PatPlanNum - This or PlanNum is required. FK to PatPlan.PlanNum.
+     * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} data.BenefitType - Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+     * @param {"None" | "Individual" | "Family"} data.CoverageLevel - Required. Either "None", "Individual", or "Family".
+     * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+     * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+     * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+     * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+     * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+     * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+     * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+     * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+     * @param {number} [data.CodeGroupNum] - Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+    * @returns {Promise<Benefit>} - The created a benefit.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createBenefit({ PlanNum, PatPlanNum, BenefitType, CoverageLevel, CovCatNum, Percent, MonetaryAmt, TimePeriod, QuantityQualifier, Quantity, CodeNum, procCode, CodeGroupNum, }: CreateBenefitParams): Promise<Benefit>;
+    /**
+     * Update a Benefit.
+     * @param {Object} data - The details of Benefit to update.
+     * @param {number} data.BenefitNum - Required. PK
+     * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+    * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} [data.BenefitType] - Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+     * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+     * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+     * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+     * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+     * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+     * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
+     * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0.
+     * @param {"None" | "Individual" | "Family"} [data.CoverageLevel] - Optional. Either "None", "Individual", or "Family".
+    * @returns {Promise<Benefit>} - The updated Benefit.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateBenefit({ BenefitNum, CovCatNum, BenefitType, Percent, MonetaryAmt, TimePeriod, QuantityQualifier, Quantity, CodeNum, procCode, CoverageLevel, }: UpdateBenefitParams): Promise<Benefit>;
+    /**
+     * Delete a Benefit entry.
+     * This removes a Benefit row from the database.
+     * @param {number} BenefitNum - Required: The unique identifier of the Benefit to delete.
+     * @returns {Promise<void>} - Resolves when the Benefit is deleted.
+     * @throws {Error} - If `BenefitNum` is not valid or the API returns an error.
+     */
+    deletePatPlan(BenefitNum: number): Promise<void>;
+}
+//# sourceMappingURL=benefits.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"benefits.d.ts","sourceRoot":"","sources":["../../src/api/benefits.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,OAAO,EACP,UAAU,EACV,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAU9C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,OAAO,EACP,UAAU,EACV,WAAW,EACX,aAAa,EACb,SAAS,EACT,OAAO,EACP,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,YAAY,GACb,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1C;;;;;;;;;;;;;;;;OAgBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,SAAS,EACT,WAAW,EACX,OAAO,EACP,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,aAAa,GACd,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB1C;;;;;;OAMG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO9D"}

package/dist/api/benefits.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Benefits {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+      * Fetch multiple benefits with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PlanNum] - FK to InsPlan.PlanNum.
+      * @param {number} [params.PatPlanNum] - FK to PatPlan.PatPlanNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<Benefit[]>} - A list of benefits.
+      */
+    async getBenefits({ PlanNum, PatPlanNum, Offset, } = {}) {
+        const params = {
+            PlanNum,
+            PatPlanNum,
+            Offset,
+        };
+        return this.httpClient.get("/benefits", params);
+    }
+    /**
+     * This adds a Benefit row to the database.
+     * @param {Object} data - The details of the Benefit to create.
+     * @param {number} data.PlanNum - This or PatPlanNum is required. FK to InsPlan.PlanNum.
+     * @param {number} data.PatPlanNum - This or PlanNum is required. FK to PatPlan.PlanNum.
+     * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} data.BenefitType - Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+     * @param {"None" | "Individual" | "Family"} data.CoverageLevel - Required. Either "None", "Individual", or "Family".
+     * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+     * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+     * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+     * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+     * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+     * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+     * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+     * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+     * @param {number} [data.CodeGroupNum] - Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+    * @returns {Promise<Benefit>} - The created a benefit.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createBenefit({ PlanNum, PatPlanNum, BenefitType, CoverageLevel, CovCatNum, Percent, MonetaryAmt, TimePeriod, QuantityQualifier, Quantity, CodeNum, procCode, CodeGroupNum, }) {
+        if (!BenefitType || !CoverageLevel) {
+            throw new Error("Invalid data: Either PlanNum or PatPlanNum and BenefitType and CoverageLevel are required.");
+        }
+        return this.httpClient.post("/benefits", {
+            PlanNum,
+            PatPlanNum,
+            BenefitType,
+            CoverageLevel,
+            CovCatNum,
+            Percent,
+            MonetaryAmt,
+            TimePeriod,
+            QuantityQualifier,
+            Quantity,
+            CodeNum,
+            procCode,
+            CodeGroupNum,
+        });
+    }
+    /**
+     * Update a Benefit.
+     * @param {Object} data - The details of Benefit to update.
+     * @param {number} data.BenefitNum - Required. PK
+     * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+    * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} [data.BenefitType] - Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+     * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+     * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+     * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+     * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+     * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+     * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
+     * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0.
+     * @param {"None" | "Individual" | "Family"} [data.CoverageLevel] - Optional. Either "None", "Individual", or "Family".
+    * @returns {Promise<Benefit>} - The updated Benefit.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateBenefit({ BenefitNum, CovCatNum, BenefitType, Percent, MonetaryAmt, TimePeriod, QuantityQualifier, Quantity, CodeNum, procCode, CoverageLevel, }) {
+        if (!BenefitNum || typeof BenefitNum !== "number") {
+            throw new Error("Invalid data: A Valid BenefitNum is required.");
+        }
+        return this.httpClient.put(`/benefits/${BenefitNum}`, {
+            CovCatNum,
+            BenefitType,
+            Percent,
+            MonetaryAmt,
+            TimePeriod,
+            QuantityQualifier,
+            Quantity,
+            CodeNum,
+            procCode,
+            CoverageLevel,
+        });
+    }
+    /**
+     * Delete a Benefit entry.
+     * This removes a Benefit row from the database.
+     * @param {number} BenefitNum - Required: The unique identifier of the Benefit to delete.
+     * @returns {Promise<void>} - Resolves when the Benefit is deleted.
+     * @throws {Error} - If `BenefitNum` is not valid or the API returns an error.
+     */
+    async deletePatPlan(BenefitNum) {
+        if (!BenefitNum || typeof BenefitNum !== "number") {
+            throw new Error("Invalid parameter: BenefitNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/benefits/${BenefitNum}`);
+    }
+}
+exports.default = Benefits;

package/dist/api/insPlans.d.ts

@@ -0,0 +1,62 @@
+import HttpClient from "../utils/httpClient";
+import { InsPlan, GetInsPlansParams, CreateInsPlanParams, UpdateInsPlanParams } from "../types/insPlanTypes";
+export default class InsPlans {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single insplan by its ID.
+     * @param {number} PlanNum - The ID of the insplan.
+     * @returns {Promise<InsPlan>} - The insplan data.
+     * @throws {Error} - If `InsPlan` is not valid or the API returns an error.
+     */
+    getInsPlan(PlanNum: number): Promise<InsPlan>;
+    /**
+      * Fetch multiple insplans with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {"percentage" | "p" | "f" | "c" } [params.PlanType] - Must be one of the following: "percentage" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Percentage PlanTypes are stored as blank in the database.
+      * @param {number} [params.CarrierNum] - FK to carrier.CarrierNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<InsPlan[]>} - A list of InsPlans.
+      */
+    getInsPlans({ PlanType, CarrierNum, Offset, }?: GetInsPlansParams): Promise<InsPlan[]>;
+    /**
+     * This adds an InsPlan row to the database.
+     * @param {Object} data - The details of the insplan to create.
+     * @param {number} data.CarrierNum - Required. FK to carrier.CarrierNum.
+     * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+     * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+     * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+     * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+     * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+     * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+     * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+     * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+     * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+     * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+     * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+     * @returns {Promise<InsPlan>} - The created insplan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createInsPlan({ CarrierNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }: CreateInsPlanParams): Promise<InsPlan>;
+    /**
+     * Update a InsPlan.
+     * @param {Object} data - The details of InsPlan to update.
+     * @param {number} data.PlanNum - Required. Primary key.
+     * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+     * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+     * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+     * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+     * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+     * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+     * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+     * @param {number} [data.CarrierNum] - Optional. FK to carrier.CarrierNum.
+     * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+     * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+     * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+     * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+    * @returns {Promise<InsPlan>} - The updated InsPlan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateInsPlan({ PlanNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CarrierNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }: UpdateInsPlanParams): Promise<InsPlan>;
+}
+//# sourceMappingURL=insPlans.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"insPlans.d.ts","sourceRoot":"","sources":["../../src/api/insPlans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1D;;;;;;;QAOI;IACS,WAAW,CAAC,EACvB,QAAQ,EACR,UAAU,EACV,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAU9C;;;;;;;;;;;;;;;;;OAiBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,QAAQ,EACR,UAAU,EACV,iBAAiB,GAClB,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB1C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EACb,QAAQ,EACR,UAAU,EACV,iBAAiB,GAClB,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAoB3C"}

package/dist/api/insPlans.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class InsPlans {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single insplan by its ID.
+     * @param {number} PlanNum - The ID of the insplan.
+     * @returns {Promise<InsPlan>} - The insplan data.
+     * @throws {Error} - If `InsPlan` is not valid or the API returns an error.
+     */
+    async getInsPlan(PlanNum) {
+        if (!PlanNum || typeof PlanNum !== "number") {
+            throw new Error("Invalid parameter: PlanNum must be a valid number.");
+        }
+        return await this.httpClient.get(`/insplans/${PlanNum}`);
+    }
+    /**
+      * Fetch multiple insplans with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {"percentage" | "p" | "f" | "c" } [params.PlanType] - Must be one of the following: "percentage" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Percentage PlanTypes are stored as blank in the database.
+      * @param {number} [params.CarrierNum] - FK to carrier.CarrierNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<InsPlan[]>} - A list of InsPlans.
+      */
+    async getInsPlans({ PlanType, CarrierNum, Offset, } = {}) {
+        const params = {
+            PlanType,
+            CarrierNum,
+            Offset,
+        };
+        return this.httpClient.get("/insplans", params);
+    }
+    /**
+     * This adds an InsPlan row to the database.
+     * @param {Object} data - The details of the insplan to create.
+     * @param {number} data.CarrierNum - Required. FK to carrier.CarrierNum.
+     * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+     * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+     * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+     * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+     * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+     * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+     * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+     * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+     * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+     * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+     * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+     * @returns {Promise<InsPlan>} - The created insplan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createInsPlan({ CarrierNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }) {
+        if (!CarrierNum) {
+            throw new Error("Invalid data: CarrierNum is required.");
+        }
+        return this.httpClient.post("/insplans", {
+            CarrierNum,
+            GroupName,
+            GroupNum,
+            PlanNote,
+            FeeSched,
+            PlanType,
+            CopayFeeSched,
+            EmployerNum,
+            CodeSubstNone,
+            IsHidden,
+            MonthRenew,
+            IsBlueBookEnabled,
+        });
+    }
+    /**
+     * Update a InsPlan.
+     * @param {Object} data - The details of InsPlan to update.
+     * @param {number} data.PlanNum - Required. Primary key.
+     * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+     * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+     * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+     * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+     * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+     * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+     * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+     * @param {number} [data.CarrierNum] - Optional. FK to carrier.CarrierNum.
+     * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+     * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+     * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+     * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+    * @returns {Promise<InsPlan>} - The updated InsPlan.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateInsPlan({ PlanNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CarrierNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }) {
+        if (!PlanNum || typeof PlanNum !== "number") {
+            throw new Error("Invalid data: A Valid PlanNum is required.");
+        }
+        return this.httpClient.put(`/insplans/${PlanNum}`, {
+            GroupName,
+            GroupNum,
+            PlanNote,
+            FeeSched,
+            PlanType,
+            CopayFeeSched,
+            EmployerNum,
+            CarrierNum,
+            CodeSubstNone,
+            IsHidden,
+            MonthRenew,
+            IsBlueBookEnabled,
+        });
+    }
+}
+exports.default = InsPlans;

package/dist/api/patPlans.d.ts

@@ -37,10 +37,10 @@ export default class PatPlans {
      */
     updatePatPlan({ PatPlanNum, InsSubNum, Ordinal, Relationship, PatID, }: UpdatePatPlanParams): Promise<PatPlan>;
     /**
-     * Delete an PatPlan entry.
+     * Delete a 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.
+     * @returns {Promise<void>} - Resolves when the PatPlan is deleted.
      * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
      */
     deletePatPlan(PatPlanNum: number): Promise<void>;

package/dist/api/patPlans.js

@@ -67,10 +67,10 @@ class PatPlans {
         });
     }
     /**
-     * Delete an PatPlan entry.
+     * Delete a 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.
+     * @returns {Promise<void>} - Resolves when the PatPlan is deleted.
      * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
      */
     async deletePatPlan(PatPlanNum) {

package/dist/openDental.d.ts

@@ -18,6 +18,8 @@ import PatPlans from "./api/patPlans";
 import LabCases from "./api/labCases";
 import Referrals from "./api/referrals";
 import RefAttaches from "./api/refAttaches";
+import InsPlans from "./api/insPlans";
+import Benefits from "./api/benefits";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -104,6 +106,14 @@ declare class OpenDental {
      * Create a new instance of the LabCases API.
      */
     static RefAttaches(): RefAttaches;
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static InsPlans(): InsPlans;
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static Benefits(): Benefits;
 }
 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;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"}
+{"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;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,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;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;CAMvB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -25,6 +25,8 @@ 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"));
+const insPlans_1 = __importDefault(require("./api/insPlans"));
+const benefits_1 = __importDefault(require("./api/benefits"));
 class OpenDental {
     static httpClient;
     /**
@@ -218,5 +220,23 @@ class OpenDental {
         }
         return new refAttaches_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static InsPlans() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new insPlans_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static Benefits() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new benefits_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/benefitTypes.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface Benefit {
+    BenefitNum?: number;
+    PlanNum?: number;
+    PatPlanNum?: number;
+    CovCatNum?: number;
+    BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod";
+    Percent?: number;
+    MonetaryAmt?: number;
+    TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months";
+    QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months";
+    Quantity?: number;
+    CodeNum?: number;
+    procCode?: string;
+    CoverageLevel?: "None" | "Individual" | "Family";
+    SecDateTEntry?: string;
+    SecDateTEdit?: string;
+    CodeGroupNum?: number;
+}
+/**
+ * Gets a list of PatPlans that meet a set of search criteria.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface GetBenefitsParams {
+    PlanNum?: number;
+    PatPlanNum?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a new insplan.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface CreateBenefitParams {
+    PlanNum?: number;
+    PatPlanNum?: number;
+    BenefitType: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod";
+    CoverageLevel: "None" | "Individual" | "Family";
+    CovCatNum?: number;
+    Percent?: number;
+    MonetaryAmt?: number;
+    TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months";
+    QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months";
+    Quantity?: number;
+    CodeNum?: number;
+    procCode?: string;
+    CodeGroupNum?: number;
+}
+/**
+ * Parameters to update an insplan.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface UpdateBenefitParams {
+    BenefitNum: number;
+    CovCatNum?: number;
+    BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod";
+    Percent?: number;
+    MonetaryAmt?: number;
+    TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months";
+    QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months";
+    Quantity?: number;
+    CodeNum?: number;
+    procCode?: string;
+    CoverageLevel?: "None" | "Individual" | "Family";
+}
+//# sourceMappingURL=benefitTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"benefitTypes.d.ts","sourceRoot":"","sources":["../../src/types/benefitTypes.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,gBAAgB,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,CAAC;IAC7H,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,GAAG,OAAO,GAAG,sBAAsB,CAAC;IACrG,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,CAAC;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,gBAAgB,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,CAAC;IAC5H,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,CAAC;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,GAAG,OAAO,GAAG,sBAAsB,CAAC;IACrG,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,gBAAgB,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,CAAC;IAC7H,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,GAAG,OAAO,GAAG,sBAAsB,CAAC;IACrG,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,CAAC;CAClD"}

package/dist/types/benefitTypes.js

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

package/dist/types/insPlanTypes.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @see https://www.opendental.com/site/apiinsplans.html
+ */
+export interface InsPlan {
+    PlanNum?: number;
+    GroupName?: string;
+    GroupNum?: string;
+    PlanNote?: string;
+    FeeSched?: number;
+    PlanType?: "" | "p" | "f" | "c";
+    ClaimFormNum?: number;
+    CopayFeeSched?: number;
+    EmployerNum?: number;
+    CarrierNum?: number;
+    CodeSubstNone?: "true" | "false";
+    IsHidden?: "true" | "false";
+    MonthRenew?: number;
+    SecUserNumEntry?: number;
+    SecDateEntry?: string;
+    SecDateTEdit?: string;
+    IsBlueBookEnabled?: "true" | "false";
+}
+/**
+ * Gets a list of PatPlans that meet a set of search criteria.
+ * @see https://www.opendental.com/site/apiinsplans.html
+ */
+export interface GetInsPlansParams {
+    PlanType?: "percentage" | "p" | "f" | "c";
+    CarrierNum?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a new insplan.
+ * @see https://www.opendental.com/site/apiinsplans.html
+ */
+export interface CreateInsPlanParams {
+    CarrierNum: number;
+    GroupName?: string;
+    GroupNum?: string;
+    PlanNote?: string;
+    FeeSched?: number;
+    PlanType?: "" | "p" | "f" | "c";
+    CopayFeeSched?: number;
+    EmployerNum?: number;
+    CodeSubstNone?: "true" | "false";
+    IsHidden?: "true" | "false";
+    MonthRenew?: number;
+    IsBlueBookEnabled?: "true" | "false";
+}
+/**
+ * Parameters to update an insplan.
+ * @see https://www.opendental.com/site/apiinsplans.html
+ */
+export interface UpdateInsPlanParams {
+    PlanNum: number;
+    GroupName?: string;
+    GroupNum?: string;
+    PlanNote?: string;
+    FeeSched?: number;
+    PlanType?: "" | "p" | "f" | "c";
+    CopayFeeSched?: number;
+    EmployerNum?: number;
+    CarrierNum: number;
+    CodeSubstNone?: "true" | "false";
+    IsHidden?: "true" | "false";
+    MonthRenew?: number;
+    IsBlueBookEnabled?: "true" | "false";
+}
+//# sourceMappingURL=insPlanTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"insPlanTypes.d.ts","sourceRoot":"","sources":["../../src/types/insPlanTypes.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,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,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,YAAY,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC"}

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

package/release.sh

@@ -41,5 +41,5 @@ gh release create "$NEW_TAG" --title "Release $NEW_TAG" --notes "$COMMIT_MSG"
 
 
 #example ./release.sh "Some commit message" patch 
-#example ./release.sh "Some commit message" minor
+#example ./release.sh "Added insplans and benefits" minor
 #example ./release.sh "Some commit message" major 

package/src/api/benefits.ts

@@ -0,0 +1,155 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Benefit,
+  GetBenefitsParams,
+  CreateBenefitParams,
+  UpdateBenefitParams,
+} from "../types/benefitTypes";
+
+export default class Benefits {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+    * Fetch multiple benefits with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PlanNum] - FK to InsPlan.PlanNum.
+    * @param {number} [params.PatPlanNum] - FK to PatPlan.PatPlanNum.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<Benefit[]>} - A list of benefits.
+    */
+  public async getBenefits({
+    PlanNum,
+    PatPlanNum,
+    Offset,
+  }: GetBenefitsParams = {}): Promise<Benefit[]> {
+    const params = {
+      PlanNum,
+      PatPlanNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<Benefit[]>("/benefits", params);
+  }
+
+  /**
+   * This adds a Benefit row to the database.
+   * @param {Object} data - The details of the Benefit to create.
+   * @param {number} data.PlanNum - This or PatPlanNum is required. FK to InsPlan.PlanNum.
+   * @param {number} data.PatPlanNum - This or PlanNum is required. FK to PatPlan.PlanNum.
+   * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} data.BenefitType - Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+   * @param {"None" | "Individual" | "Family"} data.CoverageLevel - Required. Either "None", "Individual", or "Family".
+   * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+   * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+   * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+   * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+   * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+   * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+   * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+   * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+   * @param {number} [data.CodeGroupNum] - Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+  * @returns {Promise<Benefit>} - The created a benefit.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createBenefit({
+    PlanNum,
+    PatPlanNum,
+    BenefitType,
+    CoverageLevel,
+    CovCatNum,
+    Percent,
+    MonetaryAmt,
+    TimePeriod,
+    QuantityQualifier,
+    Quantity,
+    CodeNum,
+    procCode,
+    CodeGroupNum,
+  } : CreateBenefitParams): Promise<Benefit> {
+    if (!BenefitType || !CoverageLevel) {
+      throw new Error("Invalid data: Either PlanNum or PatPlanNum and BenefitType and CoverageLevel are required.");
+    }
+
+    return this.httpClient.post<Benefit>("/benefits", {
+      PlanNum,
+      PatPlanNum,
+      BenefitType,
+      CoverageLevel,
+      CovCatNum,
+      Percent,
+      MonetaryAmt,
+      TimePeriod,
+      QuantityQualifier,
+      Quantity,
+      CodeNum,
+      procCode,
+      CodeGroupNum,
+    });
+  }
+
+  /**
+   * Update a Benefit.
+   * @param {Object} data - The details of Benefit to update.
+   * @param {number} data.BenefitNum - Required. PK
+   * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+  * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} [data.BenefitType] - Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+   * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+   * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+   * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+   * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+   * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+   * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
+   * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0.
+   * @param {"None" | "Individual" | "Family"} [data.CoverageLevel] - Optional. Either "None", "Individual", or "Family".
+  * @returns {Promise<Benefit>} - The updated Benefit.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateBenefit({
+    BenefitNum,
+    CovCatNum,
+    BenefitType,
+    Percent,
+    MonetaryAmt,
+    TimePeriod,
+    QuantityQualifier,
+    Quantity,
+    CodeNum,
+    procCode,
+    CoverageLevel,
+  } : UpdateBenefitParams): Promise<Benefit> {
+    if (!BenefitNum || typeof BenefitNum !== "number") {
+      throw new Error("Invalid data: A Valid BenefitNum is required.");
+    }
+
+    return this.httpClient.put<Benefit>(`/benefits/${BenefitNum}`, {
+      CovCatNum,
+      BenefitType,
+      Percent,
+      MonetaryAmt,
+      TimePeriod,
+      QuantityQualifier,
+      Quantity,
+      CodeNum,
+      procCode,
+      CoverageLevel,
+    });
+  }
+
+  /**
+   * Delete a Benefit entry. 
+   * This removes a Benefit row from the database.
+   * @param {number} BenefitNum - Required: The unique identifier of the Benefit to delete.
+   * @returns {Promise<void>} - Resolves when the Benefit is deleted.
+   * @throws {Error} - If `BenefitNum` is not valid or the API returns an error.
+   */
+  public async deletePatPlan(BenefitNum: number): Promise<void> {
+    if (!BenefitNum || typeof BenefitNum !== "number") {
+      throw new Error("Invalid parameter: BenefitNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/benefits/${BenefitNum}`);
+  }
+}

package/src/api/insPlans.ts

@@ -0,0 +1,158 @@
+import HttpClient from "../utils/httpClient";
+import {
+  InsPlan,
+  GetInsPlansParams,
+  CreateInsPlanParams,
+  UpdateInsPlanParams,
+} from "../types/insPlanTypes";
+
+export default class InsPlans {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single insplan by its ID.
+   * @param {number} PlanNum - The ID of the insplan.
+   * @returns {Promise<InsPlan>} - The insplan data.
+   * @throws {Error} - If `InsPlan` is not valid or the API returns an error.
+   */
+  public async getInsPlan(PlanNum: number): Promise<InsPlan> {
+    if (!PlanNum || typeof PlanNum !== "number") {
+      throw new Error("Invalid parameter: PlanNum must be a valid number.");
+    }
+
+    return await this.httpClient.get<InsPlan>(`/insplans/${PlanNum}`);
+  }
+  
+
+  /**
+    * Fetch multiple insplans with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {"percentage" | "p" | "f" | "c" } [params.PlanType] - Must be one of the following: "percentage" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Percentage PlanTypes are stored as blank in the database.
+    * @param {number} [params.CarrierNum] - FK to carrier.CarrierNum.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<InsPlan[]>} - A list of InsPlans.
+    */
+  public async getInsPlans({
+    PlanType,
+    CarrierNum,
+    Offset,
+  }: GetInsPlansParams = {}): Promise<InsPlan[]> {
+    const params = {
+      PlanType,
+      CarrierNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<InsPlan[]>("/insplans", params);
+  }
+
+  /**
+   * This adds an InsPlan row to the database.
+   * @param {Object} data - The details of the insplan to create.
+   * @param {number} data.CarrierNum - Required. FK to carrier.CarrierNum.
+   * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+   * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+   * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+   * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+   * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+   * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+   * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+   * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+   * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+   * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+   * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+   * @returns {Promise<InsPlan>} - The created insplan.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createInsPlan({
+    CarrierNum,
+    GroupName,
+    GroupNum,
+    PlanNote,
+    FeeSched,
+    PlanType,
+    CopayFeeSched,
+    EmployerNum,
+    CodeSubstNone,
+    IsHidden,
+    MonthRenew,
+    IsBlueBookEnabled,
+  } : CreateInsPlanParams): Promise<InsPlan> {
+    if (!CarrierNum) {
+      throw new Error("Invalid data: CarrierNum is required.");
+    }
+
+    return this.httpClient.post<InsPlan>("/insplans", {
+      CarrierNum,
+      GroupName,
+      GroupNum,
+      PlanNote,
+      FeeSched,
+      PlanType,
+      CopayFeeSched,
+      EmployerNum,
+      CodeSubstNone,
+      IsHidden,
+      MonthRenew,
+      IsBlueBookEnabled,
+    });
+  }
+
+  /**
+   * Update a InsPlan.
+   * @param {Object} data - The details of InsPlan to update.
+   * @param {number} data.PlanNum - Required. Primary key. 
+   * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+   * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+   * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+   * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+   * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+   * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+   * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+   * @param {number} [data.CarrierNum] - Optional. FK to carrier.CarrierNum.
+   * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+   * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+   * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+   * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  * @returns {Promise<InsPlan>} - The updated InsPlan.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateInsPlan({
+    PlanNum,
+    GroupName,
+    GroupNum,
+    PlanNote,
+    FeeSched,
+    PlanType,
+    CopayFeeSched,
+    EmployerNum,
+    CarrierNum,
+    CodeSubstNone,
+    IsHidden,
+    MonthRenew,
+    IsBlueBookEnabled,
+  } : UpdateInsPlanParams): Promise<InsPlan> {
+    if (!PlanNum || typeof PlanNum !== "number") {
+      throw new Error("Invalid data: A Valid PlanNum is required.");
+    }
+
+    return this.httpClient.put<InsPlan>(`/insplans/${PlanNum}`, {
+      GroupName,
+      GroupNum,
+      PlanNote,
+      FeeSched,
+      PlanType,
+      CopayFeeSched,
+      EmployerNum,
+      CarrierNum,
+      CodeSubstNone,
+      IsHidden,
+      MonthRenew,
+      IsBlueBookEnabled,
+    });
+  }
+}

package/src/api/patPlans.ts

@@ -97,10 +97,10 @@ export default class PatPlans {
   }
 
   /**
-   * Delete an PatPlan entry. 
+   * Delete a 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.
+   * @returns {Promise<void>} - Resolves when the PatPlan is deleted.
    * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
    */
   public async deletePatPlan(PatPlanNum: number): Promise<void> {

package/src/openDental.ts

@@ -19,6 +19,8 @@ import PatPlans from "./api/patPlans";
 import LabCases from "./api/labCases";
 import Referrals from "./api/referrals";
 import RefAttaches from "./api/refAttaches";
+import InsPlans from "./api/insPlans";
+import Benefits from "./api/benefits";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -237,6 +239,26 @@ class OpenDental {
     }
     return new RefAttaches(this.httpClient);
   }
+
+  /**
+   * Create a new instance of the LabCases API.
+   */
+  public static InsPlans() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new InsPlans(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the LabCases API.
+   */
+  public static Benefits() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Benefits(this.httpClient);
+  }
 }
 
 export { OpenDental };

package/src/types/benefitTypes.ts

@@ -0,0 +1,70 @@
+/**
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface Benefit {
+  BenefitNum?: number; // Primary Key
+  PlanNum?: number; // FK to InsPlan.PlanNum.
+  PatPlanNum?: number; // FK to PatPlan.PlanNum.
+  CovCatNum?: number; // FK to covcat.CovCatNum.
+  BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+  Percent?: number; // Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+  MonetaryAmt?: number; // Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+  Quantity?: number; // Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+  CodeNum?: number; // FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+  procCode?: string; // FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+  CoverageLevel?: "None" | "Individual" | "Family"; // Either "None", "Individual", or "Family".
+  SecDateTEntry?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+  SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+  CodeGroupNum?: number; // (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+}
+
+/**
+ * Gets a list of PatPlans that meet a set of search criteria.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface GetBenefitsParams {
+  PlanNum?: number; // FK to InsPlan.PlanNum.
+  PatPlanNum?: number; // FK to PatPlan.PatPlanNum.
+  Offset?: number; // Pagination offset for results
+}
+
+/**
+ * Parameters for creating a new insplan.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface CreateBenefitParams {
+  PlanNum?: number; // This or PatPlanNum is required. FK to InsPlan.PlanNum.
+  PatPlanNum?: number; // This or PlanNum is required. FK to PatPlan.PlanNum.
+  BenefitType: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+  CoverageLevel: "None" | "Individual" | "Family"; // Required. Either "None", "Individual", or "Family".
+  CovCatNum?: number; // Optional. FK to covcat.CovCatNum.
+  Percent?: number; // Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+  MonetaryAmt?: number; // Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+  Quantity?: number; // Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+  CodeNum?: number; // Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+  procCode?: string; // Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+  CodeGroupNum?: number; // Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+}
+
+/**
+ * Parameters to update an insplan.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface UpdateBenefitParams {
+  BenefitNum: number; // Required in URL. Primary Key. 
+  CovCatNum?: number; // Optional. FK to covcat.CovCatNum.
+  BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+  Percent?: number; // Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+  MonetaryAmt?: number; // Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+  Quantity?: number; // Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+  CodeNum?: number; // Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
+  procCode?: string; // Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+  CoverageLevel?: "None" | "Individual" | "Family"; // Optional. Either "None", "Individual", or "Family".
+}
+  

package/src/types/insPlanTypes.ts

@@ -0,0 +1,72 @@
+/**
+ * @see https://www.opendental.com/site/apiinsplans.html
+ */
+export interface InsPlan {
+    PlanNum?: number; // PK
+    GroupName?: string; // Typically the same as the employer. Used to identify difference in plans.
+    GroupNum?: string; // 
+    PlanNote?: string; // Note for this plan. Same for all subscribers.
+    FeeSched?: number; // FK to feesched.FeeSchedNum. Default 0.
+    PlanType?: "" | "p" | "f" | "c"; // Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c".
+    ClaimFormNum?: number; // A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    CopayFeeSched?: number; // FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+    EmployerNum?: number; // FK to employer.EmployerNum. Default 0.
+    CarrierNum?: number; // FK to carrier.CarrierNum.
+    CodeSubstNone?: "true" | "false"; // Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+    IsHidden?: "true" | "false"; // Either "true" or "false". Default "false".
+    MonthRenew?: number; // The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+    SecUserNumEntry?: number; //
+    SecDateEntry?: string; // String in "yyyy-MM-dd" format
+    SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+    IsBlueBookEnabled?: "true" | "false"; // Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  }
+
+  /**
+   * Gets a list of PatPlans that meet a set of search criteria.
+   * @see https://www.opendental.com/site/apiinsplans.html
+   */
+  export interface GetInsPlansParams {
+    PlanType?: "percentage" | "p" | "f" | "c"; // Must be one of the following: "percentage" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Percentage PlanTypes are stored as blank in the database.
+    CarrierNum?: number; // FK to carrier.CarrierNum.
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating a new insplan.
+   * @see https://www.opendental.com/site/apiinsplans.html
+   */
+  export interface CreateInsPlanParams {
+    CarrierNum: number; // Required. FK to carrier.CarrierNum.
+    GroupName?: string; // Optional. Typically the same as the employer. Used to identify difference in plans.
+    GroupNum?: string; // Optional. The carrier assigned identifier, unique for each plan.
+    PlanNote?: string; // Optional. Note for this plan. Same for all subscribers.
+    FeeSched?: number; // Optional. FK to feesched.FeeSchedNum. Default 0.
+    PlanType?: "" | "p" | "f" | "c"; // Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+    CopayFeeSched?: number; // Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+    EmployerNum?: number; // Optional. FK to employer.EmployerNum. Default 0.
+    CodeSubstNone?: "true" | "false"; // Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+    IsHidden?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+    MonthRenew?: number; // Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+    IsBlueBookEnabled?: "true" | "false"; // Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  }
+  
+  /**
+   * Parameters to update an insplan.
+   * @see https://www.opendental.com/site/apiinsplans.html
+   */
+  export interface UpdateInsPlanParams {
+    PlanNum: number; // Required. PK
+    GroupName?: string; // Optional. Typically the same as the employer. Used to identify difference in plans.
+    GroupNum?: string; // Optional. The carrier assigned identifier, unique for each plan.
+    PlanNote?: string; // Optional. Note for this plan. Same for all subscribers.
+    FeeSched?: number; // Optional. FK to feesched.FeeSchedNum. Default 0.
+    PlanType?: "" | "p" | "f" | "c"; // Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+    CopayFeeSched?: number; // Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+    EmployerNum?: number; // Optional. FK to employer.EmployerNum. Default 0.
+    CarrierNum: number; // Optional. FK to carrier.CarrierNum.
+    CodeSubstNone?: "true" | "false"; // Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+    IsHidden?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+    MonthRenew?: number; // Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+    IsBlueBookEnabled?: "true" | "false"; // Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  }
+