@rinse-dental/open-dental 1.0.9 → 1.2.0

package/deploy_notes.txt

@@ -10,7 +10,7 @@ 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"
+gh release create v1.0.4 --title "Release v1.0.4" --notes "addition of patplan, insplan, familymodule apis"
 
 if the tag doesn't exist locally: 
 git tag vX.Y.Z

package/dist/api/labCases.d.ts

@@ -0,0 +1,66 @@
+import HttpClient from "../utils/httpClient";
+import { LabCase, GetLabCasesParams, CreateLabCaseParams, UpdateLabCaseParams } from "../types/labCaseTypes";
+export default class LabCases {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single lab case by its ID.
+     * @param {number} LabCaseNum - The unique identifier for the LabCase.
+     * @returns {Promise<LabCase>} - The LabCase object.
+     * @throws {Error} - If `LabCaseNum` is not provided.
+     */
+    getLabCase(LabCaseNum: number): Promise<LabCase>;
+    /**
+      * Fetch multiple lab cases with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - FK to patient.PatNum.
+      * @param {number} [params.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+      * @param {number} [params.AptNum] - FK to appointment.AptNum.
+      * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum.
+      * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<LabCase[]>} - A list of lab cases.
+      */
+    getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum }?: GetLabCasesParams): Promise<LabCase[]>;
+    /**
+     * Create a new inssub.
+     * @param {Object} data - The details of InsSub to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} data.ProvNum - Required. FK to provider.ProvNum.
+     * @param {number} [data.AptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - Optional. The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - Optional. The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - Optional. The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - Optional. The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
+     * @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The created lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createLabCase({ PatNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }: CreateLabCaseParams): Promise<LabCase>;
+    /**
+     * Update an inssub.
+     * @param {Object} data - The details of lab case to update.
+     * @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
+     * @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} [data.AptNum] - FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} [data.ProvNum] - FK to provider.ProvNum.
+     * @param {string} [data.Instructions] - The text instructions for this labcase.
+     * @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The updated lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateLabCase({ LabCaseNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }: UpdateLabCaseParams): Promise<LabCase>;
+}
+//# sourceMappingURL=labCases.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"labCases.d.ts","sourceRoot":"","sources":["../../src/api/labCases.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;IAIlC;;;;;OAKG;IACU,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;;;QAUI;IACS,WAAW,CAAC,EACvB,MAAM,EACN,aAAa,EACb,MAAM,EACN,aAAa,EACb,OAAO,EACR,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAY9C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,aAAa,EACb,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,MAAM,EACN,UAAU,GACX,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,MAAM,EACN,UAAU,GACX,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAqC3C"}

package/dist/api/labCases.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class LabCases {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single lab case by its ID.
+     * @param {number} LabCaseNum - The unique identifier for the LabCase.
+     * @returns {Promise<LabCase>} - The LabCase object.
+     * @throws {Error} - If `LabCaseNum` is not provided.
+     */
+    async getLabCase(LabCaseNum) {
+        if (!LabCaseNum) {
+            throw new Error("LabCaseNum is required.");
+        }
+        return this.httpClient.get(`/labcases/${LabCaseNum}`);
+    }
+    /**
+      * Fetch multiple lab cases with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - FK to patient.PatNum.
+      * @param {number} [params.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+      * @param {number} [params.AptNum] - FK to appointment.AptNum.
+      * @param {number} [params.PlannedAptNum] - FK to appointment.AptNum.
+      * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<LabCase[]>} - A list of lab cases.
+      */
+    async getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum } = {}) {
+        const params = {
+            PatNum,
+            LaboratoryNum,
+            AptNum,
+            PlannedAptNum,
+            ProvNum
+        };
+        return this.httpClient.get("/labcases", params);
+    }
+    /**
+     * Create a new inssub.
+     * @param {Object} data - The details of InsSub to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} data.ProvNum - Required. FK to provider.ProvNum.
+     * @param {number} [data.AptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - Optional. FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - Optional. The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - Optional. The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - Optional. The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - Optional. The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - Optional. The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
+     * @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The created lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createLabCase({ PatNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }) {
+        if (!PatNum || !LaboratoryNum || !ProvNum) {
+            throw new Error("Invalid data: PatNum, LaboratoryNum, and ProvNum are required.");
+        }
+        return this.httpClient.post("/labcases", {
+            PatNum,
+            LaboratoryNum,
+            ProvNum,
+            AptNum,
+            PlannedAptNum,
+            DateTimeDue,
+            DateTimeCreated,
+            DateTimeSent,
+            DateTimeRecd,
+            DateTimeChecked,
+            Instructions,
+            LabFee,
+            InvoiceNum,
+        });
+    }
+    /**
+     * Update an inssub.
+     * @param {Object} data - The details of lab case to update.
+     * @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
+     * @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
+     * @param {number} [data.AptNum] - FK to appointment.AptNum where appointment.AptStatus=Scheduled.
+     * @param {number} [data.PlannedAptNum] - FK to appointment.AptNum where appointment.AptStatus=Planned.
+     * @param {string} [data.DateTimeDue] - The due date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeCreated] - The created date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeSent] - The sent date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeRecd] - The received date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {string} [data.DateTimeChecked] - The checked date that is put on the labslip. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {number} [data.ProvNum] - FK to provider.ProvNum.
+     * @param {string} [data.Instructions] - The text instructions for this labcase.
+     * @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
+     * @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
+    * @returns {Promise<LabCase>} - The updated lab case.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateLabCase({ LabCaseNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }) {
+        if (!LabCaseNum || typeof LabCaseNum !== "number") {
+            throw new Error("Invalid data: A Valid LabCaseNum is required.");
+        }
+        return this.httpClient.put(`/labcases/${LabCaseNum}`, {
+            LaboratoryNum,
+            ProvNum,
+            AptNum,
+            PlannedAptNum,
+            DateTimeDue,
+            DateTimeCreated,
+            DateTimeSent,
+            DateTimeRecd,
+            DateTimeChecked,
+            Instructions,
+            LabFee,
+            InvoiceNum,
+        });
+    }
+}
+exports.default = LabCases;

package/dist/api/refAttaches.d.ts

@@ -0,0 +1,57 @@
+import HttpClient from "../utils/httpClient";
+import { RefAttach, GetRefAttachesParams, CreateRefAttachParams, UpdateRefAttachParams } from "../types/refAttachTypes";
+export default class RefAttaches {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+      * Fetch multiple refattaches with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - The PatNum of the RefAttaches.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<RefAttach[]>} - A list of inssubs.
+      */
+    getRefAttaches({ PatNum, Offset, }?: GetRefAttachesParams): Promise<RefAttach[]>;
+    /**
+     * Attach a referral to a patient.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.referralName] - Required. Number assigned by insurance company.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createRefAttach({ PatNum, ReferralNum, referralName, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }: CreateRefAttachParams): Promise<RefAttach>;
+    /**
+     * Update a refattach.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.RefAttachNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateRefAttach({ RefAttachNum, ReferralNum, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }: UpdateRefAttachParams): Promise<RefAttach>;
+    /**
+     * Delete a refattach.
+     * @param {number} RefAttachNum - Required: The unique identifier of the RefAttach to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `RefAttachNum` is not valid or the API returns an error.
+     */
+    deleteInsSub(RefAttachNum: number): Promise<void>;
+}
+//# sourceMappingURL=refAttaches.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refAttaches.d.ts","sourceRoot":"","sources":["../../src/api/refAttaches.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAA;AAEhC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;QAMI;IACS,cAAc,CAAC,EAC1B,MAAM,EACN,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IASnD;;;;;;;;;;;;;;;;OAgBG;IACU,eAAe,CAAC,EAC3B,MAAM,EACN,WAAW,EACX,YAAY,EACZ,OAAO,EACP,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,OAAO,EACP,gBAAgB,EAChB,OAAO,GACR,EAAG,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAoB9C;;;;;;;;;;;;;;;OAeG;IACU,eAAe,CAAC,EAC3B,YAAY,EACZ,WAAW,EACX,OAAO,EACP,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,OAAO,EACP,gBAAgB,EAChB,OAAO,GACR,EAAG,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAkB9C;;;;;OAKG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO/D"}

