@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/sheetDefs.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class SheetDefs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single SheetDef template by its identifier.
+     * @param {number} SheetDefNum - Required. SheetDef primary key.
+     * @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<SheetDefItem>} The SheetDef object.
+     * @throws {Error} If SheetDefNum is not provided.
+     * @see https://www.opendental.com/site/apisheetdefs.html
+     */
+    async getSheetDef(SheetDefNum) {
+        if (!SheetDefNum) {
+            throw new Error("Invalid parameter: SheetDefNum is required.");
+        }
+        return this.httpClient.get(`/sheetdefs/${SheetDefNum}`);
+    }
+    /**
+     * Retrieves a list of SheetDef templates with optional type filtering.
+     * @param {GetSheetDefsParams} [params] - Optional query parameters.
+     * @param {SheetTypeEnum} [params.SheetType] - Optional. Filter by SheetTypeEnum value. Added v25.1.20.
+     * @returns {Promise<SheetDefItem[]>} Array of SheetDef objects.
+     * @see https://www.opendental.com/site/apisheetdefs.html
+     */
+    async getSheetDefs(params) {
+        return this.httpClient.get("/sheetdefs", params);
+    }
+}
+exports.default = SheetDefs;

package/dist/api/sheetFields.d.ts

@@ -0,0 +1,38 @@
+import HttpClient from "../utils/httpClient";
+import { SheetFieldItem, GetSheetFieldsParams, UpdateSheetFieldParams } from "../types/sheetFieldTypes";
+export default class SheetFields {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single SheetField record by its identifier.
+     * @param {number} SheetFieldNum - Required. SheetField primary key.
+     * @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<SheetFieldItem>} The SheetField object.
+     * @throws {Error} If SheetFieldNum is not provided.
+     * @see https://www.opendental.com/site/apisheetfields.html
+     */
+    getSheetField(SheetFieldNum: number): Promise<SheetFieldItem>;
+    /**
+     * Retrieves all SheetFields, optionally filtered by sheet.
+     * @param {GetSheetFieldsParams} [params] - Optional query parameters.
+     * @param {number} [params.SheetNum] - Optional. FK to sheet.SheetNum. Required before v25.2.3.
+     * @param {number} [params.Offset] - Optional. Pagination offset. Default 0.
+     * @returns {Promise<SheetFieldItem[]>} Array of SheetField objects.
+     * @see https://www.opendental.com/site/apisheetfields.html
+     */
+    getSheetFields(params?: GetSheetFieldsParams): Promise<SheetFieldItem[]>;
+    /**
+     * Updates the value of a SheetField.
+     * Only supported for OutputText, InputField, and CheckBox field types.
+     * @param {UpdateSheetFieldParams} data - Update parameters.
+     * @param {number} data.SheetFieldNum - Required. SheetField primary key.
+     * @param {string} [data.FieldValue] - Optional. Updated field value. For CheckBox: "X" = checked, "" = unchecked.
+     * @returns {Promise<SheetFieldItem>} The updated SheetField object.
+     * @throws {Error} If SheetFieldNum is not provided.
+     * @see https://www.opendental.com/site/apisheetfields.html
+     */
+    updateSheetField(data: UpdateSheetFieldParams): Promise<SheetFieldItem>;
+}
+//# sourceMappingURL=sheetFields.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sheetFields.d.ts","sourceRoot":"","sources":["../../src/api/sheetFields.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAO1E;;;;;;;OAOG;IACU,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIrF;;;;;;;;;OASG;IACU,gBAAgB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;CAOrF"}

