@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/treatplanattaches.js

@@ -9,13 +9,19 @@ class TreatPlanAttaches {
      * Get a list of TreatPlanAttaches that meet a set of search criteria.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {string} params.TreatPlanNum - treatplan.TreatPlanNum
-     * @param {number} [params.Offset] - Pagination offset. Default 0
+   * @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<TreatPlanAttach[]>} - An array of TreatPlanAttach objects.
      */
-    async getTreatPlanAttaches({ TreatPlanNum, Offset, } = {}) {
+    async getTreatPlanAttaches({ TreatPlanNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             TreatPlanNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/treatplanattaches", params);
     }
@@ -30,7 +36,7 @@ class TreatPlanAttaches {
     */
     async createTreatmentPlan(data) {
         if (!data.TreatPlanNum || !data.ProcNum) {
-            throw new Error("TreatPlanNum and ProcNum are required.");
+            throw new Error("Invalid parameter: TreatPlanNum and ProcNum are required.");
         }
         return this.httpClient.post("/treatplanattaches", data);
     }
@@ -44,7 +50,7 @@ class TreatPlanAttaches {
      */
     async updateTreatmentPlan(data) {
         if (!data.TreatPlanAttachNum || !data.Priority) {
-            throw new Error("TreatPlanAttachNum and Priority are required.");
+            throw new Error("Invalid parameter: TreatPlanAttachNum and Priority are required.");
         }
         return this.httpClient.put(`/treatplanattaches/${data.TreatPlanAttachNum}`, data);
     }

package/dist/api/treatplans.d.ts

@@ -9,9 +9,13 @@ export default class TreatmentPlans {
      * @param {string} [params.PatNum] - patient.PatNum.
      * @param {string} [params.SecDateTEdit] - Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
      * @param {"Saved" | "Active" | "Inactive"} [params.TPStatus] - Either "Saved", "Active", or "Inactive". Default 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<TreatmentPlan[]>} - An array of treatplan objects.
      */
-    getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, }?: GetTreatmentPlanParams): Promise<TreatmentPlan[]>;
+    getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, Limit, DateFormatString, DateTimeFormatString, }?: GetTreatmentPlanParams): Promise<TreatmentPlan[]>;
     /**
     * Create a new TreatPlan.
     * @param {Object} data - Data for the new treatment plan.
@@ -49,5 +53,15 @@ export default class TreatmentPlans {
     * @throws {Error} - If required fields are missing.
      */
     updateTreatmentPlan(data: UpdateTreatmentPlanParams): Promise<TreatmentPlan>;
+    /**
+     * Delete an unsigned Saved TreatPlan.
+     * Mirrors DELETE /treatplans/{TreatPlanNum}
+     * Only Saved treatment plans can be deleted via the API.
+     * @param {number} TreatPlanNum - Required. Primary key.
+     * @returns {Promise<void>} - Resolves on success.
+     * @throws {Error} - If TreatPlanNum is not valid.
+     * @see https://www.opendental.com/site/apitreatplans.html
+     */
+    deleteTreatmentPlan(TreatPlanNum: number): Promise<void>;
 }
 //# sourceMappingURL=treatplans.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"treatplans.d.ts","sourceRoot":"","sources":["../../src/api/treatplans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,aAAa,EACb,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;;;;OAOG;IACU,iBAAiB,CAAC,EAC3B,MAAM,EACN,YAAY,EACZ,QAAQ,GACX,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAUxD;;;;;;;;;MASE;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQzF;;;;;;;;OAQG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQrF;;;;;;;;;;;;;;OAcG;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;CAO5F"}
+{"version":3,"file":"treatplans.d.ts","sourceRoot":"","sources":["../../src/api/treatplans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,aAAa,EACb,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,iBAAiB,CAAC,EAC3B,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GAC3B,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAcpD;;;;;;;;;MASE;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQzF;;;;;;;;OAQG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQrF;;;;;;;;;;;;;;OAcG;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQzF;;;;;;;;OAQG;IACU,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMxE"}

package/dist/api/treatplans.js

@@ -11,13 +11,20 @@ class TreatmentPlans {
      * @param {string} [params.PatNum] - patient.PatNum.
      * @param {string} [params.SecDateTEdit] - Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
      * @param {"Saved" | "Active" | "Inactive"} [params.TPStatus] - Either "Saved", "Active", or "Inactive". Default 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<TreatmentPlan[]>} - An array of treatplan objects.
      */
-    async getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, } = {}) {
+    async getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             PatNum,
             SecDateTEdit,
             TPStatus,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/treatplans", params);
     }
