@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/asapComms.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AsapComms {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single ASAP communication record by its identifier.
+     * @param {number} AsapCommNum - Required. ASAP communication record identifier.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<AsapComm>} - The ASAP communication record.
+     * @throws {Error} - If AsapCommNum is not a valid number.
+     * @see https://www.opendental.com/site/apiasapcomm.html
+     */
+    async getAsapComm(AsapCommNum) {
+        if (!AsapCommNum || typeof AsapCommNum !== "number") {
+            throw new Error("Invalid parameter: A valid AsapCommNum is required.");
+        }
+        return this.httpClient.get(`/asapcomms/${AsapCommNum}`);
+    }
+    /**
+     * Retrieves a filtered list of ASAP communication records.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.ClinicNum] - Optional. FK to clinic; filters by clinic.
+     * @param {string} [params.date] - Optional. Single day filter (format: "yyyy-mm-dd"); mutually exclusive with dateStart/dateEnd.
+     * @param {string} [params.dateStart] - Optional. Records on or after this date (format: "yyyy-mm-dd"); default 7 days prior.
+     * @param {string} [params.dateEnd] - Optional. Records before this date (format: "yyyy-mm-dd"); default today midnight.
+     * @returns {Promise<AsapComm[]>} - Array of ASAP communication records.
+     * @see https://www.opendental.com/site/apiasapcomm.html
+     */
+    async getAsapComms(params) {
+        return this.httpClient.get("/asapcomms", params);
+    }
+    /**
+     * Creates an ASAP communication record and associated Web Sched ASAP blockout.
+     * Requires active WebSched ASAP and Integrated Texting eService subscriptions.
+     * The referenced appointment (aptNum) or recall (recallNum) must have Priority = 1 (ASAP).
+     * @param {Object} data - The details of the ASAP comm to create.
+     * @param {number} data.op - Required. FK to operatory.OperatoryNum.
+     * @param {number} [data.aptNum] - Conditional. FK to appointment.AptNum; required if recallNum is omitted.
+     * @param {number} [data.recallNum] - Conditional. FK to recall.RecallNum; required if aptNum is omitted (added v25.2.9).
+     * @param {string} data.dateTimeStart - Required. Blockout start date/time (format: "yyyy-MM-dd HH:mm:ss").
+     * @returns {Promise<AsapComm>} - The created ASAP communication record.
+     * @throws {Error} - If op is not a valid number, or neither aptNum nor recallNum is provided, or dateTimeStart is missing.
+     * @see https://www.opendental.com/site/apiasapcomm.html
+     */
+    async createAsapComm(data) {
+        if (!data.op || typeof data.op !== "number") {
+            throw new Error("Invalid parameter: A valid op (OperatoryNum) is required.");
+        }
+        if (!data.aptNum && !data.recallNum) {
+            throw new Error("Invalid parameter: Either aptNum or recallNum is required.");
+        }
+        if (!data.dateTimeStart) {
+            throw new Error("Invalid parameter: dateTimeStart is required.");
+        }
+        return this.httpClient.post("/asapcomms", data);
+    }
+}
+exports.default = AsapComms;

package/dist/api/autoNoteControls.d.ts

