@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/perioMeasures.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PerioMeasures {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves periomeasure records with optional filtering by exam.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.PerioExamNum] - Optional. FK to perioexam.PerioExamNum; filter to a specific exam.
+     * @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<PerioMeasure[]>} - A list of periomeasure records.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    async getPerioMeasures(params) {
+        return this.httpClient.get("/periomeasures", params);
+    }
+    /**
+     * Creates a new periomeasure.
+     * Only one PerioMeasure per SequenceType per tooth per exam is allowed.
+     * Sentinel value -1 means "not applicable" for any surface or tooth value field.
+     *
+     * SequenceType valid value ranges:
+     * - "Mobility":         ToothValue 0–19; all surface values must be -1
+     * - "Furcation":        ToothValue must be -1; surface values -1 or 0–19
+     * - "GingMargin":       ToothValue must be -1; surface values -1, 0–19, or 101–119 (101–119 = negative: subtract 100)
+     * - "MGJ":              ToothValue must be -1; surface values -1 or 0–19; lingual values must be -1 for teeth 1–16
+     * - "Probing":          ToothValue must be -1; surface values -1 or 0–19
+     * - "SkipTooth":        ToothValue must be 1; all surface values must be -1
+     * - "BleedSupPlaqCalc": ToothValue must be -1; surface values 0–15 (bitfield: bleeding=1, suppuration=2, plaque=4, calculus=8)
+     *
+     * @param {Object} data - The details of the periomeasure to create.
+     * @param {number} data.PerioExamNum - Required. FK to perioexam.PerioExamNum.
+     * @param {string} data.SequenceType - Required. Measurement classification enum.
+     * @param {number} data.IntTooth - Required. Tooth number 1–32.
+     * @param {number} [data.ToothValue] - Optional. Whole-tooth measurement; default: -1 (not applicable).
+     * @param {number} [data.MBvalue] - Optional. Mesial-buccal surface value; default: -1.
+     * @param {number} [data.Bvalue] - Optional. Buccal surface value; default: -1.
+     * @param {number} [data.DBvalue] - Optional. Distal-buccal surface value; default: -1.
+     * @param {number} [data.MLvalue] - Optional. Mesial-lingual surface value; default: -1.
+     * @param {number} [data.Lvalue] - Optional. Lingual surface value; default: -1.
+     * @param {number} [data.DLvalue] - Optional. Distal-lingual surface value; default: -1.
+     * @returns {Promise<PerioMeasure>} - The created periomeasure record.
+     * @throws {Error} - If PerioExamNum is not a valid number, SequenceType is missing, or IntTooth is not a valid number.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    async createPerioMeasure({ PerioExamNum, SequenceType, IntTooth, ToothValue, MBvalue, Bvalue, DBvalue, MLvalue, Lvalue, DLvalue, }) {
+        if (!PerioExamNum || typeof PerioExamNum !== "number") {
+            throw new Error("Invalid parameter: A valid PerioExamNum is required.");
+        }
+        if (!SequenceType) {
+            throw new Error("Invalid parameter: SequenceType is required.");
+        }
+        if (!IntTooth || typeof IntTooth !== "number") {
+            throw new Error("Invalid parameter: A valid IntTooth (1–32) is required.");
+        }
+        return this.httpClient.post("/periomeasures", {
+            PerioExamNum,
+            SequenceType,
+            IntTooth,
+            ToothValue,
+            MBvalue,
+            Bvalue,
+            DBvalue,
+            MLvalue,
+            Lvalue,
+            DLvalue,
+        });
+    }
+    /**
+     * Updates measurement values on an existing periomeasure.
+     * SequenceType and IntTooth cannot be changed after creation.
+     * @param {Object} data - The details of the periomeasure to update.
+     * @param {number} data.PerioMeasureNum - Required. Primary key.
+     * @param {number} [data.ToothValue] - Optional. Updated whole-tooth measurement.
+     * @param {number} [data.MBvalue] - Optional. Updated mesial-buccal surface value.
+     * @param {number} [data.Bvalue] - Optional. Updated buccal surface value.
+     * @param {number} [data.DBvalue] - Optional. Updated distal-buccal surface value.
+     * @param {number} [data.MLvalue] - Optional. Updated mesial-lingual surface value.
+     * @param {number} [data.Lvalue] - Optional. Updated lingual surface value.
+     * @param {number} [data.DLvalue] - Optional. Updated distal-lingual surface value.
+     * @returns {Promise<PerioMeasure>} - The updated periomeasure record.
+     * @throws {Error} - If PerioMeasureNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    async updatePerioMeasure({ PerioMeasureNum, ToothValue, MBvalue, Bvalue, DBvalue, MLvalue, Lvalue, DLvalue, }) {
+        if (!PerioMeasureNum || typeof PerioMeasureNum !== "number") {
+            throw new Error("Invalid parameter: A valid PerioMeasureNum is required.");
+        }
+        return this.httpClient.put(`/periomeasures/${PerioMeasureNum}`, {
+            ToothValue,
+            MBvalue,
+            Bvalue,
+            DBvalue,
+            MLvalue,
+            Lvalue,
+            DLvalue,
+        });
+    }
+    /**
+     * Deletes a periomeasure. Only records with SequenceType "Mobility" or "SkipTooth" can be deleted.
+     * @param {number} PerioMeasureNum - Required. Primary key.
+     * @returns {Promise<void>}
+     * @throws {Error} - If PerioMeasureNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    async deletePerioMeasure(PerioMeasureNum) {
+        if (!PerioMeasureNum || typeof PerioMeasureNum !== "number") {
+            throw new Error("Invalid parameter: A valid PerioMeasureNum is required.");
+        }
+        return this.httpClient.delete(`/periomeasures/${PerioMeasureNum}`);
+    }
+}
+exports.default = PerioMeasures;

package/dist/api/pharmacies.d.ts

@@ -0,0 +1,29 @@
+import HttpClient from "../utils/httpClient";
+import { PharmacyItem } from "../types/pharmacyTypes";
+export default class Pharmacies {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single pharmacy record by primary key.
+     * @param {number} PharmacyNum - Required. Primary key of the pharmacy.
+     * @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<PharmacyItem>} - The pharmacy record.
+     * @throws {Error} - If PharmacyNum is not a valid number.
+     */
+    getPharmacy(PharmacyNum: number): Promise<PharmacyItem>;
+    /**
+     * Retrieves all pharmacy records in the system.
+     * @returns {Promise<PharmacyItem[]>} - Array of pharmacy records.
+     */
+    getPharmacies({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<PharmacyItem[]>;
+}
+//# sourceMappingURL=pharmacies.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pharmacies.d.ts","sourceRoot":"","sources":["../../src/api/pharmacies.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAQpE;;;OAGG;IACU,aAAa,CAAC,EACzB,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,YAAY,EAAE,CAAC;CAQjC"}

package/dist/api/pharmacies.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Pharmacies {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single pharmacy record by primary key.
+     * @param {number} PharmacyNum - Required. Primary key of the pharmacy.
+     * @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<PharmacyItem>} - The pharmacy record.
+     * @throws {Error} - If PharmacyNum is not a valid number.
+     */
+    async getPharmacy(PharmacyNum) {
+        if (!PharmacyNum || typeof PharmacyNum !== "number") {
+            throw new Error("Invalid parameter: PharmacyNum must be a valid number.");
+        }
+        return this.httpClient.get(`/pharmacies/${PharmacyNum}`);
+    }
+    /**
+     * Retrieves all pharmacy records in the system.
+     * @returns {Promise<PharmacyItem[]>} - Array of pharmacy records.
+     */
+    async getPharmacies({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/pharmacies", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+}
+exports.default = Pharmacies;

package/dist/api/popups.d.ts

@@ -0,0 +1,42 @@
+import HttpClient from "../utils/httpClient";
+import { Popup, GetPopupsParams, CreatePopupParams, UpdatePopupParams } from "../types/popupTypes";
+export default class Popups {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves active and disabled popups for a patient and associated Family and SuperFamily.
+     * @param {Object} params - The filter parameters.
+     * @param {number} params.PatNum - Required. Patient number to retrieve popups for.
+     * @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<Popup[]>} - A list of popup records.
+     * @see https://www.opendental.com/site/apipopups.html
+     */
+    getPopups({ PatNum, Limit, DateFormatString, DateTimeFormatString, }: GetPopupsParams): Promise<Popup[]>;
+    /**
+     * Creates a new popup.
+     * @param {Object} data - The details of the popup to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} data.Description - Required. Popup message text.
+     * @param {string} [data.PopupLevel] - Optional. "Patient" (default), "Family", or "SuperFamily".
+     * @param {string} [data.DateTimeDisabled] - Optional. Disablement timestamp; format: yyyy-MM-dd HH:mm:ss; defaults to "0001-01-01 00:00:00" (never) (v25.1.12+).
+     * @returns {Promise<Popup>} - The created popup record.
+     * @see https://www.opendental.com/site/apipopups.html
+     */
+    createPopup({ PatNum, Description, PopupLevel, DateTimeDisabled, }: CreatePopupParams): Promise<Popup>;
+    /**
+     * Updates an existing popup.
+     * Modifying Description triggers self-archiving: a copy of the original is archived before the update.
+     * @param {Object} data - The details of the popup to update.
+     * @param {number} data.PopupNum - Required. Primary key of the popup to update.
+     * @param {string} [data.Description] - Optional. New popup message text; triggers self-archiving when changed.
+     * @param {string} [data.PopupLevel] - Optional. "Patient", "Family", or "SuperFamily".
+     * @param {string} [data.DateTimeDisabled] - Optional. Disablement timestamp; format: yyyy-MM-dd HH:mm:ss.
+     * @returns {Promise<Popup>} - The updated popup record.
+     * @see https://www.opendental.com/site/apipopups.html
+     */
+    updatePopup({ PopupNum, Description, PopupLevel, DateTimeDisabled, }: UpdatePopupParams): Promise<Popup>;
+}
+//# sourceMappingURL=popups.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"popups.d.ts","sourceRoot":"","sources":["../../src/api/popups.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,KAAK,EACL,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,SAAS,CAAC,EAAE,MAAM,EAC7B,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,EAAE,eAAe,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAQnC;;;;;;;;;OASG;IACU,WAAW,CAAC,EACvB,MAAM,EACN,WAAW,EACX,UAAU,EACV,gBAAgB,GACjB,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAgBrC;;;;;;;;;;OAUG;IACU,WAAW,CAAC,EACvB,QAAQ,EACR,WAAW,EACX,UAAU,EACV,gBAAgB,GACjB,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;CAWtC"}

package/dist/api/popups.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Popups {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves active and disabled popups for a patient and associated Family and SuperFamily.
+     * @param {Object} params - The filter parameters.
+     * @param {number} params.PatNum - Required. Patient number to retrieve popups for.
+     * @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<Popup[]>} - A list of popup records.
+     * @see https://www.opendental.com/site/apipopups.html
+     */
+    async getPopups({ PatNum, Limit, DateFormatString, DateTimeFormatString, }) {
+        if (!PatNum || typeof PatNum !== "number") {
+            throw new Error("Invalid parameter: A valid PatNum is required.");
+        }
+        return this.httpClient.get("/popups", { PatNum });
+    }
+    /**
+     * Creates a new popup.
+     * @param {Object} data - The details of the popup to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} data.Description - Required. Popup message text.
+     * @param {string} [data.PopupLevel] - Optional. "Patient" (default), "Family", or "SuperFamily".
+     * @param {string} [data.DateTimeDisabled] - Optional. Disablement timestamp; format: yyyy-MM-dd HH:mm:ss; defaults to "0001-01-01 00:00:00" (never) (v25.1.12+).
+     * @returns {Promise<Popup>} - The created popup record.
+     * @see https://www.opendental.com/site/apipopups.html
+     */
+    async createPopup({ PatNum, Description, PopupLevel, DateTimeDisabled, }) {
+        if (!PatNum || typeof PatNum !== "number") {
+            throw new Error("Invalid parameter: A valid PatNum is required.");
+        }
+        if (!Description) {
+            throw new Error("Invalid parameter: Description is required.");
+        }
+        return this.httpClient.post("/popups", {
+            PatNum,
+            Description,
+            PopupLevel,
+            DateTimeDisabled,
+        });
+    }
+    /**
+     * Updates an existing popup.
+     * Modifying Description triggers self-archiving: a copy of the original is archived before the update.
+     * @param {Object} data - The details of the popup to update.
+     * @param {number} data.PopupNum - Required. Primary key of the popup to update.
+     * @param {string} [data.Description] - Optional. New popup message text; triggers self-archiving when changed.
+     * @param {string} [data.PopupLevel] - Optional. "Patient", "Family", or "SuperFamily".
+     * @param {string} [data.DateTimeDisabled] - Optional. Disablement timestamp; format: yyyy-MM-dd HH:mm:ss.
+     * @returns {Promise<Popup>} - The updated popup record.
+     * @see https://www.opendental.com/site/apipopups.html
+     */
+    async updatePopup({ PopupNum, Description, PopupLevel, DateTimeDisabled, }) {
+        if (!PopupNum || typeof PopupNum !== "number") {
+            throw new Error("Invalid parameter: A valid PopupNum is required.");
+        }
+        return this.httpClient.put(`/popups/${PopupNum}`, {
+            Description,
+            PopupLevel,
+            DateTimeDisabled,
+        });
+    }
+}
+exports.default = Popups;

package/dist/api/preferences.d.ts

@@ -0,0 +1,31 @@
+import HttpClient from "../utils/httpClient";
+import { Preference, GetPreferencesParams, UpdatePreferenceParams } from "../types/preferenceTypes";
+export default class Preferences {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves one or more preference records.
+     * When no PrefName is specified, returns all preferences (~1,000) using pagination.
+     * All preference values are returned as strings regardless of underlying data type.
+     * @param {Object} [params] - Optional filter and pagination parameters.
+     * @param {string} [params.PrefName] - Optional. Filter for a specific preference by name (e.g., "RecallDaysPast"); omit to return all.
+     * @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<Preference[]>} - A list of preference records.
+     * @see https://www.opendental.com/site/apipreferences.html
+     */
+    getPreferences(params?: GetPreferencesParams): Promise<Preference[]>;
+    /**
+     * Updates a preference by key name.
+     * @param {Object} data - The preference to update.
+     * @param {string} data.PrefName - Required. The preference name (key) to update.
+     * @param {string} data.ValueString - Required. The new preference value as a string.
+     * @returns {Promise<Preference>} - The updated preference record.
+     * @throws {Error} - If PrefName or ValueString is missing.
+     * @see https://www.opendental.com/site/apipreferences.html
+     */
+    updatePreference({ PrefName, ValueString, }: UpdatePreferenceParams): Promise<Preference>;
+}
+//# sourceMappingURL=preferences.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../../src/api/preferences.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;;OAYG;IACU,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAIjF;;;;;;;;OAQG;IACU,gBAAgB,CAAC,EAC5B,QAAQ,EACR,WAAW,GACZ,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;CAahD"}

