@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/labTurnarounds.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class LabTurnarounds {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single lab turnaround record by primary key.
+     * @param {number} LabTurnaroundNum - Required. Primary key of the lab turnaround record.
+     * @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<LabTurnaround>} - The lab turnaround record.
+     * @throws {Error} - If LabTurnaroundNum is not a valid number.
+     * @see https://www.opendental.com/site/apilabturnarounds.html
+     */
+    async getLabTurnaround(LabTurnaroundNum) {
+        if (!LabTurnaroundNum || typeof LabTurnaroundNum !== "number") {
+            throw new Error("Invalid parameter: A valid LabTurnaroundNum is required.");
+        }
+        return this.httpClient.get(`/labturnarounds/${LabTurnaroundNum}`);
+    }
+    /**
+     * Retrieves multiple lab turnaround records, optionally filtered by laboratory.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.LaboratoryNum] - Optional. FK to laboratory.LaboratoryNum; filters to a single lab.
+     * @returns {Promise<LabTurnaround[]>} - Array of lab turnaround records.
+     * @see https://www.opendental.com/site/apilabturnarounds.html
+     */
+    async getLabTurnarounds(params) {
+        return this.httpClient.get("/labturnarounds", params);
+    }
+    /**
+     * Creates a new lab turnaround record for a laboratory.
+     * @param {Object} data - The details of the lab turnaround to create.
+     * @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum.
+     * @param {string} data.Description - Required. Description of the service the lab is performing.
+     * @param {number} data.DaysActual - Required. Actual turnaround days including travel; used for due-date calculations.
+     * @param {number} [data.DaysPublished] - Optional. Days the lab publishes as turnaround time.
+     * @returns {Promise<LabTurnaround>} - The created lab turnaround record with assigned LabTurnaroundNum.
+     * @throws {Error} - If LaboratoryNum is not a valid number, Description is missing, or DaysActual is not provided.
+     * @see https://www.opendental.com/site/apilabturnarounds.html
+     */
+    async createLabTurnaround(data) {
+        if (!data.LaboratoryNum || typeof data.LaboratoryNum !== "number") {
+            throw new Error("Invalid parameter: A valid LaboratoryNum is required.");
+        }
+        if (!data.Description) {
+            throw new Error("Invalid parameter: Description is required.");
+        }
+        if (data.DaysActual === undefined || data.DaysActual === null || typeof data.DaysActual !== "number") {
+            throw new Error("Invalid parameter: DaysActual is required.");
+        }
+        return this.httpClient.post("/labturnarounds", data);
+    }
+    /**
+     * Updates an existing lab turnaround record. All body fields are optional.
+     * LaboratoryNum cannot be changed; to reassign to a different lab, delete and recreate.
+     * @param {Object} data - The details of the lab turnaround to update.
+     * @param {number} data.LabTurnaroundNum - Required. Primary key of the record to update.
+     * @param {string} [data.Description] - Optional. Service description; overwrites existing value.
+     * @param {number} [data.DaysPublished] - Optional. Published turnaround days.
+     * @param {number} [data.DaysActual] - Optional. Actual turnaround days including travel; used for due-date calculations.
+     * @returns {Promise<LabTurnaround>} - The updated lab turnaround record.
+     * @throws {Error} - If LabTurnaroundNum is not a valid number.
+     * @see https://www.opendental.com/site/apilabturnarounds.html
+     */
+    async updateLabTurnaround(data) {
+        if (!data.LabTurnaroundNum || typeof data.LabTurnaroundNum !== "number") {
+            throw new Error("Invalid parameter: A valid LabTurnaroundNum is required.");
+        }
+        const { LabTurnaroundNum, ...body } = data;
+        return this.httpClient.put(`/labturnarounds/${LabTurnaroundNum}`, body);
+    }
+}
+exports.default = LabTurnarounds;

package/dist/api/laboratories.d.ts