@@ -0,0 +1,48 @@
+import HttpClient from "../utils/httpClient";
+import { AutoNoteControlItem, CreateAutoNoteControlParams, UpdateAutoNoteControlParams } from "../types/autoNoteControlTypes";
+export default class AutoNoteControls {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch all AutoNoteControls.
+     * @param {Object} [params] - Optional pagination and format parameters.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<AutoNoteControlItem[]>}
+     * @see https://www.opendental.com/site/apiautonotecontrols.html
+     */
+    getAutoNoteControls({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<AutoNoteControlItem[]>;
+    /**
+     * Create a new AutoNoteControl.
+     * @param {Object} data
+     * @param {string} data.Descript - Required. Description/display name for this control; referenced in Auto Note templates via [Prompt:"Descript"].
+     * @param {"Text" | "OneResponse" | "MultiResponse"} data.ControlType - Required. Type of control.
+     * @param {string} data.ControlLabel - Required. Prompt text shown to the user.
+     * @param {string} [data.ControlOptions] - Required if ControlType is "OneResponse" or "MultiResponse"; options separated by \r\n.
+     * @returns {Promise<AutoNoteControlItem>}
+     * @throws {Error} - If Descript, ControlType, or ControlLabel are not provided.
+     * @see https://www.opendental.com/site/apiautonotecontrols.html
+     */
+    createAutoNoteControl({ Descript, ControlType, ControlLabel, ControlOptions, }: CreateAutoNoteControlParams): Promise<AutoNoteControlItem>;
+    /**
+     * Update an existing AutoNoteControl.
+     * @param {Object} data
+     * @param {number} data.AutoNoteControlNum - Required. Primary key of the control to update.
+     * @param {string} [data.Descript] - Optional. Display name of the control.
+     * @param {"Text" | "OneResponse" | "MultiResponse"} [data.ControlType] - Optional. Type of control.
+     * @param {string} [data.ControlLabel] - Optional. Prompt text.
+     * @param {string} [data.ControlOptions] - Optional. Response options separated by \r\n.
+     * @returns {Promise<AutoNoteControlItem>}
+     * @throws {Error} - If AutoNoteControlNum is not provided.
+     * @see https://www.opendental.com/site/apiautonotecontrols.html
+     */
+    updateAutoNoteControl({ AutoNoteControlNum, Descript, ControlType, ControlLabel, ControlOptions, }: UpdateAutoNoteControlParams): Promise<AutoNoteControlItem>;
+}
+//# sourceMappingURL=autoNoteControls.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"autoNoteControls.d.ts","sourceRoot":"","sources":["../../src/api/autoNoteControls.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,mBAAmB,EACnB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,mBAAmB,CAAC,EAC/B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACrB,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IASvC;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,EACjC,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,cAAc,GACf,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY7D;;;;;;;;;;;OAWG;IACU,qBAAqB,CAAC,EACjC,kBAAkB,EAClB,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,cAAc,GACf,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAS9D"}

package/dist/api/autoNoteControls.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AutoNoteControls {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch all AutoNoteControls.
+     * @param {Object} [params] - Optional pagination and format parameters.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<AutoNoteControlItem[]>}
+     * @see https://www.opendental.com/site/apiautonotecontrols.html
+     */
+    async getAutoNoteControls({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/autonotecontrols", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Create a new AutoNoteControl.
+     * @param {Object} data
+     * @param {string} data.Descript - Required. Description/display name for this control; referenced in Auto Note templates via [Prompt:"Descript"].
+     * @param {"Text" | "OneResponse" | "MultiResponse"} data.ControlType - Required. Type of control.
+     * @param {string} data.ControlLabel - Required. Prompt text shown to the user.
+     * @param {string} [data.ControlOptions] - Required if ControlType is "OneResponse" or "MultiResponse"; options separated by \r\n.
+     * @returns {Promise<AutoNoteControlItem>}
+     * @throws {Error} - If Descript, ControlType, or ControlLabel are not provided.
+     * @see https://www.opendental.com/site/apiautonotecontrols.html
+     */
+    async createAutoNoteControl({ Descript, ControlType, ControlLabel, ControlOptions, }) {
+        if (!Descript)
+            throw new Error("Invalid parameter: Descript is required.");
+        if (!ControlType)
+            throw new Error("Invalid parameter: ControlType is required.");
+        if (!ControlLabel)
+            throw new Error("Invalid parameter: ControlLabel is required.");
+        return this.httpClient.post("/autonotecontrols", {
+            Descript,
+            ControlType,
+            ControlLabel,
+            ControlOptions,
+        });
+    }
+    /**
+     * Update an existing AutoNoteControl.
+     * @param {Object} data
+     * @param {number} data.AutoNoteControlNum - Required. Primary key of the control to update.
+     * @param {string} [data.Descript] - Optional. Display name of the control.
+     * @param {"Text" | "OneResponse" | "MultiResponse"} [data.ControlType] - Optional. Type of control.
+     * @param {string} [data.ControlLabel] - Optional. Prompt text.
+     * @param {string} [data.ControlOptions] - Optional. Response options separated by \r\n.
+     * @returns {Promise<AutoNoteControlItem>}
+     * @throws {Error} - If AutoNoteControlNum is not provided.
+     * @see https://www.opendental.com/site/apiautonotecontrols.html
+     */
+    async updateAutoNoteControl({ AutoNoteControlNum, Descript, ControlType, ControlLabel, ControlOptions, }) {
+        if (!AutoNoteControlNum)
+            throw new Error("Invalid parameter: AutoNoteControlNum is required.");
+        return this.httpClient.put(`/autonotecontrols/${AutoNoteControlNum}`, {
+            Descript,
+            ControlType,
+            ControlLabel,
+            ControlOptions,
+        });
+    }
+}
+exports.default = AutoNoteControls;

package/dist/api/autoNotes.d.ts

@@ -0,0 +1,42 @@
+import HttpClient from "../utils/httpClient";
+import { AutoNoteItem, GetAutoNotesParams, CreateAutoNoteParams, UpdateAutoNoteParams } from "../types/autoNoteTypes";
+export default class AutoNotes {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a list of Auto Notes, optionally filtered by category.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.Category] - Optional. FK to definition.DefNum where definition.Category=41; use 0 for uncategorized.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<AutoNoteItem[]>}
+     * @see https://www.opendental.com/site/apiautonotes.html
+     */
+    getAutoNotes({ Category, Limit, DateFormatString, DateTimeFormatString, }?: GetAutoNotesParams): Promise<AutoNoteItem[]>;
+    /**
+     * Create a new Auto Note.
+     * @param {Object} data
+     * @param {string} data.AutoNoteName - Required. Identifying name for this Auto Note.
+     * @param {string} data.MainText - Required. Template content; embed prompts as [Prompt:"autonotecontrol.Descript"].
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (category=41); use 0 for uncategorized; defaults to 0.
+     * @returns {Promise<AutoNoteItem>}
+     * @throws {Error} - If AutoNoteName or MainText are not provided.
+     * @see https://www.opendental.com/site/apiautonotes.html
+     */
+    createAutoNote({ AutoNoteName, MainText, Category, }: CreateAutoNoteParams): Promise<AutoNoteItem>;
+    /**
+     * Update an existing Auto Note.
+     * @param {Object} data
+     * @param {number} data.AutoNoteNum - Required. Primary key of the Auto Note to update.
+     * @param {string} [data.AutoNoteName] - Optional. Identifying name.
+     * @param {string} [data.MainText] - Optional. Template content.
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (category=41); use 0 for uncategorized.
+     * @returns {Promise<AutoNoteItem>}
+     * @throws {Error} - If AutoNoteNum is not provided.
+     * @see https://www.opendental.com/site/apiautonotes.html
+     */
+    updateAutoNote({ AutoNoteNum, AutoNoteName, MainText, Category, }: UpdateAutoNoteParams): Promise<AutoNoteItem>;
+}
+//# sourceMappingURL=autoNotes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"autoNotes.d.ts","sourceRoot":"","sources":["../../src/api/autoNotes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,EAAE,QAAQ,EAClC,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IASlD;;;;;;;;;OASG;IACU,cAAc,CAAC,EAC1B,YAAY,EACZ,QAAQ,EACR,QAAQ,GACT,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAY/C;;;;;;;;;;OAUG;IACU,cAAc,CAAC,EAC1B,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,QAAQ,GACT,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;CAQhD"}