@@ -33,7 +40,7 @@ class TreatmentPlans {
     */
     async createTreatmentPlan(data) {
         if (!data.PatNum) {
-            throw new Error("PatNum is required.");
+            throw new Error("Invalid parameter: PatNum is required.");
         }
         return this.httpClient.post("/treatplans", data);
     }
@@ -48,7 +55,7 @@ class TreatmentPlans {
      */
     async saveTreatmentPlan(data) {
         if (!data.TreatPlanNum) {
-            throw new Error("TreatPlanNum is required.");
+            throw new Error("Invalid parameter: TreatPlanNum is required.");
         }
         return this.httpClient.post("/treatplans/Saved", data);
     }
@@ -69,9 +76,24 @@ class TreatmentPlans {
      */
     async updateTreatmentPlan(data) {
         if (!data.TreatPlanNum) {
-            throw new Error("TreatPlanNum is required.");
+            throw new Error("Invalid parameter: TreatPlanNum is required.");
         }
         return this.httpClient.put(`/treatplans/${data.TreatPlanNum}`, data);
     }
+    /**
+     * Delete an unsigned Saved TreatPlan.
+     * Mirrors DELETE /treatplans/{TreatPlanNum}
+     * Only Saved treatment plans can be deleted via the API.
+     * @param {number} TreatPlanNum - Required. Primary key.
+     * @returns {Promise<void>} - Resolves on success.
+     * @throws {Error} - If TreatPlanNum is not valid.
+     * @see https://www.opendental.com/site/apitreatplans.html
+     */
+    async deleteTreatmentPlan(TreatPlanNum) {
+        if (!TreatPlanNum || typeof TreatPlanNum !== "number") {
+            throw new Error("Invalid parameter: TreatPlanNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/treatplans/${TreatPlanNum}`);
+    }
 }
 exports.default = TreatmentPlans;

package/dist/api/userGroupAttaches.d.ts

@@ -0,0 +1,20 @@
+import HttpClient from "../utils/httpClient";
+import { UserGroupAttachItem, GetUserGroupAttachesParams } from "../types/userGroupAttachTypes";
+export default class UserGroupAttaches {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a list of user group attachment records with optional filtering by user or group.
+     * @param {GetUserGroupAttachesParams} [params] - Optional filtering parameters.
+     * @param {number} [params.UserNum] - Optional. FK to userod.UserNum; filters to attachments for a specific user.
+     * @param {number} [params.UserGroupNum] - Optional. FK to usergroup.UserGroupNum; filters to attachments for a specific group.
+     * @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<UserGroupAttachItem[]>} - Array of user group attachment records.
+     * @see https://www.opendental.com/site/apiusergroupattaches.html
+     */
+    getUserGroupAttaches({ UserNum, UserGroupNum, Limit, DateFormatString, DateTimeFormatString, }?: GetUserGroupAttachesParams): Promise<UserGroupAttachItem[]>;
+}
+//# sourceMappingURL=userGroupAttaches.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userGroupAttaches.d.ts","sourceRoot":"","sources":["../../src/api/userGroupAttaches.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAEhG,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,oBAAoB,CAAC,EAChC,OAAO,EACP,YAAY,EACZ,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,0BAA+B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;CAUlE"}

package/dist/api/userGroupAttaches.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class UserGroupAttaches {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a list of user group attachment records with optional filtering by user or group.
+     * @param {GetUserGroupAttachesParams} [params] - Optional filtering parameters.
+     * @param {number} [params.UserNum] - Optional. FK to userod.UserNum; filters to attachments for a specific user.
+     * @param {number} [params.UserGroupNum] - Optional. FK to usergroup.UserGroupNum; filters to attachments for a specific group.
+     * @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<UserGroupAttachItem[]>} - Array of user group attachment records.
+     * @see https://www.opendental.com/site/apiusergroupattaches.html
+     */
+    async getUserGroupAttaches({ UserNum, UserGroupNum, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/usergroupattaches", {
+            UserNum,
+            UserGroupNum,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+}
+exports.default = UserGroupAttaches;

package/dist/api/userGroups.d.ts

@@ -0,0 +1,20 @@
+import HttpClient from "../utils/httpClient";
+import { UserGroupItem, GetUserGroupsParams } from "../types/userGroupTypes";
+export default class UserGroups {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a list of user groups.
+     * By default only returns non-CEMT groups; set includeCEMT to "true" to include CEMT-linked groups.
+     * @param {GetUserGroupsParams} [params] - Optional filtering parameters.
+     * @param {string} [params.includeCEMT] - Optional. Set to "true" to return both CEMT and non-CEMT groups; defaults to "false".
+     * @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<UserGroupItem[]>} - Array of user group records.
+     * @see https://www.opendental.com/site/apiusergroups.html
+     */
+    getUserGroups({ includeCEMT, Limit, DateFormatString, DateTimeFormatString, }?: GetUserGroupsParams): Promise<UserGroupItem[]>;
+}
+//# sourceMappingURL=userGroups.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userGroups.d.ts","sourceRoot":"","sources":["../../src/api/userGroups.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE7E,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,EAAE,WAAW,EACtC,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,mBAAwB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAQrD"}

package/dist/api/userGroups.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class UserGroups {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a list of user groups.
+     * By default only returns non-CEMT groups; set includeCEMT to "true" to include CEMT-linked groups.
+     * @param {GetUserGroupsParams} [params] - Optional filtering parameters.
+     * @param {string} [params.includeCEMT] - Optional. Set to "true" to return both CEMT and non-CEMT groups; defaults to "false".
+     * @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<UserGroupItem[]>} - Array of user group records.
+     * @see https://www.opendental.com/site/apiusergroups.html
+     */
+    async getUserGroups({ includeCEMT, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/usergroups", {
+            includeCEMT,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+}
+exports.default = UserGroups;

package/dist/api/userODs.d.ts

@@ -0,0 +1,49 @@
+import HttpClient from "../utils/httpClient";
+import { UserODItem, GetUserODsParams, CreateUserODParams, UpdateUserODParams } from "../types/userODTypes";
+export default class UserODs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a list of users. By default returns only visible (non-hidden), non-CEMT users.
+     * @param {GetUserODsParams} [params] - Optional query parameters.
+     * @param {"true" | "false"} [params.includeHidden] - Optional. "true" returns hidden users as well. Default "false". Added v22.4.24.
+     * @param {"true" | "false"} [params.includeCEMT] - Optional. "true" returns CEMT-designated users. Default "false". Added v25.1.10.
+     * @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<UserODItem[]>} Array of UserOD objects.
+     * @see https://www.opendental.com/site/apiuserods.html
+     */
+    getUserODs(params?: GetUserODsParams): Promise<UserODItem[]>;
+    /**
+     * Creates a new user account.
+     * @param {CreateUserODParams} data - Body parameters.
+     * @param {string} data.UserName - Required. Must be unique. Cannot end with whitespace.
+     * @param {number} data.UserGroupNum - Required. FK to usergroup.UserGroupNum.
+     * @param {string} data.Password - Required. Min 8 chars with at least one number,
+     *   one uppercase letter, and one lowercase letter.
+     * @param {"true" | "false"} [data.IsPasswordResetRequired] - Optional. Defaults to "false".
+     * @returns {Promise<UserODItem>} The created UserOD object.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apiuserods.html
+     */
+    createUserOD(data: CreateUserODParams): Promise<UserODItem>;
+    /**
+     * Updates an existing user account.
+     * Note: userGroupNums replaces ALL existing group memberships — it is not additive.
+     * @param {UpdateUserODParams} data - Update parameters.
+     * @param {number} data.UserNum - Required. Primary key of the user to update.
+     * @param {number[]} [data.userGroupNums] - Optional. Replaces all group memberships. Added v25.1.10.
+     * @param {number} [data.EmployeeNum] - Optional. FK to employee.EmployeeNum.
+     * @param {number} [data.ProviderNum] - Optional. FK to provider.ProvNum.
+     * @param {number} [data.ClinicNum] - Optional. FK to clinic.ClinicNum.
+     * @param {"true" | "false"} [data.IsHidden] - Optional. Hides or shows user in the login list.
+     * @param {"true" | "false"} [data.IsPasswordResetRequired] - Optional. Added v25.1.10.
+     * @returns {Promise<UserODItem>} The updated UserOD object.
+     * @throws {Error} If UserNum is not provided.
+     * @see https://www.opendental.com/site/apiuserods.html
+     */
+    updateUserOD(data: UpdateUserODParams): Promise<UserODItem>;
+}
+//# sourceMappingURL=userODs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userODs.d.ts","sourceRoot":"","sources":["../../src/api/userODs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAIzE;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IAOxE;;;;;;;;;;;;;;OAcG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;CAOzE"}

package/dist/api/userODs.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class UserODs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a list of users. By default returns only visible (non-hidden), non-CEMT users.
+     * @param {GetUserODsParams} [params] - Optional query parameters.
+     * @param {"true" | "false"} [params.includeHidden] - Optional. "true" returns hidden users as well. Default "false". Added v22.4.24.
+     * @param {"true" | "false"} [params.includeCEMT] - Optional. "true" returns CEMT-designated users. Default "false". Added v25.1.10.
+     * @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<UserODItem[]>} Array of UserOD objects.
+     * @see https://www.opendental.com/site/apiuserods.html
+     */
+    async getUserODs(params) {
+        return this.httpClient.get("/userods", params);
+    }
+    /**
+     * Creates a new user account.
+     * @param {CreateUserODParams} data - Body parameters.
+     * @param {string} data.UserName - Required. Must be unique. Cannot end with whitespace.
+     * @param {number} data.UserGroupNum - Required. FK to usergroup.UserGroupNum.
+     * @param {string} data.Password - Required. Min 8 chars with at least one number,
+     *   one uppercase letter, and one lowercase letter.
+     * @param {"true" | "false"} [data.IsPasswordResetRequired] - Optional. Defaults to "false".
+     * @returns {Promise<UserODItem>} The created UserOD object.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apiuserods.html
+     */
+    async createUserOD(data) {
+        if (!data.UserName || !data.UserGroupNum || !data.Password) {
+            throw new Error("Invalid parameter: UserName, UserGroupNum, and Password are required.");
+        }
+        return this.httpClient.post("/userods", data);
+    }
+    /**
+     * Updates an existing user account.
+     * Note: userGroupNums replaces ALL existing group memberships — it is not additive.
+     * @param {UpdateUserODParams} data - Update parameters.
+     * @param {number} data.UserNum - Required. Primary key of the user to update.
+     * @param {number[]} [data.userGroupNums] - Optional. Replaces all group memberships. Added v25.1.10.
+     * @param {number} [data.EmployeeNum] - Optional. FK to employee.EmployeeNum.
+     * @param {number} [data.ProviderNum] - Optional. FK to provider.ProvNum.
+     * @param {number} [data.ClinicNum] - Optional. FK to clinic.ClinicNum.
+     * @param {"true" | "false"} [data.IsHidden] - Optional. Hides or shows user in the login list.
+     * @param {"true" | "false"} [data.IsPasswordResetRequired] - Optional. Added v25.1.10.
+     * @returns {Promise<UserODItem>} The updated UserOD object.
+     * @throws {Error} If UserNum is not provided.
+     * @see https://www.opendental.com/site/apiuserods.html
+     */
+    async updateUserOD(data) {
+        if (!data.UserNum) {
+            throw new Error("Invalid parameter: UserNum is required.");
+        }
+        const { UserNum, ...body } = data;
+        return this.httpClient.put(`/userods/${UserNum}`, body);
+    }
+}
+exports.default = UserODs;