@rinse-dental/open-dental 1.1.0 → 1.3.0

package/dist/types/referralTypes.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Represents an Referral in the Open Dental system. These can be either a provider, patient, or non-person. The description of non-patient sources is stored in the LName field.
+ * @see https://www.opendental.com/site/apireferrals.html
+ */
+export interface Referral {
+    ReferralNum?: number;
+    LName?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    specialty?: string;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: number;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    IsHidden?: "true" | "false";
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    PatNum?: string;
+    IsDoctor?: "true" | "false";
+    DateTStamp?: string;
+    IsPreferred?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+    isPatient?: "true" | "false";
+}
+export interface GetReferralsParams {
+    IsHidden?: "true" | "false";
+    NotPerson?: "true" | "false";
+    IsDoctor?: "true" | "false";
+    IsPreferred?: "true" | "false";
+    isPatient?: "true" | "false";
+    BusinessName?: string;
+    Offset?: number;
+}
+/**
+ * Creates a new Referral. Referrals can be for patients (provide PatNum), providers (provide specialty) or non-persons (provide neither PatNum or specialty).
+ * In the last case, isPatient and IsDoctor will be set false automatically while NotPerson will be set to true.
+ * If you wish to create an associated RefAttach please see RefAttaches POST.
+ */
+export interface CreateReferralParams {
+    LName?: string;
+    PatNum?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    specialty?: string;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    IsDoctor?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+}
+/**
+ * Updates an existing Referral. All fields are optional. Referrals for a patient can only have the Note and DisplayNote fields modified.
+ */
+export interface UpdateReferralParams {
+    ReferralNum?: number;
+    LName?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: number;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    IsDoctor?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+}
+//# sourceMappingURL=referralTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"referralTypes.d.ts","sourceRoot":"","sources":["../../src/types/referralTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B;AAGD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/types/referralTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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

package/release.sh

@@ -41,5 +41,5 @@ gh release create "$NEW_TAG" --title "Release $NEW_TAG" --notes "$COMMIT_MSG"
 
 
 #example ./release.sh "Some commit message" patch 
-#example ./release.sh "Some commit message" minor
+#example ./release.sh "Added insplans and benefits" minor
 #example ./release.sh "Some commit message" major 

package/src/api/benefits.ts

