@rinse-dental/open-dental 3.4.2 → 4.0.2

package/README.md

@@ -1,35 +1,407 @@
+# @rinse-dental/open-dental
 
+An unofficial TypeScript/Node.js SDK for the [Open Dental REST API](https://www.opendental.com/site/apideveloperportal.html).
 
+> **Open Dental version coverage:** This release is synchronized with Open Dental **v26.1.12 (beta)** and covers every API endpoint documented as of that version.
 
-## Unofficial Open Dental node sdk. 
+---
 
+## Installation
+
+```bash
+npm install @rinse-dental/open-dental
 ```
-//Init
 
-const { OpenDental } = require('@rinse-dental/open-dental');
+---
+
+## Quick Start
+
+```ts
+import { OpenDental } from '@rinse-dental/open-dental';
+
+// Initialize once at application startup (the SDK appends /api/v1 automatically)
+OpenDental.initialize(
+  'https://your-open-dental-server.example.com', // base URL — no trailing slash
+  'YOUR_API_TOKEN',                              // Base64 "ODFHIR {DeveloperKey}/{CustomerKey}" token
+);
+
+// Use any resource
+const patients = OpenDental.Patients();
+const results = await patients.getPatients({ LName: 'Smith' });
+console.log(results);
+```
+
+---
+
+## Initialization
+
+`OpenDental.initialize(baseURL, authToken, options?)` must be called **once** before any other method. All subsequent calls reuse the same HTTP client.
+
+| Parameter          | Type    | Required | Description                                              |
+|--------------------|---------|----------|----------------------------------------------------------|
+| `baseURL`          | string  | Yes      | Root URL of your Open Dental server (no trailing slash). |
+| `authToken`        | string  | Yes      | Base64-encoded `ODFHIR {DeveloperKey}/{CustomerKey}` API token.                |
+| `options.timeout`  | number  | No       | Request timeout in milliseconds. Default: `30000`.       |
+| `options.debug`    | boolean | No       | Log HTTP errors to console (strips PHI). Default: `false`. |
 
+```ts
+// Minimal
 OpenDental.initialize(
-  OPEN_DENTAL_BASEURL, // your base url
-  OPEN_DENTAL_API_KEY // your open dental provided api key (ODFHIR ...)
+  process.env.OPEN_DENTAL_BASEURL!,
+  process.env.OPEN_DENTAL_API_KEY!
 );
 
+// With options
+OpenDental.initialize(
+  process.env.OPEN_DENTAL_BASEURL!,
+  process.env.OPEN_DENTAL_API_KEY!,
+  {
+    timeout: 15_000, // 15 seconds
+    debug: process.env.NODE_ENV !== 'production',
+  }
+);
+```
+
+---
+
+## Error Handling
+
+All API errors throw a standard JavaScript `Error` with the message:
+
+```
+API Error (Status <code>): <message>
+```
+
+Wrap calls in `try/catch`:
+
+```ts
+try {
+  const appt = await OpenDental.Appointments().getAppointment(12345);
+} catch (err) {
+  console.error(err.message); // "API Error (Status 404): Not found"
+}
+```
+
+---
 
-//Example
+## Available Resources
 
+Every resource is accessed via a factory method on `OpenDental`. Each factory returns a class instance pre-configured with the shared HTTP client.
+
+| Factory Method | API Endpoint | Description |
+|---|---|---|
+| `OpenDental.AccountModules()` | `/accountmodules` | Account sub-resource data for a patient |
+| `OpenDental.Adjustments()` | `/adjustments` | Ledger adjustments |
+| `OpenDental.Allergies()` | `/allergies` | Patient allergy records |
+| `OpenDental.AllergyDefs()` | `/allergydefs` | Allergy definition master list |
+| `OpenDental.AppointmentTypes()` | `/appointmenttypes` | Appointment type definitions |
+| `OpenDental.Appointments()` | `/appointments` | Patient appointments |
+| `OpenDental.ApptFieldDefs()` | `/apptfielddefs` | Custom appointment field definitions |
+| `OpenDental.ApptFields()` | `/apptfields` | Custom appointment field values |
+| `OpenDental.AsapComms()` | `/asapcomm` | ASAP list communications |
+| `OpenDental.AutoNoteControls()` | `/autonotecontrols` | Auto note control definitions |
+| `OpenDental.AutoNotes()` | `/autonotes` | Auto note templates |
+| `OpenDental.Benefits()` | `/benefits` | Insurance plan benefits |
+| `OpenDental.Carriers()` | `/carriers` | Insurance carriers |
+| `OpenDental.ChartModules()` | `/chartmodules` | Chart module data for a patient |
+| `OpenDental.ClaimPayments()` | `/claimpayments` | Insurance claim payments (EOBs) |
+| `OpenDental.ClaimProcs()` | `/claimprocs` | Claim procedure line items |
+| `OpenDental.ClaimTrackings()` | `/claimtrackings` | Claim tracking history |
+| `OpenDental.Claims()` | `/claims` | Insurance claims |
+| `OpenDental.Clinics()` | `/clinics` | Clinic locations |
+| `OpenDental.ClockEvents()` | `/clockevents` | Employee time clock punches |
+| `OpenDental.CodeGroups()` | `/codegroups` | Procedure code groups |
+| `OpenDental.CommLogs()` | `/commlogs` | Patient communication logs |
+| `OpenDental.Computers()` | `/computers` | Registered workstations |
+| `OpenDental.CovCats()` | `/covcats` | Insurance coverage categories |
+| `OpenDental.CovSpans()` | `/covspans` | Insurance coverage spans |
+| `OpenDental.Definitions()` | `/definitions` | Definition list items (dropdowns) |
+| `OpenDental.DiseaseDefs()` | `/diseasedefs` | Disease/problem definition master list |
+| `OpenDental.DiscountPlanSubs()` | `/discountplansubs` | Patient discount plan subscriptions |
+| `OpenDental.DiscountPlans()` | `/discountplans` | In-house discount plan definitions |
+| `OpenDental.Diseases()` | `/diseases` | Patient problem/disease records |
+| `OpenDental.Documents()` | `/documents` | Patient document/image records |
+| `OpenDental.ETrans()` | `/etrans` | Electronic transaction records |
+| `OpenDental.ETransMessageTexts()` | `/etransmessagetexts` | Raw electronic transaction message text |
+| `OpenDental.ETranss()` | `/etranss` | Bulk electronic transaction listing |
+| `OpenDental.EhrPatients()` | `/ehrpatients` | EHR/Meaningful Use patient data |
+| `OpenDental.Employees()` | `/employees` | Employee records |
+| `OpenDental.Employers()` | `/employers` | Employer records |
+| `OpenDental.EobAttaches()` | `/eobattaches` | EOB attachment images |
+| `OpenDental.Events()` | `/events` | Server audit-trail events |
+| `OpenDental.FamilyModules()` | `/familymodules` | Family module data |
+| `OpenDental.FeeScheds()` | `/feescheds` | Fee schedule records |
+| `OpenDental.Fees()` | `/fees` | Individual fee records |
+| `OpenDental.HistAppointments()` | `/histappointments` | Appointment change history |
+| `OpenDental.InsPlans()` | `/insplans` | Insurance plan records |
+| `OpenDental.InsSubs()` | `/inssubs` | Insurance subscriber records |
+| `OpenDental.InsVerifies()` | `/insverifies` | Insurance verification records |
+| `OpenDental.LabCases()` | `/labcases` | Dental lab case records |
+| `OpenDental.LabTurnarounds()` | `/labturnarounds` | Lab turnaround time records |
+| `OpenDental.Laboratories()` | `/laboratories` | Dental laboratory records |
+| `OpenDental.MedicationPats()` | `/medicationpats` | Patient medication records |
+| `OpenDental.Medications()` | `/medications` | Medication definition master list |
+| `OpenDental.Operatories()` | `/operatories` | Operatory (treatment room) records |
+| `OpenDental.PatFieldDefs()` | `/patfielddefs` | Custom patient field definitions |
+| `OpenDental.PatFields()` | `/patfields` | Custom patient field values |
+| `OpenDental.PatPlans()` | `/patplans` | Patient insurance plan enrollments |
+| `OpenDental.PatientNotes()` | `/patientnotes` | Patient note fields (financial, medical, etc.) |
+| `OpenDental.PatientRaces()` | `/patientraces` | Patient race/ethnicity records |
+| `OpenDental.Patients()` | `/patients` | Patient records |
+| `OpenDental.PayPlanCharges()` | `/payplancharges` | Payment plan charge records |
+| `OpenDental.PayPlans()` | `/payplans` | Payment plan records |
+| `OpenDental.PaySplits()` | `/paysplits` | Payment allocation splits |
+| `OpenDental.Payments()` | `/payments` | Patient payments |
+| `OpenDental.PerioExams()` | `/perioexams` | Periodontal exam records |
+| `OpenDental.PerioMeasures()` | `/periomeasures` | Periodontal measurement records |
+| `OpenDental.Pharmacies()` | `/pharmacies` | Pharmacy records |
+| `OpenDental.Popups()` | `/popups` | Patient chart popup messages |
+| `OpenDental.Preferences()` | `/preferences` | Global practice preferences |
+| `OpenDental.ProcNotes()` | `/procnotes` | Procedure notes |
+| `OpenDental.ProcTPs()` | `/proctps` | Treatment plan procedures |
+| `OpenDental.ProcedureCodes()` | `/procedurecodes` | ADA CDT procedure code definitions |
+| `OpenDental.ProcedureLogs()` | `/procedurelogs` | Procedure log records |
+| `OpenDental.Providers()` | `/providers` | Provider records |
+| `OpenDental.Queries()` | `/queries` | Arbitrary read-only SQL queries |
+| `OpenDental.QuickPasteCats()` | `/quickpastecats` | Quick-paste category records |
+| `OpenDental.QuickPasteNotes()` | `/quickpastenotes` | Quick-paste note templates |
+| `OpenDental.RecallTypes()` | `/recalltypes` | Recall type definitions |
+| `OpenDental.Recalls()` | `/recalls` | Patient recall records |
+| `OpenDental.RefAttaches()` | `/refattaches` | Referral attachment records |
+| `OpenDental.Referrals()` | `/referrals` | Referral source/destination records |
+| `OpenDental.Reports()` | `/reports` | Built-in Open Dental reports |
+| `OpenDental.RxPats()` | `/rxpats` | Prescription records |
+| `OpenDental.ScheduleOps()` | `/scheduleops` | Schedule-to-operatory links |
+| `OpenDental.Schedules()` | `/schedules` | Provider/blockout schedule blocks |
+| `OpenDental.Security()` | `/security` | User security settings |
+| `OpenDental.SecurityLogs()` | `/securitylogs` | Security audit log entries |
+| `OpenDental.SheetDefs()` | `/sheetdefs` | Sheet template definitions |
+| `OpenDental.SheetFields()` | `/sheetfields` | Sheet template field definitions |
+| `OpenDental.Sheets()` | `/sheets` | Filled-out sheet instances |
+| `OpenDental.SignalODs()` | `/signalods` | Real-time server signal records |
+| `OpenDental.Statements()` | `/statements` | Patient billing statements |
+| `OpenDental.Subscriptions()` | `/subscriptions` | Webhook event subscriptions |
+| `OpenDental.SubstitutionLinks()` | `/substitutionlinks` | Tooth material substitution rules |
+| `OpenDental.TaskLists()` | `/tasklists` | Task list folders |
+| `OpenDental.TaskNotes()` | `/tasknotes` | Task comments/notes |
+| `OpenDental.Tasks()` | `/tasks` | Task records |
+| `OpenDental.ToothInitials()` | `/toothInitials` | Existing tooth chart conditions |
+| `OpenDental.TreatmentPlanAttaches()` | `/treatplanattaches` | Procedure-to-treatment-plan links |
+| `OpenDental.TreatmentPlans()` | `/treatplans` | Treatment plan records |
+| `OpenDental.UserGroupAttaches()` | `/usergroupattaches` | User-to-group memberships |
+| `OpenDental.UserGroups()` | `/usergroups` | User security groups |
+| `OpenDental.UserODs()` | `/userods` | Open Dental user accounts |
+| `OpenDental.Transformers()` | — | Stateless data transformation utilities |
+
+---
+
+## Usage Examples
+
+### Patients
+
+```ts
 const patients = OpenDental.Patients();
-const getPatients = getPatients({
-    LName: "Smith",
-    FName: "John",
+
+// Search patients
+const results = await patients.getPatients({ LName: 'Smith', FName: 'John' });
+
+// Get a single patient
+const patient = await patients.getPatient(1234);
+
+// Create a patient
+const newPatient = await patients.createPatient({
+  LName: 'Smith',
+  FName: 'Jane',
+  Birthdate: '1985-06-15',
+});
+
+// Update a patient
+const updated = await patients.updatePatient({ PatNum: 1234, WirelessPhone: '555-867-5309' });
+```
+
+### Appointments
+
+```ts
+const appts = OpenDental.Appointments();
+
+// Fetch appointments for a date range
+const list = await appts.getAppointments({
+  dateStart: '2026-01-01',
+  dateEnd: '2026-01-31',
+});
+
+// Create an appointment
+const newAppt = await appts.createAppointment({
+  PatNum: 1234,
+  AptDateTime: '2026-03-15 09:00:00',
+  Op: 3,
+  ProvNum: 2,
+});
+
+// Break an appointment
+await appts.breakAppointment(apptNum, { sendToUnscheduledList: 'true' });
+```
+
+### Payments
+
+```ts
+const payments = OpenDental.Payments();
+
+// Create a payment
+const payment = await payments.createPayment({
+  PatNum: 1234,
+  PayAmt: '150.00',
+  PayNote: 'Visa ending in 4242',
+});
+
+// Refund a payment
+const refund = await payments.refundPayment({
+  PayNum: 567,
+  RefundAmt: 75.00,
+  PayNote: 'Partial refund',
+});
+```
+
+### Queries (read-only SQL)
+
+```ts
+const queries = OpenDental.Queries();
+
+// Short query (up to 100 rows)
+const rows = await queries.shortQuery<{ PatNum: number; LName: string }>({
+  SqlCommand: "SELECT PatNum, LName FROM patient WHERE LName = 'Smith' LIMIT 10",
 });
 
-//return getPatients;  //Returns array of patients; 
+// Larger query — results exported to SFTP
+await queries.runQuery({ SqlCommand: 'SELECT * FROM procedurelog' });
+```
+
+### Insurance Benefits
+
+```ts
+const benefits = OpenDental.Benefits();
+
+// List benefits for a plan
+const list = await benefits.getBenefits({ PlanNum: 42 });
 
-const postPatient = patients.createPatient({
-    LName: "Smith",
-    FName: "John",
-    ...additionalData,
+// Create a benefit
+const benefit = await benefits.createBenefit({
+  PlanNum: 42,
+  BenefitType: 'Percentage',
+  Percent: 80,
+  CovCatNum: 3,
 });
 
-return postPatient; //Returns patient object
+// Delete a benefit (note: method renamed from v3.4.x — see Breaking Changes)
+await benefits.deleteBenefit(benefitNum);
+```
+
+---
+
+## API Documentation (`Docs/`)
+
+This package includes the full Open Dental API reference documentation in the `Docs/` folder, enriched with database schema mappings and field-level notes for every endpoint. These markdown files are optimized for AI-assisted development.
+
+```
+Docs/
+└── Open Dental 2026-04-22/
+    ├── api-url-list.md        — Master list of all API URLs
+    ├── apiappointments.md
+    ├── apipatients.md
+    ├── apibenefits.md         — Enriched with X12 mappings and DB schema
+    └── ...                    — One file per API resource
+```
+
+---
+
+## Breaking Changes
+
+### v4.0.0
+
+The following changes are **breaking** relative to v3.x.
+
+**`ChartModules.PatientInfo()` → `ChartModules.getPatientInfo()`**
+
+The method was renamed to follow the SDK's `getX()` naming convention.
+
+```ts
+// Before (v3.x)
+const info = await OpenDental.ChartModules().PatientInfo(patNum);
+
+// After (v4.0.1)
+const info = await OpenDental.ChartModules().getPatientInfo(patNum);
+```
+
+**`Benefits.deletePatPlan()` → `Benefits.deleteBenefit()`**
+
+The method was renamed to correctly reflect that it deletes a benefit record, not a patient plan.
+
+```ts
+// Before (v3.x)
+await OpenDental.Benefits().deletePatPlan(benefitNum);
+
+// After (v4.0.0)
+await OpenDental.Benefits().deleteBenefit(benefitNum);
+```
+
+**`RefAttaches.deleteInsSub()` → `RefAttaches.deleteRefAttach()`**
+
+The method was incorrectly named after a different resource. It has been corrected.
+
+```ts
+// Before (v3.x)
+await OpenDental.RefAttaches().deleteInsSub(refAttachNum);
+
+// After (v4.0.0)
+await OpenDental.RefAttaches().deleteRefAttach(refAttachNum);
+```
+
+**`InsVerifies.createInsVerifies()` now correctly uses POST**
+
+Previously this method called `PUT /insverifies` instead of `POST /insverifies`. Any consumers relying on the incorrect behavior should verify their integration.
+
+**API errors now throw `Error` instances**
+
+Previously, API errors threw the raw Axios response object. They now throw a standard `Error` with a descriptive message string. Update any catch blocks that inspected `err.status` or `err.data` directly:
+
+```ts
+// Before (v3.x) — err was an AxiosResponse
+catch (err: any) {
+  console.log(err.status);
+}
+
+// After (v4.0.1) — err is an Error
+catch (err: unknown) {
+  if (err instanceof Error) console.log(err.message);
+}
+```
+
+**All GET list endpoints now accept `Limit`, `DateFormatString`, and `DateTimeFormatString`**
+
+These are additive and non-breaking for existing callers, but consumers relying on receiving all results in a single call should be aware of the 1000-item hard limit per request.
+
+```ts
+// Paginate through results
+const page1 = await OpenDental.Appointments().getAppointments({ Offset: 0,    Limit: 1000 });
+const page2 = await OpenDental.Appointments().getAppointments({ Offset: 1000, Limit: 1000 });
+
+// Custom date format
+const patients = await OpenDental.Patients().getPatients({ DateFormatString: "MM/dd/yyyy" });
+```
+
+---
+
+## TypeScript Support
+
+The SDK ships with full TypeScript definitions. All request parameters and response shapes are typed. Import types directly from the package:
+
+```ts
+import type { Patient } from '@rinse-dental/open-dental/dist/types/patientTypes';
+import type { Appointment } from '@rinse-dental/open-dental/dist/types/appointmentTypes';
+```
+
+---
+
+## License
 
-```
+MIT © [Rinse Dental Inc.](https://rinse.dental)

package/dist/api/accountModules.d.ts

@@ -6,18 +6,38 @@ export default class AccountModules {
     /**
      * Fetch a patient's ServiceDateView by their ID.
      * @param {number} PatNum - Required in the URL, patient.PatNum.
-     * @param {"true" | "false"} isFamily - Optional. Either "true" or "false". Return data for the entire patient's family. Default "false".
+     * @param {"true" | "false"} [isFamily] - Optional. Either "true" or "false". Return data for the entire patient's family. Default "false".
+     * @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<ServiceDateView[]>} - The ServiceDateView return object.
      * @throws {Error} - If `ServiceDateView` is not valid or the API returns an error.
      */
-    getServiceDateView(PatNum: number, isFamily?: "true" | "false"): Promise<ServiceDateView[]>;
+    getServiceDateView(PatNum: number, isFamily?: "true" | "false", params?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<ServiceDateView[]>;
     /**
      * Fetch a patient's balance and family balances by their ID.
      * @param {number} PatNum - Required in the URL, 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<PatientBalance[]>} - The PatientBalance return object.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
-    getPatientBalance(PatNum: number): Promise<PatientBalance[]>;
+    getPatientBalance(PatNum: number, params?: {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
+    }): Promise<PatientBalance[]>;
     /**
      * Fetch a patient's aging information by their ID.
      * @param {number} PatNum - Required in the URL, patient.PatNum.

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

@@ -1 +1 @@
-{"version":3,"file":"accountModules.d.ts","sourceRoot":"","sources":["../../src/api/accountModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,cAAc,EACd,KAAK,EACN,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAYxG;;;;;OAKG;IACU,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAQzE;;;;;OAKG;IACU,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;CAOtD"}
+{"version":3,"file":"accountModules.d.ts","sourceRoot":"","sources":["../../src/api/accountModules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,cAAc,EACd,KAAK,EACN,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,EAAE;QACpF,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,eAAe,EAAE,CAAC;IAa9B;;;;;;;;;;OAUG;IACU,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QACtD,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,cAAc,EAAE,CAAC;IAQ7B;;;;;OAKG;IACU,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;CAOtD"}

package/dist/api/accountModules.js

@@ -8,30 +8,41 @@ class AccountModules {
     /**
      * Fetch a patient's ServiceDateView by their ID.
      * @param {number} PatNum - Required in the URL, patient.PatNum.
-     * @param {"true" | "false"} isFamily - Optional. Either "true" or "false". Return data for the entire patient's family. Default "false".
+     * @param {"true" | "false"} [isFamily] - Optional. Either "true" or "false". Return data for the entire patient's family. Default "false".
+     * @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<ServiceDateView[]>} - The ServiceDateView return object.
      * @throws {Error} - If `ServiceDateView` is not valid or the API returns an error.
      */
-    async getServiceDateView(PatNum, isFamily) {
+    async getServiceDateView(PatNum, isFamily, params) {
         if (!PatNum || typeof PatNum !== "number") {
             throw new Error("Invalid parameter: PatNum must be a valid number.");
         }
-        const params = {
+        const queryParams = {
             isFamily,
+            ...params,
         };
-        return await this.httpClient.get(`/accountmodules/${PatNum}/ServiceDateView`, params);
+        return await this.httpClient.get(`/accountmodules/${PatNum}/ServiceDateView`, queryParams);
     }
     /**
      * Fetch a patient's balance and family balances by their ID.
      * @param {number} PatNum - Required in the URL, 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<PatientBalance[]>} - The PatientBalance return object.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
-    async getPatientBalance(PatNum) {
+    async getPatientBalance(PatNum, params) {
         if (!PatNum || typeof PatNum !== "number") {
             throw new Error("Invalid parameter: PatNum must be a valid number.");
         }
-        return await this.httpClient.get(`/accountmodules/${PatNum}/PatientBalances`);
+        return await this.httpClient.get(`/accountmodules/${PatNum}/PatientBalances`, params);
     }
     /**
      * Fetch a patient's aging information by their ID.

package/dist/api/adjustments.d.ts

@@ -9,10 +9,13 @@ export default class Adjustments {
       * @param {number} params.PatNum - Required. FK to patient.PatNum.
       * @param {number} [params.AdjType] - Optional. definition.DefNum where definition.Category=1.
       * @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
-      * @param {number} [params.Offset] - 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<Adjustment[]>} - A list of adjustments.
       */
-    getAdjustments({ PatNum, AdjType, ProcNum, Offset, }: GetAdjustmentsParams): Promise<Adjustment>;
+    getAdjustments({ PatNum, AdjType, ProcNum, Offset, Limit, DateFormatString, DateTimeFormatString, }: GetAdjustmentsParams): Promise<Adjustment>;
     /**
      * This adds an adjustments to a patient's account.
      * @param {Object} data - The details of the adjustment to create.

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

@@ -1 +1 @@
-{"version":3,"file":"adjustments.d.ts","sourceRoot":"","sources":["../../src/api/adjustments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;QAQI;IACS,cAAc,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,OAAO,EACP,MAAM,GAEP,EAAG,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAa9C;;;;;;;;;;;;;;OAcG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAG,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAkBhD;;;;;;;;;;;;;OAaG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,SAAS,GACV,EAAG,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;CAgBjD"}
+{"version":3,"file":"adjustments.d.ts","sourceRoot":"","sources":["../../src/api/adjustments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;QAWI;IACS,cAAc,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,OAAO,EACP,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,EAAG,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAiB5C;;;;;;;;;;;;;;OAcG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAG,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAkBhD;;;;;;;;;;;;;OAaG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,SAAS,GACV,EAAG,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;CAgBjD"}

package/dist/api/adjustments.js

@@ -11,18 +11,24 @@ class Adjustments {
       * @param {number} params.PatNum - Required. FK to patient.PatNum.
       * @param {number} [params.AdjType] - Optional. definition.DefNum where definition.Category=1.
       * @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
-      * @param {number} [params.Offset] - 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<Adjustment[]>} - A list of adjustments.
       */
-    async getAdjustments({ PatNum, AdjType, ProcNum, Offset, }) {
+    async getAdjustments({ PatNum, AdjType, ProcNum, Offset, Limit, DateFormatString, DateTimeFormatString, }) {
         if (!PatNum || typeof PatNum !== "number") {
-            throw new Error("Invalid data: A Valid PatNum is required.");
+            throw new Error("Invalid parameter: A Valid PatNum is required.");
         }
         return this.httpClient.get("/adjustments", {
             PatNum,
             AdjType,
             ProcNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         });
     }
     /**
@@ -42,7 +48,7 @@ class Adjustments {
      */
     async createAdjustment({ PatNum, AdjType, AdjAmt, AdjDate, ProvNum, ProcNum, ClinicNum, ProcDate, AdjNote, }) {
         if (!PatNum || !AdjType || !AdjAmt || !AdjDate) {
-            throw new Error("Invalid data: PatNum, AdjType, AdjAmt, and AdjDate are required.");
+            throw new Error("Invalid parameter: PatNum, AdjType, AdjAmt, and AdjDate are required.");
         }
         return this.httpClient.post("/adjustments", {
             PatNum,
@@ -72,7 +78,7 @@ class Adjustments {
      */
     async updateAdjustment({ AdjNum, AdjDate, AdjAmt, AdjType, ProvNum, AdjNote, ProcNum, ClinicNum, }) {
         if (!AdjNum || typeof AdjNum !== "number") {
-            throw new Error("Invalid data: A valid AdjNum is required.");
+            throw new Error("Invalid parameter: A valid AdjNum is required.");
         }
         return this.httpClient.put(`/adjustments/${AdjNum}`, {
             AdjNum,

package/dist/api/allergies.d.ts

@@ -7,10 +7,13 @@ export default class Allergies {
      * Fetch patient's allergies with optional pagination.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} params.PatNum - Required. Filter by patient.
-     * @param {number} [params.Offset] - pagination.
+     * @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<Allergy>} - A list of a patient's allergies.
      */
-    getAllergies({ PatNum, Offset, }: GetAllergiesParams): Promise<Allergy[]>;
+    getAllergies({ PatNum, Offset, Limit, DateFormatString, DateTimeFormatString, }: GetAllergiesParams): Promise<Allergy[]>;
     /**
      * Add an allergy to a patient.
      * @param {Object} data - The details of allergy to add.

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

@@ -1 +1 @@
-{"version":3,"file":"allergies.d.ts","sourceRoot":"","sources":["../../src/api/allergies.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,YAAY,CAAC,EACxB,MAAM,EACN,MAAM,GACP,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAa1C;;;;;;;;;;;OAWG;IACU,UAAU,CAAC,EACtB,MAAM,EACN,aAAa,EACb,cAAc,EACd,QAAQ,EACR,mBAAmB,EACnB,cAAc,GACf,EAAG,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAevC;;;;;;;;;OASG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,QAAQ,EACR,mBAAmB,EACnB,cAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAazC;;;;;OAKG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO9D"}
+{"version":3,"file":"allergies.d.ts","sourceRoot":"","sources":["../../src/api/allergies.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,YAAY,CAAC,EACxB,MAAM,EACN,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAiBxC;;;;;;;;;;;OAWG;IACU,UAAU,CAAC,EACtB,MAAM,EACN,aAAa,EACb,cAAc,EACd,QAAQ,EACR,mBAAmB,EACnB,cAAc,GACf,EAAG,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAevC;;;;;;;;;OASG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,QAAQ,EACR,mBAAmB,EACnB,cAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAazC;;;;;OAKG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO9D"}

package/dist/api/allergies.js

@@ -9,16 +9,22 @@ class Allergies {
      * Fetch patient's allergies with optional pagination.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} params.PatNum - Required. Filter by patient.
-     * @param {number} [params.Offset] - pagination.
+     * @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<Allergy>} - A list of a patient's allergies.
      */
-    async getAllergies({ PatNum, Offset, }) {
+    async getAllergies({ PatNum, Offset, Limit, DateFormatString, DateTimeFormatString, }) {
         if (!PatNum || typeof PatNum !== "number") {
-            throw new Error("PatNum is required to fetch allergies.");
+            throw new Error("Invalid parameter: PatNum is required.");
         }
         const params = {
             PatNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/allergies", params);
     }
@@ -36,7 +42,7 @@ class Allergies {
      */
     async addAllergy({ PatNum, AllergyDefNum, defDescription, Reaction, DateAdverseReaction, StatusIsActive, }) {
         if (!PatNum || (!AllergyDefNum && !defDescription)) {
-            throw new Error("Invalid data: PatNum and either AllergyDefNum or defDescription are required.");
+            throw new Error("Invalid parameter: PatNum and either AllergyDefNum or defDescription are required.");
         }
         return this.httpClient.post("/allergies", {
             PatNum,
@@ -59,7 +65,7 @@ class Allergies {
      */
     async updateAllergy({ AllergyNum, Reaction, DateAdverseReaction, StatusIsActive, }) {
         if (!AllergyNum || typeof AllergyNum !== "number") {
-            throw new Error("Invalid data: AllergyNum is required.");
+            throw new Error("Invalid parameter: AllergyNum is required.");
         }
         return this.httpClient.put(`/allergies/${AllergyNum}`, {
             AllergyNum,