@rinse-dental/open-dental 1.7.1 → 2.0.0

package/src/api/treatplanattaches.ts

@@ -0,0 +1,67 @@
+import HttpClient from "../utils/httpClient";
+import {
+    TreatPlanAttach,
+    GetTreatPlanAttachesParams,
+    CreateTreatPlanAttachesParams,
+    UpdateTreatPlanAttachesParams,
+} from "../types/treatPlanAttachTypes";
+
+export default class TreatPlanAttaches {
+  private httpClient: HttpClient;
+
+    constructor(httpClient: HttpClient) {
+        this.httpClient = httpClient;
+    }
+
+    /**
+     * Get a list of TreatPlanAttaches that meet a set of search criteria.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {string} params.TreatPlanNum - treatplan.TreatPlanNum
+     * @param {number} [params.Offset] - Pagination offset. Default 0
+     * @returns {Promise<TreatPlanAttach[]>} - An array of TreatPlanAttach objects.
+     */
+    public async getTreatPlanAttaches({
+        TreatPlanNum,
+        Offset,
+    }: GetTreatPlanAttachesParams = {}): Promise<TreatPlanAttach[]> {
+        const params = {
+            TreatPlanNum,
+            Offset,
+        };
+
+        return this.httpClient.get<TreatPlanAttach[]>("/treatplanattaches", params);
+    }
+
+     /**
+     * Create a new TreatPlanAttaches.
+     * @param {Object} data - Data for the new TreatPlanAttaches object.
+     * @param {number} data.TreatPlanNum - Required. FK to treatplan.TreatPlanNum.
+     * @param {number} data.ProcNum - Required. FK to procedurelog.ProcNum.
+     * @param {string} [data.Priority] - Optional. definition.DefNum where definition.Category=20. Default 0.
+     * @returns {Promise<TreatPlanAttach>} - The created TreatPlanAttaches object.
+     * @throws {Error} - If required fields are missing.
+     */
+    public async createTreatmentPlan(data: CreateTreatPlanAttachesParams): Promise<TreatPlanAttach> {
+        if (!data.TreatPlanNum || !data.ProcNum) {
+            throw new Error("TreatPlanNum and ProcNum are required.");
+        }
+
+        return this.httpClient.post<TreatPlanAttach>("/treatplanattaches", data);
+    }
+
+    /**
+    * Update a TreatPlanAttaches.
+    * @param {Object} data - Data for the treatplan.
+    * @param {number} data.TreatPlanAttachNum - Required in URL, Primary key.
+    * @param {string} data.Priority - Required. definition.DefNum where definition.Category=20.
+    * @returns {Promise<TreatPlanAttach>} - The updated TreatPlanAttaches object.
+    * @throws {Error} - If required fields are missing.
+     */
+    public async updateTreatmentPlan(data: UpdateTreatPlanAttachesParams): Promise<TreatPlanAttach> {
+        if (!data.TreatPlanAttachNum || !data.Priority) {
+            throw new Error("TreatPlanAttachNum and Priority are required.");
+        }
+
+        return this.httpClient.put<TreatPlanAttach>(`/treatplanattaches/${data.TreatPlanAttachNum}`, data);
+    }
+}

package/src/openDental.ts

@@ -7,12 +7,14 @@ import Patients from "./api/patients";
 import ProcedureLogs from "./api/procedureLog";
 import Recalls from "./api/recalls";
 import TreatmentPlans from "./api/treatplans";
+import TreatmentPlanAttaches from "./api/treatplanattaches";
 import Schedules from "./api/schedules";
 import Providers from "./api/providers";
 import Operatories from "./api/operatories";
 import Payments from "./api/payments";
 import PaySplits from "./api/paySplits";
 import Definitions from "./api/definitions";
+import DiscountPlans from "./api/discountPlans";
 import DiscountPlanSubs from "./api/discountPlanSubs";
 import FamilyModules from "./api/familyModules";
 import InsSubs from "./api/insSubs";
@@ -25,6 +27,7 @@ import Benefits from "./api/benefits";
 import ClaimProcs from "./api/claimProcs";
 import Adjustments from "./api/adjustments";
 import ProcedureCodes from "./api/procedureCodes";
+import Fees from "./api/fees"; 
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -124,6 +127,16 @@ class OpenDental {
     return new TreatmentPlans(this.httpClient);
   }
 
