@rinse-dental/open-dental 3.4.2 → 4.0.2

package/src/api/appointments.ts

@@ -1,343 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  Appointment,
-  AppointmentSlot,
-  GetAppointmentParams,
-  GetASAPParams,
-  GetSlotsParams,
-  GetSlotsWebSchedParams,
-  GetWebSchedAppointmentsParams,
-  CreateNewAppointmentParams,
-  CreatePlannedAppointmentParams,
-  SchedulePlannedAppointmentParams,
-  ScheduleWebSchedAppointmentParams,
-  UpdateAppointmentParams,
-  BreakAppointmentParams,
-  ConfirmAppointmentParams,
-} from "../types/appointmentTypes";
-
-export default class Appointments {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-   * Fetch a single appointment by its ID.
-   * @param {number} AptNum - The unique identifier for the appointment.
-   * @returns {Promise<Appointment>} - The appointment object.
-   * @throws {Error} - If `AptNum` is not provided.
-   */
-  public async getAppointment(AptNum: number): Promise<Appointment> {
-    if (!AptNum) {
-      throw new Error("AptNum is required.");
-    }
-    return this.httpClient.get<Appointment>(`/appointments/${AptNum}`);
-  }
-
-/**
- * Fetch multiple appointments with optional filtering and pagination.
- * @param {Object} params - The parameters for filtering and pagination.
- * @param {number} [params.PatNum] - Filter by patient number.
- * @param {"Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted"} [params.AptStatus] - Filter by appointment status.
- * @param {number} [params.Op] - Filter by operatory number.
- * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
- * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
- * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
- * @param {number} [params.ClinicNum] - Filter by clinic number.
- * @param {string} [params.DateTStamp] - Return only appointments updated after this timestamp.
- * @param {string} [params.AppointmentTypeNum] - Returns only appointments matching appointmenttype.AppointmentTypeNum.
- * @param {number} [params.Offset] - Pagination offset for results.
- * @returns {Promise<Appointment[]>} - A list of appointments.
- */
-public async getAppointments({
-    PatNum,
-    AptStatus,
-    Op,
-    date,
-    dateStart,
-    dateEnd,
-    ClinicNum,
-    DateTStamp,
-    AppointmentTypeNum,
-    Offset,
-  }: GetAppointmentParams = {}): Promise<Appointment[]> {
-    const params = {
-      PatNum,
-      AptStatus,
-      Op,
-      date,
-      dateStart,
-      dateEnd,
-      ClinicNum,
-      DateTStamp,
-      AppointmentTypeNum,
-      Offset,
-    };
-  
-    return this.httpClient.get<Appointment[]>("/appointments", params);
-  }
-
-  /**
-   * Fetch ASAP appointments.
-   * @param {Object} params - Parameters for fetching ASAP appointments.
-   * @param {number} params.ClinicNum - Required: Clinic number. Use 0 for appointments not attached to clinics.
-   * @param {number} [params.ProvNum] - Optional: Provider number.
-   * @returns {Promise<Appointment[]>} - A list of ASAP appointments.
-   * @throws {Error} - If `ClinicNum` is not provided.
-   */
-  public async getASAPappointments(params: GetASAPParams): Promise<Appointment[]> {
-    if (!params.ClinicNum) {
-      throw new Error("ClinicNum is required when Clinics are enabled.");
-    }
-    return this.httpClient.get<Appointment[]>("/appointments/asap", params);
-  }
-
-  /**
-   * Fetch available appointment slots.
-   * @param {Object} params - Parameters for filtering slots.
-   * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
-   * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
-   * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
-   * @param {number} [params.lengthMinutes] - Ignore slots shorter than this length.
-   * @param {number} [params.ProvNum] - Provider number.
-   * @param {number} [params.OpNum] - Operatory number.
-   * @returns {Promise<AppointmentSlot[]>} - A list of available slots.
-   */
-  public async getSlots(params?: GetSlotsParams): Promise<AppointmentSlot[]> {
-    return this.httpClient.get<AppointmentSlot[]>("/appointments/Slots", params);
-  }
-
-  /**
-   * Fetch WebSched appointment slots.
-   * @param {Object} params - Parameters for filtering WebSched slots.
-   * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
-   * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
-   * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
-   * @param {number} params.ClinicNum - Required: Clinic number.
-   * @param {number} [params.defNumApptType] - Appointment type definition number.
-   * @param {"true" | "false"} [params.isNewPatient] - Indicates if the slot is for a new patient.
-   * @returns {Promise<AppointmentSlot[]>} - A list of WebSched slots.
-   * @throws {Error} - If `ClinicNum` is not provided.
-   */
-  public async getSlotsWebSched(params: GetSlotsWebSchedParams): Promise<AppointmentSlot[]> {
-    if (!params.ClinicNum) {
-      throw new Error("ClinicNum is required when Clinics are enabled.");
-    }
-    return this.httpClient.get<AppointmentSlot[]>("/appointments/SlotsWebSched", params);
-  }
-
-  /**
-   * Fetch WebSched appointments.
-   * @param {Object} params - Parameters for fetching WebSched appointments.
-   * @param {string} [params.date] - Search for a specific day in "yyyy-MM-dd" format.
-   * @param {string} [params.dateStart] - Start date for date range in "yyyy-MM-dd" format.
-   * @param {string} [params.dateEnd] - End date for date range in "yyyy-MM-dd" format.
-   * @param {string} [params.DateTStamp] - Return only appointments updated after this timestamp.
-   * @param {number} [params.ClinicNum] - Clinic number.
-   * @returns {Promise<Appointment[]>} - A list of WebSched appointments.
-   */
-  public async getWebSchedAppointments(
-    params?: GetWebSchedAppointmentsParams
-  ): Promise<Appointment[]> {
-    return this.httpClient.get<Appointment[]>("/appointments/WebSched", params);
-  }
-
-  /**
-   * Create a new appointment.
-   * @param {Object} data - Data for the new appointment.
-   * @param {number} data.PatNum - Required: Patient number.
-   * @param {number} data.Op - Required: Operatory number.
-   * @param {string} data.AptDateTime - Required: Appointment start time in "yyyy-MM-dd HH:mm:ss" format.
-   * @param {"Scheduled" | "Complete" | "UnschedList" | "PtNote" | "PtNoteCompleted"} [data.AptStatus="Scheduled"] - Optional: Appointment status. Default is "Scheduled".
-   * @param {string} [data.Pattern="/XX/"] - Optional: Time pattern in 5-minute increments. Default is "/XX/" (20 minutes).
-   * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
-   * @param {string} [data.Note] - Optional: Appointment notes.
-   * @param {number} [data.ProvNum] - Optional: Provider number.
-   * @param {number} [data.ProvHyg=0] - Optional: Hygienist provider number. Default is 0.
-   * @param {number} [data.Assistant] - Optional: FK to employee.EmployeeNum. Default 0.
-   * @param {number} [data.ClinicNum] - Optional: Clinic number.
-   * @param {"true" | "false"} [data.IsHygiene="false"] - Optional: Indicates if the appointment is for hygiene. Default is "false".
-   * @param {"true" | "false"} [data.IsNewPatient="false"] - Optional: Indicates if the patient is new. Default is "false".
-   * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional: Appointment priority. Default is "Normal".
-   * @param {number} [data.AppointmentTypeNum=0] - Optional: Appointment type number. Default is 0.
-   * @param {string} [data.colorOverride] - Optional: Custom color in "R,G,B" format.
-   * @param {string} [data.PatternSecondary] - Optional: Secondary time pattern.
-   * @param {"true" | "false"} [data.IsMirrored] - Optional: Either "true" or "false". If true, then this appointment will show a duplicate mirrored on the secondary provider's operatory. The mirrored appointments can be set to show/hide using the preference "ShowMirroredAppts". Default "false" if "ShowMirroredAppts" is not set.
-   * @returns {Promise<Appointment>} - The created appointment.
-   * @throws {Error} - If required fields are missing.
-   */
-    public async createNewAppointment(data: CreateNewAppointmentParams): Promise<Appointment> {
-        if (!data.PatNum || !data.Op || !data.AptDateTime) {
-          throw new Error("PatNum, Op, and AptDateTime are required.");
-        }
-    
-        return this.httpClient.post<Appointment>("/appointments", data);
-      }
-    
-
-  /**
-   * Create a planned appointment.
-   * @param {Object} data - Data for the planned appointment.
-   * @param {number} data.PatNum - Required: Patient number.
-   * @param {number} [data.AppointmentTypeNum] - Optional: Appointment type number.
-   * @param {number[]} [data.procNums] - Optional: Array of procedure numbers. At least one of `AppointmentTypeNum` or `procNums` is required.
-   * @param {string} [data.Pattern="/XX/"] - Optional: Time pattern in 5-minute increments. Default is "/XX/" (20 minutes).
-   * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
-   * @param {string} [data.Note] - Optional: Appointment notes.
-   * @param {number} [data.ProvNum] - Optional: Provider number.
-   * @param {number} [data.ProvHyg=0] - Optional: Hygienist provider number. Default is 0.
-   * @param {number} [data.ClinicNum] - Optional: Clinic number.
-   * @param {"true" | "false"} [data.IsHygiene="false"] - Optional: Indicates if the appointment is for hygiene. Default is "false".
-   * @param {"true" | "false"} [data.IsNewPatient="false"] - Optional: Indicates if the patient is new. Default is "false".
-   * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional: Appointment priority. Default is "Normal".
-   * @param {string} [data.PatternSecondary] - Optional: Secondary time pattern.
-   * @returns {Promise<Appointment>} - The created planned appointment.
-   * @throws {Error} - If required fields are missing.
-   */
-  public async createPlannedAppointment(data: CreatePlannedAppointmentParams): Promise<Appointment> {
-    if (!data.PatNum || (!data.AppointmentTypeNum && (!data.procNums || data.procNums.length === 0))) {
-      throw new Error("PatNum and either AppointmentTypeNum or procNums are required.");
-    }
-
-    return this.httpClient.post<Appointment>("/appointments/Planned", data);
-  }
-
-
-  /**
-   * Schedule a planned appointment.
-   * @param {Object} data - Data for scheduling the planned appointment.
-   * @param {number} data.AptNum - Required: The appointment number with Planned status.
-   * @param {string} data.AptDateTime - Required: Start time for the appointment in "yyyy-MM-dd HH:mm:ss" format.
-   * @param {number} data.ProvNum - Required: The provider number for the appointment.
-   * @param {number} data.Op - Required: The operatory number for the appointment.
-   * @param {number} [data.Confirmed] - Optional: Confirmation status definition number.
-   * @param {string} [data.Note] - Optional: Notes for the appointment. Will overwrite any existing note.
-   * @returns {Promise<Appointment>} - The scheduled appointment.
-   * @throws {Error} - If required fields are missing.
-   */
-  public async schedulePlannedAppointment(
-    data: SchedulePlannedAppointmentParams
-  ): Promise<Appointment> {
-    if (!data.AptNum || !data.AptDateTime || !data.ProvNum || !data.Op) {
-      throw new Error("AptNum, AptDateTime, ProvNum, and Op are required.");
-    }
-
-    return this.httpClient.post<Appointment>("/appointments/SchedulePlanned", data);
-  }
-
-  /**
-   * Schedule a WebSched appointment.
-   * @param {Object} data - Data for scheduling the WebSched appointment.
-   * @param {number} data.PatNum - Required: Patient number.
-   * @param {string} data.DateTimeStart - Required: The start time of the appointment in "yyyy-MM-dd HH:mm:ss" format.
-   * @param {string} data.DateTimeEnd - Required: The end time of the appointment in "yyyy-MM-dd HH:mm:ss" format.
-   * @param {number} data.ProvNum - Required: Provider number associated with the appointment slot.
-   * @param {number} data.OpNum - Required: Operatory number associated with the appointment slot.
-   * @param {number} data.defNumApptType - Required: Appointment type definition number.
-   * @returns {Promise<Appointment>} - The scheduled WebSched appointment.
-   * @throws {Error} - If required fields are missing.
-   */
-  public async scheduleWebSchedAppointment(
-    data: ScheduleWebSchedAppointmentParams
-  ): Promise<Appointment> {
-    if (
-      !data.PatNum ||
-      !data.DateTimeStart ||
-      !data.DateTimeEnd ||
-      !data.ProvNum ||
-      !data.OpNum ||
-      !data.defNumApptType
-    ) {
-      throw new Error(
-        "PatNum, DateTimeStart, DateTimeEnd, ProvNum, OpNum, and defNumApptType are required."
-      );
-    }
-
-    return this.httpClient.post<Appointment>("/appointments/WebSched", data);
-  }
-
-  /**
-   * Update an existing appointment.
-   * @param {Object} data - Data for updating the appointment.
-   * @param {number} data.AptNum - Required: The unique identifier of the appointment to update.
-   * @param {"Scheduled" | "Complete" | "UnschedList" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted"} [data.AptStatus] - Optional: Updated status of the appointment.
-   * @param {string} [data.Pattern] - Optional: Updated time pattern in 5-minute increments.
-   * @param {number} [data.Confirmed] - Optional: Updated confirmation status definition number.
-   * @param {number} [data.Op] - Optional: Updated operatory number.
-   * @param {string} [data.Note] - Optional: Updated notes for the appointment. Will overwrite existing notes.
-   * @param {number} [data.ProvNum] - Optional: Updated provider number.
-   * @param {number} [data.ProvHyg] - Optional: Updated hygienist provider number.
-   * @param {number} [data.Assistant] - Optional: FK to employee.EmployeeNum. Default 0.
-   * @param {string} [data.AptDateTime] - Optional: Updated appointment start time in "yyyy-MM-dd HH:mm:ss" format.
-   * @param {number} [data.ClinicNum] - Optional: Updated clinic number.
-   * @param {"true" | "false"} [data.IsHygiene] - Optional: Indicates if the appointment is for hygiene.
-   * @param {"true" | "false"} [data.IsNewPatient] - Optional: Indicates if the appointment is for a new patient.
-   * @param {"Normal" | "ASAP"} [data.Priority] - Optional: Updated priority of the appointment.
-   * @param {number} [data.AppointmentTypeNum] - Optional: Updated appointment type number.
-   * @param {number} [data.UnschedStatus] - Optional: Updated unscheduled status definition number.
-   * @param {string} [data.colorOverride] - Optional: Updated custom color in "R,G,B" format.
-   * @param {string} [data.PatternSecondary] - Optional: Updated secondary time pattern.
-   * @param {"true" | "false"} [data.IsMirrored] - Optional: Either "true" or "false". If true, then this appointment will show a duplicate mirrored on the secondary provider's operatory. The mirrored appointments can be set to show/hide using the preference "ShowMirroredAppts". Default "false" if "ShowMirroredAppts" is not set.
-   * @returns {Promise<Appointment>} - The updated appointment.
-   * @throws {Error} - If `AptNum` is missing.
-   */
-  public async updateAppointment(data: UpdateAppointmentParams): Promise<Appointment> {
-    if (!data.AptNum) {
-      throw new Error("AptNum is required.");
-    }
-
-    return this.httpClient.put<Appointment>(`/appointments/${data.AptNum}`, data);
-  }
-
-  /**
-   * Break an existing appointment.
-   * Only appointments with an AptStatus of "Scheduled" can be broken.
-   * @param {Object} data - Data for breaking the appointment.
-   * @param {number} data.AptNum - Required: The unique identifier of the appointment to break.
-   * @param {"true" | "false"} data.sendToUnscheduledList - Required: Indicates if the appointment should be added to the Unscheduled List.
-   * @param {"Missed" | "Cancelled"} [data.breakType] - Optional: Reason for breaking the appointment.
-   * @returns {Promise<void>} - Resolves when the appointment is successfully broken.
-   * @throws {Error} - If required fields are missing.
-   */
-  public async breakAppointment(data: BreakAppointmentParams): Promise<void> {
-    if (!data.AptNum || !data.sendToUnscheduledList) {
-      throw new Error("AptNum and sendToUnscheduledList are required.");
-    }
-
-    return this.httpClient.put<void>(`/appointments/${data.AptNum}/Break`, data);
-  }
-
-  /**
-   * Update the note for an existing appointment.
-   * @param {number} AptNum - Required: The unique identifier of the appointment to update.
-   * @param {string} Note - Required: The new note content for the appointment.
-   * @returns {Promise<void>} - Resolves when the note is successfully updated.
-   * @throws {Error} - If required fields are missing.
-   */
-  public async updateAppointmentNote(AptNum: number, Note: string): Promise<void> {
-    if (!AptNum || !Note) {
-      throw new Error("AptNum and Note are required.");
-    }
-
-    return this.httpClient.put<void>(`/appointments/${AptNum}/Note`, { Note });
-  }
-  
-  /**
-   * Confirm an existing appointment.
-   * @param {Object} data - Data for confirming the appointment.
-   * @param {number} data.AptNum - Required: The unique identifier of the appointment to confirm.
-   * @param {string} [data.confirmVal] - Optional: Confirmation value, e.g., "Sent", "Confirmed".
-   * @param {number} [data.defNum] - Optional: Confirmation definition number.
-   * @returns {Promise<void>} - Resolves when the appointment is successfully confirmed.
-   * @throws {Error} - If required fields are missing.
-   */
-  public async confirmAppointment(data: ConfirmAppointmentParams): Promise<void> {
-    if (!data.AptNum || (!data.confirmVal && !data.defNum)) {
-      throw new Error("AptNum and either confirmVal or defNum are required.");
-    }
-
-    return this.httpClient.put<void>(`/appointments/${data.AptNum}/Confirm`, data);
-  }
-}

