@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/substitutionLinks.d.ts

@@ -0,0 +1,51 @@
+import HttpClient from "../utils/httpClient";
+import { SubstitutionLinkItem, GetSubstitutionLinksParams, CreateSubstitutionLinkParams, UpdateSubstitutionLinkParams } from "../types/substitutionLinkTypes";
+export default class SubstitutionLinks {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves all substitution links for a specific insurance plan.
+     * @param {GetSubstitutionLinksParams} params - Query parameters.
+     * @param {number} params.PlanNum - Required. FK to insplan.PlanNum.
+     * @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<SubstitutionLinkItem[]>} Array of SubstitutionLink objects.
+     * @throws {Error} If PlanNum is not provided.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    getSubstitutionLinks(params: GetSubstitutionLinksParams): Promise<SubstitutionLinkItem[]>;
+    /**
+     * Creates a new substitution link for an insurance plan.
+     * @param {CreateSubstitutionLinkParams} data - Body parameters.
+     * @param {number} data.PlanNum - Required. FK to insplan.PlanNum.
+     * @param {number} data.CodeNum - Required. FK to procedurecode.CodeNum.
+     * @param {string} data.SubstitutionCode - Required. FK to procedurecode.ProcCode (case-sensitive).
+     * @param {SubstitutionCondition} data.SubstOnlyIf - Required. Condition for substitution.
+     * @returns {Promise<SubstitutionLinkItem>} The created SubstitutionLink object.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    createSubstitutionLink(data: CreateSubstitutionLinkParams): Promise<SubstitutionLinkItem>;
+    /**
+     * Updates an existing substitution link.
+     * @param {UpdateSubstitutionLinkParams} data - Update parameters.
+     * @param {number} data.SubstitutionLinkNum - Required. Primary key of the substitution link to update.
+     * @param {string} [data.SubstitutionCode] - Optional. Updated replacement code (case-sensitive).
+     * @param {SubstitutionCondition} [data.SubstOnlyIf] - Optional. Updated substitution condition.
+     * @returns {Promise<SubstitutionLinkItem>} The updated SubstitutionLink object.
+     * @throws {Error} If SubstitutionLinkNum is not provided.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    updateSubstitutionLink(data: UpdateSubstitutionLinkParams): Promise<SubstitutionLinkItem>;
+    /**
+     * Removes a substitution link.
+     * @param {number} SubstitutionLinkNum - Required. Primary key of the substitution link to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} If SubstitutionLinkNum is not provided.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    deleteSubstitutionLink(SubstitutionLinkNum: number): Promise<void>;
+}
+//# sourceMappingURL=substitutionLinks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"substitutionLinks.d.ts","sourceRoot":"","sources":["../../src/api/substitutionLinks.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC7B,MAAM,gCAAgC,CAAC;AAExC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAOtG;;;;;;;;;;OAUG;IACU,sBAAsB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAOtG;;;;;;;;;OASG;IACU,sBAAsB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQtG;;;;;;OAMG;IACU,sBAAsB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMhF"}

package/dist/api/substitutionLinks.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class SubstitutionLinks {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves all substitution links for a specific insurance plan.
+     * @param {GetSubstitutionLinksParams} params - Query parameters.
+     * @param {number} params.PlanNum - Required. FK to insplan.PlanNum.
+     * @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<SubstitutionLinkItem[]>} Array of SubstitutionLink objects.
+     * @throws {Error} If PlanNum is not provided.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    async getSubstitutionLinks(params) {
+        if (!params.PlanNum) {
+            throw new Error("Invalid parameter: PlanNum is required.");
+        }
+        return this.httpClient.get("/substitutionlinks", params);
+    }
+    /**
+     * Creates a new substitution link for an insurance plan.
+     * @param {CreateSubstitutionLinkParams} data - Body parameters.
+     * @param {number} data.PlanNum - Required. FK to insplan.PlanNum.
+     * @param {number} data.CodeNum - Required. FK to procedurecode.CodeNum.
+     * @param {string} data.SubstitutionCode - Required. FK to procedurecode.ProcCode (case-sensitive).
+     * @param {SubstitutionCondition} data.SubstOnlyIf - Required. Condition for substitution.
+     * @returns {Promise<SubstitutionLinkItem>} The created SubstitutionLink object.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    async createSubstitutionLink(data) {
+        if (!data.PlanNum || !data.CodeNum || !data.SubstitutionCode || !data.SubstOnlyIf) {
+            throw new Error("Invalid parameter: PlanNum, CodeNum, SubstitutionCode, and SubstOnlyIf are required.");
+        }
+        return this.httpClient.post("/substitutionlinks", data);
+    }
+    /**
+     * Updates an existing substitution link.
+     * @param {UpdateSubstitutionLinkParams} data - Update parameters.
+     * @param {number} data.SubstitutionLinkNum - Required. Primary key of the substitution link to update.
+     * @param {string} [data.SubstitutionCode] - Optional. Updated replacement code (case-sensitive).
+     * @param {SubstitutionCondition} [data.SubstOnlyIf] - Optional. Updated substitution condition.
+     * @returns {Promise<SubstitutionLinkItem>} The updated SubstitutionLink object.
+     * @throws {Error} If SubstitutionLinkNum is not provided.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    async updateSubstitutionLink(data) {
+        if (!data.SubstitutionLinkNum) {
+            throw new Error("Invalid parameter: SubstitutionLinkNum is required.");
+        }
+        const { SubstitutionLinkNum, ...body } = data;
+        return this.httpClient.put(`/substitutionlinks/${SubstitutionLinkNum}`, body);
+    }
+    /**
+     * Removes a substitution link.
+     * @param {number} SubstitutionLinkNum - Required. Primary key of the substitution link to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} If SubstitutionLinkNum is not provided.
+     * @see https://www.opendental.com/site/apisubstitutionlinks.html
+     */
+    async deleteSubstitutionLink(SubstitutionLinkNum) {
+        if (!SubstitutionLinkNum) {
+            throw new Error("Invalid parameter: SubstitutionLinkNum is required.");
+        }
+        return this.httpClient.delete(`/substitutionlinks/${SubstitutionLinkNum}`);
+    }
+}
+exports.default = SubstitutionLinks;

