@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/employees.d.ts

@@ -0,0 +1,66 @@
+import HttpClient from "../utils/httpClient";
+import { Employee, GetEmployeesParams, CreateEmployeeParams, UpdateEmployeeParams } from "../types/employeeTypes";
+export default class Employees {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single employee record by its identifier.
+     * @param {number} EmployeeNum - Required. Unique employee identifier.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<Employee>} - The employee record.
+     * @throws {Error} - If EmployeeNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    getEmployee(EmployeeNum: number): Promise<Employee>;
+    /**
+     * Retrieves multiple employee records with optional filtering.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.ReportsTo] - Optional. Filter by supervisor FK to employee.EmployeeNum.
+     * @returns {Promise<Employee[]>} - Array of employee records.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    getEmployees(params?: GetEmployeesParams): Promise<Employee[]>;
+    /**
+     * Creates a new employee record (v25.4.36+).
+     * At least one of LName or FName must be provided.
+     * @param {Object} data - The details of the employee to create.
+     * @param {string} [data.LName] - Conditional. Last name; required if FName is absent.
+     * @param {string} [data.FName] - Conditional. First name; required if LName is absent.
+     * @param {string} [data.MiddleI] - Optional. Middle initial or name; default empty string.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false"; default "false".
+     * @param {string} [data.PayrollID] - Optional. Payroll ID; default empty string.
+     * @param {string} [data.WirelessPhone] - Optional. Phone number with punctuation; default empty string.
+     * @param {string} [data.EmailWork] - Optional. Work email address; default empty string.
+     * @param {string} [data.EmailPersonal] - Optional. Personal email address; default empty string.
+     * @param {string} [data.IsFurloughed] - Optional. "true" or "false"; default "false".
+     * @param {number} [data.ReportsTo] - Optional. FK to employee.EmployeeNum; default 0 (no supervisor).
+     * @returns {Promise<Employee>} - The created employee record.
+     * @throws {Error} - If neither LName nor FName is provided.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    createEmployee(data: CreateEmployeeParams): Promise<Employee>;
+    /**
+     * Updates an existing employee record (v25.4.36+).
+     * Setting both LName and FName to blank will result in 400 BadRequest.
+     * @param {Object} data - The details of the employee to update.
+     * @param {number} data.EmployeeNum - Required. Primary key of the employee to update.
+     * @param {string} [data.LName] - Optional. Last name.
+     * @param {string} [data.FName] - Optional. First name.
+     * @param {string} [data.MiddleI] - Optional. Middle initial or name.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false".
+     * @param {string} [data.PayrollID] - Optional. Payroll identification number.
+     * @param {string} [data.WirelessPhone] - Optional. Phone number with punctuation.
+     * @param {string} [data.EmailWork] - Optional. Work email address.
+     * @param {string} [data.EmailPersonal] - Optional. Personal email address.
+     * @param {string} [data.IsFurloughed] - Optional. "true" or "false".
+     * @param {number} [data.ReportsTo] - Optional. FK to employee.EmployeeNum; set to 0 to remove supervisor.
+     * @returns {Promise<Employee>} - The updated employee record.
+     * @throws {Error} - If EmployeeNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    updateEmployee(data: UpdateEmployeeParams): Promise<Employee>;
+}
+//# sourceMappingURL=employees.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"employees.d.ts","sourceRoot":"","sources":["../../src/api/employees.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,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,QAAQ,CAAC;IAQhE;;;;;;OAMG;IACU,YAAY,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI3E;;;;;;;;;;;;;;;;;OAiBG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQ1E;;;;;;;;;;;;;;;;;;OAkBG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQ3E"}

package/dist/api/employees.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Employees {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single employee record by its identifier.
+     * @param {number} EmployeeNum - Required. Unique employee identifier.
+     * @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
+     * @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
+     * @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
+     * @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
+     * @returns {Promise<Employee>} - The employee record.
+     * @throws {Error} - If EmployeeNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    async getEmployee(EmployeeNum) {
+        if (!EmployeeNum || typeof EmployeeNum !== "number") {
+            throw new Error("Invalid parameter: A valid EmployeeNum is required.");
+        }
+        return this.httpClient.get(`/employees/${EmployeeNum}`);
+    }
+    /**
+     * Retrieves multiple employee records with optional filtering.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.ReportsTo] - Optional. Filter by supervisor FK to employee.EmployeeNum.
+     * @returns {Promise<Employee[]>} - Array of employee records.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    async getEmployees(params) {
+        return this.httpClient.get("/employees", params);
+    }
+    /**
+     * Creates a new employee record (v25.4.36+).
+     * At least one of LName or FName must be provided.
+     * @param {Object} data - The details of the employee to create.
+     * @param {string} [data.LName] - Conditional. Last name; required if FName is absent.
+     * @param {string} [data.FName] - Conditional. First name; required if LName is absent.
+     * @param {string} [data.MiddleI] - Optional. Middle initial or name; default empty string.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false"; default "false".
+     * @param {string} [data.PayrollID] - Optional. Payroll ID; default empty string.
+     * @param {string} [data.WirelessPhone] - Optional. Phone number with punctuation; default empty string.
+     * @param {string} [data.EmailWork] - Optional. Work email address; default empty string.
+     * @param {string} [data.EmailPersonal] - Optional. Personal email address; default empty string.
+     * @param {string} [data.IsFurloughed] - Optional. "true" or "false"; default "false".
+     * @param {number} [data.ReportsTo] - Optional. FK to employee.EmployeeNum; default 0 (no supervisor).
+     * @returns {Promise<Employee>} - The created employee record.
+     * @throws {Error} - If neither LName nor FName is provided.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    async createEmployee(data) {
+        if (!data.LName && !data.FName) {
+            throw new Error("Invalid parameter: At least one of LName or FName is required.");
+        }
+        return this.httpClient.post("/employees", data);
+    }
+    /**
+     * Updates an existing employee record (v25.4.36+).
+     * Setting both LName and FName to blank will result in 400 BadRequest.
+     * @param {Object} data - The details of the employee to update.
+     * @param {number} data.EmployeeNum - Required. Primary key of the employee to update.
+     * @param {string} [data.LName] - Optional. Last name.
+     * @param {string} [data.FName] - Optional. First name.
+     * @param {string} [data.MiddleI] - Optional. Middle initial or name.
+     * @param {string} [data.IsHidden] - Optional. "true" or "false".
+     * @param {string} [data.PayrollID] - Optional. Payroll identification number.
+     * @param {string} [data.WirelessPhone] - Optional. Phone number with punctuation.
+     * @param {string} [data.EmailWork] - Optional. Work email address.
+     * @param {string} [data.EmailPersonal] - Optional. Personal email address.
+     * @param {string} [data.IsFurloughed] - Optional. "true" or "false".
+     * @param {number} [data.ReportsTo] - Optional. FK to employee.EmployeeNum; set to 0 to remove supervisor.
+     * @returns {Promise<Employee>} - The updated employee record.
+     * @throws {Error} - If EmployeeNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployees.html
+     */
+    async updateEmployee(data) {
+        if (!data.EmployeeNum || typeof data.EmployeeNum !== "number") {
+            throw new Error("Invalid parameter: A valid EmployeeNum is required.");
+        }
+        const { EmployeeNum, ...body } = data;
+        return this.httpClient.put(`/employees/${EmployeeNum}`, body);
+    }
+}
+exports.default = Employees;

