@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/api/payPlans.d.ts

@@ -8,13 +8,22 @@ export default class PayPlans {
      * Mirrors GET /payplans
      * @see https://www.opendental.com/site/apipayplans.html
      * @param params - Query parameters: { PatNum: number } OR { Guarantor: number } (mutually exclusive, one required)
+     * @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.
      */
-    getPayPlans(params: {
+    getPayPlans(params: ({
         PatNum: number;
         Guarantor?: never;
     } | {
         Guarantor: number;
         PatNum?: never;
+    }) & {
+        Offset?: number;
+        Limit?: number;
+        DateFormatString?: string;
+        DateTimeFormatString?: string;
     }): Promise<PayPlan[]>;
     /**
      * Fetch a single payment plan by PayPlanNum.

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

@@ -1 +1 @@
-{"version":3,"file":"payPlans.d.ts","sourceRoot":"","sources":["../../src/api/payPlans.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,oBAAoB,EACpB,0BAA0B,EAC1B,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,uBAAuB,CAAC;AAS/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsBnI;;;;OAIG;IACU,UAAU,CAAC,EACtB,UAAU,GACX,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO1C;;;;;;;;;;;OAWG;IACU,oBAAoB,CAC/B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,OAAO,CAAC;IA4DnB;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAuDvE;;;;OAIG;IACU,YAAY,CAAC,EACxB,UAAU,GACX,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAaxC;;;;;;OAMG;IACU,oBAAoB,CAC/B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,OAAO,CAAC;CAoCpB"}
+{"version":3,"file":"payPlans.d.ts","sourceRoot":"","sources":["../../src/api/payPlans.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,oBAAoB,EACpB,0BAA0B,EAC1B,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,uBAAuB,CAAC;AAS/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,WAAW,CAAC,MAAM,EAAE,CAC7B;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,KAAK,CAAA;KAAE,GACrC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,KAAK,CAAA;KAAE,CACxC,GAAG;QACF,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,OAAO,EAAE,CAAC;IA0BtB;;;;OAIG;IACU,UAAU,CAAC,EACtB,UAAU,GACX,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO1C;;;;;;;;;;;OAWG;IACU,oBAAoB,CAC/B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,OAAO,CAAC;IAqDnB;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAmDvE;;;;OAIG;IACU,YAAY,CAAC,EACxB,UAAU,GACX,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAaxC;;;;;;OAMG;IACU,oBAAoB,CAC/B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,OAAO,CAAC;CA6BpB"}

package/dist/api/payPlans.js

@@ -14,6 +14,10 @@ class PayPlans {
      * Mirrors GET /payplans
      * @see https://www.opendental.com/site/apipayplans.html
      * @param params - Query parameters: { PatNum: number } OR { Guarantor: number } (mutually exclusive, one required)
+     * @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.
      */
     async getPayPlans(params) {
         // API requires either PatNum OR Guarantor, not both
@@ -26,6 +30,10 @@ class PayPlans {
         const query = clean({
             PatNum: 'PatNum' in params ? params.PatNum : undefined,
             Guarantor: 'Guarantor' in params ? params.Guarantor : undefined,
+            Offset: params.Offset,
+            Limit: params.Limit,
+            DateFormatString: params.DateFormatString,
+            DateTimeFormatString: params.DateTimeFormatString,
         });
         return this.httpClient.get("/payplans", query);
     }
@@ -55,24 +63,20 @@ class PayPlans {
     async createDynamicPayPlan(data) {
         // Validate required fields
         if (!data || typeof data !== "object") {
-            throw new Error("Invalid payload: createDynamicPayPlan requires a request body.");
+            throw new Error("Invalid parameter: createDynamicPayPlan requires a request body.");
         }
         if (!data.PatNum || typeof data.PatNum !== "number") {
-            throw new Error("Invalid payload: PatNum is required and must be a number.");
+            throw new Error("Invalid parameter: PatNum is required and must be a number.");
         }
         // Either PayAmt OR NumberOfPayments is required
         if (!data.PayAmt && !data.NumberOfPayments) {
-            throw new Error("Invalid payload: Either PayAmt or NumberOfPayments is required.");
+            throw new Error("Invalid parameter: Either PayAmt or NumberOfPayments is required.");
         }
         // At least one of procNums or adjNums must be provided and non-empty
         const hasProcNums = Array.isArray(data.procNums) && data.procNums.length > 0;
         const hasAdjNums = Array.isArray(data.adjNums) && data.adjNums.length > 0;
         if (!hasProcNums && !hasAdjNums) {
-            throw new Error("Invalid payload: At least one of procNums or adjNums must be a non-empty array.");
-        }
-        // Validate APR and IsLocked relationship
-        if (data.APR && data.APR > 0 && data.IsLocked === false) {
-            console.warn("Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences.");
+            throw new Error("Invalid parameter: At least one of procNums or adjNums must be a non-empty array.");
         }
         const payload = clean({
             PatNum: data.PatNum,
@@ -107,22 +111,21 @@ class PayPlans {
      *  - PayAmt OR NumberOfPayments
      */
     async createPayPlan(data) {
-        console.warn("Warning: createPayPlan is deprecated as of version 23.3.1. Use createDynamicPayPlan instead.");
         // Validate required fields
         if (!data || typeof data !== "object") {
-            throw new Error("Invalid payload: createPayPlan requires a request body.");
+            throw new Error("Invalid parameter: createPayPlan requires a request body.");
         }
         if (!data.PatNum || typeof data.PatNum !== "number") {
-            throw new Error("Invalid payload: PatNum is required and must be a number.");
+            throw new Error("Invalid parameter: PatNum is required and must be a number.");
         }
         // Either useEstBalance OR principalAmount is required
         if (data.useEstBalance === undefined &&
             data.principalAmount === undefined) {
-            throw new Error("Invalid payload: Either useEstBalance or principalAmount is required.");
+            throw new Error("Invalid parameter: Either useEstBalance or principalAmount is required.");
         }
         // Either PayAmt OR NumberOfPayments is required
         if (!data.PayAmt && !data.NumberOfPayments) {
-            throw new Error("Invalid payload: Either PayAmt or NumberOfPayments is required.");
+            throw new Error("Invalid parameter: Either PayAmt or NumberOfPayments is required.");
         }
         const payload = clean({
             PatNum: data.PatNum,
@@ -162,11 +165,7 @@ class PayPlans {
      */
     async updateDynamicPayPlan(data) {
         if (!data?.PayPlanNum || typeof data.PayPlanNum !== "number") {
-            throw new Error("Invalid payload: PayPlanNum is required and must be a number.");
-        }
-        // Validate APR and IsLocked relationship
-        if (data.APR && data.APR > 0 && data.IsLocked === false) {
-            console.warn("Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences.");
+            throw new Error("Invalid parameter: PayPlanNum is required and must be a number.");
         }
         const { PayPlanNum, ...updateFields } = data;
         const payload = clean({

package/dist/api/paySplits.d.ts

@@ -1,27 +1,32 @@
 import HttpClient from "../utils/httpClient";
-import { GetPaySplitsParams, UpdatePaySplitsParams } from "../types/paySplitTypes";
+import { PaySplit, GetPaySplitsParams, UpdatePaySplitsParams } from "../types/paySplitTypes";
 export default class PaySplits {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
-     * Fetch multiple payments with optional filtering and pagination.
+     * Fetch multiple payment splits with optional filtering and pagination.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} [params.PatNum] - Optional. Get all PaySplits for a single patient.
      * @param {number} [params.PayNum] - Optional. Get all PaySplits for a single payment.
      * @param {number} [params.ProcNum] - Optional. Get all PaySplits attached to a specific procedure.
-     * @param {number} [params.Offset] - Optional. Pagination offset for results.
-     * @returns {Promise<PaySplits[]>} - A list of paysplits.
+       * @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<PaySplit[]>} - A list of paysplits.
+     * @see https://www.opendental.com/site/apipaysplits.html
      */
-    getPaySplits({ PatNum, PayNum, ProcNum, Offset, }?: GetPaySplitsParams): Promise<PaySplits[]>;
+    getPaySplits({ PatNum, PayNum, ProcNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetPaySplitsParams): Promise<PaySplit[]>;
     /**
        * Update a paysplit.
        * @param {Object} data - Data for the updated paysplit.
        * @param {number} data.SplitNum - Required in the URL.
        * @param {number} [data.ProvNum] - FK to provider.ProvNum. This field can always be updated when the AllowPrepayProvider preference is enabled. Without this preference, ProvNum can only be updated for paysplits that do not have an UnearnedType.
        * @param {number} [data.ClinicNum] - FK to clinic.ClinicNum.
-       * @returns {Promise<PaySplits>} - The updated paysplit.
+       * @returns {Promise<PaySplit>} - The updated paysplit.
        * @throws {Error} - If required fields are missing.
+       * @see https://www.opendental.com/site/apipaysplits.html
        */
-    updatePaySplit(data: UpdatePaySplitsParams): Promise<PaySplits>;
+    updatePaySplit(data: UpdatePaySplitsParams): Promise<PaySplit>;
 }
 //# sourceMappingURL=paySplits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"paySplits.d.ts","sourceRoot":"","sources":["../../src/api/paySplits.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAEL,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;OAQG;IACU,YAAY,CAAC,EACxB,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,GACP,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAW/C;;;;;;;;SAQK;IACU,cAAc,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;CAO/E"}
+{"version":3,"file":"paySplits.d.ts","sourceRoot":"","sources":["../../src/api/paySplits.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;;;;;OAYG;IACU,YAAY,CAAC,EACxB,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACrB,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAe9C;;;;;;;;;SASK;IACU,cAAc,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAO9E"}

package/dist/api/paySplits.js

@@ -6,20 +6,27 @@ class PaySplits {
         this.httpClient = httpClient;
     }
     /**
-     * Fetch multiple payments with optional filtering and pagination.
+     * Fetch multiple payment splits with optional filtering and pagination.
      * @param {Object} params - The parameters for filtering and pagination.
      * @param {number} [params.PatNum] - Optional. Get all PaySplits for a single patient.
      * @param {number} [params.PayNum] - Optional. Get all PaySplits for a single payment.
      * @param {number} [params.ProcNum] - Optional. Get all PaySplits attached to a specific procedure.
-     * @param {number} [params.Offset] - Optional. Pagination offset for results.
-     * @returns {Promise<PaySplits[]>} - A list of paysplits.
+       * @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<PaySplit[]>} - A list of paysplits.
+     * @see https://www.opendental.com/site/apipaysplits.html
      */
-    async getPaySplits({ PatNum, PayNum, ProcNum, Offset, } = {}) {
+    async getPaySplits({ PatNum, PayNum, ProcNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             PatNum,
             PayNum,
             ProcNum,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/paysplits", params);
     }
@@ -29,12 +36,13 @@ class PaySplits {
        * @param {number} data.SplitNum - Required in the URL.
        * @param {number} [data.ProvNum] - FK to provider.ProvNum. This field can always be updated when the AllowPrepayProvider preference is enabled. Without this preference, ProvNum can only be updated for paysplits that do not have an UnearnedType.
        * @param {number} [data.ClinicNum] - FK to clinic.ClinicNum.
-       * @returns {Promise<PaySplits>} - The updated paysplit.
+       * @returns {Promise<PaySplit>} - The updated paysplit.
        * @throws {Error} - If required fields are missing.
+       * @see https://www.opendental.com/site/apipaysplits.html
        */
     async updatePaySplit(data) {
         if (!data.SplitNum) {
-            throw new Error("SplitNum is required.");
+            throw new Error("Invalid parameter: SplitNum is required.");
         }
         return this.httpClient.put(`/paysplits/${data.SplitNum}`, data);
     }

package/dist/api/payments.d.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { Payment, GetPaymentsParams, CreatePaymentParams, UpdatePaymentParams } from "../types/paymentTypes";
+import { Payment, GetPaymentsParams, CreatePaymentParams, UpdatePaymentParams, RefundPaymentParams } from "../types/paymentTypes";
 export default class Payments {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -9,10 +9,13 @@ export default class Payments {
      * @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
      * @param {number} [params.PatNum] - FK to patient.PatNum.
      * @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
-     * @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<Payment[]>} - A list of payments.
      */
-    getPayments({ PayType, PatNum, DateEntry, Offset, }?: GetPaymentsParams): Promise<Payment[]>;
+    getPayments({ PayType, PatNum, DateEntry, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetPaymentsParams): Promise<Payment[]>;
     /**
      * Create a payment.
      * @param {Object} data - Data for the new payment.
@@ -45,5 +48,17 @@ export default class Payments {
      * @throws {Error} - If required fields are missing.
      */
     updatePayment(data: UpdatePaymentParams): Promise<Payment>;
+    /**
+     * Issue a partial or full refund for an existing payment.
+     * Mirrors POST /payments/{PayNum}/Refund
+     * @param {Object} data - Refund details.
+     * @param {number} data.PayNum - Required. PK of the payment to refund.
+     * @param {number} data.RefundAmt - Required. Amount to refund; must be <= original PayAmt.
+     * @param {string} [data.PayNote] - Optional. Note for the refund record.
+     * @returns {Promise<Payment>} - The created refund payment.
+     * @throws {Error} - If PayNum or RefundAmt are missing.
+     * @see https://www.opendental.com/site/apipayments.html
+     */
+    refundPayment({ PayNum, RefundAmt, PayNote }: RefundPaymentParams): Promise<Payment>;
 }
 //# sourceMappingURL=payments.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/api/payments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;OAQG;IACU,WAAW,CAAC,EACrB,OAAO,EACP,MAAM,EACN,SAAS,EACT,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAW9C;;;;;;;;;;;;;;;;;OAiBG;IACY,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzE;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAOxE"}
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/api/payments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;;;;OAWG;IACU,WAAW,CAAC,EACrB,OAAO,EACP,MAAM,EACN,SAAS,EACT,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAe5C;;;;;;;;;;;;;;;;;OAiBG;IACY,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzE;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvE;;;;;;;;;;OAUG;IACU,aAAa,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CASlG"}

package/dist/api/payments.js

@@ -11,15 +11,21 @@ class Payments {
      * @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
      * @param {number} [params.PatNum] - FK to patient.PatNum.
      * @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
-     * @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<Payment[]>} - A list of payments.
      */
-    async getPayments({ PayType, PatNum, DateEntry, Offset, } = {}) {
+    async getPayments({ PayType, PatNum, DateEntry, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
         const params = {
             PayType,
             PatNum,
             DateEntry,
             Offset,
+            Limit,
+            DateFormatString,
+            DateTimeFormatString,
         };
         return this.httpClient.get("/payments", params);
     }
@@ -43,7 +49,7 @@ class Payments {
      */
     async createPayment(data) {
         if (!data.PayAmt || !data.PatNum) {
-            throw new Error("PayAmt and PatNum are required.");
+            throw new Error("Invalid parameter: PayAmt and PatNum are required.");
         }
         return this.httpClient.post("/payments", data);
     }
@@ -61,9 +67,29 @@ class Payments {
      */
     async updatePayment(data) {
         if (!data.PayNum) {
-            throw new Error("PayNum is required.");
+            throw new Error("Invalid parameter: PayNum is required.");
         }
         return this.httpClient.put(`/payments/${data.PayNum}`, data);
     }
+    /**
+     * Issue a partial or full refund for an existing payment.
+     * Mirrors POST /payments/{PayNum}/Refund
+     * @param {Object} data - Refund details.
+     * @param {number} data.PayNum - Required. PK of the payment to refund.
+     * @param {number} data.RefundAmt - Required. Amount to refund; must be <= original PayAmt.
+     * @param {string} [data.PayNote] - Optional. Note for the refund record.
+     * @returns {Promise<Payment>} - The created refund payment.
+     * @throws {Error} - If PayNum or RefundAmt are missing.
+     * @see https://www.opendental.com/site/apipayments.html
+     */
+    async refundPayment({ PayNum, RefundAmt, PayNote }) {
+        if (!PayNum || typeof PayNum !== "number") {
+            throw new Error("Invalid parameter: PayNum must be a valid number.");
+        }
+        if (RefundAmt === undefined || RefundAmt === null) {
+            throw new Error("Invalid parameter: RefundAmt is required.");
+        }
+        return this.httpClient.post(`/payments/${PayNum}/Refund`, { RefundAmt, PayNote });
+    }
 }
 exports.default = Payments;

package/dist/api/perioExams.d.ts

@@ -0,0 +1,67 @@
+import HttpClient from "../utils/httpClient";
+import { PerioExam, GetPerioExamsParams, CreatePerioExamParams, UpdatePerioExamParams } from "../types/perioExamTypes";
+export default class PerioExams {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves a single periodontal exam record by primary key.
+     * @param {number} PerioExamNum - Required. Primary key of the perioexam.
+     * @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<PerioExam>} - The periodontal exam record.
+     * @throws {Error} - If PerioExamNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    getPerioExam(PerioExamNum: number): Promise<PerioExam>;
+    /**
+     * Retrieves multiple periodontal exam records with optional filtering.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.PatNum] - Optional. FK to patient.PatNum.
+     * @param {string} [params.ExamDate] - Optional. Format: yyyy-MM-dd; retrieves exams on or after this date.
+     * @returns {Promise<PerioExam[]>} - A list of periodontal exam records.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    getPerioExams(params?: GetPerioExamsParams): Promise<PerioExam[]>;
+    /**
+     * Creates a new periodontal exam, optionally including surface measurement strings.
+     * Surface measurement strings: each digit (0–9) is a probing measurement;
+     * optional letter flags can follow each digit: b=bleeding, s=suppuration, p=plaque, c=calculus.
+     * @param {Object} data - The details of the perioexam to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.UpperFacial] - Optional. Measurement string for facial surfaces of upper teeth (1–16).
+     * @param {string} [data.UpperLingual] - Optional. Measurement string for lingual surfaces of upper teeth (1–16).
+     * @param {string} [data.LowerLingual] - Optional. Measurement string for lingual surfaces of lower teeth (17–32).
+     * @param {string} [data.LowerFacial] - Optional. Measurement string for facial surfaces of lower teeth (17–32).
+     * @param {string} [data.ExamDate] - Optional. Format: yyyy-MM-dd; defaults to today (v23.3.27+).
+     * @param {number} [data.ProvNum] - Optional. FK to provider.ProvNum; defaults to patient's primary provider (v23.3.27+).
+     * @param {string} [data.Note] - Optional. Exam notes (v23.3.27+).
+     * @returns {Promise<PerioExam>} - The created perioexam record.
+     * @throws {Error} - If PatNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    createPerioExam({ PatNum, UpperFacial, UpperLingual, LowerLingual, LowerFacial, ExamDate, ProvNum, Note, }: CreatePerioExamParams): Promise<PerioExam>;
+    /**
+     * Updates exam-level metadata for an existing perioexam.
+     * Note field overwrites the existing value.
+     * @param {Object} data - The details of the perioexam to update.
+     * @param {number} data.PerioExamNum - Required. Primary key of the perioexam.
+     * @param {string} [data.ExamDate] - Optional. Format: yyyy-MM-dd.
+     * @param {number} [data.ProvNum] - Optional. FK to provider.ProvNum.
+     * @param {string} [data.Note] - Optional. Overwrites existing note.
+     * @returns {Promise<PerioExam>} - The updated perioexam record.
+     * @throws {Error} - If PerioExamNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    updatePerioExam({ PerioExamNum, ExamDate, ProvNum, Note, }: UpdatePerioExamParams): Promise<PerioExam>;
+    /**
+     * Deletes a periodontal exam and all of its associated periomeasure records.
+     * @param {number} PerioExamNum - Required. Primary key of the perioexam.
+     * @returns {Promise<void>}
+     * @throws {Error} - If PerioExamNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    deletePerioExam(PerioExamNum: number): Promise<void>;
+}
+//# sourceMappingURL=perioExams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perioExams.d.ts","sourceRoot":"","sources":["../../src/api/perioExams.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,mBAAmB,EACnB,qBAAqB,EACrB,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,SAAS,CAAC;IAQnE;;;;;;;OAOG;IACU,aAAa,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAI9E;;;;;;;;;;;;;;;;OAgBG;IACU,eAAe,CAAC,EAC3B,MAAM,EACN,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,OAAO,EACP,IAAI,GACL,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAiB7C;;;;;;;;;;;OAWG;IACU,eAAe,CAAC,EAC3B,YAAY,EACZ,QAAQ,EACR,OAAO,EACP,IAAI,GACL,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAY7C;;;;;;OAMG;IACU,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOlE"}

package/dist/api/perioExams.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PerioExams {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Retrieves a single periodontal exam record by primary key.
+     * @param {number} PerioExamNum - Required. Primary key of the perioexam.
+     * @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<PerioExam>} - The periodontal exam record.
+     * @throws {Error} - If PerioExamNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    async getPerioExam(PerioExamNum) {
+        if (!PerioExamNum || typeof PerioExamNum !== "number") {
+            throw new Error("Invalid parameter: A valid PerioExamNum is required.");
+        }
+        return this.httpClient.get(`/perioexams/${PerioExamNum}`);
+    }
+    /**
+     * Retrieves multiple periodontal exam records with optional filtering.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.PatNum] - Optional. FK to patient.PatNum.
+     * @param {string} [params.ExamDate] - Optional. Format: yyyy-MM-dd; retrieves exams on or after this date.
+     * @returns {Promise<PerioExam[]>} - A list of periodontal exam records.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    async getPerioExams(params) {
+        return this.httpClient.get("/perioexams", params);
+    }
+    /**
+     * Creates a new periodontal exam, optionally including surface measurement strings.
+     * Surface measurement strings: each digit (0–9) is a probing measurement;
+     * optional letter flags can follow each digit: b=bleeding, s=suppuration, p=plaque, c=calculus.
+     * @param {Object} data - The details of the perioexam to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.UpperFacial] - Optional. Measurement string for facial surfaces of upper teeth (1–16).
+     * @param {string} [data.UpperLingual] - Optional. Measurement string for lingual surfaces of upper teeth (1–16).
+     * @param {string} [data.LowerLingual] - Optional. Measurement string for lingual surfaces of lower teeth (17–32).
+     * @param {string} [data.LowerFacial] - Optional. Measurement string for facial surfaces of lower teeth (17–32).
+     * @param {string} [data.ExamDate] - Optional. Format: yyyy-MM-dd; defaults to today (v23.3.27+).
+     * @param {number} [data.ProvNum] - Optional. FK to provider.ProvNum; defaults to patient's primary provider (v23.3.27+).
+     * @param {string} [data.Note] - Optional. Exam notes (v23.3.27+).
+     * @returns {Promise<PerioExam>} - The created perioexam record.
+     * @throws {Error} - If PatNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    async createPerioExam({ PatNum, UpperFacial, UpperLingual, LowerLingual, LowerFacial, ExamDate, ProvNum, Note, }) {
+        if (!PatNum || typeof PatNum !== "number") {
+            throw new Error("Invalid parameter: A valid PatNum is required.");
+        }
+        return this.httpClient.post("/perioexams", {
+            PatNum,
+            UpperFacial,
+            UpperLingual,
+            LowerLingual,
+            LowerFacial,
+            ExamDate,
+            ProvNum,
+            Note,
+        });
+    }
+    /**
+     * Updates exam-level metadata for an existing perioexam.
+     * Note field overwrites the existing value.
+     * @param {Object} data - The details of the perioexam to update.
+     * @param {number} data.PerioExamNum - Required. Primary key of the perioexam.
+     * @param {string} [data.ExamDate] - Optional. Format: yyyy-MM-dd.
+     * @param {number} [data.ProvNum] - Optional. FK to provider.ProvNum.
+     * @param {string} [data.Note] - Optional. Overwrites existing note.
+     * @returns {Promise<PerioExam>} - The updated perioexam record.
+     * @throws {Error} - If PerioExamNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    async updatePerioExam({ PerioExamNum, ExamDate, ProvNum, Note, }) {
+        if (!PerioExamNum || typeof PerioExamNum !== "number") {
+            throw new Error("Invalid parameter: A valid PerioExamNum is required.");
+        }
+        return this.httpClient.put(`/perioexams/${PerioExamNum}`, {
+            ExamDate,
+            ProvNum,
+            Note,
+        });
+    }
+    /**
+     * Deletes a periodontal exam and all of its associated periomeasure records.
+     * @param {number} PerioExamNum - Required. Primary key of the perioexam.
+     * @returns {Promise<void>}
+     * @throws {Error} - If PerioExamNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperioexams.html
+     */
+    async deletePerioExam(PerioExamNum) {
+        if (!PerioExamNum || typeof PerioExamNum !== "number") {
+            throw new Error("Invalid parameter: A valid PerioExamNum is required.");
+        }
+        return this.httpClient.delete(`/perioexams/${PerioExamNum}`);
+    }
+}
+exports.default = PerioExams;

package/dist/api/perioMeasures.d.ts

@@ -0,0 +1,74 @@
+import HttpClient from "../utils/httpClient";
+import { PerioMeasure, GetPerioMeasuresParams, CreatePerioMeasureParams, UpdatePerioMeasureParams } from "../types/perioMeasureTypes";
+export default class PerioMeasures {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Retrieves periomeasure records with optional filtering by exam.
+     * @param {Object} [params] - Optional filter parameters.
+     * @param {number} [params.PerioExamNum] - Optional. FK to perioexam.PerioExamNum; filter to a specific exam.
+     * @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<PerioMeasure[]>} - A list of periomeasure records.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    getPerioMeasures(params?: GetPerioMeasuresParams): Promise<PerioMeasure[]>;
+    /**
+     * Creates a new periomeasure.
+     * Only one PerioMeasure per SequenceType per tooth per exam is allowed.
+     * Sentinel value -1 means "not applicable" for any surface or tooth value field.
+     *
+     * SequenceType valid value ranges:
+     * - "Mobility":         ToothValue 0–19; all surface values must be -1
+     * - "Furcation":        ToothValue must be -1; surface values -1 or 0–19
+     * - "GingMargin":       ToothValue must be -1; surface values -1, 0–19, or 101–119 (101–119 = negative: subtract 100)
+     * - "MGJ":              ToothValue must be -1; surface values -1 or 0–19; lingual values must be -1 for teeth 1–16
+     * - "Probing":          ToothValue must be -1; surface values -1 or 0–19
+     * - "SkipTooth":        ToothValue must be 1; all surface values must be -1
+     * - "BleedSupPlaqCalc": ToothValue must be -1; surface values 0–15 (bitfield: bleeding=1, suppuration=2, plaque=4, calculus=8)
+     *
+     * @param {Object} data - The details of the periomeasure to create.
+     * @param {number} data.PerioExamNum - Required. FK to perioexam.PerioExamNum.
+     * @param {string} data.SequenceType - Required. Measurement classification enum.
+     * @param {number} data.IntTooth - Required. Tooth number 1–32.
+     * @param {number} [data.ToothValue] - Optional. Whole-tooth measurement; default: -1 (not applicable).
+     * @param {number} [data.MBvalue] - Optional. Mesial-buccal surface value; default: -1.
+     * @param {number} [data.Bvalue] - Optional. Buccal surface value; default: -1.
+     * @param {number} [data.DBvalue] - Optional. Distal-buccal surface value; default: -1.
+     * @param {number} [data.MLvalue] - Optional. Mesial-lingual surface value; default: -1.
+     * @param {number} [data.Lvalue] - Optional. Lingual surface value; default: -1.
+     * @param {number} [data.DLvalue] - Optional. Distal-lingual surface value; default: -1.
+     * @returns {Promise<PerioMeasure>} - The created periomeasure record.
+     * @throws {Error} - If PerioExamNum is not a valid number, SequenceType is missing, or IntTooth is not a valid number.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    createPerioMeasure({ PerioExamNum, SequenceType, IntTooth, ToothValue, MBvalue, Bvalue, DBvalue, MLvalue, Lvalue, DLvalue, }: CreatePerioMeasureParams): Promise<PerioMeasure>;
+    /**
+     * Updates measurement values on an existing periomeasure.
+     * SequenceType and IntTooth cannot be changed after creation.
+     * @param {Object} data - The details of the periomeasure to update.
+     * @param {number} data.PerioMeasureNum - Required. Primary key.
+     * @param {number} [data.ToothValue] - Optional. Updated whole-tooth measurement.
+     * @param {number} [data.MBvalue] - Optional. Updated mesial-buccal surface value.
+     * @param {number} [data.Bvalue] - Optional. Updated buccal surface value.
+     * @param {number} [data.DBvalue] - Optional. Updated distal-buccal surface value.
+     * @param {number} [data.MLvalue] - Optional. Updated mesial-lingual surface value.
+     * @param {number} [data.Lvalue] - Optional. Updated lingual surface value.
+     * @param {number} [data.DLvalue] - Optional. Updated distal-lingual surface value.
+     * @returns {Promise<PerioMeasure>} - The updated periomeasure record.
+     * @throws {Error} - If PerioMeasureNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    updatePerioMeasure({ PerioMeasureNum, ToothValue, MBvalue, Bvalue, DBvalue, MLvalue, Lvalue, DLvalue, }: UpdatePerioMeasureParams): Promise<PerioMeasure>;
+    /**
+     * Deletes a periomeasure. Only records with SequenceType "Mobility" or "SkipTooth" can be deleted.
+     * @param {number} PerioMeasureNum - Required. Primary key.
+     * @returns {Promise<void>}
+     * @throws {Error} - If PerioMeasureNum is not a valid number.
+     * @see https://www.opendental.com/site/apiperiomeasures.html
+     */
+    deletePerioMeasure(PerioMeasureNum: number): Promise<void>;
+}
+//# sourceMappingURL=perioMeasures.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perioMeasures.d.ts","sourceRoot":"","sources":["../../src/api/perioMeasures.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,gBAAgB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAIvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,kBAAkB,CAAC,EAC9B,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,MAAM,EACN,OAAO,GACR,EAAE,wBAAwB,GAAG,OAAO,CAAC,YAAY,CAAC;IAyBnD;;;;;;;;;;;;;;;OAeG;IACU,kBAAkB,CAAC,EAC9B,eAAe,EACf,UAAU,EACV,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,MAAM,EACN,OAAO,GACR,EAAE,wBAAwB,GAAG,OAAO,CAAC,YAAY,CAAC;IAgBnD;;;;;;OAMG;IACU,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOxE"}