package/dist/api/taskLists.d.ts

@@ -0,0 +1,20 @@
+import HttpClient from "../utils/httpClient";
+import { TaskListItem, GetTaskListsParams } from "../types/taskListTypes";
+export default class TaskLists {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a list of task lists, optionally filtered by status.
+     * Supports pagination via Offset.
+     * @param {GetTaskListsParams} [params] - Optional query parameters.
+     * @param {"Active" | "Archived"} [params.TaskListStatus] - Optional. Filter by status. Default: "Active".
+     * @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<TaskListItem[]>} Array of TaskList objects.
+     * @see https://www.opendental.com/site/apitasklists.html
+     */
+    getTaskLists(params?: GetTaskListsParams): Promise<TaskListItem[]>;
+}
+//# sourceMappingURL=taskLists.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"taskLists.d.ts","sourceRoot":"","sources":["../../src/api/taskLists.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE1E,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAGhF"}

package/dist/api/taskLists.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TaskLists {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a list of task lists, optionally filtered by status.
+     * Supports pagination via Offset.
+     * @param {GetTaskListsParams} [params] - Optional query parameters.
+     * @param {"Active" | "Archived"} [params.TaskListStatus] - Optional. Filter by status. Default: "Active".
+     * @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<TaskListItem[]>} Array of TaskList objects.
+     * @see https://www.opendental.com/site/apitasklists.html
+     */
+    async getTaskLists(params) {
+        return this.httpClient.get("/tasklists", params);
+    }
+}
+exports.default = TaskLists;

package/dist/api/taskNotes.d.ts