package/dist/api/autoNotes.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AutoNotes {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a list of Auto Notes, optionally filtered by category.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.Category] - Optional. FK to definition.DefNum where definition.Category=41; use 0 for uncategorized.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<AutoNoteItem[]>}
+     * @see https://www.opendental.com/site/apiautonotes.html
+     */
+    async getAutoNotes({ Category, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/autonotes", {
+            Category,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Create a new Auto Note.
+     * @param {Object} data
+     * @param {string} data.AutoNoteName - Required. Identifying name for this Auto Note.
+     * @param {string} data.MainText - Required. Template content; embed prompts as [Prompt:"autonotecontrol.Descript"].
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (category=41); use 0 for uncategorized; defaults to 0.
+     * @returns {Promise<AutoNoteItem>}
+     * @throws {Error} - If AutoNoteName or MainText are not provided.
+     * @see https://www.opendental.com/site/apiautonotes.html
+     */
+    async createAutoNote({ AutoNoteName, MainText, Category, }) {
+        if (!AutoNoteName)
+            throw new Error("Invalid parameter: AutoNoteName is required.");
+        if (MainText === undefined || MainText === null) {
+            throw new Error("Invalid parameter: MainText is required.");
+        }
+        return this.httpClient.post("/autonotes", {
+            AutoNoteName,
+            MainText,
+            Category,
+        });
+    }
+    /**
+     * Update an existing Auto Note.
+     * @param {Object} data
+     * @param {number} data.AutoNoteNum - Required. Primary key of the Auto Note to update.
+     * @param {string} [data.AutoNoteName] - Optional. Identifying name.
+     * @param {string} [data.MainText] - Optional. Template content.
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (category=41); use 0 for uncategorized.
+     * @returns {Promise<AutoNoteItem>}
+     * @throws {Error} - If AutoNoteNum is not provided.
+     * @see https://www.opendental.com/site/apiautonotes.html
+     */
+    async updateAutoNote({ AutoNoteNum, AutoNoteName, MainText, Category, }) {
+        if (!AutoNoteNum)
+            throw new Error("Invalid parameter: AutoNoteNum is required.");
+        return this.httpClient.put(`/autonotes/${AutoNoteNum}`, {
+            AutoNoteName,
+            MainText,
+            Category,
+        });
+    }
+}
+exports.default = AutoNotes;

package/dist/api/benefits.d.ts

@@ -8,10 +8,21 @@ export default class Benefits {
       * @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.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
       * @returns {Promise<Benefit[]>} - A list of benefits.
       */
-    getBenefits({ PlanNum, PatPlanNum, Offset, }?: GetBenefitsParams): Promise<Benefit[]>;
+    getBenefits({ PlanNum, PatPlanNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetBenefitsParams): Promise<Benefit[]>;
+    /**
+     * Fetch a single Benefit by its ID.
+     * @param {number} BenefitNum - Required. Primary key of the benefit.
+     * @returns {Promise<Benefit>} - The benefit object.
+     * @throws {Error} - If BenefitNum is not a valid number.
+     * @see https://www.opendental.com/site/apibenefits.html
+     */
+    getBenefit(BenefitNum: number): Promise<Benefit>;
     /**
      * This adds a Benefit row to the database.
      * @param {Object} data - The details of the Benefit to create.
@@ -57,6 +68,6 @@ export default class Benefits {
      * @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>;
+    deleteBenefit(BenefitNum: number): Promise<void>;
 }
 //# sourceMappingURL=benefits.d.ts.map

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

@@ -1 +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"}
+{"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;;;;;;;;;;QAUI;IACS,WAAW,CAAC,EACvB,OAAO,EACP,UAAU,EACV,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAc5C;;;;;;OAMG;IACU,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;;;;;;;;;;;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

@@ -10,17 +10,36 @@ class Benefits {
       * @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.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
       * @returns {Promise<Benefit[]>} - A list of benefits.
       */
-    async getBenefits({ PlanNum, PatPlanNum, Offset, } = {}) {
+    async getBenefits({ PlanNum, PatPlanNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             PlanNum,
             PatPlanNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/benefits", params);
     }
+    /**
+     * Fetch a single Benefit by its ID.
+     * @param {number} BenefitNum - Required. Primary key of the benefit.
+     * @returns {Promise<Benefit>} - The benefit object.
+     * @throws {Error} - If BenefitNum is not a valid number.
+     * @see https://www.opendental.com/site/apibenefits.html
+     */
+    async getBenefit(BenefitNum) {
+        if (!BenefitNum || typeof BenefitNum !== "number") {
+            throw new Error("Invalid parameter: BenefitNum must be a valid number.");
+        }
+        return this.httpClient.get(`/benefits/${BenefitNum}`);
+    }
     /**
      * This adds a Benefit row to the database.
      * @param {Object} data - The details of the Benefit to create.
@@ -42,7 +61,7 @@ class Benefits {
      */
     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.");
+            throw new Error("Invalid parameter: Either PlanNum or PatPlanNum and BenefitType and CoverageLevel are required.");
         }
         return this.httpClient.post("/benefits", {
             PlanNum,
@@ -79,7 +98,7 @@ class Benefits {
      */
     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.");
+            throw new Error("Invalid parameter: A Valid BenefitNum is required.");
         }
         return this.httpClient.put(`/benefits/${BenefitNum}`, {
             CovCatNum,
@@ -101,7 +120,7 @@ class Benefits {
      * @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) {
+    async deleteBenefit(BenefitNum) {
         if (!BenefitNum || typeof BenefitNum !== "number") {
             throw new Error("Invalid parameter: BenefitNum must be a valid number.");
         }

package/dist/api/carriers.d.ts

@@ -0,0 +1,68 @@
+import HttpClient from "../utils/httpClient";
+import { CarrierItem, CreateCarrierParams, UpdateCarrierParams } from "../types/carrierTypes";
+export default class Carriers {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single carrier by ID.
+     * @param {number} CarrierNum - Required. Primary key of the carrier.
+     * @param {Object} [params] - Optional pagination and format parameters.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<CarrierItem>}
+     * @throws {Error} - If CarrierNum is not valid.
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    getCarrier(CarrierNum: number): Promise<CarrierItem>;
+    /**
+     * Fetch all insurance carriers.
+     * @returns {Promise<CarrierItem[]>}
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    getCarriers({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<CarrierItem[]>;
+    /**
+     * Create a new insurance carrier.
+     * @param {Object} data
+     * @param {string} data.CarrierName - Required. Carrier display name.
+     * @param {string} [data.Address] - Optional. Street address line 1.
+     * @param {string} [data.Address2] - Optional. Street address line 2.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. Two uppercase characters for USA; province for Canada.
+     * @param {string} [data.Zip] - Optional. Format: 12345, 12345-1234, or 123456789.
+     * @param {string} [data.Phone] - Optional. Phone number.
+     * @param {string} [data.ElectID] - Optional. Electronic payer ID for EDI/clearinghouse claim submission.
+     * @param {"SendElect" | "NoSendElect" | "NoSendSecondaryElect"} [data.NoSendElect] - Optional. Electronic claim sending behavior.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false".
+     * @returns {Promise<CarrierItem>}
+     * @throws {Error} - If CarrierName is not provided.
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    createCarrier({ CarrierName, Address, Address2, City, State, Zip, Phone, ElectID, NoSendElect, IsHidden, }: CreateCarrierParams): Promise<CarrierItem>;
+    /**
+     * Update an existing insurance carrier.
+     * @param {Object} data
+     * @param {number} data.CarrierNum - Required. Primary key of the carrier to update.
+     * @param {string} [data.CarrierName] - Optional. Carrier display name.
+     * @param {string} [data.Address] - Optional. Street address line 1.
+     * @param {string} [data.Address2] - Optional. Street address line 2.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. Two uppercase characters for USA; province for Canada.
+     * @param {string} [data.Zip] - Optional. Format: 12345, 12345-1234, or 123456789.
+     * @param {string} [data.Phone] - Optional. Phone number.
+     * @param {string} [data.ElectID] - Optional. Electronic payer ID.
+     * @param {"SendElect" | "NoSendElect" | "NoSendSecondaryElect"} [data.NoSendElect] - Optional. Electronic claim sending behavior.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false".
+     * @returns {Promise<CarrierItem>}
+     * @throws {Error} - If CarrierNum is not provided.
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    updateCarrier({ CarrierNum, CarrierName, Address, Address2, City, State, Zip, Phone, ElectID, NoSendElect, IsHidden, }: UpdateCarrierParams): Promise<CarrierItem>;
+}
+//# sourceMappingURL=carriers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"carriers.d.ts","sourceRoot":"","sources":["../../src/api/carriers.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOjE;;;;OAIG;IACU,WAAW,CAAC,EACvB,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACrB,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAS/B;;;;;;;;;;;;;;;;OAgBG;IACU,aAAa,CAAC,EACzB,WAAW,EACX,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,GAAG,EACH,KAAK,EACL,OAAO,EACP,WAAW,EACX,QAAQ,GACT,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IAgB7C;;;;;;;;;;;;;;;;;OAiBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,WAAW,EACX,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,GAAG,EACH,KAAK,EACL,OAAO,EACP,WAAW,EACX,QAAQ,GACT,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;CAe9C"}

package/dist/api/carriers.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Carriers {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single carrier by ID.
+     * @param {number} CarrierNum - Required. Primary key of the carrier.
+     * @param {Object} [params] - Optional pagination and format parameters.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<CarrierItem>}
+     * @throws {Error} - If CarrierNum is not valid.
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    async getCarrier(CarrierNum) {
+        if (!CarrierNum || typeof CarrierNum !== "number") {
+            throw new Error("Invalid parameter: CarrierNum must be a valid number.");
+        }
+        return this.httpClient.get(`/carriers/${CarrierNum}`);
+    }
+    /**
+     * Fetch all insurance carriers.
+     * @returns {Promise<CarrierItem[]>}
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    async getCarriers({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/carriers", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Create a new insurance carrier.
+     * @param {Object} data
+     * @param {string} data.CarrierName - Required. Carrier display name.
+     * @param {string} [data.Address] - Optional. Street address line 1.
+     * @param {string} [data.Address2] - Optional. Street address line 2.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. Two uppercase characters for USA; province for Canada.
+     * @param {string} [data.Zip] - Optional. Format: 12345, 12345-1234, or 123456789.
+     * @param {string} [data.Phone] - Optional. Phone number.
+     * @param {string} [data.ElectID] - Optional. Electronic payer ID for EDI/clearinghouse claim submission.
+     * @param {"SendElect" | "NoSendElect" | "NoSendSecondaryElect"} [data.NoSendElect] - Optional. Electronic claim sending behavior.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false".
+     * @returns {Promise<CarrierItem>}
+     * @throws {Error} - If CarrierName is not provided.
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    async createCarrier({ CarrierName, Address, Address2, City, State, Zip, Phone, ElectID, NoSendElect, IsHidden, }) {
+        if (!CarrierName)
+            throw new Error("Invalid parameter: CarrierName is required.");
+        return this.httpClient.post("/carriers", {
+            CarrierName,
+            Address,
+            Address2,
+            City,
+            State,
+            Zip,
+            Phone,
+            ElectID,
+            NoSendElect,
+            IsHidden,
+        });
+    }
+    /**
+     * Update an existing insurance carrier.
+     * @param {Object} data
+     * @param {number} data.CarrierNum - Required. Primary key of the carrier to update.
+     * @param {string} [data.CarrierName] - Optional. Carrier display name.
+     * @param {string} [data.Address] - Optional. Street address line 1.
+     * @param {string} [data.Address2] - Optional. Street address line 2.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. Two uppercase characters for USA; province for Canada.
+     * @param {string} [data.Zip] - Optional. Format: 12345, 12345-1234, or 123456789.
+     * @param {string} [data.Phone] - Optional. Phone number.
+     * @param {string} [data.ElectID] - Optional. Electronic payer ID.
+     * @param {"SendElect" | "NoSendElect" | "NoSendSecondaryElect"} [data.NoSendElect] - Optional. Electronic claim sending behavior.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false".
+     * @returns {Promise<CarrierItem>}
+     * @throws {Error} - If CarrierNum is not provided.
+     * @see https://www.opendental.com/site/apicarriers.html
+     */
+    async updateCarrier({ CarrierNum, CarrierName, Address, Address2, City, State, Zip, Phone, ElectID, NoSendElect, IsHidden, }) {
+        if (!CarrierNum)
+            throw new Error("Invalid parameter: CarrierNum is required.");
+        return this.httpClient.put(`/carriers/${CarrierNum}`, {
+            CarrierName,
+            Address,
+            Address2,
+            City,
+            State,
+            Zip,
+            Phone,
+            ElectID,
+            NoSendElect,
+            IsHidden,
+        });
+    }
+}
+exports.default = Carriers;

package/dist/api/chartModules.d.ts

@@ -16,7 +16,7 @@ export default class ChartModules {
      * @returns {Promise<PatientInfo>} - The PatientInfo object.
      * @throws {Error} - If `PatNum` is not provided.
      */
-    PatientInfo(PatNum: number): Promise<PatientInfo>;
+    getPatientInfo(PatNum: number): Promise<PatientInfo>;
     /**
      * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
      * @param {number} PatNum - The unique identifier for the patient.

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

@@ -1 +1 @@
-{"version":3,"file":"chartModules.d.ts","sourceRoot":"","sources":["../../src/api/chartModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,WAAW,EACX,kBAAkB,EACnB,MAAM,2BAA2B,CAAA;AAElC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO5D;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAO9D;;;;;OAKG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAM1E"}
+{"version":3,"file":"chartModules.d.ts","sourceRoot":"","sources":["../../src/api/chartModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,WAAW,EACX,kBAAkB,EACnB,MAAM,2BAA2B,CAAA;AAElC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO5D;;;;;OAKG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOjE;;;;;OAKG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAM1E"}

package/dist/api/chartModules.js

@@ -13,7 +13,7 @@ class ChartModules {
      */
     async getProgNotes(PatNum) {
         if (!PatNum || typeof PatNum !== "number") {
-            throw new Error("PatNum must be an integer.");
+            throw new Error("Invalid parameter: PatNum must be an integer.");
         }
         return this.httpClient.get(`/chartmodules/${PatNum}/ProgNotes`);
     }
@@ -23,9 +23,9 @@ class ChartModules {
      * @returns {Promise<PatientInfo>} - The PatientInfo object.
      * @throws {Error} - If `PatNum` is not provided.
      */
-    async PatientInfo(PatNum) {
+    async getPatientInfo(PatNum) {
         if (!PatNum || typeof PatNum !== "number") {
-            throw new Error("PatNum must be an integer.");
+            throw new Error("Invalid parameter: PatNum must be an integer.");
         }
         return this.httpClient.get(`/chartmodules/${PatNum}/PatientInfo`);
     }
@@ -37,7 +37,7 @@ class ChartModules {
      */
     async getPlannedAppts(PatNum) {
         if (!PatNum || typeof PatNum !== "number") {
-            throw new Error("PatNum must be an integer.");
+            throw new Error("Invalid parameter: PatNum must be an integer.");
         }
         return this.httpClient.get(`/chartmodules/${PatNum}/PlannedAppts`);
     }