@@ -0,0 +1,71 @@
+import HttpClient from "../utils/httpClient";
+import { Laboratory, CreateLaboratoryParams, UpdateLaboratoryParams } from "../types/laboratoryTypes";
+export default class Laboratories {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single laboratory record by primary key.
+     * @param {number} LaboratoryNum - Required. Primary key of the laboratory.
+     * @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<Laboratory>} - The laboratory record.
+     * @throws {Error} - If LaboratoryNum is not a valid number.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    getLaboratory(LaboratoryNum: number): Promise<Laboratory>;
+    /**
+     * Retrieves all laboratory records as an array.
+     * @returns {Promise<Laboratory[]>} - Array of all laboratory records.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    getLaboratories({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<Laboratory[]>;
+    /**
+     * Creates a new laboratory record.
+     * @param {Object} data - The details of the laboratory to create.
+     * @param {string} data.Description - Required. Laboratory name.
+     * @param {string} [data.Phone] - Optional. Contact phone number.
+     * @param {string} [data.Notes] - Optional. Additional notes.
+     * @param {number} [data.Slip] - Optional. FK to sheetdef.SheetDefNum; default 0 (uses default internal lab slip).
+     * @param {string} [data.Address] - Optional. Street address.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. State/province code.
+     * @param {string} [data.Zip] - Optional. Postal code; US formats: 12345, 12345-1234, 123456789; Canada: A0A 0A0.
+     * @param {string} [data.Email] - Optional. Email address.
+     * @param {string} [data.WirelessPhone] - Optional. Additional phone number.
+     * @param {string} [data.IsHidden] - Optional. "true" to mark inactive; default "false".
+     * @returns {Promise<Laboratory>} - The created laboratory record with assigned LaboratoryNum.
+     * @throws {Error} - If Description is missing.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    createLaboratory(data: CreateLaboratoryParams): Promise<Laboratory>;
+    /**
+     * Updates an existing laboratory record. All body fields are optional.
+     * Notes field overwrites the entire existing value; GET first if appending is desired.
+     * @param {Object} data - The details of the laboratory to update.
+     * @param {number} data.LaboratoryNum - Required. Primary key of the laboratory to update.
+     * @param {string} [data.Description] - Optional. Laboratory name.
+     * @param {string} [data.Phone] - Optional. Contact phone number.
+     * @param {string} [data.Notes] - Optional. Additional notes; overwrites existing notes entirely.
+     * @param {number} [data.Slip] - Optional. FK to sheetdef.SheetDefNum.
+     * @param {string} [data.Address] - Optional. Street address.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. State/province code.
+     * @param {string} [data.Zip] - Optional. Postal code.
+     * @param {string} [data.Email] - Optional. Email address.
+     * @param {string} [data.WirelessPhone] - Optional. Additional phone number.
+     * @param {string} [data.IsHidden] - Optional. "true" to mark inactive.
+     * @returns {Promise<Laboratory>} - The updated laboratory record.
+     * @throws {Error} - If LaboratoryNum is not a valid number.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    updateLaboratory(data: UpdateLaboratoryParams): Promise<Laboratory>;
+}
+//# sourceMappingURL=laboratories.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"laboratories.d.ts","sourceRoot":"","sources":["../../src/api/laboratories.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQtE;;;;OAIG;IACU,eAAe,CAAC,EAC3B,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,UAAU,EAAE,CAAC;IAS9B;;;;;;;;;;;;;;;;;OAiBG;IACU,gBAAgB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAQhF;;;;;;;;;;;;;;;;;;;OAmBG;IACU,gBAAgB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;CAQjF"}

package/dist/api/laboratories.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Laboratories {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single laboratory record by primary key.
+     * @param {number} LaboratoryNum - Required. Primary key of the laboratory.
+     * @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<Laboratory>} - The laboratory record.
+     * @throws {Error} - If LaboratoryNum is not a valid number.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    async getLaboratory(LaboratoryNum) {
+        if (!LaboratoryNum || typeof LaboratoryNum !== "number") {
+            throw new Error("Invalid parameter: A valid LaboratoryNum is required.");
+        }
+        return this.httpClient.get(`/laboratories/${LaboratoryNum}`);
+    }
+    /**
+     * Retrieves all laboratory records as an array.
+     * @returns {Promise<Laboratory[]>} - Array of all laboratory records.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    async getLaboratories({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/laboratories", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a new laboratory record.
+     * @param {Object} data - The details of the laboratory to create.
+     * @param {string} data.Description - Required. Laboratory name.
+     * @param {string} [data.Phone] - Optional. Contact phone number.
+     * @param {string} [data.Notes] - Optional. Additional notes.
+     * @param {number} [data.Slip] - Optional. FK to sheetdef.SheetDefNum; default 0 (uses default internal lab slip).
+     * @param {string} [data.Address] - Optional. Street address.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. State/province code.
+     * @param {string} [data.Zip] - Optional. Postal code; US formats: 12345, 12345-1234, 123456789; Canada: A0A 0A0.
+     * @param {string} [data.Email] - Optional. Email address.
+     * @param {string} [data.WirelessPhone] - Optional. Additional phone number.
+     * @param {string} [data.IsHidden] - Optional. "true" to mark inactive; default "false".
+     * @returns {Promise<Laboratory>} - The created laboratory record with assigned LaboratoryNum.
+     * @throws {Error} - If Description is missing.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    async createLaboratory(data) {
+        if (!data.Description) {
+            throw new Error("Invalid parameter: Description is required.");
+        }
+        return this.httpClient.post("/laboratories", data);
+    }
+    /**
+     * Updates an existing laboratory record. All body fields are optional.
+     * Notes field overwrites the entire existing value; GET first if appending is desired.
+     * @param {Object} data - The details of the laboratory to update.
+     * @param {number} data.LaboratoryNum - Required. Primary key of the laboratory to update.
+     * @param {string} [data.Description] - Optional. Laboratory name.
+     * @param {string} [data.Phone] - Optional. Contact phone number.
+     * @param {string} [data.Notes] - Optional. Additional notes; overwrites existing notes entirely.
+     * @param {number} [data.Slip] - Optional. FK to sheetdef.SheetDefNum.
+     * @param {string} [data.Address] - Optional. Street address.
+     * @param {string} [data.City] - Optional. City.
+     * @param {string} [data.State] - Optional. State/province code.
+     * @param {string} [data.Zip] - Optional. Postal code.
+     * @param {string} [data.Email] - Optional. Email address.
+     * @param {string} [data.WirelessPhone] - Optional. Additional phone number.
+     * @param {string} [data.IsHidden] - Optional. "true" to mark inactive.
+     * @returns {Promise<Laboratory>} - The updated laboratory record.
+     * @throws {Error} - If LaboratoryNum is not a valid number.
+     * @see https://www.opendental.com/site/apilaboratories.html
+     */
+    async updateLaboratory(data) {
+        if (!data.LaboratoryNum || typeof data.LaboratoryNum !== "number") {
+            throw new Error("Invalid parameter: A valid LaboratoryNum is required.");
+        }
+        const { LaboratoryNum, ...body } = data;
+        return this.httpClient.put(`/laboratories/${LaboratoryNum}`, body);
+    }
+}
+exports.default = Laboratories;