@@ -0,0 +1,50 @@
+import HttpClient from "../utils/httpClient";
+import { TaskNoteItem, GetTaskNotesParams, CreateTaskNoteParams, UpdateTaskNoteParams } from "../types/taskNoteTypes";
+export default class TaskNotes {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single task note record by primary key.
+     * @param {number} TaskNoteNum - Required. Primary key of the task note.
+     * @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<TaskNoteItem>} - The task note record.
+     * @throws {Error} - If TaskNoteNum is not a valid number.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    getTaskNote(TaskNoteNum: number): Promise<TaskNoteItem>;
+    /**
+     * Retrieves multiple task note records with optional filtering.
+     * @param {GetTaskNotesParams} [params] - Optional filtering parameters.
+     * @param {number} [params.TaskNum] - Optional. FK to task.TaskNum; filters to notes for a specific task.
+     * @param {number} [params.UserNum] - Optional. FK to userod.UserNum; filters to notes by a specific user.
+     * @returns {Promise<TaskNoteItem[]>} - Array of task note records.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    getTaskNotes({ TaskNum, UserNum, Limit, DateFormatString, DateTimeFormatString, }?: GetTaskNotesParams): Promise<TaskNoteItem[]>;
+    /**
+     * Creates a new task note.
+     * @param {CreateTaskNoteParams} data - Required body parameters.
+     * @param {number} data.TaskNum - Required. FK to task.TaskNum.
+     * @param {number} data.UserNum - Required. FK to userod.UserNum.
+     * @param {string} data.Note - Required. Note content; cannot be blank.
+     * @returns {Promise<TaskNoteItem>} - The created task note with system-generated TaskNoteNum and DateTimeNote.
+     * @throws {Error} - If TaskNum, UserNum, or Note is missing.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    createTaskNote(data: CreateTaskNoteParams): Promise<TaskNoteItem>;
+    /**
+     * Updates an existing task note.
+     * @param {UpdateTaskNoteParams} data - Update parameters.
+     * @param {number} data.TaskNoteNum - Required. Primary key of the task note to update.
+     * @param {string} [data.DateTimeNote] - Optional. Format "yyyy-MM-dd HH:mm:ss".
+     * @param {string} [data.Note] - Optional. Updated note content; cannot be blank if provided.
+     * @returns {Promise<TaskNoteItem>} - The updated task note record.
+     * @throws {Error} - If TaskNoteNum is missing, or Note is provided but blank.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    updateTaskNote(data: UpdateTaskNoteParams): Promise<TaskNoteItem>;
+}
+//# sourceMappingURL=taskNotes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"taskNotes.d.ts","sourceRoot":"","sources":["../../src/api/taskNotes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAQpE;;;;;;;OAOG;IACU,YAAY,CAAC,EAAE,OAAO,EAAE,OAAO,EAC1C,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IASlD;;;;;;;;;OASG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAW9E;;;;;;;;;OASG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;CAW/E"}

package/dist/api/taskNotes.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TaskNotes {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single task note record by primary key.
+     * @param {number} TaskNoteNum - Required. Primary key of the task note.
+     * @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<TaskNoteItem>} - The task note record.
+     * @throws {Error} - If TaskNoteNum is not a valid number.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    async getTaskNote(TaskNoteNum) {
+        if (!TaskNoteNum || typeof TaskNoteNum !== "number") {
+            throw new Error("Invalid parameter: TaskNoteNum must be a valid number.");
+        }
+        return this.httpClient.get(`/tasknotes/${TaskNoteNum}`);
+    }
+    /**
+     * Retrieves multiple task note records with optional filtering.
+     * @param {GetTaskNotesParams} [params] - Optional filtering parameters.
+     * @param {number} [params.TaskNum] - Optional. FK to task.TaskNum; filters to notes for a specific task.
+     * @param {number} [params.UserNum] - Optional. FK to userod.UserNum; filters to notes by a specific user.
+     * @returns {Promise<TaskNoteItem[]>} - Array of task note records.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    async getTaskNotes({ TaskNum, UserNum, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/tasknotes", {
+            TaskNum, UserNum,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a new task note.
+     * @param {CreateTaskNoteParams} data - Required body parameters.
+     * @param {number} data.TaskNum - Required. FK to task.TaskNum.
+     * @param {number} data.UserNum - Required. FK to userod.UserNum.
+     * @param {string} data.Note - Required. Note content; cannot be blank.
+     * @returns {Promise<TaskNoteItem>} - The created task note with system-generated TaskNoteNum and DateTimeNote.
+     * @throws {Error} - If TaskNum, UserNum, or Note is missing.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    async createTaskNote(data) {
+        if (!data.TaskNum || !data.UserNum) {
+            throw new Error("Invalid parameter: TaskNum and UserNum are required.");
+        }
+        if (!data.Note || data.Note.trim() === "") {
+            throw new Error("Invalid parameter: Note is required and cannot be blank.");
+        }
+        return this.httpClient.post("/tasknotes", data);
+    }
+    /**
+     * Updates an existing task note.
+     * @param {UpdateTaskNoteParams} data - Update parameters.
+     * @param {number} data.TaskNoteNum - Required. Primary key of the task note to update.
+     * @param {string} [data.DateTimeNote] - Optional. Format "yyyy-MM-dd HH:mm:ss".
+     * @param {string} [data.Note] - Optional. Updated note content; cannot be blank if provided.
+     * @returns {Promise<TaskNoteItem>} - The updated task note record.
+     * @throws {Error} - If TaskNoteNum is missing, or Note is provided but blank.
+     * @see https://www.opendental.com/site/apitasknotes.html
+     */
+    async updateTaskNote(data) {
+        if (!data.TaskNoteNum) {
+            throw new Error("Invalid parameter: TaskNoteNum is required.");
+        }
+        if (data.Note !== undefined && data.Note.trim() === "") {
+            throw new Error("Invalid parameter: Note cannot be blank if provided.");
+        }
+        const { TaskNoteNum, ...body } = data;
+        return this.httpClient.put(`/tasknotes/${TaskNoteNum}`, body);
+    }
+}
+exports.default = TaskNotes;