package/dist/api/employers.d.ts

@@ -0,0 +1,53 @@
+import HttpClient from "../utils/httpClient";
+import { EmployerItem, GetEmployersParams, CreateEmployerParams, UpdateEmployerParams } from "../types/employerTypes";
+export default class Employers {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single employer record by its identifier.
+     * @param {number} EmployerNum - Required. integer. Employer identifier (PK).
+     * @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<EmployerItem>} - The employer record.
+     * @throws {Error} - If EmployerNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    getEmployer(EmployerNum: number): Promise<EmployerItem>;
+    /**
+     * Retrieves all employer records with optional pagination.
+     * @param {GetEmployersParams} [params] - Optional query parameters.
+     * @param {number} [params.Offset] - Optional. integer. Pagination offset. Default 0.
+     * @returns {Promise<EmployerItem[]>} - Array of employer records.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    getEmployers(params?: GetEmployersParams): Promise<EmployerItem[]>;
+    /**
+     * Creates a new employer record.
+     * @param {CreateEmployerParams} data - Employer creation parameters.
+     * @param {string} data.EmpName - Required. string. The employer's business name.
+     * @returns {Promise<EmployerItem>} - The newly created employer record with generated EmployerNum.
+     * @throws {Error} - If EmpName is not provided.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    createEmployer(data: CreateEmployerParams): Promise<EmployerItem>;
+    /**
+     * Updates an existing employer's name.
+     * @param {UpdateEmployerParams} data - Employer update parameters.
+     * @param {number} data.EmployerNum - Required. integer. Employer identifier (PK).
+     * @param {string} data.EmpName - Required. string. Updated employer name.
+     * @returns {Promise<EmployerItem>} - The updated employer record.
+     * @throws {Error} - If EmployerNum is not a valid number or EmpName is not provided.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    updateEmployer(data: UpdateEmployerParams): Promise<EmployerItem>;
+    /**
+     * Deletes an employer record.
+     * @param {number} EmployerNum - Required. integer. Employer identifier (PK).
+     * @returns {Promise<void>} - Resolves when the employer is deleted.
+     * @throws {Error} - If EmployerNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    deleteEmployer(EmployerNum: number): Promise<void>;
+}
+//# sourceMappingURL=employers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"employers.d.ts","sourceRoot":"","sources":["../../src/api/employers.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;;;;;;;;;OASG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAQpE;;;;;;OAMG;IACU,YAAY,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAI/E;;;;;;;OAOG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAQ9E;;;;;;;;OAQG;IACU,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAY9E;;;;;;OAMG;IACU,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOhE"}

package/dist/api/employers.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Employers {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single employer record by its identifier.
+     * @param {number} EmployerNum - Required. integer. Employer identifier (PK).
+     * @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<EmployerItem>} - The employer record.
+     * @throws {Error} - If EmployerNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    async getEmployer(EmployerNum) {
+        if (!EmployerNum || typeof EmployerNum !== "number") {
+            throw new Error("Invalid parameter: EmployerNum must be a valid number.");
+        }
+        return this.httpClient.get(`/employers/${EmployerNum}`);
+    }
+    /**
+     * Retrieves all employer records with optional pagination.
+     * @param {GetEmployersParams} [params] - Optional query parameters.
+     * @param {number} [params.Offset] - Optional. integer. Pagination offset. Default 0.
+     * @returns {Promise<EmployerItem[]>} - Array of employer records.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    async getEmployers(params) {
+        return this.httpClient.get("/employers", params);
+    }
+    /**
+     * Creates a new employer record.
+     * @param {CreateEmployerParams} data - Employer creation parameters.
+     * @param {string} data.EmpName - Required. string. The employer's business name.
+     * @returns {Promise<EmployerItem>} - The newly created employer record with generated EmployerNum.
+     * @throws {Error} - If EmpName is not provided.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    async createEmployer(data) {
+        if (!data.EmpName) {
+            throw new Error("Invalid parameter: EmpName is required.");
+        }
+        return this.httpClient.post("/employers", data);
+    }
+    /**
+     * Updates an existing employer's name.
+     * @param {UpdateEmployerParams} data - Employer update parameters.
+     * @param {number} data.EmployerNum - Required. integer. Employer identifier (PK).
+     * @param {string} data.EmpName - Required. string. Updated employer name.
+     * @returns {Promise<EmployerItem>} - The updated employer record.
+     * @throws {Error} - If EmployerNum is not a valid number or EmpName is not provided.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    async updateEmployer(data) {
+        if (!data.EmployerNum || typeof data.EmployerNum !== "number") {
+            throw new Error("Invalid parameter: EmployerNum must be a valid number.");
+        }
+        if (!data.EmpName) {
+            throw new Error("Invalid parameter: EmpName is required.");
+        }
+        const { EmployerNum, ...body } = data;
+        return this.httpClient.put(`/employers/${EmployerNum}`, body);
+    }
+    /**
+     * Deletes an employer record.
+     * @param {number} EmployerNum - Required. integer. Employer identifier (PK).
+     * @returns {Promise<void>} - Resolves when the employer is deleted.
+     * @throws {Error} - If EmployerNum is not a valid number.
+     * @see https://www.opendental.com/site/apiemployers.html
+     */
+    async deleteEmployer(EmployerNum) {
+        if (!EmployerNum || typeof EmployerNum !== "number") {
+            throw new Error("Invalid parameter: EmployerNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/employers/${EmployerNum}`);
+    }
+}
+exports.default = Employers;

package/dist/api/eobAttaches.d.ts

@@ -0,0 +1,56 @@
+import HttpClient from "../utils/httpClient";
+import { EobAttach, GetEobAttachesParams, DownloadSftpParams, UploadSftpParams } from "../types/eobAttachTypes";
+export default class EobAttaches {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a list of EOB attachments for a specified claim payment.
+     * @param {Object} params - Required filter parameters.
+     * @param {number} params.ClaimPaymentNum - Required. FK to claimpayment; identifies the claim payment whose attachments to retrieve.
+     * @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<EobAttach[]>} - Array of EOB attachment records.
+     * @throws {Error} - If ClaimPaymentNum is not a valid number.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    getEobAttaches(params: GetEobAttachesParams): Promise<EobAttach[]>;
+    /**
+     * Exports an EOB attachment to a specified SFTP location.
+     * SftpAddress must use forward slashes regardless of platform.
+     * @param {Object} data - The SFTP download parameters.
+     * @param {number} data.EobAttachNum - Required. FK to the EOB attachment to export.
+     * @param {string} data.SftpAddress - Required. Full file path on the SFTP server using forward slashes.
+     * @param {string} data.SftpUsername - Required. SFTP authentication username.
+     * @param {string} data.SftpPassword - Required. SFTP authentication password.
+     * @param {number} [data.SftpPort] - Optional. SFTP port; default 22 (added v25.4.45).
+     * @returns {Promise<string>} - Full filepath of the saved file on the SFTP server.
+     * @throws {Error} - If EobAttachNum is not a valid number, or SftpAddress, SftpUsername, or SftpPassword is missing.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    downloadSftp(data: DownloadSftpParams): Promise<string>;
+    /**
+     * Imports an EOB file from an SFTP server into the system's storage, creating a new EobAttach record.
+     * SftpAddress must use forward slashes regardless of platform.
+     * @param {Object} data - The SFTP upload parameters.
+     * @param {number} data.ClaimPaymentNum - Required. FK to claim payment to associate the uploaded file with.
+     * @param {string} data.SftpAddress - Required. Full file path on the SFTP server using forward slashes.
+     * @param {string} data.SftpUsername - Required. SFTP authentication username.
+     * @param {string} data.SftpPassword - Required. SFTP authentication password.
+     * @param {number} [data.SftpPort] - Optional. SFTP port; default 22 (added v25.4.45).
+     * @returns {Promise<EobAttach>} - The newly created EobAttach record.
+     * @throws {Error} - If ClaimPaymentNum is not a valid number, or SftpAddress, SftpUsername, or SftpPassword is missing.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    uploadSftp(data: UploadSftpParams): Promise<EobAttach>;
+    /**
+     * Removes an EOB attachment record and its associated file.
+     * @param {number} EobAttachNum - Required. EOB attachment to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} - If EobAttachNum is not a valid number.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    deleteEobAttach(EobAttachNum: number): Promise<void>;
+}
+//# sourceMappingURL=eobAttaches.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eobAttaches.d.ts","sourceRoot":"","sources":["../../src/api/eobAttaches.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAQ/E;;;;;;;;;;;;OAYG;IACU,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBpE;;;;;;;;;;;;OAYG;IACU,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAiBnE;;;;;;OAMG;IACU,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOlE"}

package/dist/api/eobAttaches.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class EobAttaches {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a list of EOB attachments for a specified claim payment.
+     * @param {Object} params - Required filter parameters.
+     * @param {number} params.ClaimPaymentNum - Required. FK to claimpayment; identifies the claim payment whose attachments to retrieve.
+     * @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<EobAttach[]>} - Array of EOB attachment records.
+     * @throws {Error} - If ClaimPaymentNum is not a valid number.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    async getEobAttaches(params) {
+        if (!params.ClaimPaymentNum || typeof params.ClaimPaymentNum !== "number") {
+            throw new Error("Invalid parameter: A valid ClaimPaymentNum is required.");
+        }
+        return this.httpClient.get("/eobattaches", params);
+    }
+    /**
+     * Exports an EOB attachment to a specified SFTP location.
+     * SftpAddress must use forward slashes regardless of platform.
+     * @param {Object} data - The SFTP download parameters.
+     * @param {number} data.EobAttachNum - Required. FK to the EOB attachment to export.
+     * @param {string} data.SftpAddress - Required. Full file path on the SFTP server using forward slashes.
+     * @param {string} data.SftpUsername - Required. SFTP authentication username.
+     * @param {string} data.SftpPassword - Required. SFTP authentication password.
+     * @param {number} [data.SftpPort] - Optional. SFTP port; default 22 (added v25.4.45).
+     * @returns {Promise<string>} - Full filepath of the saved file on the SFTP server.
+     * @throws {Error} - If EobAttachNum is not a valid number, or SftpAddress, SftpUsername, or SftpPassword is missing.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    async downloadSftp(data) {
+        if (!data.EobAttachNum || typeof data.EobAttachNum !== "number") {
+            throw new Error("Invalid parameter: A valid EobAttachNum 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("/eobattaches/DownloadSftp", data);
+    }
+    /**
+     * Imports an EOB file from an SFTP server into the system's storage, creating a new EobAttach record.
+     * SftpAddress must use forward slashes regardless of platform.
+     * @param {Object} data - The SFTP upload parameters.
+     * @param {number} data.ClaimPaymentNum - Required. FK to claim payment to associate the uploaded file with.
+     * @param {string} data.SftpAddress - Required. Full file path on the SFTP server using forward slashes.
+     * @param {string} data.SftpUsername - Required. SFTP authentication username.
+     * @param {string} data.SftpPassword - Required. SFTP authentication password.
+     * @param {number} [data.SftpPort] - Optional. SFTP port; default 22 (added v25.4.45).
+     * @returns {Promise<EobAttach>} - The newly created EobAttach record.
+     * @throws {Error} - If ClaimPaymentNum is not a valid number, or SftpAddress, SftpUsername, or SftpPassword is missing.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    async uploadSftp(data) {
+        if (!data.ClaimPaymentNum || typeof data.ClaimPaymentNum !== "number") {
+            throw new Error("Invalid parameter: A valid ClaimPaymentNum 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("/eobattaches/UploadSftp", data);
+    }
+    /**
+     * Removes an EOB attachment record and its associated file.
+     * @param {number} EobAttachNum - Required. EOB attachment to delete.
+     * @returns {Promise<void>}
+     * @throws {Error} - If EobAttachNum is not a valid number.
+     * @see https://www.opendental.com/site/apieobattaches.html
+     */
+    async deleteEobAttach(EobAttachNum) {
+        if (!EobAttachNum || typeof EobAttachNum !== "number") {
+            throw new Error("Invalid parameter: A valid EobAttachNum is required.");
+        }
+        return this.httpClient.delete(`/eobattaches/${EobAttachNum}`);
+    }
+}
+exports.default = EobAttaches;