package/dist/api/medicationPats.d.ts

@@ -7,10 +7,13 @@ export default class MedicationPats {
      * Fetch patient's medications with optional pagination.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} params.PatNum - Required. Filter by patient.
-     * @param {number} [params.Offset] - pagination.
+     * @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<MedicationPat>} - A list of a patient's medications.
      */
-    getMedicationPats({ PatNum, Offset, }: GetMedicationPatsParams): Promise<MedicationPat[]>;
+    getMedicationPats({ PatNum, Offset, Limit, DateFormatString, DateTimeFormatString, }: GetMedicationPatsParams): Promise<MedicationPat[]>;
     /**
      * Add a medication to a patient.
      * @param {Object} data - The details of MedicationPat to add.

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

@@ -1 +1 @@
-{"version":3,"file":"medicationPats.d.ts","sourceRoot":"","sources":["../../src/api/medicationPats.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,iBAAiB,CAAC,EAC7B,MAAM,EACN,MAAM,GACP,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAcrD;;;;;;;;;;;;OAYG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,aAAa,EACb,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAG,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;IAgBnD;;;;;;;;;OASG;IACU,mBAAmB,CAAC,EAC/B,gBAAgB,EAChB,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAcrD;;;;;OAKG;IACU,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}
+{"version":3,"file":"medicationPats.d.ts","sourceRoot":"","sources":["../../src/api/medicationPats.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,iBAAiB,CAAC,EAC7B,MAAM,EACN,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAkBnD;;;;;;;;;;;;OAYG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,aAAa,EACb,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAG,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;IAgBnD;;;;;;;;;OASG;IACU,mBAAmB,CAAC,EAC/B,gBAAgB,EAChB,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAcrD;;;;;OAKG;IACU,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}

package/dist/api/medicationPats.js

@@ -9,16 +9,22 @@ class MedicationPats {
      * Fetch patient's medications with optional pagination.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} params.PatNum - Required. Filter by patient.
-     * @param {number} [params.Offset] - pagination.
+     * @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<MedicationPat>} - A list of a patient's medications.
      */
