@rinse-dental/open-dental 0.1.7 → 1.0.1

package/deploy_notes.txt

@@ -1,13 +1,17 @@
 npm run build
-npm version patch //patch, minor, major
-npm pack
+
 git add .
 git commit -m "notes"
+
+npm version patch //patch, minor, major
+npm pack
 git push origin main
 git tag //confirm tag
 git push origin vX.Y.Z
 gh release create vX.Y.Z --title "Release vX.Y.Z" --notes ""
 
+gh release create v1.0.0 --title "Release v1.0.0" --notes "first major release"
+
 if the tag doesn't exist locally: 
 git tag vX.Y.Z
 git push origin vX.Y.Z

package/dist/api/definitions.d.ts

@@ -0,0 +1,16 @@
+import HttpClient from "../utils/httpClient";
+import { Definition, GetDefinitionsParams } from "../types/definitionTypes";
+export default class Definitions {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple definitions with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.Category] - Filter by category.
+     * @param {"true" | "false"} [data.includeHidden="false"] - Optional parameter that defaults to false.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Definition[]>} - A list of definitions.
+     */
+    getDefinitions({ Category, includeHidden, Offset, }?: GetDefinitionsParams): Promise<Definition[]>;
+}
+//# sourceMappingURL=definitions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/api/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;OAOG;IACU,cAAc,CAAC,EACxB,QAAQ,EACR,aAAa,EACb,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CASrD"}

package/dist/api/definitions.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Definitions {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch multiple definitions with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.Category] - Filter by category.
+     * @param {"true" | "false"} [data.includeHidden="false"] - Optional parameter that defaults to false.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Definition[]>} - A list of definitions.
+     */
+    async getDefinitions({ Category, includeHidden, Offset, } = {}) {
+        const params = {
+            Category,
+            includeHidden,
+            Offset,
+        };
+        return this.httpClient.get("/definitions", params);
+    }
+}
+exports.default = Definitions;

package/dist/api/discountPlanSubs.d.ts

@@ -0,0 +1,46 @@
+import HttpClient from "../utils/httpClient";
+import { DiscountPlanSub, GetDiscountPlanSubsParams, CreateDiscountPlanSubParams, UpdateDiscountPlanSubParams } from "../types/discountPlanSubTypes";
+export default class DiscountPlanSubs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple definitinos with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PatNum] - Filter by patient.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<DiscountPlanSub[]>} - A list of appointments.
+     */
+    getDiscountPlanSubs({ PatNum, Offset, }?: GetDiscountPlanSubsParams): Promise<DiscountPlanSub[]>;
+    /**
+     * Create a new discount plan sub.
+     * @param {Object} data - The details of discount plan sub to create.
+     * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createDiscountPlanSub(data: CreateDiscountPlanSubParams): Promise<DiscountPlanSub>;
+    /**
+     * Update a discount plan sub.
+     * @param {Object} data - The details of the discount sub to update.
+     * @param {number} data.DiscountSubNum - Required: PK
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub>;
+    /**
+     * Delete a discount plan sub entry.
+     * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
+     */
+    deleteDiscountPlanSub(DiscountSubNum: number): Promise<void>;
+}
+//# sourceMappingURL=discountPlanSubs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discountPlanSubs.d.ts","sourceRoot":"","sources":["../../src/api/discountPlanSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,mBAAmB,CAAC,EAC/B,MAAM,EACN,MAAM,GACP,GAAE,yBAA8B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS9D;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;OAKG;IACU,qBAAqB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}