+  /**
+   * Create a new instance of the TreatmentPlanAttaches API.
+   */
+  public static TreatmentPlanAttaches() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new TreatmentPlanAttaches(this.httpClient);
+  }
+
   /**
    * Create a new instance of the Schedules API.
    */
@@ -174,6 +187,16 @@ class OpenDental {
     return new Definitions(this.httpClient);
   }
 
+  /**
+   * Create a new instance of the DiscountPlans API.
+   */
+  public static DiscountPlans() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new DiscountPlans(this.httpClient);
+  }
+
   /**
    * Create a new instance of the DiscountPlanSubs API.
    */
@@ -304,6 +327,16 @@ class OpenDental {
     return new PaySplits(this.httpClient);
   }
 
+  /**
+   * Create a new instance of the Fees API.
+   */
+  public static Fees() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Fees(this.httpClient);
+  }
+
 }
 
 export { OpenDental };

package/src/types/DiscountPlanTypes.ts

@@ -0,0 +1,70 @@
+/**
+ * Represents a discount plan in the Open Dental system.
+ * @see https://www.opendental.com/site/apidiscountplans.html
+ */
+export interface DiscountPlan {
+    DiscountPlanNum?: number; //Primary key
+    Description?: string; //
+    FeeSchedNum?: number; //
+    DefNum?: number; //
+    IsHidden?: 'true' | 'false'; //
+    PlanNote?: string; // 
+    ExamFreqLimit?: number; //
+    XrayFreqLimit?: number; //
+    ProphyFreqLimit?: number; //
+    FluorideFreqLimit?: number; //
+    PerioFreqLimit?: number; //
+    LimitedExamFreqLimit?: number; //
+    PAFreqLimit?: number; //
+    AnnualMax?: number; //
+  }
+
+  /**
+   * Parameters for GET discount plans.
+   * @see https://www.opendental.com/site/apidiscountplans.html
+   */
+  export interface GetDiscountPlansParams {
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating a discount plan.
+   * @see https://www.opendental.com/site/apidiscountplans.html
+   */
+  export interface CreateDiscountPlanParams {
+    Description: string; // Required. Description of this Discount Plan.
+    FeeSchedNum: number; //  Required. FK to feesched.FeeSchedNum.
+    DefNum: number; // Required. definition.DefNum where definition.Category=1 and definition.ItemValue=dp.
+    IsHidden?: 'true' | 'false'; // Optional. Hides a Discount Plan. Default "false".
+    PlanNote?: string; // Optional. Note on a Discount Plan.
+    ExamFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Exam category. Default -1.
+    XrayFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's X-Ray category. Default -1.
+    ProphyFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Prophy category. Default -1.
+    FluorideFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Fluoride category. Default -1.
+    PerioFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Periodontal category. Default -1.
+    LimitedExamFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Limited Exam category. Default -1.
+    PAFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's  Periapical X-Ray category. Default -1.
+    AnnualMax?: number; // Optional. Annual discount maximum for frequency limitations. Default -1, indicates no annual max limitation.
+  }
+  
+  /**
+   * Parameters for updating a discount plan.
+   * @see https://www.opendental.com/site/apidiscountplans.html
+   */
+  export interface UpdateDiscountPlanParams {
+    DiscountPlanNum: number; // Required (in URL). Primary key.
+    Description?: string; // Optional. Description of this Discount Plan.
+    FeeSchedNum?: number; //  Optional. FK to feesched.FeeSchedNum.
+    DefNum?: number; // Optional. definition.DefNum where definition.Category=1 and definition.ItemValue=dp.
+    IsHidden?: 'true' | 'false'; // Optional. Hides a Discount Plan. Default "false".
+    PlanNote?: string; // Optional. Note on a Discount Plan.
+    ExamFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Exam category. Default -1.
+    XrayFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's X-Ray category. Default -1.
+    ProphyFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Prophy category. Default -1.
+    FluorideFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Fluoride category. Default -1.
+    PerioFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Periodontal category. Default -1.
+    LimitedExamFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's Limited Exam category. Default -1.
+    PAFreqLimit?: number; // Optional. Number of procedures allowed for a Discount Plan's  Periapical X-Ray category. Default -1.
+    AnnualMax?: number; // Optional. Annual discount maximum for frequency limitations. Default -1, indicates no annual max limitation.
+  }
+  

package/src/types/appointmentTypes.ts

@@ -54,6 +54,7 @@ export interface Appointment {
     dateEnd?: string; // End date for date range in "yyyy-MM-dd" format
     ClinicNum?: number; // Filter by clinic number
     DateTStamp?: string; // Return only appointments updated after this timestamp
+    AppointmentTypeNum?: number; //  (Added in version 24.4.22) FK to appointmenttype.AppointmentTypeNum.
     Offset?: number; // Pagination offset for results
   }
 

package/src/types/feeTypes.ts

@@ -0,0 +1,49 @@
+/**
+ * Represents a fees in Open Dental
+ * @see https://www.opendental.com/site/apifees.html
+ */
+export interface Fee {
+    FeeNum?: number; //
+    Amount?: number; //
+    FeeSched?: number; //
+    CodeNum?: number; //
+    ClinicNum?: number; //
+    ProvNum?: number; //
+    SecUserNumEntry?: number; //String in "yyyy-MM-dd" format. 
+    SecDateEntry?: string; //
+    SecDateTEdit?: string; //String in "yyyy-MM-dd" format. 
+  }
+
+  /**
+   * Parameters for GET Fees.
+   * @see https://www.opendental.com/site/apifees.html
+   */
+  export interface GetFeesParams {
+    FeeSched?: number; // Optional. FK to feesched.FeeSchedNum.
+    CodeNum?: number; // Optional. FK to procedurecode.CodeNum.
+    ClinicNum?: number; // Optional. FK to clinic.ClinicNum.
+    ProvNum?: number; // Optional. FK to provider.ProvNum.
+    Offset?: number; // Optional. Pagination.
+  }
+
+  /**
+   * Parameters for Create Fee.
+   * @see https://www.opendental.com/site/apifees.html
+   */
+  export interface CreateFeeParams {
+    Amount: number; // Required. The amount usually charged.
+    FeeSched: number; // Required. FK to feesched.FeeSchedNum.
+    CodeNum: number; // Required. FK to procedurecode.CodeNum.
+    ClinicNum?: number; // Optional. FK to clinic.ClinicNum. Default 0.
+    ProvNum?: number; // Optional. FK to provider.ProvNum. Default 0.
+  }
+
+  /**
+   * Parameters for Update Fee.
+   * @see https://www.opendental.com/site/apifees.html
+   */
+  export interface UpdateFeeParams {
+    FeeSched: number; // Required in the URL.
+    Amount?: number; //  Required. The amount of the fee.
+  }
+  

package/src/types/treatPlanAttachTypes.ts

@@ -0,0 +1,39 @@
+/**
+* TreatPlanAttaches object.
+* @see https://www.opendental.com/site/apitreatplanattaches.html
+*/
+export interface TreatPlanAttach {
+    TreatPlanAttachNum?: number; // Primary key
+    TreatPlanNum?: number; // FK to treatplan.TreatPlanNum
+    ProcNum?: number; // FK to procedurelog.ProcNum
+    Priority?: number; // definition.DefNum where definition.Category=20. Default 0
+    priority?: string;
+}
+
+/**
+ * Get TreatPlanAttaches Params. Returns TreatPlanAttaches object
+ * @see https://www.opendental.com/site/apitreatplanattaches.html
+ */
+export interface GetTreatPlanAttachesParams {
+    TreatPlanNum?: number; // FK to treatplan.TreatPlanNum
+    Offset?: number; //pagination
+}
+
+/**
+ * POST TreatPlanAttaches Params. Returns TreatPlanAttaches object
+ * @see https://www.opendental.com/site/apitreatplanattaches.html
+ */
+export interface CreateTreatPlanAttachesParams {
+    TreatPlanNum: number; // Required. FK to treatplan.TreatPlanNum
+    ProcNum: number; // Required. FK to procedurelog.ProcNum
+    Priority?: number; // Optional. definition.DefNum where definition.Category=20. Default 0
+}
+
+/**
+* PUT TreatPlanAttaches Params. Returns TreatPlanAttaches object.
+* @see https://www.opendental.com/site/apitreatplanattaches.html
+*/
+export interface UpdateTreatPlanAttachesParams {
+    TreatPlanAttachNum: number; // Required. Primary key
+    Priority: number; // Required. definition.DefNum where definition.Category=20. Default 0
+}