@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/claims.js

@@ -13,6 +13,10 @@ class Claims {
      * Fetch multiple claims with optional filtering.
      * Mirrors GET /claims
      * @see https://www.opendental.com/site/apiclaims.html
+     * @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.
      */
     async getClaims(params = {}) {
         const query = clean({
@@ -49,22 +53,22 @@ class Claims {
     async createClaim(data) {
         // Base validation common to all claim types
         if (!data || typeof data !== "object") {
-            throw new Error("Invalid payload: createClaim requires a request body.");
+            throw new Error("Invalid parameter: createClaim requires a request body.");
         }
         if (!data.PatNum || typeof data.PatNum !== "number") {
-            throw new Error("Invalid payload: PatNum is required and must be a number.");
+            throw new Error("Invalid parameter: PatNum is required and must be a number.");
         }
         if (!Array.isArray(data.procNums) || data.procNums.length === 0) {
-            throw new Error("Invalid payload: procNums must be a non-empty number array.");
+            throw new Error("Invalid parameter: procNums must be a non-empty number array.");
         }
         if (!("ClaimType" in data)) {
-            throw new Error("Invalid payload: ClaimType is required.");
+            throw new Error("Invalid parameter: ClaimType is required.");
         }
         // Type-specific validation
         if (data.ClaimType === "PreAuth" || data.ClaimType === "Other") {
             const requires = data.InsSubNum && data.PatRelat;
             if (!requires) {
-                throw new Error(`Invalid payload: InsSubNum and PatRelat are required when ClaimType is "${data.ClaimType}".`);
+                throw new Error(`Invalid parameter: InsSubNum and PatRelat are required when ClaimType is "${data.ClaimType}".`);
             }
             // Optional small guard to keep PatRelat within the documented domain
             const patRel = data.PatRelat;
@@ -89,7 +93,7 @@ class Claims {
      */
     async updateClaim(data) {
         if (!data?.ClaimNum || typeof data.ClaimNum !== "number") {
-            throw new Error("Invalid payload: ClaimNum is required and must be a number.");
+            throw new Error("Invalid parameter: ClaimNum is required and must be a number.");
         }
         const { ClaimNum, ClaimStatus, DateSent, DateReceived, ProvTreat, IsProsthesis, PriorDate, ClaimNote, ReasonUnderPaid, ProvBill, PlaceService, AccidentRelated, AccidentDate, AccidentST, IsOrtho, OrthoRemainM, OrthoDate, PatRelat, PatRelat2, ClaimForm, InsSubNum2, PriorAuthorizationNumber, MedType, OrthoTotalM, } = data;
         const payload = clean({
@@ -119,5 +123,55 @@ class Claims {
         });
         return this.httpClient.put(`/claims/${ClaimNum}`, payload);
     }
+    /**
+     * Update the status of a Claim.
+     * Mirrors PUT /claims/{ClaimNum}/Status
+     * @param {number} ClaimNum - Required. Primary key.
+     * @param {"U" | "H" | "W" | "P" | "S" | "R"} ClaimStatus - Required. New status code.
+     * @returns {Promise<Claim>} - The updated claim.
+     * @throws {Error} - If ClaimNum or ClaimStatus are missing.
+     * @see https://www.opendental.com/site/apiclaims.html
+     */
+    async updateClaimStatus(ClaimNum, ClaimStatus) {
+        if (!ClaimNum || typeof ClaimNum !== "number") {
+            throw new Error("Invalid parameter: ClaimNum must be a valid number.");
+        }
+        if (!ClaimStatus) {
+            throw new Error("Invalid parameter: ClaimStatus is required.");
+        }
+        return this.httpClient.put(`/claims/${ClaimNum}/Status`, { ClaimStatus });
+    }
+    /**
+     * Split a claim — moves selected procedures to a new claim.
+     * Mirrors PUT /claims/{ClaimNum}/Split
+     * @param {number} ClaimNum - Required. Primary key of claim to split.
+     * @param {number[]} procNums - Required. Non-empty array of ProcNums to move to the new claim.
+     * @returns {Promise<Claim>} - The newly created split claim.
+     * @throws {Error} - If ClaimNum or procNums are invalid.
+     * @see https://www.opendental.com/site/apiclaims.html
+     */
+    async splitClaim(ClaimNum, procNums) {
+        if (!ClaimNum || typeof ClaimNum !== "number") {
+            throw new Error("Invalid parameter: ClaimNum must be a valid number.");
+        }
+        if (!Array.isArray(procNums) || procNums.length === 0) {
+            throw new Error("Invalid parameter: procNums must be a non-empty array.");
+        }
+        return this.httpClient.put(`/claims/${ClaimNum}/Split`, { ProcNums: procNums });
+    }
+    /**
+     * Delete a Claim record.
+     * Mirrors DELETE /claims/{ClaimNum}
+     * @param {number} ClaimNum - Required. Primary key.
+     * @returns {Promise<void>} - Resolves on success.
+     * @throws {Error} - If ClaimNum is not valid.
+     * @see https://www.opendental.com/site/apiclaims.html
+     */
+    async deleteClaim(ClaimNum) {
+        if (!ClaimNum || typeof ClaimNum !== "number") {
+            throw new Error("Invalid parameter: ClaimNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/claims/${ClaimNum}`);
+    }
 }
 exports.default = Claims;

package/dist/api/clinics.d.ts

@@ -0,0 +1,47 @@
+import HttpClient from "../utils/httpClient";
+import { ClinicItem, UpdateClinicParams } from "../types/clinicTypes";
+export default class Clinics {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch all non-hidden clinics.
+     * Returns an empty list if the dental office does not utilize the Clinics feature (not an error).
+     * @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<ClinicItem[]>}
+     * @see https://www.opendental.com/site/apiclinics.html
+     */
+    getClinics({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<ClinicItem[]>;
+    /**
+     * Update general contact and billing information for a clinic.
+     * @param {Object} data
+     * @param {number} data.ClinicNum - Required. Clinic identifier (primary key).
+     * @param {string} [data.Description] - Optional. Clinic name appearing on statements and letters.
+     * @param {string} [data.Phone] - Optional. Exactly 10 digits; no punctuation.
+     * @param {string} [data.BillingAddress] - Optional. Billing address used on claims if different from physical treating address.
+     * @param {string} [data.BillingAddress2] - Optional. Secondary billing address line.
+     * @param {string} [data.BillingCity] - Optional. Billing city.
+     * @param {string} [data.BillingState] - Optional. Billing state.
+     * @param {string} [data.BillingZip] - Optional. Billing postal code.
+     * @param {string} [data.PayToAddress] - Optional. Address where insurance payments will go; accepts PO Box.
+     * @param {string} [data.PayToAddress2] - Optional. Secondary payment address line.
+     * @param {string} [data.PayToCity] - Optional. Payment city.
+     * @param {string} [data.PayToState] - Optional. Payment state.
+     * @param {string} [data.PayToZip] - Optional. Payment postal code.
+     * @param {string} [data.Abbr] - Optional. Abbreviation for the clinic description; displayed in dropdowns and pick lists.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false"; cannot hide a clinic that has attached patients.
+     * @returns {Promise<ClinicItem>}
+     * @throws {Error} - If ClinicNum is not provided.
+     * @see https://www.opendental.com/site/apiclinics.html
+     */
+    updateClinic({ ClinicNum, Description, Phone, BillingAddress, BillingAddress2, BillingCity, BillingState, BillingZip, PayToAddress, PayToAddress2, PayToCity, PayToState, PayToZip, Abbr, IsHidden, }: UpdateClinicParams): Promise<ClinicItem>;
+}
+//# sourceMappingURL=clinics.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clinics.d.ts","sourceRoot":"","sources":["../../src/api/clinics.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,UAAU,CAAC,EACtB,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;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,YAAY,CAAC,EACxB,SAAS,EACT,WAAW,EACX,KAAK,EACL,cAAc,EACd,eAAe,EACf,WAAW,EACX,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,EACb,SAAS,EACT,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,QAAQ,GACT,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;CAmB5C"}

package/dist/api/clinics.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Clinics {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch all non-hidden clinics.
+     * Returns an empty list if the dental office does not utilize the Clinics feature (not an error).
+     * @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<ClinicItem[]>}
+     * @see https://www.opendental.com/site/apiclinics.html
+     */
+    async getClinics({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/clinics", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Update general contact and billing information for a clinic.
+     * @param {Object} data
+     * @param {number} data.ClinicNum - Required. Clinic identifier (primary key).
+     * @param {string} [data.Description] - Optional. Clinic name appearing on statements and letters.
+     * @param {string} [data.Phone] - Optional. Exactly 10 digits; no punctuation.
+     * @param {string} [data.BillingAddress] - Optional. Billing address used on claims if different from physical treating address.
+     * @param {string} [data.BillingAddress2] - Optional. Secondary billing address line.
+     * @param {string} [data.BillingCity] - Optional. Billing city.
+     * @param {string} [data.BillingState] - Optional. Billing state.
+     * @param {string} [data.BillingZip] - Optional. Billing postal code.
+     * @param {string} [data.PayToAddress] - Optional. Address where insurance payments will go; accepts PO Box.
+     * @param {string} [data.PayToAddress2] - Optional. Secondary payment address line.
+     * @param {string} [data.PayToCity] - Optional. Payment city.
+     * @param {string} [data.PayToState] - Optional. Payment state.
+     * @param {string} [data.PayToZip] - Optional. Payment postal code.
+     * @param {string} [data.Abbr] - Optional. Abbreviation for the clinic description; displayed in dropdowns and pick lists.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false"; cannot hide a clinic that has attached patients.
+     * @returns {Promise<ClinicItem>}
+     * @throws {Error} - If ClinicNum is not provided.
+     * @see https://www.opendental.com/site/apiclinics.html
+     */
+    async updateClinic({ ClinicNum, Description, Phone, BillingAddress, BillingAddress2, BillingCity, BillingState, BillingZip, PayToAddress, PayToAddress2, PayToCity, PayToState, PayToZip, Abbr, IsHidden, }) {
+        if (!ClinicNum)
+            throw new Error("Invalid parameter: ClinicNum is required.");
+        return this.httpClient.put(`/clinics/${ClinicNum}`, {
+            Description,
+            Phone,
+            BillingAddress,
+            BillingAddress2,
+            BillingCity,
+            BillingState,
+            BillingZip,
+            PayToAddress,
+            PayToAddress2,
+            PayToCity,
+            PayToState,
+            PayToZip,
+            Abbr,
+            IsHidden,
+        });
+    }
+}
+exports.default = Clinics;

package/dist/api/clockEvents.d.ts

@@ -0,0 +1,33 @@
+import HttpClient from "../utils/httpClient";
+import { ClockEvent, GetClockEventsParams } from "../types/clockEventTypes";
+export default class ClockEvents {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single clock event record by its unique identifier.
+     * @param {number} ClockEventNum - Required. Unique clock event 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<ClockEvent>} - The clock event record.
+     * @throws {Error} - If ClockEventNum is not a valid number.
+     * @see https://www.opendental.com/site/apiclockevents.html
+     */
+    getClockEvent(ClockEventNum: number): Promise<ClockEvent>;
+    /**
+     * Retrieves multiple clock event records with optional filtering.
+     * Date filters apply to TimeDisplayed1, not TimeEntered1.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.EmployeeNum] - Optional. FK to employee; filter by employee.
+     * @param {string} [params.ClockStatus] - Optional. Filter by status: "Home" | "Lunch" | "Break".
+     * @param {number} [params.ClinicNum] - Optional. FK to clinic; filter by clinic.
+     * @param {string} [params.date] - Optional. Single day filter (format: "yyyy-MM-dd"); based on TimeDisplayed1.
+     * @param {string} [params.dateStart] - Optional. Filter events on or after this date (format: "yyyy-MM-dd"); based on TimeDisplayed1.
+     * @param {string} [params.dateEnd] - Optional. Filter events before this date (format: "yyyy-MM-dd"); based on TimeDisplayed1.
+     * @returns {Promise<ClockEvent[]>} - Array of clock event records.
+     * @see https://www.opendental.com/site/apiclockevents.html
+     */
+    getClockEvents(params?: GetClockEventsParams): Promise<ClockEvent[]>;
+}
+//# sourceMappingURL=clockEvents.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clockEvents.d.ts","sourceRoot":"","sources":["../../src/api/clockEvents.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQtE;;;;;;;;;;;;OAYG;IACU,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAGlF"}

package/dist/api/clockEvents.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ClockEvents {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single clock event record by its unique identifier.
+     * @param {number} ClockEventNum - Required. Unique clock event 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<ClockEvent>} - The clock event record.
+     * @throws {Error} - If ClockEventNum is not a valid number.
+     * @see https://www.opendental.com/site/apiclockevents.html
+     */
+    async getClockEvent(ClockEventNum) {
+        if (!ClockEventNum || typeof ClockEventNum !== "number") {
+            throw new Error("Invalid parameter: A valid ClockEventNum is required.");
+        }
+        return this.httpClient.get(`/clockevents/${ClockEventNum}`);
+    }
+    /**
+     * Retrieves multiple clock event records with optional filtering.
+     * Date filters apply to TimeDisplayed1, not TimeEntered1.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.EmployeeNum] - Optional. FK to employee; filter by employee.
+     * @param {string} [params.ClockStatus] - Optional. Filter by status: "Home" | "Lunch" | "Break".
+     * @param {number} [params.ClinicNum] - Optional. FK to clinic; filter by clinic.
+     * @param {string} [params.date] - Optional. Single day filter (format: "yyyy-MM-dd"); based on TimeDisplayed1.
+     * @param {string} [params.dateStart] - Optional. Filter events on or after this date (format: "yyyy-MM-dd"); based on TimeDisplayed1.
+     * @param {string} [params.dateEnd] - Optional. Filter events before this date (format: "yyyy-MM-dd"); based on TimeDisplayed1.
+     * @returns {Promise<ClockEvent[]>} - Array of clock event records.
+     * @see https://www.opendental.com/site/apiclockevents.html
+     */
+    async getClockEvents(params) {
+        return this.httpClient.get("/clockevents", params);
+    }
+}
+exports.default = ClockEvents;

package/dist/api/codeGroups.d.ts

@@ -0,0 +1,64 @@
+import HttpClient from "../utils/httpClient";
+import { CodeGroup, CreateCodeGroupParams, UpdateCodeGroupParams } from "../types/codeGroupTypes";
+export default class CodeGroups {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single code group by its identifier.
+     * @param {number} CodeGroupNum - Required. Code group identifier.
+     * @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<CodeGroup>} - The code group record.
+     * @throws {Error} - If CodeGroupNum is not a valid number.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    getCodeGroup(CodeGroupNum: number): Promise<CodeGroup>;
+    /**
+     * Returns all code groups as an array.
+     * @returns {Promise<CodeGroup[]>} - Array of all code group records.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    getCodeGroups({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<CodeGroup[]>;
+    /**
+     * Creates a new code group.
+     * IsHidden cannot be "true" if any ShowIn* field is "true".
+     * @param {Object} data - The details of the code group to create.
+     * @param {string} data.GroupName - Required. Name of the code group.
+     * @param {string} [data.ProcCodes] - Optional. Comma-delimited procedure codes.
+     * @param {string} [data.CodeGroupFixed] - Optional. Fixed group type; default "None".
+     * @param {string} [data.IsHidden] - Optional. "true" or "false"; default "false". Cannot be "true" if any ShowIn* field is "true".
+     * @param {string} [data.ShowInAgeLimit] - Optional. "true" or "false"; default "false".
+     * @param {string} [data.ShowInFrequency] - Optional. "true" or "false"; default "false" (v25.3.10+).
+     * @param {string} [data.ShowInOther] - Optional. "true" or "false"; default "false" (v25.3.10+).
+     * @returns {Promise<CodeGroup>} - The created code group record.
+     * @throws {Error} - If GroupName is not provided.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    createCodeGroup(data: CreateCodeGroupParams): Promise<CodeGroup>;
+    /**
+     * Updates an existing code group.
+     * IsHidden cannot be "true" if any ShowIn* field is "true".
+     * @param {Object} data - The details of the code group to update.
+     * @param {number} data.CodeGroupNum - Required. Code group identifier.
+     * @param {string} [data.GroupName] - Optional. Name of the code group.
+     * @param {string} [data.ProcCodes] - Optional. Comma-delimited procedure codes.
+     * @param {string} [data.CodeGroupFixed] - Optional. Fixed group type.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false". Cannot be "true" if any ShowIn* field is "true".
+     * @param {string} [data.ShowInAgeLimit] - Optional. "true" or "false".
+     * @param {string} [data.ShowInFrequency] - Optional. "true" or "false" (v25.3.10+).
+     * @param {string} [data.ShowInOther] - Optional. "true" or "false" (v25.3.10+).
+     * @returns {Promise<CodeGroup>} - The updated code group record.
+     * @throws {Error} - If CodeGroupNum is not a valid number.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    updateCodeGroup(data: UpdateCodeGroupParams): Promise<CodeGroup>;
+}
+//# sourceMappingURL=codeGroups.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"codeGroups.d.ts","sourceRoot":"","sources":["../../src/api/codeGroups.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQnE;;;;OAIG;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,SAAS,EAAE,CAAC;IAS7B;;;;;;;;;;;;;;OAcG;IACU,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAQ7E;;;;;;;;;;;;;;;OAeG;IACU,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;CAQ9E"}

package/dist/api/codeGroups.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class CodeGroups {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single code group by its identifier.
+     * @param {number} CodeGroupNum - Required. Code group identifier.
+     * @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<CodeGroup>} - The code group record.
+     * @throws {Error} - If CodeGroupNum is not a valid number.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    async getCodeGroup(CodeGroupNum) {
+        if (!CodeGroupNum || typeof CodeGroupNum !== "number") {
+            throw new Error("Invalid parameter: A valid CodeGroupNum is required.");
+        }
+        return this.httpClient.get(`/codegroups/${CodeGroupNum}`);
+    }
+    /**
+     * Returns all code groups as an array.
+     * @returns {Promise<CodeGroup[]>} - Array of all code group records.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    async getCodeGroups({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/codegroups", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a new code group.
+     * IsHidden cannot be "true" if any ShowIn* field is "true".
+     * @param {Object} data - The details of the code group to create.
+     * @param {string} data.GroupName - Required. Name of the code group.
+     * @param {string} [data.ProcCodes] - Optional. Comma-delimited procedure codes.
+     * @param {string} [data.CodeGroupFixed] - Optional. Fixed group type; default "None".
+     * @param {string} [data.IsHidden] - Optional. "true" or "false"; default "false". Cannot be "true" if any ShowIn* field is "true".
+     * @param {string} [data.ShowInAgeLimit] - Optional. "true" or "false"; default "false".
+     * @param {string} [data.ShowInFrequency] - Optional. "true" or "false"; default "false" (v25.3.10+).
+     * @param {string} [data.ShowInOther] - Optional. "true" or "false"; default "false" (v25.3.10+).
+     * @returns {Promise<CodeGroup>} - The created code group record.
+     * @throws {Error} - If GroupName is not provided.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    async createCodeGroup(data) {
+        if (!data.GroupName) {
+            throw new Error("Invalid parameter: GroupName is required.");
+        }
+        return this.httpClient.post("/codegroups", data);
+    }
+    /**
+     * Updates an existing code group.
+     * IsHidden cannot be "true" if any ShowIn* field is "true".
+     * @param {Object} data - The details of the code group to update.
+     * @param {number} data.CodeGroupNum - Required. Code group identifier.
+     * @param {string} [data.GroupName] - Optional. Name of the code group.
+     * @param {string} [data.ProcCodes] - Optional. Comma-delimited procedure codes.
+     * @param {string} [data.CodeGroupFixed] - Optional. Fixed group type.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false". Cannot be "true" if any ShowIn* field is "true".
+     * @param {string} [data.ShowInAgeLimit] - Optional. "true" or "false".
+     * @param {string} [data.ShowInFrequency] - Optional. "true" or "false" (v25.3.10+).
+     * @param {string} [data.ShowInOther] - Optional. "true" or "false" (v25.3.10+).
+     * @returns {Promise<CodeGroup>} - The updated code group record.
+     * @throws {Error} - If CodeGroupNum is not a valid number.
+     * @see https://www.opendental.com/site/apicodegroups.html
+     */
+    async updateCodeGroup(data) {
+        if (!data.CodeGroupNum || typeof data.CodeGroupNum !== "number") {
+            throw new Error("Invalid parameter: A valid CodeGroupNum is required.");
+        }
+        const { CodeGroupNum, ...body } = data;
+        return this.httpClient.put(`/codegroups/${CodeGroupNum}`, body);
+    }
+}
+exports.default = CodeGroups;

package/dist/api/commlogs.d.ts

@@ -6,10 +6,21 @@ export default class CommLogs {
     /**
      * Fetch communication logs for a specific patient.
      * @param {number} PatNum - Required: The unique identifier for the patient.
+     * @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<CommLog[]>} - A list of communication logs for the patient.
-     * @throws {Error} - If `PatNum` is not provided or the API returns an error.
+     * @throws {Error} - If PatNum is not a valid number or the API returns an error.
+     * @see https://www.opendental.com/site/apicommlogs.html
      */
-    getCommLogs(PatNum: number): Promise<CommLog[]>;
+    getCommLogs(PatNum: number, params?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<CommLog[]>;
     /**
      * Create a new communication log.
      * @param {CreateCommLogParams} params - The details of the communication log to create.
@@ -22,6 +33,7 @@ export default class CommLogs {
      * @param {"Sent" | "Received" | "Neither"} [params.SentOrReceived] - Optional: Direction of communication.
      * @returns {Promise<CommLog>} - The created communication log.
      * @throws {Error} - If required fields are missing or the API returns an error.
+     * @see https://www.opendental.com/site/apicommlogs.html
      */
     createCommLog({ PatNum, CommDateTime, Mode_, Note, CommType, commType, SentOrReceived, }: CreateCommLogParams): Promise<CommLog>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"commlogs.d.ts","sourceRoot":"","sources":["../../src/api/commlogs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAErE,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQ5D;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,cAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAiB1C"}
+{"version":3,"file":"commlogs.d.ts","sourceRoot":"","sources":["../../src/api/commlogs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAErE,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAChD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQtB;;;;;;;;;;;;;OAaG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,cAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAiB1C"}

package/dist/api/commlogs.js

@@ -8,14 +8,20 @@ class CommLogs {
     /**
      * Fetch communication logs for a specific patient.
      * @param {number} PatNum - Required: The unique identifier for the patient.
+     * @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<CommLog[]>} - A list of communication logs for the patient.
-     * @throws {Error} - If `PatNum` is not provided or the API returns an error.
+     * @throws {Error} - If PatNum is not a valid number or the API returns an error.
+     * @see https://www.opendental.com/site/apicommlogs.html
      */
-    async getCommLogs(PatNum) {
+    async getCommLogs(PatNum, params) {
         if (!PatNum || typeof PatNum !== "number") {
             throw new Error("Invalid parameter: PatNum must be a valid number.");
         }
-        return this.httpClient.get("/commlogs", { PatNum });
+        return this.httpClient.get("/commlogs", { PatNum, ...params });
     }
     /**
      * Create a new communication log.
@@ -29,10 +35,11 @@ class CommLogs {
      * @param {"Sent" | "Received" | "Neither"} [params.SentOrReceived] - Optional: Direction of communication.
      * @returns {Promise<CommLog>} - The created communication log.
      * @throws {Error} - If required fields are missing or the API returns an error.
+     * @see https://www.opendental.com/site/apicommlogs.html
      */
     async createCommLog({ PatNum, CommDateTime, Mode_, Note, CommType, commType, SentOrReceived, }) {
         if (!PatNum || !CommDateTime || !Mode_ || !Note) {
-            throw new Error("Invalid data: PatNum, CommDateTime, Mode_, and Note are required.");
+            throw new Error("Invalid parameter: PatNum, CommDateTime, Mode_, and Note are required.");
         }
         return this.httpClient.post("/commlogs", {
             PatNum,

package/dist/api/computers.d.ts

@@ -0,0 +1,25 @@
+import HttpClient from "../utils/httpClient";
+import { ComputerItem } from "../types/computerTypes";
+export default class Computers {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch all computers registered in Open Dental.
+     * The LastHeartBeat field indicates which computers are actively running the Open Dental client.
+     * A LastHeartBeat value of "0001-01-01 00:00:00" (DateTime.MinValue) indicates an inactive computer.
+     * @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<ComputerItem[]>}
+     * @see https://www.opendental.com/site/apicomputers.html
+     */
+    getComputers({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<ComputerItem[]>;
+}
+//# sourceMappingURL=computers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"computers.d.ts","sourceRoot":"","sources":["../../src/api/computers.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,EACxB,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/computers.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Computers {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch all computers registered in Open Dental.
+     * The LastHeartBeat field indicates which computers are actively running the Open Dental client.
+     * A LastHeartBeat value of "0001-01-01 00:00:00" (DateTime.MinValue) indicates an inactive computer.
+     * @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<ComputerItem[]>}
+     * @see https://www.opendental.com/site/apicomputers.html
+     */
+    async getComputers({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/computers", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+}
+exports.default = Computers;