package/dist/api/events.d.ts

@@ -0,0 +1,26 @@
+/**
+ * API Events — Open Dental Webhook System
+ *
+ * Events are webhook callbacks sent by Open Dental to a caller-configured endpoint.
+ * There are no direct HTTP endpoints under /events itself; all configuration is
+ * managed through the Subscriptions API (/subscriptions).
+ *
+ * Two categories of events exist:
+ *  - Database Events: polling-based, fire per PollingSeconds interval, capped at
+ *    1000 elements per payload. Undelivered events are retained for up to 72 hours.
+ *  - UI Events: fire immediately on user action in the Open Dental UI (e.g., PatientSelected).
+ *
+ * All event deliveries include these HTTP headers on the outbound request:
+ *  - Authorization: Customer API Key
+ *  - Workstation: Machine name of the sending workstation (v22.4.28+)
+ *  - Event-Type: Event type identifier string (v22.4.35+)
+ *
+ * To set up events:
+ *  1. POST /subscriptions with the desired WatchType/EventType and EndPointUrl.
+ *  2. Listen at the configured EndPointUrl for incoming payloads.
+ *  3. Manage subscriptions using GET/PUT/DELETE /subscriptions.
+ *
+ * @see https://www.opendental.com/site/apievents.html
+ */
+export {};
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/api/events.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAMH,OAAO,EAAE,CAAC"}