package/dist/api/discountPlanSubs.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class DiscountPlanSubs {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch multiple definitinos with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PatNum] - Filter by patient.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<DiscountPlanSub[]>} - A list of appointments.
+     */
+    async getDiscountPlanSubs({ PatNum, Offset, } = {}) {
+        const params = {
+            PatNum,
+            Offset,
+        };
+        return this.httpClient.get("/discountplansubs", params);
+    }
+    /**
+     * Create a new discount plan sub.
+     * @param {Object} data - The details of discount plan sub to create.
+     * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createDiscountPlanSub(data) {
+        if (!data.DiscountPlanNum || !data.PatNum) {
+            throw new Error("Invalid data: DiscountPlanNum and PatNum are required.");
+        }
+        return this.httpClient.post("/discountplansubs", data);
+    }
+    /**
+     * Update a discount plan sub.
+     * @param {Object} data - The details of the discount sub to update.
+     * @param {number} data.DiscountSubNum - Required: PK
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateDiscountPlanSub(data) {
+        if (!data.DiscountSubNum || !data.PatNum) {
+            throw new Error("Invalid data: DiscountSubNum and PatNum are required.");
+        }
+        return this.httpClient.put(`/discountplansubs/${data.DiscountSubNum}`, data);
+    }
+    /**
+     * Delete a discount plan sub entry.
+     * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
+     */
+    async deleteDiscountPlanSub(DiscountSubNum) {
+        if (!DiscountSubNum || typeof DiscountSubNum !== "number") {
+            throw new Error("Invalid parameter: ProcNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/discountplansubs/${DiscountSubNum}`);
+    }
+}
+exports.default = DiscountPlanSubs;

package/dist/api/index.d.ts

@@ -6,5 +6,10 @@ export { default as Patients } from "./patients";
 export { default as ProcedureLogs } from "./procedureLog";
 export { default as Recalls } from "./recalls";
 export { default as TreatmentPlans } from "./treatplans";
-export { default as Schedule } from "./schedules";
+export { default as Schedules } from "./schedules";
+export { default as Providers } from "./providers";
+export { default as Operatories } from "./operatories";
+export { default as Payments } from "./payments";
+export { default as Definitions } from "./definitions";
+export { default as DiscountPlanSubs } from "./discountPlanSubs";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/api/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schedule = exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
+exports.DiscountPlanSubs = exports.Definitions = exports.Payments = exports.Operatories = exports.Providers = exports.Schedules = exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
 var appointments_1 = require("./appointments");
 Object.defineProperty(exports, "Appointments", { enumerable: true, get: function () { return __importDefault(appointments_1).default; } });
 var chartModules_1 = require("./chartModules");
@@ -21,5 +21,15 @@ Object.defineProperty(exports, "Recalls", { enumerable: true, get: function () {
 var treatplans_1 = require("./treatplans");
 Object.defineProperty(exports, "TreatmentPlans", { enumerable: true, get: function () { return __importDefault(treatplans_1).default; } });
 var schedules_1 = require("./schedules");
-Object.defineProperty(exports, "Schedule", { enumerable: true, get: function () { return __importDefault(schedules_1).default; } });
+Object.defineProperty(exports, "Schedules", { enumerable: true, get: function () { return __importDefault(schedules_1).default; } });
+var providers_1 = require("./providers");
+Object.defineProperty(exports, "Providers", { enumerable: true, get: function () { return __importDefault(providers_1).default; } });
+var operatories_1 = require("./operatories");
+Object.defineProperty(exports, "Operatories", { enumerable: true, get: function () { return __importDefault(operatories_1).default; } });
+var payments_1 = require("./payments");
+Object.defineProperty(exports, "Payments", { enumerable: true, get: function () { return __importDefault(payments_1).default; } });
+var definitions_1 = require("./definitions");
+Object.defineProperty(exports, "Definitions", { enumerable: true, get: function () { return __importDefault(definitions_1).default; } });
+var discountPlanSubs_1 = require("./discountPlanSubs");
+Object.defineProperty(exports, "DiscountPlanSubs", { enumerable: true, get: function () { return __importDefault(discountPlanSubs_1).default; } });
 // Add other APIs as needed

package/dist/api/operatories.d.ts

@@ -5,9 +5,9 @@ export default class Operatories {
     constructor(httpClient: HttpClient);
     /**
      * Fetch a single operatory by its ID.
-     * @param {number} OperatoryNum - The ID of the patfield.
-     * @returns {Promise<Operatory>} - The patient data.
-     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     * @param {number} OperatoryNum - The ID of the operatory.
+     * @returns {Promise<Operatory>} - The operatory data.
+     * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
      */
     getOperatory(OperatoryNum: number): Promise<Operatory>;
     /**
@@ -15,7 +15,7 @@ export default class Operatories {
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.ClinicNum] - Filter by clinicnum
      * @param {string} [params.Offset] - Filter by clinicnum
-    * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+    * @returns {Promise<Operatory[]>} - A list of operatories.
      * @throws {Error} - If the API returns an error.
      */
     getOperatories({ ClinicNum, Offset, }?: GetOperatoriesParams): Promise<Operatory[]>;

package/dist/api/operatories.js

@@ -7,9 +7,9 @@ class Operatories {
     }
     /**
      * Fetch a single operatory by its ID.
-     * @param {number} OperatoryNum - The ID of the patfield.
-     * @returns {Promise<Operatory>} - The patient data.
-     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     * @param {number} OperatoryNum - The ID of the operatory.
+     * @returns {Promise<Operatory>} - The operatory data.
+     * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
      */
     async getOperatory(OperatoryNum) {
         if (!OperatoryNum || typeof OperatoryNum !== "number") {
@@ -22,7 +22,7 @@ class Operatories {
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.ClinicNum] - Filter by clinicnum
      * @param {string} [params.Offset] - Filter by clinicnum
-    * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+    * @returns {Promise<Operatory[]>} - A list of operatories.
      * @throws {Error} - If the API returns an error.
      */
     async getOperatories({ ClinicNum, Offset, } = {}) {

package/dist/api/patFields.d.ts

@@ -6,17 +6,17 @@ export default class PatFields {
     /**
      * Fetch a single patfield by its ID.
      * @param {number} PatFieldNum - The ID of the patfield.
-     * @returns {Promise<PatField>} - The patient data.
+     * @returns {Promise<PatField>} - The patfield data.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
     getPatField(PatFieldNum: number): Promise<PatField>;
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * Fetch multiple patfields with optional filtering and pagination.
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.PatNum] - Filter by last name (case-insensitive, partial match).
      * @param {string} [params.FieldName] - Filter by last name (case-insensitive, partial match).
      * @param {string} [params.SecDateTEdit] - Filter by last name (case-insensitive, partial match).
-     * @returns {Promise<PatField[]>} - A list of summarized patient data.
+     * @returns {Promise<PatField[]>} - A list of patfields.
      * @throws {Error} - If the API returns an error.
      */
     getPatFields({ PatNum, FieldName, SecDateTEdit, }?: GetPatFieldsParams): Promise<PatField[]>;

package/dist/api/patFields.js

@@ -8,7 +8,7 @@ class PatFields {
     /**
      * Fetch a single patfield by its ID.
      * @param {number} PatFieldNum - The ID of the patfield.
-     * @returns {Promise<PatField>} - The patient data.
+     * @returns {Promise<PatField>} - The patfield data.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
     async getPatField(PatFieldNum) {
@@ -18,12 +18,12 @@ class PatFields {
         return await this.httpClient.get(`/patfields/${PatFieldNum}`);
     }
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * Fetch multiple patfields with optional filtering and pagination.
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.PatNum] - Filter by last name (case-insensitive, partial match).
      * @param {string} [params.FieldName] - Filter by last name (case-insensitive, partial match).
      * @param {string} [params.SecDateTEdit] - Filter by last name (case-insensitive, partial match).
-     * @returns {Promise<PatField[]>} - A list of summarized patient data.
+     * @returns {Promise<PatField[]>} - A list of patfields.
      * @throws {Error} - If the API returns an error.
      */
     async getPatFields({ PatNum, FieldName, SecDateTEdit, } = {}) {

package/dist/api/payments.d.ts

@@ -0,0 +1,49 @@
+import HttpClient from "../utils/httpClient";
+import { Payment, GetPaymentsParams, CreatePaymentParams, UpdatePaymentParams } from "../types/paymentTypes";
+export default class Payments {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple payments with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @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.
+     * @returns {Promise<Payment[]>} - A list of payments.
+     */
+    getPayments({ PayType, PatNum, DateEntry, Offset, }?: GetPaymentsParams): Promise<Payment[]>;
+    /**
+     * Create a payment.
+     * @param {Object} data - Data for the new payment.
+     * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
+     * @param {number} data.PatNum - Required: FK to Patient
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
+     * @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
+     * @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+     * @param {number[]} [data.procNums=[]] - Optional. An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
+     * @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+     * @returns {Promise<Payment>} - The created payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    createPayment(data: CreatePaymentParams): Promise<Payment>;
+    /**
+     * Update a payment.
+     * @param {Object} data - Data for the new payment.
+     * @param {string} data.PayNum - Required: PK of Payment to update.
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+     * @returns {Promise<Payment>} - The updated payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    updatePayment(data: UpdatePaymentParams): Promise<Payment>;
+}
+//# sourceMappingURL=payments.d.ts.map

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

@@ -0,0 +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"}

package/dist/api/payments.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Payments {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch multiple payments with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @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.
+     * @returns {Promise<Payment[]>} - A list of payments.
+     */
+    async getPayments({ PayType, PatNum, DateEntry, Offset, } = {}) {
+        const params = {
+            PayType,
+            PatNum,
+            DateEntry,
+            Offset,
+        };
+        return this.httpClient.get("/payments", params);
+    }
+    /**
+     * Create a payment.
+     * @param {Object} data - Data for the new payment.
+     * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
+     * @param {number} data.PatNum - Required: FK to Patient
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
+     * @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
+     * @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+     * @param {number[]} [data.procNums=[]] - Optional. An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
+     * @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+     * @returns {Promise<Payment>} - The created payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async createPayment(data) {
+        if (!data.PayAmt || !data.PatNum) {
+            throw new Error("PayAmt and PatNum are required.");
+        }
+        return this.httpClient.post("/payments", data);
+    }
+    /**
+     * Update a payment.
+     * @param {Object} data - Data for the new payment.
+     * @param {string} data.PayNum - Required: PK of Payment to update.
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+     * @returns {Promise<Payment>} - The updated payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async updatePayment(data) {
+        if (!data.PayNum) {
+            throw new Error("PayNum is required.");
+        }
+        return this.httpClient.put(`/payments/${data.PayNum}`, data);
+    }
+}
+exports.default = Payments;

package/dist/api/providers.d.ts

@@ -16,56 +16,56 @@ export default class Providers {
      * @param {number} [params.ClinicNum] - Get providers by ClinicNum
      * @param {string} [params.DateTStamp] - Get providers altered after the specified date and time
      * @param {string} [params.Offset] - Pagination
-    * @returns {Promise<Provider[]>} - A list of summarized patient data.
+    * @returns {Promise<Provider[]>} - A list of providers.
      * @throws {Error} - If the API returns an error.
      */
     getProviders({ ClinicNum, DateTStamp, Offset, }?: GetProviderParams): Promise<Provider[]>;
     /**
      * Creates a provider. Cannot create PatFields associated with hidden PatFieldDefs.
-     * @param {Object} data - The data for the new patfield.
+     * @param {Object} data - The data for the new provider.
      * @param {string} data.Abbr - Required.
-     * @param {string} data.LName - Optional.
-     * @param {string} data.FName - Optional.
-     * @param {string} data.MI - Optional.
-     * @param {string} data.Suffix - Optional.
-     * @param {number} data.FeeSched - Optional.
-     * @param {number} data.Specialty - Optional.
-     * @param {string} data.SSN - Optional.
-     * @param {'true' | 'false'} data.IsSecondary - Optional.
-     * @param {'true' | 'false'} data.IsHidden - Optional.
-     * @param {'true' | 'false'} data.UsingTIN - Optional.
-     * @param {'true' | 'false'} data.SigOnFile - Optional.
-     * @param {'true' | 'false'} data.IsNotPerson - Optional.
-     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
-     * @param {string} data.Birthdate - Optional.
-     * @param {string} data.SchedNote - Optional.
-     * @param {string} data.PreferredName - Optional.
-     * @returns {Promise<Provider>} - The created PatField.
+     * @param {string} [data.LName] - Optional.
+     * @param {string} [data.FName] - Optional.
+     * @param {string} [data.MI] - Optional.
+     * @param {string} [data.Suffix] - Optional.
+     * @param {number} [data.FeeSched] - Optional.
+     * @param {number} [data.Specialty] - Optional.
+     * @param {string} [data.SSN] - Optional.
+     * @param {'true' | 'false'} [data.IsSecondary] - Optional.
+     * @param {'true' | 'false'} [data.IsHidden] - Optional.
+     * @param {'true' | 'false'} [data.UsingTIN] - Optional.
+     * @param {'true' | 'false'} [data.SigOnFile] - Optional.
+     * @param {'true' | 'false'} [data.IsNotPerson] - Optional.
+     * @param {'true' | 'false'} [data.IsHiddenReport] - Optional.
+     * @param {string} [data.Birthdate] - Optional.
+     * @param {string} [data.SchedNote] - Optional.
+     * @param {string} [data.PreferredName] - Optional.
+     * @returns {Promise<Provider>} - The created provider.
      * @throws {Error} - If the data is invalid or the API returns an error.
      */
     createProvider({ Abbr, LName, FName, MI, Suffix, FeeSched, Specialty, SSN, IsSecondary, IsHidden, UsingTIN, SigOnFile, IsNotPerson, IsHiddenReport, Birthdate, SchedNote, PreferredName, }: createProviderParams): Promise<Provider>;
     /**
      * Update a provider.
      * @param {number} ProvNum - The ID of the provider.
-     * @param {Object} data - The data for the new patfield.
-     * @param {string} data.Abbr - Optional but must not be blank.
-     * @param {string} data.LName - Optional.
-     * @param {string} data.FName - Optional.
-     * @param {string} data.MI - Optional.
-     * @param {string} data.Suffix - Optional.
-     * @param {number} data.FeeSched - Optional.
-     * @param {number} data.Specialty - Optional.
-     * @param {string} data.SSN - Optional.
-     * @param {'true' | 'false'} data.IsSecondary - Optional.
-     * @param {'true' | 'false'} data.IsHidden - Optional.
-     * @param {'true' | 'false'} data.UsingTIN - Optional.
-     * @param {'true' | 'false'} data.SigOnFile - Optional.
-     * @param {'true' | 'false'} data.IsNotPerson - Optional.
-     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
-     * @param {string} data.Birthdate - Optional.
-     * @param {string} data.SchedNote - Optional.
-     * @param {string} data.PreferredName - Optional.
-     * @returns {Promise<Provider>} - The created PatField.
+     * @param {Object} data - The data for a provider.
+     * @param {string} [data.Abbr] - Optional but must not be blank.
+     * @param {string} [data.LName] - Optional.
+     * @param {string} [data.FName] - Optional.
+     * @param {string} [data.MI] - Optional.
+     * @param {string} [data.Suffix] - Optional.
+     * @param {number} [data.FeeSched] - Optional.
+     * @param {number} [data.Specialty] - Optional.
+     * @param {string} [data.SSN] - Optional.
+     * @param {'true' | 'false'} [data.IsSecondary] - Optional.
+     * @param {'true' | 'false'} [data.IsHidden] - Optional.
+     * @param {'true' | 'false'} [data.UsingTIN] - Optional.
+     * @param {'true' | 'false'} [data.SigOnFile] - Optional.
+     * @param {'true' | 'false'} [data.IsNotPerson] - Optional.
+     * @param {'true' | 'false'} [data.IsHiddenReport] - Optional.
+     * @param {string} [data.Birthdate] - Optional.
+     * @param {string} [data.SchedNote] - Optional.
+     * @param {string} [data.PreferredName] - Optional.
+     * @returns {Promise<Provider>} - The updated Provider.
      * @throws {Error} - If the data is invalid or the API returns an error.
      */
     updateProvider({ ProvNum, Abbr, LName, FName, MI, Suffix, Specialty, SSN, NationalProvID, StateLicense, UsingTIN, SigOnFile, PreferredName, }: updateProviderParams): Promise<Provider>;