package/dist/api/tasks.d.ts

@@ -0,0 +1,69 @@
+import HttpClient from "../utils/httpClient";
+import { TaskItem, GetTasksParams, CreateTaskParams, UpdateTaskParams } from "../types/taskTypes";
+export default class Tasks {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single task by its primary key.
+     * @param {number} TaskNum - Required. Primary key of the task.
+     * @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<TaskItem>} The Task object.
+     * @throws {Error} If TaskNum is not provided.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    getTask(TaskNum: number): Promise<TaskItem>;
+    /**
+     * Retrieves multiple tasks with optional filters.
+     * When DateTimeOriginal is not specified, defaults to tasks from the previous 14 days.
+     * @param {GetTasksParams} [params] - Optional query parameters.
+     * @param {number} [params.TaskListNum] - Optional. FK to tasklist.TaskListNum.
+     * @param {number} [params.KeyNum] - Optional. FK to patient.PatNum or appointment.AptNum.
+     * @param {"None" | "Patient" | "Appointment"} [params.ObjectType] - Optional. Filter by object type.
+     * @param {"New" | "Viewed" | "Done"} [params.TaskStatus] - Optional. Filter by task status.
+     * @param {string} [params.DateTimeOriginal] - Optional. Returns tasks created after this datetime.
+     *   Format: "yyyy-MM-dd HH:mm:ss". Default: previous 14 days.
+     * @returns {Promise<TaskItem[]>} Array of Task objects.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    getTasks(params?: GetTasksParams): Promise<TaskItem[]>;
+    /**
+     * Creates a new task.
+     * @param {CreateTaskParams} data - Body parameters.
+     * @param {number} data.TaskListNum - Required. FK to tasklist.TaskListNum.
+     * @param {string} data.Descript - Required. Task description.
+     * @param {number} data.UserNum - Required. FK to userod.UserNum — creating user.
+     * @param {number} [data.KeyNum] - Optional. FK to patient.PatNum or appointment.AptNum.
+     *   Required when ObjectType is not None.
+     * @param {"None" | "Patient" | "Appointment"} [data.ObjectType] - Optional. Defaults to "None".
+     * @param {string} [data.DateTimeEntry] - Optional. Format: "yyyy-MM-dd HH:mm:ss". Defaults to now.
+     * @param {number} [data.PriorityDefNum] - Optional. FK to definition.DefNum (Category=33).
+     * @param {string} [data.DescriptOverride] - Optional. Max 256 chars. Overrides task list grid display text.
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (Category=54). Requires TaskCategoryShow pref.
+     * @returns {Promise<TaskItem>} The created Task object.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    createTask(data: CreateTaskParams): Promise<TaskItem>;
+    /**
+     * Updates an existing task.
+     * Note: updating Descript automatically resets a "Done" task status back to "Viewed".
+     * @param {UpdateTaskParams} data - Update parameters.
+     * @param {number} data.TaskNum - Required. Primary key of the task to update.
+     * @param {string} [data.Descript] - Optional. Overwrites existing description; resets "Done" to "Viewed".
+     * @param {"New" | "Viewed" | "Done"} [data.TaskStatus] - Optional. Updated status. Added v24.2.10.
+     * @param {number} [data.KeyNum] - Optional. FK to patient.PatNum or appointment.AptNum.
+     * @param {"None" | "Patient" | "Appointment"} [data.ObjectType] - Optional. Updated object type.
+     * @param {string} [data.DateTimeEntry] - Optional. Format: "yyyy-MM-dd HH:mm:ss".
+     * @param {number} [data.PriorityDefNum] - Optional. FK to definition.DefNum (Category=33).
+     * @param {string} [data.DescriptOverride] - Optional. Max 256 characters.
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (Category=54). Requires TaskCategoryShow pref.
+     * @returns {Promise<TaskItem>} The updated Task object.
+     * @throws {Error} If TaskNum is not provided.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    updateTask(data: UpdateTaskParams): Promise<TaskItem>;
+}
+//# sourceMappingURL=tasks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../../src/api/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOxD;;;;;;;;;;;;OAYG;IACU,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAInE;;;;;;;;;;;;;;;;OAgBG;IACU,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOlE;;;;;;;;;;;;;;;;OAgBG;IACU,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAOnE"}

package/dist/api/tasks.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Tasks {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single task by its primary key.
+     * @param {number} TaskNum - Required. Primary key of the task.
+     * @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<TaskItem>} The Task object.
+     * @throws {Error} If TaskNum is not provided.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    async getTask(TaskNum) {
+        if (!TaskNum) {
+            throw new Error("Invalid parameter: TaskNum is required.");
+        }
+        return this.httpClient.get(`/tasks/${TaskNum}`);
+    }
+    /**
+     * Retrieves multiple tasks with optional filters.
+     * When DateTimeOriginal is not specified, defaults to tasks from the previous 14 days.
+     * @param {GetTasksParams} [params] - Optional query parameters.
+     * @param {number} [params.TaskListNum] - Optional. FK to tasklist.TaskListNum.
+     * @param {number} [params.KeyNum] - Optional. FK to patient.PatNum or appointment.AptNum.
+     * @param {"None" | "Patient" | "Appointment"} [params.ObjectType] - Optional. Filter by object type.
+     * @param {"New" | "Viewed" | "Done"} [params.TaskStatus] - Optional. Filter by task status.
+     * @param {string} [params.DateTimeOriginal] - Optional. Returns tasks created after this datetime.
+     *   Format: "yyyy-MM-dd HH:mm:ss". Default: previous 14 days.
+     * @returns {Promise<TaskItem[]>} Array of Task objects.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    async getTasks(params) {
+        return this.httpClient.get("/tasks", params);
+    }
+    /**
+     * Creates a new task.
+     * @param {CreateTaskParams} data - Body parameters.
+     * @param {number} data.TaskListNum - Required. FK to tasklist.TaskListNum.
+     * @param {string} data.Descript - Required. Task description.
+     * @param {number} data.UserNum - Required. FK to userod.UserNum — creating user.
+     * @param {number} [data.KeyNum] - Optional. FK to patient.PatNum or appointment.AptNum.
+     *   Required when ObjectType is not None.
+     * @param {"None" | "Patient" | "Appointment"} [data.ObjectType] - Optional. Defaults to "None".
+     * @param {string} [data.DateTimeEntry] - Optional. Format: "yyyy-MM-dd HH:mm:ss". Defaults to now.
+     * @param {number} [data.PriorityDefNum] - Optional. FK to definition.DefNum (Category=33).
+     * @param {string} [data.DescriptOverride] - Optional. Max 256 chars. Overrides task list grid display text.
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (Category=54). Requires TaskCategoryShow pref.
+     * @returns {Promise<TaskItem>} The created Task object.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    async createTask(data) {
+        if (!data.TaskListNum || !data.Descript || !data.UserNum) {
+            throw new Error("Invalid parameter: TaskListNum, Descript, and UserNum are required.");
+        }
+        return this.httpClient.post("/tasks", data);
+    }
+    /**
+     * Updates an existing task.
+     * Note: updating Descript automatically resets a "Done" task status back to "Viewed".
+     * @param {UpdateTaskParams} data - Update parameters.
+     * @param {number} data.TaskNum - Required. Primary key of the task to update.
+     * @param {string} [data.Descript] - Optional. Overwrites existing description; resets "Done" to "Viewed".
+     * @param {"New" | "Viewed" | "Done"} [data.TaskStatus] - Optional. Updated status. Added v24.2.10.
+     * @param {number} [data.KeyNum] - Optional. FK to patient.PatNum or appointment.AptNum.
+     * @param {"None" | "Patient" | "Appointment"} [data.ObjectType] - Optional. Updated object type.
+     * @param {string} [data.DateTimeEntry] - Optional. Format: "yyyy-MM-dd HH:mm:ss".
+     * @param {number} [data.PriorityDefNum] - Optional. FK to definition.DefNum (Category=33).
+     * @param {string} [data.DescriptOverride] - Optional. Max 256 characters.
+     * @param {number} [data.Category] - Optional. FK to definition.DefNum (Category=54). Requires TaskCategoryShow pref.
+     * @returns {Promise<TaskItem>} The updated Task object.
+     * @throws {Error} If TaskNum is not provided.
+     * @see https://www.opendental.com/site/apitasks.html
+     */
+    async updateTask(data) {
+        if (!data.TaskNum) {
+            throw new Error("Invalid parameter: TaskNum is required.");
+        }
+        const { TaskNum, ...body } = data;
+        return this.httpClient.put(`/tasks/${TaskNum}`, body);
+    }
+}
+exports.default = Tasks;