package/dist/api/events.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * API Events — Open Dental Webhook System
+ *
+ * Events are webhook callbacks sent by Open Dental to a caller-configured endpoint.
+ * There are no direct HTTP endpoints under /events itself; all configuration is
+ * managed through the Subscriptions API (/subscriptions).
+ *
+ * Two categories of events exist:
+ *  - Database Events: polling-based, fire per PollingSeconds interval, capped at
+ *    1000 elements per payload. Undelivered events are retained for up to 72 hours.
+ *  - UI Events: fire immediately on user action in the Open Dental UI (e.g., PatientSelected).
+ *
+ * All event deliveries include these HTTP headers on the outbound request:
+ *  - Authorization: Customer API Key
+ *  - Workstation: Machine name of the sending workstation (v22.4.28+)
+ *  - Event-Type: Event type identifier string (v22.4.35+)
+ *
+ * To set up events:
+ *  1. POST /subscriptions with the desired WatchType/EventType and EndPointUrl.
+ *  2. Listen at the configured EndPointUrl for incoming payloads.
+ *  3. Manage subscriptions using GET/PUT/DELETE /subscriptions.
+ *
+ * @see https://www.opendental.com/site/apievents.html
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/familyModules.d.ts

@@ -9,9 +9,19 @@ export default class FamilyModules {
      * Use another API method or a query to get additional details in each table.
      * This area of the Family Module UI also shows discount plans, which are obtained through DiscountPlanSubs GET.
      * @param {number} PatNum - FK to patient.PatNum
+     * @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<Insurance[]>} - The appointment object.
-     * @throws {Error} - If `AptNum` is not provided.
+     * @throws {Error} - If `PatNum` is not provided.
      */