package/dist/api/sheetFields.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class SheetFields {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single SheetField record by its identifier.
+     * @param {number} SheetFieldNum - Required. SheetField primary key.
+     * @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<SheetFieldItem>} The SheetField object.
+     * @throws {Error} If SheetFieldNum is not provided.
+     * @see https://www.opendental.com/site/apisheetfields.html
+     */
+    async getSheetField(SheetFieldNum) {
+        if (!SheetFieldNum) {
+            throw new Error("Invalid parameter: SheetFieldNum is required.");
+        }
+        return this.httpClient.get(`/sheetfields/${SheetFieldNum}`);
+    }
+    /**
+     * Retrieves all SheetFields, optionally filtered by sheet.
+     * @param {GetSheetFieldsParams} [params] - Optional query parameters.
+     * @param {number} [params.SheetNum] - Optional. FK to sheet.SheetNum. Required before v25.2.3.
+     * @param {number} [params.Offset] - Optional. Pagination offset. Default 0.
+     * @returns {Promise<SheetFieldItem[]>} Array of SheetField objects.
+     * @see https://www.opendental.com/site/apisheetfields.html
+     */
+    async getSheetFields(params) {
+        return this.httpClient.get("/sheetfields", params);
+    }
+    /**
+     * Updates the value of a SheetField.
+     * Only supported for OutputText, InputField, and CheckBox field types.
+     * @param {UpdateSheetFieldParams} data - Update parameters.
+     * @param {number} data.SheetFieldNum - Required. SheetField primary key.
+     * @param {string} [data.FieldValue] - Optional. Updated field value. For CheckBox: "X" = checked, "" = unchecked.
+     * @returns {Promise<SheetFieldItem>} The updated SheetField object.
+     * @throws {Error} If SheetFieldNum is not provided.
+     * @see https://www.opendental.com/site/apisheetfields.html
+     */
+    async updateSheetField(data) {
+        if (!data.SheetFieldNum) {
+            throw new Error("Invalid parameter: SheetFieldNum is required.");
+        }
+        const { SheetFieldNum, ...body } = data;
+        return this.httpClient.put(`/sheetfields/${SheetFieldNum}`, body);
+    }
+}
+exports.default = SheetFields;

package/dist/api/sheets.d.ts

@@ -0,0 +1,47 @@
+import HttpClient from "../utils/httpClient";
+import { SheetItem, GetSheetsParams, CreateSheetParams, DownloadSftpParams, DownloadSftpResponse } from "../types/sheetTypes";
+export default class Sheets {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves all sheets for a single patient.
+     * @param {GetSheetsParams} params - Query parameters.
+     * @param {number} params.PatNum - Required. FK to patient.PatNum.
+     * @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<SheetItem[]>} Array of Sheet objects for the patient.
+     * @throws {Error} If PatNum is not provided.
+     * @see https://www.opendental.com/site/apisheets.html
+     */
+    getSheets(params: GetSheetsParams): Promise<SheetItem[]>;
+    /**
+     * Creates a new sheet for a patient using an existing SheetDef template.
+     * Supported SheetTypes: "Consent", "PatientLetter", "PatientForm", "MedicalHistory", and "ExamSheet".
+     * @param {CreateSheetParams} data - Body parameters.
+     * @param {number} data.SheetDefNum - Required. FK to sheetdef.SheetDefNum.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.InternalNote] - Optional. Internal staff note (not printed).
+     * @returns {Promise<SheetItem>} The created Sheet object.
+     * @throws {Error} If SheetDefNum or PatNum is not provided.
+     * @see https://www.opendental.com/site/apisheets.html
+     */
+    createSheet(data: CreateSheetParams): Promise<SheetItem>;
+    /**
+     * Converts a sheet to PDF and uploads it to an SFTP server.
+     * Existing files at the target path are overwritten without warning.
+     * Default filename if not specified in SftpAddress: "sheet.pdf".
+     * @param {DownloadSftpParams} data - Body parameters.
+     * @param {number} data.SheetNum - Required. Sheet identifier to convert and upload.
+     * @param {string} data.SftpAddress - Required. Full SFTP destination path including filename.
+     * @param {string} data.SftpUsername - Required. SFTP authentication username.
+     * @param {string} data.SftpPassword - Required. SFTP authentication password.
+     * @param {number} [data.SftpPort] - Optional. SFTP port. Defaults to 22. Added v25.4.45.
+     * @returns {Promise<DownloadSftpResponse>} Object with `location` field containing the full remote filepath.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apisheets.html
+     */
+    downloadSftp(data: DownloadSftpParams): Promise<DownloadSftpResponse>;
+}
+//# sourceMappingURL=sheets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sheets.d.ts","sourceRoot":"","sources":["../../src/api/sheets.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAOrE;;;;;;;;;;OAUG;IACU,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC;IAOrE;;;;;;;;;;;;;OAaG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAMnF"}

