@rinse-dental/open-dental 2.5.2 → 2.5.3

package/dist/api/paySplits.d.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { GetPaySplitsParams } from "../types/paySplitTypes";
+import { GetPaySplitsParams, UpdatePaySplitsParams } from "../types/paySplitTypes";
 export default class PaySplits {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -13,5 +13,15 @@ export default class PaySplits {
      * @returns {Promise<PaySplits[]>} - A list of paysplits.
      */
     getPaySplits({ PatNum, PayNum, ProcNum, Offset, }?: GetPaySplitsParams): Promise<PaySplits[]>;
+    /**
+       * 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.
+       * @throws {Error} - If required fields are missing.
+       */
+    updatePayment(data: UpdatePaySplitsParams): Promise<PaySplits>;
 }
 //# 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,EACnB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;OAQG;IACU,YAAY,CAAC,EACtB,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,GACP,GAAE,kBAAuB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAUlD"}
+{"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,aAAa,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;CAO9E"}

package/dist/api/paySplits.js

@@ -23,5 +23,20 @@ class PaySplits {
         };
         return this.httpClient.get("/paysplits", params);
     }
+    /**
+       * 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.
+       * @throws {Error} - If required fields are missing.
+       */
+    async updatePayment(data) {
+        if (!data.SplitNum) {
+            throw new Error("SplitNum is required.");
+        }
+        return this.httpClient.put(`/paysplits/${data.SplitNum}`, data);
+    }
 }
 exports.default = PaySplits;

package/dist/types/paySplitTypes.d.ts

@@ -30,4 +30,13 @@ export interface GetPaySplitsParams {
     ProcNum?: number;
     Offset?: number;
 }
+/**
+ * Parameters for UPDATE Pay Splits.
+ * @see https://www.opendental.com/site/apipaysplits.html
+ */
+export interface UpdatePaySplitsParams {
+    SplitNum?: number;
+    ProvNum?: number;
+    ClinicNum?: number;
+}
 //# sourceMappingURL=paySplitTypes.d.ts.map

package/dist/types/paySplitTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paySplitTypes.d.ts","sourceRoot":"","sources":["../../src/types/paySplitTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"paySplitTypes.d.ts","sourceRoot":"","sources":["../../src/types/paySplitTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "2.5.2",
+    "version": "2.5.3",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/paySplits.ts

@@ -2,6 +2,7 @@ import HttpClient from "../utils/httpClient";
 import {
   PaySplit,
   GetPaySplitsParams,
+  UpdatePaySplitsParams
 } from "../types/paySplitTypes";
 
 export default class PaySplits {
@@ -21,18 +22,35 @@ export default class PaySplits {
  * @returns {Promise<PaySplits[]>} - A list of paysplits.
  */
 public async getPaySplits({
+  PatNum,
+  PayNum,
+  ProcNum,
+  Offset,
+}: GetPaySplitsParams = {}): Promise<PaySplits[]> {
+  const params = {
     PatNum,
     PayNum,
     ProcNum,
     Offset,
-  }: GetPaySplitsParams = {}): Promise<PaySplits[]> {
-    const params = {
-      PatNum,
-      PayNum,
-      ProcNum,
-      Offset,
-    };
+  };
+
+  return this.httpClient.get<PaySplits[]>("/paysplits", params);
+}
+
+  /**
+     * 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.
+     * @throws {Error} - If required fields are missing.
+     */
+    public async updatePayment(data: UpdatePaySplitsParams): Promise<PaySplits> {
+      if (!data.SplitNum) {
+        throw new Error("SplitNum is required.");
+      }
   
-    return this.httpClient.get<PaySplits[]>("/paysplits", params);
-  }
+      return this.httpClient.put<PaySplits>(`/paysplits/${data.SplitNum}`, data);
+    }
 }

package/src/types/paySplitTypes.ts

@@ -31,4 +31,14 @@ export interface PaySplit {
     ProcNum?: number; //Optional. Get all PaySplits attached to a specific procedure.
     Offset?: number; // Pagination offset for results
   }
+
+  /**
+   * Parameters for UPDATE Pay Splits.
+   * @see https://www.opendental.com/site/apipaysplits.html
+   */
+  export interface UpdatePaySplitsParams {
+    SplitNum?: number; //Required in the URL.
+    ProvNum?: number; //Optional. 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.
+    ClinicNum?: number; // FK to clinic.ClinicNum.
+  }