-    getInsurance(PatNum: number): Promise<Insurance[]>;
+    getInsurance(PatNum: number, params?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<Insurance[]>;
 }
 //# sourceMappingURL=familyModules.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"familyModules.d.ts","sourceRoot":"","sources":["../../src/api/familyModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACV,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;OAQG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAOhE"}
+{"version":3,"file":"familyModules.d.ts","sourceRoot":"","sources":["../../src/api/familyModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACV,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;;;OAaG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QACjD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAOzB"}

package/dist/api/familyModules.js

@@ -11,14 +11,19 @@ class FamilyModules {
      * Use another API method or a query to get additional details in each table.
      * This area of the Family Module UI also shows discount plans, which are obtained through DiscountPlanSubs GET.
      * @param {number} PatNum - FK to patient.PatNum
+     * @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<Insurance[]>} - The appointment object.
-     * @throws {Error} - If `AptNum` is not provided.
+     * @throws {Error} - If `PatNum` is not provided.
      */
-    async getInsurance(PatNum) {
+    async getInsurance(PatNum, params) {
         if (!PatNum) {
-            throw new Error("PatNum is required.");
+            throw new Error("Invalid parameter: PatNum is required.");
         }
-        return this.httpClient.get(`/familymodules/${PatNum}/Insurance`);
+        return this.httpClient.get(`/familymodules/${PatNum}/Insurance`, params);
     }
 }
 exports.default = FamilyModules;

package/dist/api/feeScheds.d.ts

@@ -6,11 +6,17 @@ export default class FeeScheds {
     /**
      * Fetch fee schedules with optional filtering and pagination.
      * @param {Object} params - The parameters for filtering and pagination.
-     * @param {number} [params.Offset] - Optional. Pagination offset for results.
+     * @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<FeeSched[]>} - A list of fees.
      */
-    getFeeScheds({ Offset }: {
+    getFeeScheds({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
         Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
     }): Promise<FeeSched[]>;
 }
 //# sourceMappingURL=feeScheds.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"feeScheds.d.ts","sourceRoot":"","sources":["../../src/api/feeScheds.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EAGT,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAShF"}
+{"version":3,"file":"feeScheds.d.ts","sourceRoot":"","sources":["../../src/api/feeScheds.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EAGT,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;OAQG;IACU,YAAY,CAAC,EACxB,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACrB,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAkB7B"}

package/dist/api/feeScheds.js

@@ -8,14 +8,26 @@ class FeeScheds {
     /**
      * Fetch fee schedules with optional filtering and pagination.
      * @param {Object} params - The parameters for filtering and pagination.
-     * @param {number} [params.Offset] - Optional. Pagination offset for results.
+     * @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<FeeSched[]>} - A list of fees.
      */
-    async getFeeScheds({ Offset }) {
+    async getFeeScheds({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {};
         if (Offset !== undefined) {
             params.Offset = Offset;
         }
+        if (Limit !== undefined) {
+            params.Limit = Limit;
+        }
+        if (DateFormatString !== undefined) {
+            params.DateFormatString = DateFormatString;
+        }
+        if (DateTimeFormatString !== undefined) {
+            params.DateTimeFormatString = DateTimeFormatString;
+        }
         return this.httpClient.get("/feescheds", params);
     }
 }