package/dist/api/sheets.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Sheets {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves all sheets for a single patient.
+     * @param {GetSheetsParams} params - Query parameters.
+     * @param {number} params.PatNum - Required. FK to patient.PatNum.
+     * @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<SheetItem[]>} Array of Sheet objects for the patient.
+     * @throws {Error} If PatNum is not provided.
+     * @see https://www.opendental.com/site/apisheets.html
+     */
+    async getSheets(params) {
+        if (!params.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        return this.httpClient.get("/sheets", params);
+    }
+    /**
+     * Creates a new sheet for a patient using an existing SheetDef template.
+     * Supported SheetTypes: "Consent", "PatientLetter", "PatientForm", "MedicalHistory", and "ExamSheet".
+     * @param {CreateSheetParams} data - Body parameters.
+     * @param {number} data.SheetDefNum - Required. FK to sheetdef.SheetDefNum.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.InternalNote] - Optional. Internal staff note (not printed).
+     * @returns {Promise<SheetItem>} The created Sheet object.
+     * @throws {Error} If SheetDefNum or PatNum is not provided.
+     * @see https://www.opendental.com/site/apisheets.html
+     */
+    async createSheet(data) {
+        if (!data.SheetDefNum || !data.PatNum) {
+            throw new Error("Invalid parameter: SheetDefNum and PatNum are required.");
+        }
+        return this.httpClient.post("/sheets", data);
+    }
+    /**
+     * Converts a sheet to PDF and uploads it to an SFTP server.
+     * Existing files at the target path are overwritten without warning.
+     * Default filename if not specified in SftpAddress: "sheet.pdf".
+     * @param {DownloadSftpParams} data - Body parameters.
+     * @param {number} data.SheetNum - Required. Sheet identifier to convert and upload.
+     * @param {string} data.SftpAddress - Required. Full SFTP destination path including filename.
+     * @param {string} data.SftpUsername - Required. SFTP authentication username.
+     * @param {string} data.SftpPassword - Required. SFTP authentication password.
+     * @param {number} [data.SftpPort] - Optional. SFTP port. Defaults to 22. Added v25.4.45.
+     * @returns {Promise<DownloadSftpResponse>} Object with `location` field containing the full remote filepath.
+     * @throws {Error} If any required field is missing.
+     * @see https://www.opendental.com/site/apisheets.html
+     */
+    async downloadSftp(data) {
+        if (!data.SheetNum || !data.SftpAddress || !data.SftpUsername || !data.SftpPassword) {
+            throw new Error("Invalid parameter: SheetNum, SftpAddress, SftpUsername, and SftpPassword are required.");
+        }
+        return this.httpClient.post("/sheets/DownloadSftp", data);
+    }
+}
+exports.default = Sheets;

package/dist/api/signalODs.d.ts

@@ -0,0 +1,23 @@
+import HttpClient from "../utils/httpClient";
+import { SignalODItem, GetSignalODsParams } from "../types/signalODTypes";
+export default class SignalODs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Returns all Signalod entries that exist after the given SigDateTime.
+     * Use the returned `serverDateTime` as the input for subsequent requests to implement polling.
+     * An empty array is returned when no new signals exist — this is normal, not an error.
+     * @param {GetSignalODsParams} params - Query parameters.
+     * @param {string} params.SigDateTime - Required. Returns all signals after this datetime.
+     *   Store the returned `serverDateTime` and pass it here on each subsequent call.
+     * @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<SignalODItem[]>} Array of SignalOD objects (may be empty).
+     * @throws {Error} If SigDateTime is not provided.
+     * @see https://www.opendental.com/site/apisignalods.html
+     */
+    getSignalODs(params: GetSignalODsParams): Promise<SignalODItem[]>;
+}
+//# sourceMappingURL=signalODs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"signalODs.d.ts","sourceRoot":"","sources":["../../src/api/signalODs.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;;;;;;;;;;;;;;OAcG;IACU,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAM/E"}