package/dist/api/toothInitials.d.ts

@@ -0,0 +1,39 @@
+import HttpClient from "../utils/httpClient";
+import { ToothInitialItem, GetToothInitialsParams, CreateToothInitialParams } from "../types/toothInitialTypes";
+export default class ToothInitials {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves all tooth initial records, optionally filtered by patient.
+     * @param {GetToothInitialsParams} [params] - Optional filtering parameters.
+     * @param {number} [params.PatNum] - Optional. FK to patient.PatNum; filters results to a single patient.
+     * @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<ToothInitialItem[]>} - Array of tooth initial records.
+     * @see https://www.opendental.com/site/apitoothInitials.html
+     */
+    getToothInitials({ PatNum, Limit, DateFormatString, DateTimeFormatString, }?: GetToothInitialsParams): Promise<ToothInitialItem[]>;
+    /**
+     * Creates a new tooth initial record for a patient.
+     * Only InitialType values "Missing", "Hidden", and "Primary" are supported via the API.
+     * @param {CreateToothInitialParams} data - Required body parameters.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} data.ToothNum - Required. Single tooth number: 1–32 (permanent) or A–T (primary/deciduous).
+     * @param {"Missing" | "Hidden" | "Primary"} data.InitialType - Required. Type classification; API only supports "Missing", "Hidden", "Primary".
+     * @returns {Promise<ToothInitialItem>} - The created record with all fields populated.
+     * @throws {Error} - If PatNum, ToothNum, or InitialType is missing.
+     * @see https://www.opendental.com/site/apitoothInitials.html
+     */
+    createToothInitial(data: CreateToothInitialParams): Promise<ToothInitialItem>;
+    /**
+     * Removes an existing tooth initial record.
+     * @param {number} ToothInitialNum - Required. Primary key of the record to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} - If ToothInitialNum is not a valid number.
+     * @see https://www.opendental.com/site/apitoothInitials.html
+     */
+    deleteToothInitial(ToothInitialNum: number): Promise<void>;
+}
+//# sourceMappingURL=toothInitials.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"toothInitials.d.ts","sourceRoot":"","sources":["../../src/api/toothInitials.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,gBAAgB,CAAC,EAAE,MAAM,EACpC,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,sBAA2B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAS1D;;;;;;;;;;OAUG;IACU,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAc1F;;;;;;OAMG;IACU,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOxE"}

