@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/documents.d.ts

@@ -0,0 +1,137 @@
+import HttpClient from "../utils/httpClient";
+import { DocumentItem, DocumentThumbnailRef, GetDocumentsParams, UploadDocumentParams, UploadSftpDocumentParams, SetByUrlDocumentParams, DownloadSftpParams, ThumbnailsParams, DownloadMountParams, UpdateDocumentParams } from "../types/documentTypes";
+export default class Documents {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single document record by its identifier.
+     * @param {number} DocNum - Required. integer. Document identifier (PK).
+     * @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<DocumentItem>} - The document record.
+     * @throws {Error} - If DocNum is not a valid number.
+     */
+    getDocument(DocNum: number): Promise<DocumentItem>;
+    /**
+     * Retrieves all document records for a patient, ordered by DateCreated.
+     * @param {GetDocumentsParams} params - Query parameters.
+     * @param {number} params.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @returns {Promise<DocumentItem[]>} - Array of document records.
+     * @throws {Error} - If PatNum is not provided.
+     */
+    getDocuments(params: GetDocumentsParams): Promise<DocumentItem[]>;
+    /**
+     * Uploads a document as a Base64-encoded file and creates a document record.
+     * @param {UploadDocumentParams} data - Upload parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.rawBase64 - Required. string. Base64-encoded file content.
+     * @param {string} data.extension - Required. string. File extension (e.g., ".jpg", ".pdf").
+     * @param {string} [data.Description] - Optional. string. Document description.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss".
+     * @param {number} [data.DocCategory] - Optional. integer. FK to definitions.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Default: "Document".
+     * @param {string} [data.ToothNumbers] - Optional. string. Comma/hyphen-separated tooth numbers. v23.1.35+.
+     * @param {number} [data.ProvNum] - Optional. integer. FK to provider.ProvNum. v24.2.32+.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. Whether to print a heading. v24.2.32+.
+     * @returns {Promise<DocumentItem>} - The created document record.
+     * @throws {Error} - If required fields are missing.
+     */
+    upload(data: UploadDocumentParams): Promise<DocumentItem>;
+    /**
+     * Uploads a document from an SFTP server and creates a document record.
+     * @param {UploadSftpDocumentParams} data - SFTP upload parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.SftpAddress - Required. string. Full SFTP path using forward slashes.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @param {string} [data.Description] - Optional. string. Document description. v24.2.32+.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss". v21.4+.
+     * @param {number} [data.DocCategory] - Optional. integer. FK to definitions.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Image type enum.
+     * @param {string} [data.ToothNumbers] - Optional. string. Comma/hyphen-separated tooth numbers. v23.1.35+.
+     * @param {number} [data.ProvNum] - Optional. integer. FK to provider.ProvNum. v24.2.32+.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. v24.2.32+.
+     * @returns {Promise<DocumentItem>} - The created document record.
+     * @throws {Error} - If required fields are missing.
+     */
+    uploadSftp(data: UploadSftpDocumentParams): Promise<DocumentItem>;
+    /**
+     * Creates a document record that references a file by URL.
+     * @param {SetByUrlDocumentParams} data - URL document parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.url - Required. string. URL of the file to link.
+     * @param {string} [data.Description] - Optional. string. Document description.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss". v24.2.32+.
+     * @param {number} [data.DocCategory] - Optional. integer. FK to definitions.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Image type enum.
+     * @param {string} [data.ToothNumbers] - Optional. string. Comma/hyphen-separated tooth numbers. v23.1.35+.
+     * @param {number} [data.ProvNum] - Optional. integer. FK to provider.ProvNum. v24.2.32+.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. v24.2.32+.
+     * @returns {Promise<DocumentItem>} - The created document record.
+     * @throws {Error} - If required fields are missing.
+     */
+    setByUrl(data: SetByUrlDocumentParams): Promise<DocumentItem>;
+    /**
+     * Downloads a document or mount item to an SFTP server.
+     * @param {DownloadSftpParams} data - SFTP download parameters.
+     * @param {number} [data.DocNum] - Conditional. integer. Document identifier. Required if MountNum not provided.
+     * @param {number} [data.MountNum] - Conditional. integer. Mount identifier. Required if DocNum not provided.
+     * @param {string} data.SftpAddress - Required. string. SFTP destination path.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @returns {Promise<void>} - Resolves on successful upload; Location header contains full filepath.
+     * @throws {Error} - If required fields are missing or neither DocNum nor MountNum is provided.
+     */
+    downloadSftp(data: DownloadSftpParams): Promise<void>;
+    /**
+     * Uploads thumbnail images for all documents of a patient to an SFTP server.
+     * @param {ThumbnailsParams} data - Thumbnails parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.SftpAddress - Required. string. SFTP destination path.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @returns {Promise<DocumentThumbnailRef[]>} - Array of objects with DocNum and FileName.
+     * @throws {Error} - If required fields are missing.
+     */
+    thumbnails(data: ThumbnailsParams): Promise<DocumentThumbnailRef[]>;
+    /**
+     * Downloads all images from a mount to an SFTP server.
+     * @param {DownloadMountParams} data - DownloadMount parameters.
+     * @param {number} data.MountNum - Required. integer. Mount identifier; FK to mount.MountNum.
+     * @param {string} data.SftpAddress - Required. string. SFTP destination path.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @returns {Promise<DocumentThumbnailRef[]>} - Array of objects with DocNum and FileName.
+     * @throws {Error} - If required fields are missing.
+     */
+    downloadMount(data: DownloadMountParams): Promise<DocumentThumbnailRef[]>;
+    /**
+     * Updates metadata on an existing document record.
+     * @param {UpdateDocumentParams} data - Update parameters.
+     * @param {number} data.DocNum - Required. integer. Document identifier (PK).
+     * @param {string} [data.Description] - Optional. string. Updated description.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss".
+     * @param {number} [data.DocCategory] - Optional. integer. Updated category definition number.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Updated image type.
+     * @param {string} [data.ToothNumbers] - Optional. string. Updated tooth numbers (comma/hyphen-separated).
+     * @param {number} [data.ProvNum] - Optional. integer. Updated provider identifier.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. Updated print heading flag.
+     * @returns {Promise<DocumentItem>} - The updated document record.
+     * @throws {Error} - If DocNum is not provided.
+     */
+    updateDocument(data: UpdateDocumentParams): Promise<DocumentItem>;
+    /**
+     * Deletes a document record.
+     * @param {number} DocNum - Required. integer. Document identifier (PK).
+     * @returns {Promise<void>} - Resolves when the document is deleted.
+     * @throws {Error} - If DocNum is not a valid number.
+     */
+    deleteDocument(DocNum: number): Promise<void>;
+}
+//# sourceMappingURL=documents.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/api/documents.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAQ/D;;;;;;OAMG;IACU,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAQ9E;;;;;;;;;;;;;;;OAeG;IACU,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IActE;;;;;;;;;;;;;;;;;OAiBG;IACU,UAAU,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,YAAY,CAAC;IAiB9E;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC;IAW1E;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBlE;;;;;;;;;;OAUG;IACU,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAiBhF;;;;;;;;;;OAUG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAiBtF;;;;;;;;;;;;;OAaG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAS9E;;;;;OAKG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO3D"}