@@ -0,0 +1,155 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Benefit,
+  GetBenefitsParams,
+  CreateBenefitParams,
+  UpdateBenefitParams,
+} from "../types/benefitTypes";
+
+export default class Benefits {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+    * Fetch multiple benefits with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PlanNum] - FK to InsPlan.PlanNum.
+    * @param {number} [params.PatPlanNum] - FK to PatPlan.PatPlanNum.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<Benefit[]>} - A list of benefits.
+    */
+  public async getBenefits({
+    PlanNum,
+    PatPlanNum,
+    Offset,
+  }: GetBenefitsParams = {}): Promise<Benefit[]> {
+    const params = {
+      PlanNum,
+      PatPlanNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<Benefit[]>("/benefits", params);
+  }
+
+  /**
+   * This adds a Benefit row to the database.
+   * @param {Object} data - The details of the Benefit to create.
+   * @param {number} data.PlanNum - This or PatPlanNum is required. FK to InsPlan.PlanNum.
+   * @param {number} data.PatPlanNum - This or PlanNum is required. FK to PatPlan.PlanNum.
+   * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} data.BenefitType - Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+   * @param {"None" | "Individual" | "Family"} data.CoverageLevel - Required. Either "None", "Individual", or "Family".
+   * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+   * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+   * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+   * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+   * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+   * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+   * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+   * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+   * @param {number} [data.CodeGroupNum] - Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+  * @returns {Promise<Benefit>} - The created a benefit.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createBenefit({
+    PlanNum,
+    PatPlanNum,
+    BenefitType,
+    CoverageLevel,
+    CovCatNum,
+    Percent,
+    MonetaryAmt,
+    TimePeriod,
+    QuantityQualifier,
+    Quantity,
+    CodeNum,
+    procCode,
+    CodeGroupNum,
+  } : CreateBenefitParams): Promise<Benefit> {
+    if (!BenefitType || !CoverageLevel) {
+      throw new Error("Invalid data: Either PlanNum or PatPlanNum and BenefitType and CoverageLevel are required.");
+    }
+
+    return this.httpClient.post<Benefit>("/benefits", {
+      PlanNum,
+      PatPlanNum,
+      BenefitType,
+      CoverageLevel,
+      CovCatNum,
+      Percent,
+      MonetaryAmt,
+      TimePeriod,
+      QuantityQualifier,
+      Quantity,
+      CodeNum,
+      procCode,
+      CodeGroupNum,
+    });
+  }
+
+  /**
+   * Update a Benefit.
+   * @param {Object} data - The details of Benefit to update.
+   * @param {number} data.BenefitNum - Required. PK
+   * @param {number} [data.CovCatNum] - Optional. FK to covcat.CovCatNum.
+  * @param {"ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"} [data.BenefitType] - Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+   * @param {number} [data.Percent] - Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+   * @param {number} [data.MonetaryAmt] - Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+   * @param {"None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"} [data.TimePeriod] - Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+   * @param {"None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"} [data.QuantityQualifier] - Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+   * @param {number} [data.Quantity] - Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+   * @param {number} [data.CodeNum] - Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
+   * @param {string} [data.procCode] - Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0.
+   * @param {"None" | "Individual" | "Family"} [data.CoverageLevel] - Optional. Either "None", "Individual", or "Family".
+  * @returns {Promise<Benefit>} - The updated Benefit.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateBenefit({
+    BenefitNum,
+    CovCatNum,
+    BenefitType,
+    Percent,
+    MonetaryAmt,
+    TimePeriod,
+    QuantityQualifier,
+    Quantity,
+    CodeNum,
+    procCode,
+    CoverageLevel,
+  } : UpdateBenefitParams): Promise<Benefit> {
+    if (!BenefitNum || typeof BenefitNum !== "number") {
+      throw new Error("Invalid data: A Valid BenefitNum is required.");
+    }
+
+    return this.httpClient.put<Benefit>(`/benefits/${BenefitNum}`, {
+      CovCatNum,
+      BenefitType,
+      Percent,
+      MonetaryAmt,
+      TimePeriod,
+      QuantityQualifier,
+      Quantity,
+      CodeNum,
+      procCode,
+      CoverageLevel,
+    });
+  }
+
+  /**
+   * Delete a Benefit entry. 
+   * This removes a Benefit row from the database.
+   * @param {number} BenefitNum - Required: The unique identifier of the Benefit to delete.
+   * @returns {Promise<void>} - Resolves when the Benefit is deleted.
+   * @throws {Error} - If `BenefitNum` is not valid or the API returns an error.
+   */
+  public async deletePatPlan(BenefitNum: number): Promise<void> {
+    if (!BenefitNum || typeof BenefitNum !== "number") {
+      throw new Error("Invalid parameter: BenefitNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/benefits/${BenefitNum}`);
+  }
+}

package/src/api/insPlans.ts

@@ -0,0 +1,158 @@
+import HttpClient from "../utils/httpClient";
+import {
+  InsPlan,
+  GetInsPlansParams,
+  CreateInsPlanParams,
+  UpdateInsPlanParams,
+} from "../types/insPlanTypes";
+
+export default class InsPlans {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single insplan by its ID.
+   * @param {number} PlanNum - The ID of the insplan.
+   * @returns {Promise<InsPlan>} - The insplan data.
+   * @throws {Error} - If `InsPlan` is not valid or the API returns an error.
+   */
+  public async getInsPlan(PlanNum: number): Promise<InsPlan> {
+    if (!PlanNum || typeof PlanNum !== "number") {
+      throw new Error("Invalid parameter: PlanNum must be a valid number.");
+    }
+
+    return await this.httpClient.get<InsPlan>(`/insplans/${PlanNum}`);
+  }
+  
+
+  /**
+    * Fetch multiple insplans with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {"percentage" | "p" | "f" | "c" } [params.PlanType] - Must be one of the following: "percentage" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Percentage PlanTypes are stored as blank in the database.
+    * @param {number} [params.CarrierNum] - FK to carrier.CarrierNum.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<InsPlan[]>} - A list of InsPlans.
+    */
+  public async getInsPlans({
+    PlanType,
+    CarrierNum,
+    Offset,
+  }: GetInsPlansParams = {}): Promise<InsPlan[]> {
+    const params = {
+      PlanType,
+      CarrierNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<InsPlan[]>("/insplans", params);
+  }
+
+  /**
+   * This adds an InsPlan row to the database.
+   * @param {Object} data - The details of the insplan to create.
+   * @param {number} data.CarrierNum - Required. FK to carrier.CarrierNum.
+   * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+   * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+   * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+   * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+   * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+   * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+   * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+   * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+   * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+   * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+   * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+   * @returns {Promise<InsPlan>} - The created insplan.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createInsPlan({
+    CarrierNum,
+    GroupName,
+    GroupNum,
+    PlanNote,
+    FeeSched,
+    PlanType,
+    CopayFeeSched,
+    EmployerNum,
+    CodeSubstNone,
+    IsHidden,
+    MonthRenew,
+    IsBlueBookEnabled,
+  } : CreateInsPlanParams): Promise<InsPlan> {
+    if (!CarrierNum) {
+      throw new Error("Invalid data: CarrierNum is required.");
+    }
+
+    return this.httpClient.post<InsPlan>("/insplans", {
+      CarrierNum,
+      GroupName,
+      GroupNum,
+      PlanNote,
+      FeeSched,
+      PlanType,
+      CopayFeeSched,
+      EmployerNum,
+      CodeSubstNone,
+      IsHidden,
+      MonthRenew,
+      IsBlueBookEnabled,
+    });
+  }
+
+  /**
+   * Update a InsPlan.
+   * @param {Object} data - The details of InsPlan to update.
+   * @param {number} data.PlanNum - Required. Primary key. 
+   * @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
+   * @param {string} [data.GroupNum] - Optional. The carrier assigned identifier, unique for each plan.
+   * @param {string} [data.PlanNote] - Optional. Note for this plan. Same for all subscribers.
+   * @param {number} [data.FeeSched] - Optional. FK to feesched.FeeSchedNum. Default 0.
+   * @param {"" | "p" | "f" | "c"} [data.PlanType] - Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+   * @param {number} [data.CopayFeeSched] - Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+   * @param {number} [data.EmployerNum] - Optional. FK to employer.EmployerNum. Default 0.
+   * @param {number} [data.CarrierNum] - Optional. FK to carrier.CarrierNum.
+   * @param {"true" | "false"} [data.CodeSubstNone] - Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+   * @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+   * @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+   * @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  * @returns {Promise<InsPlan>} - The updated InsPlan.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateInsPlan({
+    PlanNum,
+    GroupName,
+    GroupNum,
+    PlanNote,
+    FeeSched,
+    PlanType,
+    CopayFeeSched,
+    EmployerNum,
+    CarrierNum,
+    CodeSubstNone,
+    IsHidden,
+    MonthRenew,
+    IsBlueBookEnabled,
+  } : UpdateInsPlanParams): Promise<InsPlan> {
+    if (!PlanNum || typeof PlanNum !== "number") {
+      throw new Error("Invalid data: A Valid PlanNum is required.");
+    }
+
+    return this.httpClient.put<InsPlan>(`/insplans/${PlanNum}`, {
+      GroupName,
+      GroupNum,
+      PlanNote,
+      FeeSched,
+      PlanType,
+      CopayFeeSched,
+      EmployerNum,
+      CarrierNum,
+      CodeSubstNone,
+      IsHidden,
+      MonthRenew,
+      IsBlueBookEnabled,
+    });
+  }
+}

package/src/api/patPlans.ts

@@ -97,10 +97,10 @@ export default class PatPlans {
   }
 
   /**
-   * Delete an PatPlan entry. 
+   * Delete a PatPlan entry. 
    * This is called "Drop" in the Open Dental UI. This removes a PatPlan row from the database, indicating no coverage, but does not affect the InsPlan itself.
    * @param {number} PatPlanNum - Required: The unique identifier of the inssub to delete.
-   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @returns {Promise<void>} - Resolves when the PatPlan is deleted.
    * @throws {Error} - If `PatPlanNum` is not valid or the API returns an error.
    */
   public async deletePatPlan(PatPlanNum: number): Promise<void> {

package/src/api/refAttaches.ts

@@ -0,0 +1,142 @@
+import HttpClient from "../utils/httpClient";
+import {
+  RefAttach,
+  GetRefAttachesParams,
+  CreateRefAttachParams,
+  UpdateRefAttachParams,
+} from "../types/refAttachTypes"
+
+export default class RefAttaches {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: 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.
+    */
+  public async getRefAttaches({
+    PatNum,
+    Offset,
+  }: GetRefAttachesParams = {}): Promise<RefAttach[]> {
+    const params = {
+      PatNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<RefAttach[]>("/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.
+   */
+  public async createRefAttach({
+    PatNum,
+    ReferralNum,
+    referralName,
+    RefDate,
+    ReferralType,
+    RefToStatus,
+    Note,
+    IsTransitionOfCare,
+    ProcNum,
+    DateProcComplete,
+    ProvNum,
+  } : CreateRefAttachParams): Promise<RefAttach> {
+    if (!PatNum || (!ReferralNum && !referralName)) {
+      throw new Error("Invalid data: PatNum and either ReferralNum or referralName are required.");
+    }
+
+    return this.httpClient.post<RefAttach>("/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.
+   */
+  public async updateRefAttach({
+    RefAttachNum,
+    ReferralNum,
+    RefDate,
+    ReferralType,
+    RefToStatus,
+    Note,
+    IsTransitionOfCare,
+    ProcNum,
+    DateProcComplete,
+    ProvNum,
+  } : UpdateRefAttachParams): Promise<RefAttach> {
+    if (!RefAttachNum) {
+      throw new Error("Invalid data: RefAttachNum is required.");
+    }
+
+    return this.httpClient.put<RefAttach>(`/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.
+   */
+  public async deleteInsSub(RefAttachNum: number): Promise<void> {
+    if (!RefAttachNum || typeof RefAttachNum !== "number") {
+      throw new Error("Invalid parameter: RefAttachNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/refattaches/${RefAttachNum}`);
+  }
+}