package/src/api/benefits.ts

@@ -1,155 +0,0 @@
-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/chartModules.ts

@@ -1,53 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  ProgNote,
-  PatientInfo,
-  PlannedAppointment,
-} from "../types/chartModuleTypes"
-
-export default class ChartModules {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-   * Gets the Progress Notes for a patient, similarly to how it shows in the Chart Module. Use another API method or a query to get specific details about each object.
-   * @param {number} PatNum - The unique identifier for the patient.
-   * @returns {Promise<ProgNote>} - The ProgNote object.
-   * @throws {Error} - If `PatNum` is not provided.
-   */
-  public async getProgNotes(PatNum: number): Promise<ProgNote> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("PatNum must be an integer.");
-    }
-    return this.httpClient.get<ProgNote>(`/chartmodules/${PatNum}/ProgNotes`);
-  }
-
-  /**
-   * Gets Patient Info for a patient, similarly to how it shows in the Chart Module. Use another API method or a query to get specific details about returned elements.
-   * @param {number} PatNum - The unique identifier for the patient.
-   * @returns {Promise<PatientInfo>} - The PatientInfo object.
-   * @throws {Error} - If `PatNum` is not provided.
-   */
-  public async PatientInfo(PatNum: number): Promise<PatientInfo> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("PatNum must be an integer.");
-    }
-    return this.httpClient.get<PatientInfo>(`/chartmodules/${PatNum}/PatientInfo`);
-  }
-
-  /**
-   * Gets Planned Appointments for a patient, similarly to how it shows in the Chart Module's Planned Appointments tab.
-   * @param {number} PatNum - The unique identifier for the patient.
-   * @returns {Promise<PlannedAppointment>} - The planned appts object.
-   * @throws {Error} - If `PatNum` is not provided.
-   */
-  public async getPlannedAppts(PatNum: number): Promise<PlannedAppointment> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("PatNum must be an integer.");
-    }
-    return this.httpClient.get<PlannedAppointment>(`/chartmodules/${PatNum}/PlannedAppts`);
-  }
-}