package/dist/api/documents.js

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Documents {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single document record by its identifier.
+     * @param {number} DocNum - Required. integer. Document identifier (PK).
+     * @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<DocumentItem>} - The document record.
+     * @throws {Error} - If DocNum is not a valid number.
+     */
+    async getDocument(DocNum) {
+        if (!DocNum || typeof DocNum !== "number") {
+            throw new Error("Invalid parameter: DocNum must be a valid number.");
+        }
+        return this.httpClient.get(`/documents/${DocNum}`);
+    }
+    /**
+     * Retrieves all document records for a patient, ordered by DateCreated.
+     * @param {GetDocumentsParams} params - Query parameters.
+     * @param {number} params.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @returns {Promise<DocumentItem[]>} - Array of document records.
+     * @throws {Error} - If PatNum is not provided.
+     */
+    async getDocuments(params) {
+        if (!params.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        return this.httpClient.get("/documents", params);
+    }
+    /**
+     * Uploads a document as a Base64-encoded file and creates a document record.
+     * @param {UploadDocumentParams} data - Upload parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.rawBase64 - Required. string. Base64-encoded file content.
+     * @param {string} data.extension - Required. string. File extension (e.g., ".jpg", ".pdf").
+     * @param {string} [data.Description] - Optional. string. Document description.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss".
+     * @param {number} [data.DocCategory] - Optional. integer. FK to definitions.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Default: "Document".
+     * @param {string} [data.ToothNumbers] - Optional. string. Comma/hyphen-separated tooth numbers. v23.1.35+.
+     * @param {number} [data.ProvNum] - Optional. integer. FK to provider.ProvNum. v24.2.32+.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. Whether to print a heading. v24.2.32+.
+     * @returns {Promise<DocumentItem>} - The created document record.
+     * @throws {Error} - If required fields are missing.
+     */
+    async upload(data) {
+        if (!data.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        if (!data.rawBase64) {
+            throw new Error("Invalid parameter: rawBase64 is required.");
+        }
+        if (!data.extension) {
+            throw new Error("Invalid parameter: extension is required.");
+        }
+        return this.httpClient.post("/documents/Upload", data);
+    }
+    /**
+     * Uploads a document from an SFTP server and creates a document record.
+     * @param {UploadSftpDocumentParams} data - SFTP upload parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.SftpAddress - Required. string. Full SFTP path using forward slashes.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @param {string} [data.Description] - Optional. string. Document description. v24.2.32+.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss". v21.4+.
+     * @param {number} [data.DocCategory] - Optional. integer. FK to definitions.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Image type enum.
+     * @param {string} [data.ToothNumbers] - Optional. string. Comma/hyphen-separated tooth numbers. v23.1.35+.
+     * @param {number} [data.ProvNum] - Optional. integer. FK to provider.ProvNum. v24.2.32+.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. v24.2.32+.
+     * @returns {Promise<DocumentItem>} - The created document record.
+     * @throws {Error} - If required fields are missing.
+     */
+    async uploadSftp(data) {
+        if (!data.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        if (!data.SftpAddress) {
+            throw new Error("Invalid parameter: SftpAddress is required.");
+        }
+        if (!data.SftpUsername) {
+            throw new Error("Invalid parameter: SftpUsername is required.");
+        }
+        if (!data.SftpPassword) {
+            throw new Error("Invalid parameter: SftpPassword is required.");
+        }
+        return this.httpClient.post("/documents/UploadSftp", data);
+    }
+    /**
+     * Creates a document record that references a file by URL.
+     * @param {SetByUrlDocumentParams} data - URL document parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.url - Required. string. URL of the file to link.
+     * @param {string} [data.Description] - Optional. string. Document description.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss". v24.2.32+.
+     * @param {number} [data.DocCategory] - Optional. integer. FK to definitions.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Image type enum.
+     * @param {string} [data.ToothNumbers] - Optional. string. Comma/hyphen-separated tooth numbers. v23.1.35+.
+     * @param {number} [data.ProvNum] - Optional. integer. FK to provider.ProvNum. v24.2.32+.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. v24.2.32+.
+     * @returns {Promise<DocumentItem>} - The created document record.
+     * @throws {Error} - If required fields are missing.
+     */
+    async setByUrl(data) {
+        if (!data.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        if (!data.url) {
+            throw new Error("Invalid parameter: url is required.");
+        }
+        return this.httpClient.post("/documents/SetByUrl", data);
+    }
+    /**
+     * Downloads a document or mount item to an SFTP server.
+     * @param {DownloadSftpParams} data - SFTP download parameters.
+     * @param {number} [data.DocNum] - Conditional. integer. Document identifier. Required if MountNum not provided.
+     * @param {number} [data.MountNum] - Conditional. integer. Mount identifier. Required if DocNum not provided.
+     * @param {string} data.SftpAddress - Required. string. SFTP destination path.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @returns {Promise<void>} - Resolves on successful upload; Location header contains full filepath.
+     * @throws {Error} - If required fields are missing or neither DocNum nor MountNum is provided.
+     */
+    async downloadSftp(data) {
+        if (!data.DocNum && !data.MountNum) {
+            throw new Error("Invalid parameter: Either DocNum or MountNum is required.");
+        }
+        if (!data.SftpAddress) {
+            throw new Error("Invalid parameter: SftpAddress is required.");
+        }
+        if (!data.SftpUsername) {
+            throw new Error("Invalid parameter: SftpUsername is required.");
+        }
+        if (!data.SftpPassword) {
+            throw new Error("Invalid parameter: SftpPassword is required.");
+        }
+        return this.httpClient.post("/documents/DownloadSftp", data);
+    }
+    /**
+     * Uploads thumbnail images for all documents of a patient to an SFTP server.
+     * @param {ThumbnailsParams} data - Thumbnails parameters.
+     * @param {number} data.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {string} data.SftpAddress - Required. string. SFTP destination path.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @returns {Promise<DocumentThumbnailRef[]>} - Array of objects with DocNum and FileName.
+     * @throws {Error} - If required fields are missing.
+     */
+    async thumbnails(data) {
+        if (!data.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        if (!data.SftpAddress) {
+            throw new Error("Invalid parameter: SftpAddress is required.");
+        }
+        if (!data.SftpUsername) {
+            throw new Error("Invalid parameter: SftpUsername is required.");
+        }
+        if (!data.SftpPassword) {
+            throw new Error("Invalid parameter: SftpPassword is required.");
+        }
+        return this.httpClient.post("/documents/Thumbnails", data);
+    }
+    /**
+     * Downloads all images from a mount to an SFTP server.
+     * @param {DownloadMountParams} data - DownloadMount parameters.
+     * @param {number} data.MountNum - Required. integer. Mount identifier; FK to mount.MountNum.
+     * @param {string} data.SftpAddress - Required. string. SFTP destination path.
+     * @param {string} data.SftpUsername - Required. string. SFTP username.
+     * @param {string} data.SftpPassword - Required. string. SFTP password.
+     * @param {number} [data.SftpPort] - Optional. integer. SFTP port; default 22. v25.4.45+.
+     * @returns {Promise<DocumentThumbnailRef[]>} - Array of objects with DocNum and FileName.
+     * @throws {Error} - If required fields are missing.
+     */
+    async downloadMount(data) {
+        if (!data.MountNum) {
+            throw new Error("Invalid parameter: MountNum is required.");
+        }
+        if (!data.SftpAddress) {
+            throw new Error("Invalid parameter: SftpAddress is required.");
+        }
+        if (!data.SftpUsername) {
+            throw new Error("Invalid parameter: SftpUsername is required.");
+        }
+        if (!data.SftpPassword) {
+            throw new Error("Invalid parameter: SftpPassword is required.");
+        }
+        return this.httpClient.post("/documents/DownloadMount", data);
+    }
+    /**
+     * Updates metadata on an existing document record.
+     * @param {UpdateDocumentParams} data - Update parameters.
+     * @param {number} data.DocNum - Required. integer. Document identifier (PK).
+     * @param {string} [data.Description] - Optional. string. Updated description.
+     * @param {string} [data.DateCreated] - Optional. string. Format: "yyyy-MM-dd HH:mm:ss".
+     * @param {number} [data.DocCategory] - Optional. integer. Updated category definition number.
+     * @param {"Photo"|"Document"|"Radiograph"|"File"|"Attachment"} [data.ImgType] - Optional. Updated image type.
+     * @param {string} [data.ToothNumbers] - Optional. string. Updated tooth numbers (comma/hyphen-separated).
+     * @param {number} [data.ProvNum] - Optional. integer. Updated provider identifier.
+     * @param {boolean} [data.PrintHeading] - Optional. boolean. Updated print heading flag.
+     * @returns {Promise<DocumentItem>} - The updated document record.
+     * @throws {Error} - If DocNum is not provided.
+     */
+    async updateDocument(data) {
+        if (!data.DocNum || typeof data.DocNum !== "number") {
+            throw new Error("Invalid parameter: DocNum is required.");
+        }
+        const { DocNum, ...body } = data;
+        return this.httpClient.put(`/documents/${DocNum}`, body);
+    }
+    /**
+     * Deletes a document record.
+     * @param {number} DocNum - Required. integer. Document identifier (PK).
+     * @returns {Promise<void>} - Resolves when the document is deleted.
+     * @throws {Error} - If DocNum is not a valid number.
+     */
+    async deleteDocument(DocNum) {
+        if (!DocNum || typeof DocNum !== "number") {
+            throw new Error("Invalid parameter: DocNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/documents/${DocNum}`);
+    }
+}
+exports.default = Documents;

package/dist/api/eTrans.d.ts

@@ -0,0 +1,20 @@
+import HttpClient from "../utils/httpClient";
+import { CreateETransParams } from "../types/eTransTypes";
+export default class ETrans {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Creates one Etrans record of the type ERA 835.
+     * Returns 201 Created with no response body.
+     * @param {CreateETransParams} data - ERA 835 transaction parameters.
+     * @param {string} data.DateTimeTrans - Required. string. Transaction timestamp.
+     * @param {number} data.HqClearinghouseNum - Required. integer. Clearinghouse identifier; FK to hqclearinghouse.
+     * @param {string} data.MessageText - Required. string. ERA 835 EDI message content; must begin with "ISA" segment.
+     * @param {number} data.UserNum - Required. integer. User identifier; FK to userod.UserNum.
+     * @returns {Promise<void>} - Resolves on successful creation (no response body returned).
+     * @throws {Error} - If any required field is missing.
+     * @see https://www.opendental.com/site/apietrans.html
+     */
+    createETrans(data: CreateETransParams): Promise<void>;
+}
+//# sourceMappingURL=eTrans.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eTrans.d.ts","sourceRoot":"","sources":["../../src/api/eTrans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBnE"}

package/dist/api/eTrans.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ETrans {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Creates one Etrans record of the type ERA 835.
+     * Returns 201 Created with no response body.
+     * @param {CreateETransParams} data - ERA 835 transaction parameters.
+     * @param {string} data.DateTimeTrans - Required. string. Transaction timestamp.
+     * @param {number} data.HqClearinghouseNum - Required. integer. Clearinghouse identifier; FK to hqclearinghouse.
+     * @param {string} data.MessageText - Required. string. ERA 835 EDI message content; must begin with "ISA" segment.
+     * @param {number} data.UserNum - Required. integer. User identifier; FK to userod.UserNum.
+     * @returns {Promise<void>} - Resolves on successful creation (no response body returned).
+     * @throws {Error} - If any required field is missing.
+     * @see https://www.opendental.com/site/apietrans.html
+     */
+    async createETrans(data) {
+        if (!data.DateTimeTrans) {
+            throw new Error("Invalid parameter: DateTimeTrans is required.");
+        }
+        if (!data.HqClearinghouseNum) {
+            throw new Error("Invalid parameter: HqClearinghouseNum is required.");
+        }
+        if (!data.MessageText) {
+            throw new Error("Invalid parameter: MessageText is required.");
+        }
+        if (!data.UserNum) {
+            throw new Error("Invalid parameter: UserNum is required.");
+        }
+        return this.httpClient.post("/etrans", data);
+    }
+}
+exports.default = ETrans;

package/dist/api/eTransMessageTexts.d.ts

@@ -0,0 +1,15 @@
+import HttpClient from "../utils/httpClient";
+import { ETransMessageTextItem } from "../types/eTransMessageTextTypes";
+export default class ETransMessageTexts {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single EtransMessageText record containing the full EDI message.
+     * @param {number} EtransMessageTextNum - Required. integer. Message text identifier (PK).
+     * @returns {Promise<ETransMessageTextItem>} - The EtransMessageText record with the full X12 EDI message.
+     * @throws {Error} - If EtransMessageTextNum is not a valid number.
+     * @see https://www.opendental.com/site/apietransmessagetexts.html
+     */
+    getETransMessageText(EtransMessageTextNum: number): Promise<ETransMessageTextItem>;
+}
+//# sourceMappingURL=eTransMessageTexts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eTransMessageTexts.d.ts","sourceRoot":"","sources":["../../src/api/eTransMessageTexts.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,oBAAoB,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAOhG"}

package/dist/api/eTransMessageTexts.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ETransMessageTexts {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single EtransMessageText record containing the full EDI message.
+     * @param {number} EtransMessageTextNum - Required. integer. Message text identifier (PK).
+     * @returns {Promise<ETransMessageTextItem>} - The EtransMessageText record with the full X12 EDI message.
+     * @throws {Error} - If EtransMessageTextNum is not a valid number.
+     * @see https://www.opendental.com/site/apietransmessagetexts.html
+     */
+    async getETransMessageText(EtransMessageTextNum) {
+        if (!EtransMessageTextNum || typeof EtransMessageTextNum !== "number") {
+            throw new Error("Invalid parameter: EtransMessageTextNum must be a valid number.");
+        }
+        return this.httpClient.get(`/etransmessagetexts/${EtransMessageTextNum}`);
+    }
+}
+exports.default = ETransMessageTexts;

package/dist/api/eTranss.d.ts

@@ -0,0 +1,22 @@
+import HttpClient from "../utils/httpClient";
+import { ETranssItem, GetETranssParams } from "../types/eTranssTypes";
+export default class ETranss {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves all electronic transaction records for a patient, with optional filtering by carrier or claim.
+     * @param {GetETranssParams} params - Query parameters.
+     * @param {number} params.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {number} [params.CarrierNum] - Optional. integer. Filter by carrier; FK to Carrier.CarrierNum.
+     * @param {number} [params.ClaimNum] - Optional. integer. Filter by claim; FK to Claim.ClaimNum.
+     * @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<ETranssItem[]>} - Array of electronic transaction records.
+     * @throws {Error} - If PatNum is not provided.
+     * @see https://www.opendental.com/site/apietranss.html
+     */
+    getETranss(params: GetETranssParams): Promise<ETranssItem[]>;
+}
+//# sourceMappingURL=eTranss.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eTranss.d.ts","sourceRoot":"","sources":["../../src/api/eTranss.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEtE,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;;;OAaG;IACU,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;CAO1E"}

package/dist/api/eTranss.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ETranss {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves all electronic transaction records for a patient, with optional filtering by carrier or claim.
+     * @param {GetETranssParams} params - Query parameters.
+     * @param {number} params.PatNum - Required. integer. Patient identifier; FK to patient.PatNum.
+     * @param {number} [params.CarrierNum] - Optional. integer. Filter by carrier; FK to Carrier.CarrierNum.
+     * @param {number} [params.ClaimNum] - Optional. integer. Filter by claim; FK to Claim.ClaimNum.
+     * @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<ETranssItem[]>} - Array of electronic transaction records.
+     * @throws {Error} - If PatNum is not provided.
+     * @see https://www.opendental.com/site/apietranss.html
+     */
+    async getETranss(params) {
+        if (!params.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        return this.httpClient.get("/etranss", params);
+    }
+}
+exports.default = ETranss;

package/dist/api/ehrPatients.d.ts

@@ -0,0 +1,29 @@
+import HttpClient from "../utils/httpClient";
+import { EhrPatient, UpdateEhrPatientParams } from "../types/ehrPatientTypes";
+export default class EhrPatients {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves the EHR patient record for a given patient.
+     * One record exists per patient, created automatically with the patient.
+     * @param {number} PatNum - Required. Patient identifier (FK to patient).
+     * @returns {Promise<EhrPatient>} - The EHR patient record.
+     * @throws {Error} - If PatNum is not a valid number.
+     * @see https://www.opendental.com/site/apiehrpatients.html
+     */
+    getEhrPatient(PatNum: number): Promise<EhrPatient>;
+    /**
+     * Updates the EHR patient record for a given patient.
+     * Only DischargeDate and MedicaidState are currently writable; all other fields
+     * must be managed through the Open Dental UI.
+     * @param {Object} data - The fields to update.
+     * @param {number} data.PatNum - Required. Patient identifier (FK to patient).
+     * @param {string} [data.DischargeDate] - Optional. Patient discharge date (format: "yyyy-MM-dd").
+     * @param {string} [data.MedicaidState] - Optional. Two-character state abbreviation for Medicaid ID (added v24.4.13).
+     * @returns {Promise<EhrPatient>} - The updated EHR patient record.
+     * @throws {Error} - If PatNum is not a valid number.
+     * @see https://www.opendental.com/site/apiehrpatients.html
+     */
+    updateEhrPatient(data: UpdateEhrPatientParams): Promise<EhrPatient>;
+}
+//# sourceMappingURL=ehrPatients.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ehrPatients.d.ts","sourceRoot":"","sources":["../../src/api/ehrPatients.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;OAOG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQ/D;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;CAQjF"}

package/dist/api/ehrPatients.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class EhrPatients {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves the EHR patient record for a given patient.
+     * One record exists per patient, created automatically with the patient.
+     * @param {number} PatNum - Required. Patient identifier (FK to patient).
+     * @returns {Promise<EhrPatient>} - The EHR patient record.
+     * @throws {Error} - If PatNum is not a valid number.
+     * @see https://www.opendental.com/site/apiehrpatients.html
+     */
+    async getEhrPatient(PatNum) {
+        if (!PatNum || typeof PatNum !== "number") {
+            throw new Error("Invalid parameter: A valid PatNum is required.");
+        }
+        return this.httpClient.get(`/ehrpatients/${PatNum}`);
+    }
+    /**
+     * Updates the EHR patient record for a given patient.
+     * Only DischargeDate and MedicaidState are currently writable; all other fields
+     * must be managed through the Open Dental UI.
+     * @param {Object} data - The fields to update.
+     * @param {number} data.PatNum - Required. Patient identifier (FK to patient).
+     * @param {string} [data.DischargeDate] - Optional. Patient discharge date (format: "yyyy-MM-dd").
+     * @param {string} [data.MedicaidState] - Optional. Two-character state abbreviation for Medicaid ID (added v24.4.13).
+     * @returns {Promise<EhrPatient>} - The updated EHR patient record.
+     * @throws {Error} - If PatNum is not a valid number.
+     * @see https://www.opendental.com/site/apiehrpatients.html
+     */
+    async updateEhrPatient(data) {
+        if (!data.PatNum || typeof data.PatNum !== "number") {
+            throw new Error("Invalid parameter: A valid PatNum is required.");
+        }
+        const { PatNum, ...body } = data;
+        return this.httpClient.put(`/ehrpatients/${PatNum}`, body);
+    }
+}
+exports.default = EhrPatients;