package/dist/api/toothInitials.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ToothInitials {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves all tooth initial records, optionally filtered by patient.
+     * @param {GetToothInitialsParams} [params] - Optional filtering parameters.
+     * @param {number} [params.PatNum] - Optional. FK to patient.PatNum; filters results to a single patient.
+     * @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<ToothInitialItem[]>} - Array of tooth initial records.
+     * @see https://www.opendental.com/site/apitoothInitials.html
+     */
+    async getToothInitials({ PatNum, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/toothinitials", {
+            PatNum,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a new tooth initial record for a patient.
+     * Only InitialType values "Missing", "Hidden", and "Primary" are supported via the API.
+     * @param {CreateToothInitialParams} data - Required body parameters.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} data.ToothNum - Required. Single tooth number: 1–32 (permanent) or A–T (primary/deciduous).
+     * @param {"Missing" | "Hidden" | "Primary"} data.InitialType - Required. Type classification; API only supports "Missing", "Hidden", "Primary".
+     * @returns {Promise<ToothInitialItem>} - The created record with all fields populated.
+     * @throws {Error} - If PatNum, ToothNum, or InitialType is missing.
+     * @see https://www.opendental.com/site/apitoothInitials.html
+     */
+    async createToothInitial(data) {
+        if (!data.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        if (!data.ToothNum) {
+            throw new Error("Invalid parameter: ToothNum is required.");
+        }
+        if (!data.InitialType) {
+            throw new Error("Invalid parameter: InitialType is required.");
+        }
+        return this.httpClient.post("/toothinitials", data);
+    }
+    /**
+     * Removes an existing tooth initial record.
+     * @param {number} ToothInitialNum - Required. Primary key of the record to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} - If ToothInitialNum is not a valid number.
+     * @see https://www.opendental.com/site/apitoothInitials.html
+     */
+    async deleteToothInitial(ToothInitialNum) {
+        if (!ToothInitialNum || typeof ToothInitialNum !== "number") {
+            throw new Error("Invalid parameter: ToothInitialNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/toothinitials/${ToothInitialNum}`);
+    }
+}
+exports.default = ToothInitials;

package/dist/api/treatplanattaches.d.ts

@@ -7,10 +7,13 @@ export default 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.
      */
-    getTreatPlanAttaches({ TreatPlanNum, Offset, }?: GetTreatPlanAttachesParams): Promise<TreatPlanAttach[]>;
+    getTreatPlanAttaches({ TreatPlanNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetTreatPlanAttachesParams): Promise<TreatPlanAttach[]>;
     /**
     * Create a new TreatPlanAttaches.
     * @param {Object} data - Data for the new TreatPlanAttaches object.

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

@@ -1 +1 @@
-{"version":3,"file":"treatplanattaches.d.ts","sourceRoot":"","sources":["../../src/api/treatplanattaches.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,eAAe,EACf,0BAA0B,EAC1B,6BAA6B,EAC7B,6BAA6B,EAChC,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,oBAAoB,CAAC,EAC9B,YAAY,EACZ,MAAM,GACT,GAAE,0BAA+B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS9D;;;;;;;;MAQE;IACU,mBAAmB,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;;;OAOG;IACU,mBAAmB,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC;CAOlG"}
+{"version":3,"file":"treatplanattaches.d.ts","sourceRoot":"","sources":["../../src/api/treatplanattaches.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,eAAe,EACf,0BAA0B,EAC1B,6BAA6B,EAC7B,6BAA6B,EAChC,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,oBAAoB,CAAC,EAC9B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GAC3B,GAAE,0BAA+B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAa1D;;;;;;;;MAQE;IACU,mBAAmB,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;;;OAOG;IACU,mBAAmB,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC;CAOlG"}