package/src/api/claimProcs.ts

@@ -1,117 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  ClaimProc,
-  GetClaimProcsParams,
-  updateClaimProcParams,
-} from "../types/claimProcTypes";
-
-export default class ClaimProcs {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-    * Fetch multiple ClaimProcs with optional filtering and pagination.
-    * @param {Object} params - The parameters for filtering and pagination.
-    * @param {number} [params.ProcNum] - FK to procedurelog.ProcNum.
-    * @param {number} [params.ClaimNum] - FK to claim.ClaimNum.
-    * @param {number} [params.PatNum] - FK to patient.PatNum.
-    * @param {"NotReceived" | "Received" | "Preauth" | "Adjustment" | "Supplemental" | "CapClaim" | "Estimate" | "CapComplete" | "CapEstimate" | "InsHist"} [params.Status] - Either "NotReceived", "Received", "Preauth", "Adjustment", "Supplemental", "CapClaim", "Estimate",
-    * @param {number} [params.ClaimPaymentNum] - FK to claimpayment.ClaimPaymentNum.
-    * @param {number} [params.Offset] - Pagination offset for results.
-    * @returns {Promise<ClaimProc[]>} - A list of ClaimProcs.
-    */
-  public async getClaimProcs({
-    ProcNum,
-    ClaimNum,
-    PatNum,
-    Status,
-    ClaimPaymentNum,
-    Offset,
-  }: GetClaimProcsParams = {}): Promise<ClaimProc[]> {
-    const params = {
-      ProcNum,
-      ClaimNum,
-      PatNum,
-      Status,
-      ClaimPaymentNum,
-      Offset,
-    };
-  
-    return this.httpClient.get<ClaimProc[]>("/claimprocs", params);
-  }
-
-  /**
-     * Updates an existing procedure. When changing procCode, the treatment area of the current and passed in procedure codes must match. Attempting to pass in empty strings for ToothNum, Surf, and ToothRange will be silently ignored. The CodeNum, procCode, Discount, ToothNum, Surf, and ToothRange fields cannot be updated on procedures with a ProcStatus of C. If the procedurelog is associated with certain appointments, claims, or orthocases, then some fields cannot be updated. Procedure code default notes will not be used.
-     * ProcedureLogs associated with adjustments, appointments, payments, payplancharges, or paysplits are updated exactly as in Open Dental.
-     * @param {Object} data - The updated details of the procedure log.
-     * @param {number} data.ClaimProcNum - Primary Key. Required in the URL.
-     * @param {number} [data.ProvNum]   - ProvNum of a provider. Follows the ProcProvChangesClaimProcWithClaim preference. See Claimproc Provider for more information.,
-     * @param {number} [data.FeeBilled]   - The amount billed to insurance.
-     * @param {number} [data.DedApplied]   - Deductible applied to this procedure only. DedApplied will always match the DedEstOverride value when ClaimProc status is NotReceived or Preauth.
-     * @param {"NotReceived" | "Received" | "Preauth" | "Supplemental" | "Estimate" } [data.Status] - Either "NotReceived", "Received", "Preauth", "Supplemental", or "Estimate". When set to Received or Supplemental, ClaimProc.DateEntry will be updated to DateTime.Now.
-     * @param {number} [data.InsPayAmt]  - Amount insurance actually paid. Cannot be updated once the procedure is attached to a check.
-     * @param {string} [data.Remarks] - The remarks that insurance sends in the EOB about procedures. Overwrites any existing Remarks.
-     * @param {number} [data.ClaimPaymentNum]   - ClaimPaymentNum of a partial claimpayment. Attaches this ClaimProc, alongside any other able ClaimProcs on the same Claim, to the specified ClaimPayment. Can supply 0 to detach this ClaimProc, and all other ClaimProcs from the same claim that are on the same ClaimPayment. See Finalize Insurance Payment and Batch Insurance Payment for more information.
-     * @param {number} [data.WriteOff]   - Amount not covered by insurance which is written off.
-     * @param {string} [data.CodeSent] - The procedure code that was sent to insurance. Usually it is the same as the actual procedure code, but may be different if using alternate codes (for example: Medicaid), medical codes, or custom codes with suffixes that get removed before being sent. See also Incorrect Procedures on Claim. Use ProcedureCodes GET to get a list of valid codes.
-     * @param {number} [data.PercentOverride]   - The percentage that insurance is expected to cover. A number between 0 and 100. Use -1 to indicate no override.
-     * @param {"true" | "false"} [data.NoBillIns]
-     * @param {number} [data.CopayOverride]   - Based on the insurance plan's copay fee schedule, and subtracted from the amount that insurance will pay. Use -1 to indicate no override.
-     * @param {number} [data.DedEstOverride]   -  The amount that the patient must pay each year before insurance kicks in, and always subtracted before Percentage is calculated. Use -1 to indicate no override.
-     * @param {number} [data.InsEstTotalOverride]   - The estimated amount that insurance will pay. If the claimproc is already attached to a claim, this will not affect the patient balance. Use -1 to indicate no override.
-     * @param {number} [data.PaidOtherInsOverride]   - Adds up all amounts paid by insurance plans that are lower in order. Use -1 to indicate no override.
-     * @param {number} [data.WriteOffEstOverride]   - WriteOff amount usually only used for PPOs. Use -1 to indicate no override.
-     * @param {number} [data.ClaimPaymentTracking] - Used to document information about the payment of the procedure. Useful to track why payment was rejected. See also Definitions: Claim Payment Tracking. Definition.DefNum where definition.Category=36.
-     * @returns {Promise<ClaimProc>} - The updated procedure log.
-     * @throws {Error} - If required fields are missing or the API returns an error.
-     */
-    public async updateClaimProc(
-      {
-        ClaimProcNum,
-        ProvNum,
-        FeeBilled,
-        DedApplied,
-        Status,
-        InsPayAmt,
-        Remarks,
-        ClaimPaymentNum,
-        WriteOff,
-        CodeSent,
-        PercentOverride,
-        NoBillIns,
-        CopayOverride,
-        DedEstOverride,
-        InsEstTotalOverride,
-        PaidOtherInsOverride,
-        WriteOffEstOverride,
-        ClaimPaymentTracking,
-      }: updateClaimProcParams
-    ): Promise<ClaimProc> {
-      if (!ClaimProcNum || typeof ClaimProcNum !== "number") {
-        throw new Error("Invalid parameter: ClaimProcNum must be a valid number.");
-      }
-  
-      return this.httpClient.put<ClaimProc>(`/claimprocs/${ClaimProcNum}`, {
-        ProvNum,
-        FeeBilled,
-        DedApplied,
-        Status,
-        InsPayAmt,
-        Remarks,
-        ClaimPaymentNum,
-        WriteOff,
-        CodeSent,
-        PercentOverride,
-        NoBillIns,
-        CopayOverride,
-        DedEstOverride,
-        InsEstTotalOverride,
-        PaidOtherInsOverride,
-        WriteOffEstOverride,
-        ClaimPaymentTracking,
-      });
-    }
-}