package/dist/api/preferences.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Preferences {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves one or more preference records.
+     * When no PrefName is specified, returns all preferences (~1,000) using pagination.
+     * All preference values are returned as strings regardless of underlying data type.
+     * @param {Object} [params] - Optional filter and pagination parameters.
+     * @param {string} [params.PrefName] - Optional. Filter for a specific preference by name (e.g., "RecallDaysPast"); omit to return all.
+     * @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<Preference[]>} - A list of preference records.
+     * @see https://www.opendental.com/site/apipreferences.html
+     */
+    async getPreferences(params) {
+        return this.httpClient.get("/preferences", params);
+    }
+    /**
+     * Updates a preference by key name.
+     * @param {Object} data - The preference to update.
+     * @param {string} data.PrefName - Required. The preference name (key) to update.
+     * @param {string} data.ValueString - Required. The new preference value as a string.
+     * @returns {Promise<Preference>} - The updated preference record.
+     * @throws {Error} - If PrefName or ValueString is missing.
+     * @see https://www.opendental.com/site/apipreferences.html
+     */
+    async updatePreference({ PrefName, ValueString, }) {
+        if (!PrefName) {
+            throw new Error("Invalid parameter: PrefName is required.");
+        }
+        if (ValueString === undefined || ValueString === null) {
+            throw new Error("Invalid parameter: ValueString is required.");
+        }
+        return this.httpClient.put(`/preferences`, {
+            PrefName,
+            ValueString,
+        });
+    }
+}
+exports.default = Preferences;