package/dist/api/signalODs.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class SignalODs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Returns all Signalod entries that exist after the given SigDateTime.
+     * Use the returned `serverDateTime` as the input for subsequent requests to implement polling.
+     * An empty array is returned when no new signals exist — this is normal, not an error.
+     * @param {GetSignalODsParams} params - Query parameters.
+     * @param {string} params.SigDateTime - Required. Returns all signals after this datetime.
+     *   Store the returned `serverDateTime` and pass it here on each subsequent call.
+     * @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<SignalODItem[]>} Array of SignalOD objects (may be empty).
+     * @throws {Error} If SigDateTime is not provided.
+     * @see https://www.opendental.com/site/apisignalods.html
+     */
+    async getSignalODs(params) {
+        if (!params.SigDateTime) {
+            throw new Error("Invalid parameter: SigDateTime is required.");
+        }
+        return this.httpClient.get("/signalods", params);
+    }
+}
+exports.default = SignalODs;

package/dist/api/statements.d.ts

@@ -0,0 +1,48 @@
+import HttpClient from "../utils/httpClient";
+import { StatementItem, GetStatementsParams, CreateStatementParams } from "../types/statementTypes";
+export default class Statements {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single statement record by primary key.
+     * @param {number} StatementNum - Required. Primary key of the statement.
+     * @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<StatementItem>} - The statement record.
+     * @throws {Error} - If StatementNum is not a valid number.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    getStatement(StatementNum: number): Promise<StatementItem>;
+    /**
+     * Retrieves multiple statement records, optionally filtered by patient.
+     * @param {GetStatementsParams} [params] - Optional filtering parameters.
+     * @param {number} [params.PatNum] - Optional. Filters results to statements for a specific patient.
+     * @returns {Promise<StatementItem[]>} - Array of statement records.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    getStatements({ PatNum, Limit, DateFormatString, DateTimeFormatString, }?: GetStatementsParams): Promise<StatementItem[]>;
+    /**
+     * Creates a statement entry in the Account Module ledger.
+     * Does not impact billing processing.
+     * @param {CreateStatementParams} data - Required body parameters.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.DateSent] - Optional. Format "yyyy-MM-dd"; defaults to current date.
+     * @param {string} [data.Note] - Optional. Statement note; defaults to empty string.
+     * @param {number} [data.DocNum] - Optional. FK to document.DocNum; defaults to 0.
+     * @returns {Promise<StatementItem>} - The created statement record with assigned StatementNum.
+     * @throws {Error} - If PatNum is missing.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    createStatement(data: CreateStatementParams): Promise<StatementItem>;
+    /**
+     * Deletes a statement record. Only API-mode statements (Mode_ = "API") may be deleted.
+     * @param {number} StatementNum - Required. Primary key of the statement to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} - If StatementNum is not a valid number.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    deleteStatement(StatementNum: number): Promise<void>;
+}
+//# sourceMappingURL=statements.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"statements.d.ts","sourceRoot":"","sources":["../../src/api/statements.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQvE;;;;;;OAMG;IACU,aAAa,CAAC,EAAE,MAAM,EACjC,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,mBAAwB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IASpD;;;;;;;;;;;OAWG;IACU,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQjF;;;;;;OAMG;IACU,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOlE"}

package/dist/api/statements.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Statements {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single statement record by primary key.
+     * @param {number} StatementNum - Required. Primary key of the statement.
+     * @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<StatementItem>} - The statement record.
+     * @throws {Error} - If StatementNum is not a valid number.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    async getStatement(StatementNum) {
+        if (!StatementNum || typeof StatementNum !== "number") {
+            throw new Error("Invalid parameter: StatementNum must be a valid number.");
+        }
+        return this.httpClient.get(`/statements/${StatementNum}`);
+    }
+    /**
+     * Retrieves multiple statement records, optionally filtered by patient.
+     * @param {GetStatementsParams} [params] - Optional filtering parameters.
+     * @param {number} [params.PatNum] - Optional. Filters results to statements for a specific patient.
+     * @returns {Promise<StatementItem[]>} - Array of statement records.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    async getStatements({ PatNum, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/statements", {
+            PatNum,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Creates a statement entry in the Account Module ledger.
+     * Does not impact billing processing.
+     * @param {CreateStatementParams} data - Required body parameters.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.DateSent] - Optional. Format "yyyy-MM-dd"; defaults to current date.
+     * @param {string} [data.Note] - Optional. Statement note; defaults to empty string.
+     * @param {number} [data.DocNum] - Optional. FK to document.DocNum; defaults to 0.
+     * @returns {Promise<StatementItem>} - The created statement record with assigned StatementNum.
+     * @throws {Error} - If PatNum is missing.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    async createStatement(data) {
+        if (!data.PatNum) {
+            throw new Error("Invalid parameter: PatNum is required.");
+        }
+        return this.httpClient.post("/statements", data);
+    }
+    /**
+     * Deletes a statement record. Only API-mode statements (Mode_ = "API") may be deleted.
+     * @param {number} StatementNum - Required. Primary key of the statement to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} - If StatementNum is not a valid number.
+     * @see https://www.opendental.com/site/apistatements.html
+     */
+    async deleteStatement(StatementNum) {
+        if (!StatementNum || typeof StatementNum !== "number") {
+            throw new Error("Invalid parameter: StatementNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/statements/${StatementNum}`);
+    }
+}
+exports.default = Statements;

package/dist/api/subscriptions.d.ts

@@ -0,0 +1,67 @@
+import HttpClient from "../utils/httpClient";
+import { SubscriptionItem, CreateSubscriptionParams, UpdateSubscriptionParams } from "../types/subscriptionTypes";
+export default class Subscriptions {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Creates a new subscription for database (WatchTable) or UI (UiEventType) events.
+     * When a subscribed event fires, Open Dental POSTs to the EndPointUrl.
+     * - For database subscriptions: provide WatchTable and PollingSeconds.
+     * - For UI subscriptions: provide UiEventType.
+     * Subscriptions are scoped to the authenticated API customer key.
+     * @param {CreateSubscriptionParams} data - Body parameters.
+     * @param {string} data.EndPointUrl - Required. URL to receive event POST requests.
+     * @param {string} [data.Workstation] - Conditional. Machine name. Omit to broadcast from all workstations.
+     * @param {number} [data.PollingSeconds] - Conditional. Required for WatchTable subscriptions.
+     * @param {string} [data.WatchTable] - Conditional. DB table to monitor. Required for database subscriptions.
+     * @param {string} [data.UiEventType] - Conditional. UI event type. Required for UI subscriptions.
+     * @param {string} [data.DateTimeStart] - Optional. Monitoring start time. Defaults to now.
+     * @param {string} [data.DateTimeStop] - Optional. Expiration time. Defaults to no expiration (MinVal 0001-01-01).
+     * @param {string} [data.Note] - Optional. Free-text notes.
+     * @param {Object} [params] - Optional pagination and format parameters.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<SubscriptionItem>} The created subscription object.
+     * @throws {Error} If EndPointUrl is not provided.
+     * @throws {Error} If neither WatchTable nor UiEventType is provided.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    createSubscription(data: CreateSubscriptionParams): Promise<SubscriptionItem>;
+    /**
+     * Retrieves all subscriptions associated with the authenticated API key.
+     * @returns {Promise<SubscriptionItem[]>} Array of subscription objects.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    getSubscriptions({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<SubscriptionItem[]>;
+    /**
+     * Updates an existing subscription.
+     * @param {UpdateSubscriptionParams} data - Update parameters.
+     * @param {number} data.SubscriptionNum - Required. Primary key of the subscription to update.
+     * @param {string} [data.EndPointUrl] - Optional. Updated target endpoint URL.
+     * @param {string} [data.Workstation] - Optional. Updated machine name.
+     * @param {number} [data.PollingSeconds] - Optional. Updated polling frequency (WatchTable only).
+     * @param {string} [data.DateTimeStart] - Optional. Updated start timestamp.
+     * @param {string} [data.DateTimeStop] - Optional. Updated expiration timestamp. MinVal = no expiration.
+     * @param {string} [data.Note] - Optional. Updated notes.
+     * @returns {Promise<SubscriptionItem>} The updated subscription object.
+     * @throws {Error} If SubscriptionNum is not provided.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    updateSubscription(data: UpdateSubscriptionParams): Promise<SubscriptionItem>;
+    /**
+     * Removes an existing subscription.
+     * @param {number} SubscriptionNum - Required. Primary key of the subscription to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} If SubscriptionNum is not provided.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    deleteSubscription(SubscriptionNum: number): Promise<void>;
+}
+//# sourceMappingURL=subscriptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/api/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,gBAAgB,EAChB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAa1F;;;;OAIG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACrB,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IASpC;;;;;;;;;;;;;OAaG;IACU,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQ1F;;;;;;OAMG;IACU,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMxE"}

package/dist/api/subscriptions.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Subscriptions {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Creates a new subscription for database (WatchTable) or UI (UiEventType) events.
+     * When a subscribed event fires, Open Dental POSTs to the EndPointUrl.
+     * - For database subscriptions: provide WatchTable and PollingSeconds.
+     * - For UI subscriptions: provide UiEventType.
+     * Subscriptions are scoped to the authenticated API customer key.
+     * @param {CreateSubscriptionParams} data - Body parameters.
+     * @param {string} data.EndPointUrl - Required. URL to receive event POST requests.
+     * @param {string} [data.Workstation] - Conditional. Machine name. Omit to broadcast from all workstations.
+     * @param {number} [data.PollingSeconds] - Conditional. Required for WatchTable subscriptions.
+     * @param {string} [data.WatchTable] - Conditional. DB table to monitor. Required for database subscriptions.
+     * @param {string} [data.UiEventType] - Conditional. UI event type. Required for UI subscriptions.
+     * @param {string} [data.DateTimeStart] - Optional. Monitoring start time. Defaults to now.
+     * @param {string} [data.DateTimeStop] - Optional. Expiration time. Defaults to no expiration (MinVal 0001-01-01).
+     * @param {string} [data.Note] - Optional. Free-text notes.
+     * @param {Object} [params] - Optional pagination and format parameters.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<SubscriptionItem>} The created subscription object.
+     * @throws {Error} If EndPointUrl is not provided.
+     * @throws {Error} If neither WatchTable nor UiEventType is provided.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    async createSubscription(data) {
+        if (!data.EndPointUrl) {
+            throw new Error("Invalid parameter: EndPointUrl is required.");
+        }
+        if (!data.WatchTable && !data.UiEventType) {
+            throw new Error("Invalid parameter: Either WatchTable (with PollingSeconds) or UiEventType is required.");
+        }
+        if (data.WatchTable && !data.PollingSeconds) {
+            throw new Error("Invalid parameter: PollingSeconds is required for WatchTable subscriptions.");
+        }
+        return this.httpClient.post("/subscriptions", data);
+    }
+    /**
+     * Retrieves all subscriptions associated with the authenticated API key.
+     * @returns {Promise<SubscriptionItem[]>} Array of subscription objects.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    async getSubscriptions({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
+        return this.httpClient.get("/subscriptions", {
+            Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
+        });
+    }
+    /**
+     * Updates an existing subscription.
+     * @param {UpdateSubscriptionParams} data - Update parameters.
+     * @param {number} data.SubscriptionNum - Required. Primary key of the subscription to update.
+     * @param {string} [data.EndPointUrl] - Optional. Updated target endpoint URL.
+     * @param {string} [data.Workstation] - Optional. Updated machine name.
+     * @param {number} [data.PollingSeconds] - Optional. Updated polling frequency (WatchTable only).
+     * @param {string} [data.DateTimeStart] - Optional. Updated start timestamp.
+     * @param {string} [data.DateTimeStop] - Optional. Updated expiration timestamp. MinVal = no expiration.
+     * @param {string} [data.Note] - Optional. Updated notes.
+     * @returns {Promise<SubscriptionItem>} The updated subscription object.
+     * @throws {Error} If SubscriptionNum is not provided.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    async updateSubscription(data) {
+        if (!data.SubscriptionNum) {
+            throw new Error("Invalid parameter: SubscriptionNum is required.");
+        }
+        const { SubscriptionNum, ...body } = data;
+        return this.httpClient.put(`/subscriptions/${SubscriptionNum}`, body);
+    }
+    /**
+     * Removes an existing subscription.
+     * @param {number} SubscriptionNum - Required. Primary key of the subscription to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} If SubscriptionNum is not provided.
+     * @see https://www.opendental.com/site/apisubscriptions.html
+     */
+    async deleteSubscription(SubscriptionNum) {
+        if (!SubscriptionNum) {
+            throw new Error("Invalid parameter: SubscriptionNum is required.");
+        }
+        return this.httpClient.delete(`/subscriptions/${SubscriptionNum}`);
+    }
+}
+exports.default = Subscriptions;