package/dist/api/refAttaches.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class RefAttaches {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+      * Fetch multiple refattaches with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - The PatNum of the RefAttaches.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<RefAttach[]>} - A list of inssubs.
+      */
+    async getRefAttaches({ PatNum, Offset, } = {}) {
+        const params = {
+            PatNum,
+            Offset,
+        };
+        return this.httpClient.get("/refattaches", params);
+    }
+    /**
+     * Attach a referral to a patient.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.referralName] - Required. Number assigned by insurance company.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createRefAttach({ PatNum, ReferralNum, referralName, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }) {
+        if (!PatNum || (!ReferralNum && !referralName)) {
+            throw new Error("Invalid data: PatNum and either ReferralNum or referralName are required.");
+        }
+        return this.httpClient.post("/refattaches", {
+            PatNum,
+            ReferralNum,
+            referralName,
+            RefDate,
+            ReferralType,
+            RefToStatus,
+            Note,
+            IsTransitionOfCare,
+            ProcNum,
+            DateProcComplete,
+            ProvNum,
+        });
+    }
+    /**
+     * Update a refattach.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.RefAttachNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateRefAttach({ RefAttachNum, ReferralNum, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }) {
+        if (!RefAttachNum) {
+            throw new Error("Invalid data: RefAttachNum is required.");
+        }
+        return this.httpClient.put(`/refattaches/${RefAttachNum}`, {
+            ReferralNum,
+            RefDate,
+            ReferralType,
+            RefToStatus,
+            Note,
+            IsTransitionOfCare,
+            ProcNum,
+            DateProcComplete,
+            ProvNum,
+        });
+    }
+    /**
+     * Delete a refattach.
+     * @param {number} RefAttachNum - Required: The unique identifier of the RefAttach to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `RefAttachNum` is not valid or the API returns an error.
+     */
+    async deleteInsSub(RefAttachNum) {
+        if (!RefAttachNum || typeof RefAttachNum !== "number") {
+            throw new Error("Invalid parameter: RefAttachNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/refattaches/${RefAttachNum}`);
+    }
+}
+exports.default = RefAttaches;

package/dist/api/referrals.d.ts

@@ -0,0 +1,84 @@
+import HttpClient from "../utils/httpClient";
+import { Referral, GetReferralsParams, CreateReferralParams, UpdateReferralParams } from "../types/referralTypes";
+export default class Referrals {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single referral by its ID.
+     * @param {number} ReferralNum - The unique identifier for the referal.
+     * @returns {Promise<Referral>} - The referral object.
+     * @throws {Error} - If `ReferralNum` is not provided.
+     */
+    getReferral(ReferralNum: number): Promise<Referral>;
+    /**
+      * Fetch multiple referrals with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {"true" | "false"} [data.IsHidden] - Optional.
+      * @param {"true" | "false"} [data.NotPerson] - Optional.
+      * @param {"true" | "false"} [data.IsDoctor] - Optional.
+      * @param {"true" | "false"} [data.IsPreferred] - Optional.
+      * @param {"true" | "false"} [data.isPatient] - Optional.
+      * @param {string} [data.BusinessName] - Optional. Filter referrals by business name. Supports partial string matching.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<Referral[]>} - A list of referrals.
+      */
+    getReferrals({ IsHidden, NotPerson, IsDoctor, IsPreferred, isPatient, BusinessName, Offset, }?: GetReferralsParams): Promise<Referral[]>;
+    /**
+     * Create a new referral.
+     * @param {Object} data - The details of referral to create.
+     * @param {string} data.LName - Required. The last name of a referral source or referral source description.
+     * @param {number} [data.PatNum] - Optional. Only set this if the referral source is a patient. The provided LName must match the patient for whom the PatNum is given. This automatically populates the rest of the referral based on the given patient. If this is set, IsDoctor and NotPerson are set to "false", while isPatient will be true.
+     * @param {string} [data.FName] - Optional. The referral source's first name.
+     * @param {string} [data.MName] - Optional. The referral source's middle name or initial.
+     * @param {string} [data.SSN] - Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+     * @param {"true" | "false"} [data.UsingTIN] - Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+     * @param {number} [data.Specialty] - Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+     * @param {string} [data.specialty] - Optional. Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
+     * @param {string} [data.ST] - Optional. The referral source's state. Two characters maximum.
+     * @param {string} [data.Telephone] - Optional. The referral source's phone number. Must be ten digits.
+     * @param {string} [data.Address] - Optional. The referral source's mailing address.
+     * @param {string} [data.Address2] - Optional. Additional info regarding the referral source's mailing address.
+     * @param {string} [data.City] - Optional. The referral source's city.
+     * @param {string} [data.Zip] - Optional. The referral source's ZIP code.
+     * @param {string} [data.Note] - Optional.
+     * @param {string} [data.Phone2] - Optional. Additional phone.
+     * @param {"true" | "false"} [data.NotPerson] - Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+     * @param {string} [data.Title] - Optional. The referral source's title.
+     * @param {string} [data.EMail] - Optional. The email address for the referral.
+     * @param {"true" | "false"} [data.IsDoctor] - Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+     * @param {string} [data.BusinessName] - Optional. Name of the business that the referral works for.
+     * @param {string} [data.DisplayNote] - Optional. Shows in the Family Module's Patient Info grid.
+     * @returns {Promise<Referral>} - The created referral.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createReferral({ LName, PatNum, FName, MName, SSN, UsingTIN, Specialty, specialty, ST, Telephone, Address, Address2, City, Zip, Note, Phone2, NotPerson, Title, EMail, IsDoctor, BusinessName, DisplayNote, }: CreateReferralParams): Promise<Referral>;
+    /**
+     * Update a referral.
+     * @param {Object} data - The details of referral to update.
+     * @param {number} data.ReferralNum - Required. PK of the referral to update.
+     * @param {string} data.LName - Required. The last name of a referral source or referral source description.
+     * @param {string} [data.FName] - Optional. The referral source's first name.
+     * @param {string} [data.MName] - Optional. The referral source's middle name or initial.
+     * @param {string} [data.SSN] - Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+     * @param {"true" | "false"} [data.UsingTIN] - Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+     * @param {number} [data.Specialty] - Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+     * @param {string} [data.ST] - Optional. The referral source's state. Two characters maximum.
+     * @param {string} [data.Telephone] - Optional. The referral source's phone number. Must be ten digits.
+     * @param {string} [data.Address] - Optional. The referral source's mailing address.
+     * @param {string} [data.Address2] - Optional. Additional info regarding the referral source's mailing address.
+     * @param {string} [data.City] - Optional. The referral source's city.
+     * @param {string} [data.Zip] - Optional. The referral source's ZIP code.
+     * @param {string} [data.Note] - Optional.
+     * @param {string} [data.Phone2] - Optional. Additional phone.
+     * @param {"true" | "false"} [data.NotPerson] - Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+     * @param {string} [data.Title] - Optional. The referral source's title.
+     * @param {string} [data.EMail] - Optional. The email address for the referral.
+     * @param {"true" | "false"} [data.IsDoctor] - Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+     * @param {string} [data.BusinessName] - Optional. Name of the business that the referral works for.
+     * @param {string} [data.DisplayNote] - Optional. Shows in the Family Module's Patient Info grid.
+     * @returns {Promise<Referral>} - The updated referral.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateReferral({ ReferralNum, LName, FName, MName, SSN, UsingTIN, Specialty, ST, Telephone, Address, Address2, City, Zip, Note, Phone2, NotPerson, Title, EMail, IsDoctor, BusinessName, DisplayNote, }: UpdateReferralParams): Promise<Referral>;
+}
+//# sourceMappingURL=referrals.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"referrals.d.ts","sourceRoot":"","sources":["../../src/api/referrals.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOhE;;;;;;;;;;;QAWI;IACS,YAAY,CAAC,EACxB,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,SAAS,EACT,YAAY,EACZ,MAAM,GACP,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAchD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,cAAc,CAAC,EAC1B,KAAK,EACL,MAAM,EACN,KAAK,EACL,KAAK,EACL,GAAG,EACH,QAAQ,EACR,SAAS,EACT,SAAS,EACT,EAAE,EACF,SAAS,EACT,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,WAAW,GACZ,EAAG,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IA+B5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,cAAc,CAAC,EAC1B,WAAW,EACX,KAAK,EACL,KAAK,EACL,KAAK,EACL,GAAG,EACH,QAAQ,EACR,SAAS,EACT,EAAE,EACF,SAAS,EACT,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,WAAW,GACZ,EAAG,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;CA4B7C"}

package/dist/api/referrals.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Referrals {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single referral by its ID.
+     * @param {number} ReferralNum - The unique identifier for the referal.
+     * @returns {Promise<Referral>} - The referral object.
+     * @throws {Error} - If `ReferralNum` is not provided.
+     */
+    async getReferral(ReferralNum) {
+        if (!ReferralNum || typeof ReferralNum !== "number") {
+            throw new Error("Invalid data: ReferralNum is required.");
+        }
+        return this.httpClient.get(`/referrals/${ReferralNum}`);
+    }
+    /**
+      * Fetch multiple referrals with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {"true" | "false"} [data.IsHidden] - Optional.
+      * @param {"true" | "false"} [data.NotPerson] - Optional.
+      * @param {"true" | "false"} [data.IsDoctor] - Optional.
+      * @param {"true" | "false"} [data.IsPreferred] - Optional.
+      * @param {"true" | "false"} [data.isPatient] - Optional.
+      * @param {string} [data.BusinessName] - Optional. Filter referrals by business name. Supports partial string matching.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<Referral[]>} - A list of referrals.
+      */
+    async getReferrals({ IsHidden, NotPerson, IsDoctor, IsPreferred, isPatient, BusinessName, Offset, } = {}) {
+        const params = {
+            IsHidden,
+            NotPerson,
+            IsDoctor,
+            IsPreferred,
+            isPatient,
+            BusinessName,
+            Offset,
+        };
+        return this.httpClient.get("/referrals", params);
+    }
+    /**
+     * Create a new referral.
+     * @param {Object} data - The details of referral to create.
+     * @param {string} data.LName - Required. The last name of a referral source or referral source description.
+     * @param {number} [data.PatNum] - Optional. Only set this if the referral source is a patient. The provided LName must match the patient for whom the PatNum is given. This automatically populates the rest of the referral based on the given patient. If this is set, IsDoctor and NotPerson are set to "false", while isPatient will be true.
+     * @param {string} [data.FName] - Optional. The referral source's first name.
+     * @param {string} [data.MName] - Optional. The referral source's middle name or initial.
+     * @param {string} [data.SSN] - Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+     * @param {"true" | "false"} [data.UsingTIN] - Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+     * @param {number} [data.Specialty] - Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+     * @param {string} [data.specialty] - Optional. Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
+     * @param {string} [data.ST] - Optional. The referral source's state. Two characters maximum.
+     * @param {string} [data.Telephone] - Optional. The referral source's phone number. Must be ten digits.
+     * @param {string} [data.Address] - Optional. The referral source's mailing address.
+     * @param {string} [data.Address2] - Optional. Additional info regarding the referral source's mailing address.
+     * @param {string} [data.City] - Optional. The referral source's city.
+     * @param {string} [data.Zip] - Optional. The referral source's ZIP code.
+     * @param {string} [data.Note] - Optional.
+     * @param {string} [data.Phone2] - Optional. Additional phone.
+     * @param {"true" | "false"} [data.NotPerson] - Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+     * @param {string} [data.Title] - Optional. The referral source's title.
+     * @param {string} [data.EMail] - Optional. The email address for the referral.
+     * @param {"true" | "false"} [data.IsDoctor] - Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+     * @param {string} [data.BusinessName] - Optional. Name of the business that the referral works for.
+     * @param {string} [data.DisplayNote] - Optional. Shows in the Family Module's Patient Info grid.
+     * @returns {Promise<Referral>} - The created referral.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createReferral({ LName, PatNum, FName, MName, SSN, UsingTIN, Specialty, specialty, ST, Telephone, Address, Address2, City, Zip, Note, Phone2, NotPerson, Title, EMail, IsDoctor, BusinessName, DisplayNote, }) {
+        if (!LName) {
+            throw new Error("Invalid data: LName is required.");
+        }
+        return this.httpClient.post("/referrals", {
+            LName,
+            PatNum,
+            FName,
+            MName,
+            SSN,
+            UsingTIN,
+            Specialty,
+            specialty,
+            ST,
+            Telephone,
+            Address,
+            Address2,
+            City,
+            Zip,
+            Note,
+            Phone2,
+            NotPerson,
+            Title,
+            EMail,
+            IsDoctor,
+            BusinessName,
+            DisplayNote,
+        });
+    }
+    /**
+     * Update a referral.
+     * @param {Object} data - The details of referral to update.
+     * @param {number} data.ReferralNum - Required. PK of the referral to update.
+     * @param {string} data.LName - Required. The last name of a referral source or referral source description.
+     * @param {string} [data.FName] - Optional. The referral source's first name.
+     * @param {string} [data.MName] - Optional. The referral source's middle name or initial.
+     * @param {string} [data.SSN] - Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+     * @param {"true" | "false"} [data.UsingTIN] - Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+     * @param {number} [data.Specialty] - Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+     * @param {string} [data.ST] - Optional. The referral source's state. Two characters maximum.
+     * @param {string} [data.Telephone] - Optional. The referral source's phone number. Must be ten digits.
+     * @param {string} [data.Address] - Optional. The referral source's mailing address.
+     * @param {string} [data.Address2] - Optional. Additional info regarding the referral source's mailing address.
+     * @param {string} [data.City] - Optional. The referral source's city.
+     * @param {string} [data.Zip] - Optional. The referral source's ZIP code.
+     * @param {string} [data.Note] - Optional.
+     * @param {string} [data.Phone2] - Optional. Additional phone.
+     * @param {"true" | "false"} [data.NotPerson] - Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+     * @param {string} [data.Title] - Optional. The referral source's title.
+     * @param {string} [data.EMail] - Optional. The email address for the referral.
+     * @param {"true" | "false"} [data.IsDoctor] - Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+     * @param {string} [data.BusinessName] - Optional. Name of the business that the referral works for.
+     * @param {string} [data.DisplayNote] - Optional. Shows in the Family Module's Patient Info grid.
+     * @returns {Promise<Referral>} - The updated referral.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateReferral({ ReferralNum, LName, FName, MName, SSN, UsingTIN, Specialty, ST, Telephone, Address, Address2, City, Zip, Note, Phone2, NotPerson, Title, EMail, IsDoctor, BusinessName, DisplayNote, }) {
+        if (!ReferralNum || typeof ReferralNum !== "number") {
+            throw new Error("Invalid data: ReferralNum is required.");
+        }
+        return this.httpClient.put(`/referrals/${ReferralNum}`, {
+            LName,
+            FName,
+            MName,
+            SSN,
+            UsingTIN,
+            Specialty,
+            ST,
+            Telephone,
+            Address,
+            Address2,
+            City,
+            Zip,
+            Note,
+            Phone2,
+            NotPerson,
+            Title,
+            EMail,
+            IsDoctor,
+            BusinessName,
+            DisplayNote,
+        });
+    }
+}
+exports.default = Referrals;