-    async getMedicationPats({ PatNum, Offset, }) {
+    async getMedicationPats({ PatNum, Offset, Limit, DateFormatString, DateTimeFormatString, }) {
         if (!PatNum || typeof PatNum !== "number") {
-            throw new Error("PatNum is required to fetch medicationpats.");
+            throw new Error("Invalid parameter: PatNum is required.");
         }
         const params = {
             PatNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/medicationpats", params);
     }
@@ -37,7 +43,7 @@ class MedicationPats {
      */
     async addMedicationPat({ PatNum, medName, MedicationNum, PatNote, DateStart, DateStop, ProvNum, }) {
         if (!PatNum || (!medName && !MedicationNum)) {
-            throw new Error("Invalid data: PatNum and either medName or MedicationNum are required.");
+            throw new Error("Invalid parameter: PatNum and either medName or MedicationNum are required.");
         }
         return this.httpClient.post("/medicationpats", {
             PatNum,
@@ -61,7 +67,7 @@ class MedicationPats {
      */
     async updateMedicationPat({ MedicationPatNum, PatNote, DateStart, DateStop, ProvNum, }) {
         if (!MedicationPatNum || typeof MedicationPatNum !== "number") {
-            throw new Error("Invalid data: MedicationPatNum is required.");
+            throw new Error("Invalid parameter: MedicationPatNum is required.");
         }
         return this.httpClient.put(`/medicationpats/${MedicationPatNum}`, {
             MedicationPatNum,

package/dist/api/medications.d.ts

@@ -0,0 +1,37 @@
+import HttpClient from "../utils/httpClient";
+import { MedicationItem, CreateMedicationParams } from "../types/medicationTypes";
+export default class Medications {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves the list of all available medication definitions.
+     * Note: This resource is rarely used directly. The recommended workflow is to use
+     * MedicationPats GET and POST for patient medication management.
+     * @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<MedicationItem[]>} - Array of medication definition records.
+     * @see https://www.opendental.com/site/apimedications.html
+     */
+    getMedications({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<MedicationItem[]>;
+    /**
+     * Creates a new medication definition record.
+     * @param {CreateMedicationParams} data - Medication creation parameters.
+     * @param {string} data.MedName - Required. string. The medication name.
+     * @param {string} [data.genericName] - Optional. string. Generic name; defaults to MedName if omitted.
+     *   Returns 404 if provided but does not match an existing medication record.
+     * @param {string} [data.Notes] - Optional. string. Supplementary information about the medication.
+     * @returns {Promise<MedicationItem>} - The newly created medication record.
+     * @throws {Error} - If MedName is not provided.
+     * @see https://www.opendental.com/site/apimedications.html
+     */
+    createMedication(data: CreateMedicationParams): Promise<MedicationItem>;
+}
+//# sourceMappingURL=medications.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"medications.d.ts","sourceRoot":"","sources":["../../src/api/medications.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElF,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,cAAc,CAAC,EAC1B,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,cAAc,EAAE,CAAC;IASlC;;;;;;;;;;OAUG;IACU,gBAAgB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;CAOrF"}

package/dist/api/medications.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Medications {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves the list of all available medication definitions.
+     * Note: This resource is rarely used directly. The recommended workflow is to use
+     * MedicationPats GET and POST for patient medication management.
+     * @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<MedicationItem[]>} - Array of medication definition records.
+     * @see https://www.opendental.com/site/apimedications.html
+     */
+    async getMedications({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/medications", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a new medication definition record.
+     * @param {CreateMedicationParams} data - Medication creation parameters.
+     * @param {string} data.MedName - Required. string. The medication name.
+     * @param {string} [data.genericName] - Optional. string. Generic name; defaults to MedName if omitted.
+     *   Returns 404 if provided but does not match an existing medication record.
+     * @param {string} [data.Notes] - Optional. string. Supplementary information about the medication.
+     * @returns {Promise<MedicationItem>} - The newly created medication record.
+     * @throws {Error} - If MedName is not provided.
+     * @see https://www.opendental.com/site/apimedications.html
+     */
+    async createMedication(data) {
+        if (!data.MedName) {
+            throw new Error("Invalid parameter: MedName is required.");
+        }
+        return this.httpClient.post("/medications", data);
+    }
+}
+exports.default = Medications;

package/dist/api/operatories.d.ts

@@ -8,16 +8,17 @@ export default class Operatories {
      * @param {number} OperatoryNum - The ID of the operatory.
      * @returns {Promise<Operatory>} - The operatory data.
      * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
+     * @see https://www.opendental.com/site/apioperatories.html
      */
     getOperatory(OperatoryNum: number): Promise<Operatory>;
     /**
      * Fetch multiple operatories with optional filtering and pagination.
      * @param {Object} params - Filtering and pagination parameters.
-     * @param {string} [params.ClinicNum] - Filter by clinicnum
-     * @param {string} [params.Offset] - Filter by clinicnum
+     * @param {number} [params.ClinicNum] - Filter by clinic number.
+     * @param {number} [params.Offset] - Pagination offset for results.
     * @returns {Promise<Operatory[]>} - A list of operatories.
      * @throws {Error} - If the API returns an error.
      */
-    getOperatories({ ClinicNum, Offset, }?: GetOperatoriesParams): Promise<Operatory[]>;
+    getOperatories({ ClinicNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetOperatoriesParams): Promise<Operatory[]>;
 }
 //# sourceMappingURL=operatories.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"operatories.d.ts","sourceRoot":"","sources":["../../src/api/operatories.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,SAAS,EACT,oBAAoB,EACvB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQnE;;;;;;;OAOG;IACY,cAAc,CAAC,EAC1B,SAAS,EACT,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAOtD"}
+{"version":3,"file":"operatories.d.ts","sourceRoot":"","sources":["../../src/api/operatories.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,SAAS,EACT,oBAAoB,EACvB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQnE;;;;;;;OAOG;IACY,cAAc,CAAC,EAC1B,SAAS,EACT,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACzB,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAWlD"}

package/dist/api/operatories.js

@@ -10,25 +10,29 @@ class Operatories {
      * @param {number} OperatoryNum - The ID of the operatory.
      * @returns {Promise<Operatory>} - The operatory data.
      * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
+     * @see https://www.opendental.com/site/apioperatories.html
      */
     async getOperatory(OperatoryNum) {
         if (!OperatoryNum || typeof OperatoryNum !== "number") {
-            throw new Error("Invalid parameter: PatNum must be a valid number.");
+            throw new Error("Invalid parameter: OperatoryNum must be a valid number.");
         }
         return await this.httpClient.get(`/operatories/${OperatoryNum}`);
     }
     /**
      * Fetch multiple operatories with optional filtering and pagination.
      * @param {Object} params - Filtering and pagination parameters.
-     * @param {string} [params.ClinicNum] - Filter by clinicnum
-     * @param {string} [params.Offset] - Filter by clinicnum
+     * @param {number} [params.ClinicNum] - Filter by clinic number.
+     * @param {number} [params.Offset] - Pagination offset for results.
     * @returns {Promise<Operatory[]>} - A list of operatories.
      * @throws {Error} - If the API returns an error.
      */
-    async getOperatories({ ClinicNum, Offset, } = {}) {
+    async getOperatories({ ClinicNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         return await this.httpClient.get("/operatories", {
             ClinicNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         });
     }
 }

package/dist/api/patFieldDefs.d.ts

@@ -0,0 +1,57 @@
+import HttpClient from "../utils/httpClient";
+import { PatFieldDefItem, CreatePatFieldDefParams, UpdatePatFieldDefParams } from "../types/patFieldDefTypes";
+export default class PatFieldDefs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a list of all patient field definitions.
+     * @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<PatFieldDefItem[]>} - Array of patient field definition records.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    getPatFieldDefs({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<PatFieldDefItem[]>;
+    /**
+     * Creates a new patient field definition.
+     * @param {CreatePatFieldDefParams} data - Patient field definition creation parameters.
+     * @param {string} data.FieldName - Required. string. Must be unique across all PatFieldDefs.
+     * @param {"Text"|"PickList"|"Date"|"Checkbox"|"Currency"|"CareCreditStatus"|"CareCreditPreApprovalAmt"|"CareCreditAvailableCredit"} data.FieldType - Required. enum. Field type.
+     * @param {string} [data.PickList] - Conditional. string. Required when FieldType is "PickList". Items separated by \r\n.
+     * @param {string} [data.IsHidden] - Optional. string. "true" or "false"; default "false".
+     * @returns {Promise<PatFieldDefItem>} - The newly created patient field definition record.
+     * @throws {Error} - If required fields are missing or PickList is absent for PickList type.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    createPatFieldDef(data: CreatePatFieldDefParams): Promise<PatFieldDefItem>;
+    /**
+     * Updates an existing patient field definition.
+     * @param {UpdatePatFieldDefParams} data - Patient field definition update parameters.
+     * @param {number} data.PatFieldDefNum - Required. integer. Patient field definition primary key (PK).
+     * @param {string} [data.FieldName] - Optional. string. Must remain unique; cannot change for in-use CareCredit fields.
+     * @param {"Text"|"PickList"|"Date"|"Checkbox"|"Currency"|"CareCreditStatus"|"CareCreditPreApprovalAmt"|"CareCreditAvailableCredit"} [data.FieldType] - Optional. enum.
+     * @param {string} [data.PickList] - Optional. string. Only allowed when converting FieldType to "PickList" from another type. Items separated by \r\n. Cannot edit existing PickList items (v24.1+).
+     * @param {string} [data.IsHidden] - Optional. string. "true" or "false".
+     * @returns {Promise<PatFieldDefItem>} - The updated patient field definition record.
+     * @throws {Error} - If PatFieldDefNum is not provided.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    updatePatFieldDef(data: UpdatePatFieldDefParams): Promise<PatFieldDefItem>;
+    /**
+     * Removes a patient field definition.
+     * Cannot delete definitions that are currently in use by any patient.
+     * @param {number} PatFieldDefNum - Required. integer. Patient field definition primary key (PK).
+     * @returns {Promise<void>} - Resolves when the definition is deleted.
+     * @throws {Error} - If PatFieldDefNum is not a valid number.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    deletePatFieldDef(PatFieldDefNum: number): Promise<void>;
+}
+//# sourceMappingURL=patFieldDefs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"patFieldDefs.d.ts","sourceRoot":"","sources":["../../src/api/patFieldDefs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,eAAe,CAAC,EAC3B,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,eAAe,EAAE,CAAC;IASnC;;;;;;;;;;OAUG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,eAAe,CAAC;IAcvF;;;;;;;;;;;OAWG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,eAAe,CAAC;IASvF;;;;;;;OAOG;IACU,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOtE"}

package/dist/api/patFieldDefs.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PatFieldDefs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a list of all patient field definitions.
+     * @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<PatFieldDefItem[]>} - Array of patient field definition records.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    async getPatFieldDefs({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/patfielddefs", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a new patient field definition.
+     * @param {CreatePatFieldDefParams} data - Patient field definition creation parameters.
+     * @param {string} data.FieldName - Required. string. Must be unique across all PatFieldDefs.
+     * @param {"Text"|"PickList"|"Date"|"Checkbox"|"Currency"|"CareCreditStatus"|"CareCreditPreApprovalAmt"|"CareCreditAvailableCredit"} data.FieldType - Required. enum. Field type.
+     * @param {string} [data.PickList] - Conditional. string. Required when FieldType is "PickList". Items separated by \r\n.
+     * @param {string} [data.IsHidden] - Optional. string. "true" or "false"; default "false".
+     * @returns {Promise<PatFieldDefItem>} - The newly created patient field definition record.
+     * @throws {Error} - If required fields are missing or PickList is absent for PickList type.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    async createPatFieldDef(data) {
+        if (!data.FieldName) {
+            throw new Error("Invalid parameter: FieldName is required.");
+        }
+        if (!data.FieldType) {
+            throw new Error("Invalid parameter: FieldType is required.");
+        }
+        if (data.FieldType === "PickList" && !data.PickList) {
+            throw new Error("Invalid parameter: PickList is required when FieldType is 'PickList'.");
+        }
+        return this.httpClient.post("/patfielddefs", data);
+    }
+    /**
+     * Updates an existing patient field definition.
+     * @param {UpdatePatFieldDefParams} data - Patient field definition update parameters.
+     * @param {number} data.PatFieldDefNum - Required. integer. Patient field definition primary key (PK).
+     * @param {string} [data.FieldName] - Optional. string. Must remain unique; cannot change for in-use CareCredit fields.
+     * @param {"Text"|"PickList"|"Date"|"Checkbox"|"Currency"|"CareCreditStatus"|"CareCreditPreApprovalAmt"|"CareCreditAvailableCredit"} [data.FieldType] - Optional. enum.
+     * @param {string} [data.PickList] - Optional. string. Only allowed when converting FieldType to "PickList" from another type. Items separated by \r\n. Cannot edit existing PickList items (v24.1+).
+     * @param {string} [data.IsHidden] - Optional. string. "true" or "false".
+     * @returns {Promise<PatFieldDefItem>} - The updated patient field definition record.
+     * @throws {Error} - If PatFieldDefNum is not provided.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    async updatePatFieldDef(data) {
+        if (!data.PatFieldDefNum || typeof data.PatFieldDefNum !== "number") {
+            throw new Error("Invalid parameter: PatFieldDefNum is required.");
+        }
+        const { PatFieldDefNum, ...body } = data;
+        return this.httpClient.put(`/patfielddefs/${PatFieldDefNum}`, body);
+    }
+    /**
+     * Removes a patient field definition.
+     * Cannot delete definitions that are currently in use by any patient.
+     * @param {number} PatFieldDefNum - Required. integer. Patient field definition primary key (PK).
+     * @returns {Promise<void>} - Resolves when the definition is deleted.
+     * @throws {Error} - If PatFieldDefNum is not a valid number.
+     * @see https://www.opendental.com/site/apipatfielddefs.html
+     */
+    async deletePatFieldDef(PatFieldDefNum) {
+        if (!PatFieldDefNum || typeof PatFieldDefNum !== "number") {
+            throw new Error("Invalid parameter: PatFieldDefNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/patfielddefs/${PatFieldDefNum}`);
+    }
+}
+exports.default = PatFieldDefs;