package/dist/api/procNotes.d.ts

@@ -8,10 +8,13 @@ export default class ProcNotes {
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} [params.PatNum] - Optional. FK to patient.PatNum.
      * @param {number} [params.ProcNum] -  Optional. FK to procedure.ProcNum.
-     * @param {number} [params.Offset] - Optional. 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<ProcNote[]>} - A list of ProcNotes.
      */
-    getProcNotes({ PatNum, ProcNum, Offset, }?: GetProcNotesParams): Promise<ProcNote[]>;
+    getProcNotes({ PatNum, ProcNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetProcNotesParams): Promise<ProcNote[]>;
     /**
        * Creates a ProcNote
        * @param {Object} data - The details of ProcNote to create.

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

@@ -1 +1 @@
-{"version":3,"file":"procNotes.d.ts","sourceRoot":"","sources":["../../src/api/procNotes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;OAOG;IACU,YAAY,CAAC,EACtB,MAAM,EACN,OAAO,EACP,MAAM,GACP,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUlD;;;;;;;;;;SAUK;IACU,cAAc,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,YAAY,GACb,EAAG,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAa7C"}
+{"version":3,"file":"procNotes.d.ts","sourceRoot":"","sources":["../../src/api/procNotes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,EACtB,MAAM,EACN,OAAO,EACP,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAchD;;;;;;;;;;SAUK;IACU,cAAc,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,YAAY,GACb,EAAG,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAa7C"}

package/dist/api/procNotes.js

@@ -10,14 +10,20 @@ class ProcNotes {
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} [params.PatNum] - Optional. FK to patient.PatNum.
      * @param {number} [params.ProcNum] -  Optional. FK to procedure.ProcNum.
-     * @param {number} [params.Offset] - Optional. 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<ProcNote[]>} - A list of ProcNotes.
      */
-    async getProcNotes({ PatNum, ProcNum, Offset, } = {}) {
+    async getProcNotes({ PatNum, ProcNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             PatNum,
             ProcNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/procnotes", params);
     }
@@ -34,7 +40,7 @@ class ProcNotes {
        */
     async createProcNote({ PatNum, ProcNum, Note, isSigned, doAppendNote, }) {
         if (!PatNum || !ProcNum || !Note) {
-            throw new Error("Invalid data: PatNum, ProcNum, and Note are required.");
+            throw new Error("Invalid parameter: PatNum, ProcNum, and Note are required.");
         }
         return this.httpClient.post("/procnotes", {
             PatNum,

package/dist/api/procTPs.d.ts

@@ -1,16 +1,19 @@
 import HttpClient from "../utils/httpClient";
 import { ProcTP, GetProcTPsParams, updateProcTPParams } from "../types/procTPTypes";
-export default class procTPs {
+export default class ProcTPs {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
      * Get a list of ProcTPs by the TreatPlanNum. Before calling this method, use TreatPlans GET to find the TreatPlanNum of an existing TreatPlan.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} params.TreatPlanNum - Required. FK to TreatPlan.TreatPlanNum.
-     * @param {number} [params.Offset] - Optional. 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<ProcTP[]>} - A list of procTPs.
      */
-    getProcTPs({ TreatPlanNum, Offset, }?: GetProcTPsParams): Promise<ProcTP[]>;
+    getProcTPs({ TreatPlanNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetProcTPsParams): Promise<ProcTP[]>;
     /**
      * Update an existing procedure log entry.
     * @param {Object} data - The updated details of the ProcTP.

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

@@ -1 +1 @@
-{"version":3,"file":"procTPs.d.ts","sourceRoot":"","sources":["../../src/api/procTPs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;OAMG;IACU,UAAU,CAAC,EACpB,YAAY,EACZ,MAAM,GACP,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAS9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAsCE;IACW,YAAY,CACvB,EACE,SAAS,EACT,QAAQ,EACR,UAAU,EACV,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,EACT,MAAM,EACN,QAAQ,EACR,SAAS,EACT,EAAE,EACF,QAAQ,GACT,EAAE,kBAAkB,GAClB,OAAO,CAAC,MAAM,CAAC;CAsBnB"}
+{"version":3,"file":"procTPs.d.ts","sourceRoot":"","sources":["../../src/api/procTPs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;;OASG;IACU,UAAU,CAAC,EACpB,YAAY,EACZ,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAa5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAsCE;IACW,YAAY,CACvB,EACE,SAAS,EACT,QAAQ,EACR,UAAU,EACV,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,EACT,MAAM,EACN,QAAQ,EACR,SAAS,EACT,EAAE,EACF,QAAQ,GACT,EAAE,kBAAkB,GAClB,OAAO,CAAC,MAAM,CAAC;CAsBnB"}

package/dist/api/procTPs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-class procTPs {
+class ProcTPs {
     httpClient;
     constructor(httpClient) {
         this.httpClient = httpClient;
@@ -9,13 +9,19 @@ class procTPs {
      * Get a list of ProcTPs by the TreatPlanNum. Before calling this method, use TreatPlans GET to find the TreatPlanNum of an existing TreatPlan.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} params.TreatPlanNum - Required. FK to TreatPlan.TreatPlanNum.
-     * @param {number} [params.Offset] - Optional. 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<ProcTP[]>} - A list of procTPs.
      */
-    async getProcTPs({ TreatPlanNum, Offset, } = {}) {
+    async getProcTPs({ TreatPlanNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             TreatPlanNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/proctps", params);
     }
@@ -79,4 +85,4 @@ class procTPs {
         });
     }
 }
-exports.default = procTPs;
+exports.default = ProcTPs;

package/dist/api/procedureCodes.d.ts

@@ -4,19 +4,21 @@ export default class ProcedureCodes {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
-     * Fetch a single inssub by its ID.
-     * @param {number} CodeNum - The unique identifier for the inssub.
-     * @returns {Promise<ProcedureCode>} - The inssub object.
-     * @throws {Error} - If `InsSubNum` is not provided.
+     * Fetch a single procedure code by its ID.
+     * @param {number} CodeNum - The unique identifier for the procedure code.
+     * @returns {Promise<ProcedureCode>} - The procedure code object.
+     * @throws {Error} - If `CodeNum` is not provided.
+     * @see https://www.opendental.com/site/apiprocedurecodes.html
      */
     getProcedureCode(CodeNum: number): Promise<ProcedureCode>;
     /**
-      * Fetch multiple inssubs with optional filtering and pagination.
+      * Fetch multiple procedure codes with optional filtering and pagination.
       * @param {Object} params - The parameters for filtering and pagination.
       * @param {string} [params.DateTStamp] - String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
       * @param {number} [params.Offset] - Pagination offset for results.
-      * @returns {Promise<ProcedureCode[]>} - A list of inssubs.
+      * @returns {Promise<ProcedureCode[]>} - A list of procedure codes.
+      * @see https://www.opendental.com/site/apiprocedurecodes.html
       */
-    getProcedureCodes({ DateTStamp, Offset, }?: GetProcedureCodeParams): Promise<ProcedureCode[]>;
+    getProcedureCodes({ DateTStamp, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetProcedureCodeParams): Promise<ProcedureCode[]>;
 }
 //# sourceMappingURL=procedureCodes.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"procedureCodes.d.ts","sourceRoot":"","sources":["../../src/api/procedureCodes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAOtE;;;;;;QAMI;IACS,iBAAiB,CAAC,EAC7B,UAAU,EACV,MAAM,GACP,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAQ1D"}
+{"version":3,"file":"procedureCodes.d.ts","sourceRoot":"","sources":["../../src/api/procedureCodes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAOtE;;;;;;;QAOI;IACS,iBAAiB,CAAC,EAC7B,UAAU,EACV,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAYxD"}

package/dist/api/procedureCodes.js

@@ -6,28 +6,33 @@ class ProcedureCodes {
         this.httpClient = httpClient;
     }
     /**
-     * Fetch a single inssub by its ID.
-     * @param {number} CodeNum - The unique identifier for the inssub.
-     * @returns {Promise<ProcedureCode>} - The inssub object.
-     * @throws {Error} - If `InsSubNum` is not provided.
+     * Fetch a single procedure code by its ID.
+     * @param {number} CodeNum - The unique identifier for the procedure code.
+     * @returns {Promise<ProcedureCode>} - The procedure code object.
+     * @throws {Error} - If `CodeNum` is not provided.
+     * @see https://www.opendental.com/site/apiprocedurecodes.html
      */
     async getProcedureCode(CodeNum) {
         if (!CodeNum) {
-            throw new Error("CodeNum is required.");
+            throw new Error("Invalid parameter: CodeNum is required.");
         }
         return this.httpClient.get(`/procedurecodes/${CodeNum}`);
     }
     /**
-      * Fetch multiple inssubs with optional filtering and pagination.
+      * Fetch multiple procedure codes with optional filtering and pagination.
       * @param {Object} params - The parameters for filtering and pagination.
       * @param {string} [params.DateTStamp] - String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
       * @param {number} [params.Offset] - Pagination offset for results.
-      * @returns {Promise<ProcedureCode[]>} - A list of inssubs.
+      * @returns {Promise<ProcedureCode[]>} - A list of procedure codes.
+      * @see https://www.opendental.com/site/apiprocedurecodes.html
       */
-    async getProcedureCodes({ DateTStamp, Offset, } = {}) {
+    async getProcedureCodes({ DateTStamp, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             DateTStamp,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/procedurecodes", params);
     }

package/dist/api/procedureLog.d.ts

@@ -6,6 +6,9 @@ export default class ProcedureLogs {
     /**
      * Fetch a specific procedure log entry by its ID.
      * @param {number} ProcNum - Required: The unique identifier of the procedure log.
+     * @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<ProcedureLog>} - The procedure log details.
      * @throws {Error} - If `ProcNum` is not valid or the API returns an error.
      */
@@ -25,7 +28,7 @@ export default class ProcedureLogs {
       * @returns {Promise<ProcedureLog[]>} - A list of procedurelogs.
       * @throws {Error} - If the API returns an error.
       */
-    getProcedureLogs({ PatNum, AptNum, ProcDate, ProcStatus, PlannedAptNum, ClinicNum, CodeNum, DateTStamp, Offset, }?: GetProcedureLogParams): Promise<ProcedureLog[]>;
+    getProcedureLogs({ PatNum, AptNum, ProcDate, ProcStatus, PlannedAptNum, ClinicNum, CodeNum, DateTStamp, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetProcedureLogParams): Promise<ProcedureLog[]>;
     /**
      * Create a new procedure log entry.
      * @param {Object} data - The details of the procedure log to create.
@@ -148,7 +151,7 @@ export default class ProcedureLogs {
      * @returns {Promise<InsuranceHistory[]>} - The insurance history details.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
-    getInsuranceHistory({ PatNum, InsSubNum, }: getInsuranceHistoryParams): Promise<InsuranceHistory[]>;
+    getInsuranceHistory({ PatNum, InsSubNum, Limit, DateFormatString, DateTimeFormatString, }: getInsuranceHistoryParams): Promise<InsuranceHistory[]>;
     /**
      * Add an insurance history entry.
      * @param {Object} data - the insurance history object to create.