@rinse-dental/open-dental 3.4.2 → 4.0.2

package/src/api/recalls.ts

@@ -1,148 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-    Recall,
-    RecallListParams,
-    RecallList,
-    CreateRecallParams,
-    UpdateRecallParams,
-    UpdateRecallStatusParams
-} from "../types/recallTypes";
-
-export default class Recalls {
-  private httpClient: HttpClient;
-
-    constructor(httpClient: HttpClient) {
-        this.httpClient = httpClient;
-    }
-
-    /**
-     * Gets a list of recalls.
-     * @param {number} PatNum - Optional search by PatNum.
-     * @returns {Promise<Recall>} - An array of recall objects.
-     */
-    public async getRecalls(PatNum: number): Promise<Recall> {
-        if (!PatNum) {
-            return this.httpClient.get<Recall>(`/recalls`);
-        } else {
-            return this.httpClient.get<Recall>(`/recalls?PatNum=${PatNum}`);
-        }
-    }
-
-    /**
-     * Gets the Recall List similar to how it's shown in the Appointment Module when you click on Lists and select Recall List.
-     * @param {Object} params - The parameters for filtering and pagination.
-     * @param {string} [params.DateStart] - Due date range. String in "yyyy-mm-dd" format. Default is based on RecallDaysPast preference.
-     * @param {string} [params.DateEnd] - Due date range. String in "yyyy-mm-dd" format. Default is based on RecallDaysFuture preference.
-     * @param {number} [params.ProvNum] - Provider. Default is all providers. Will consider PriProv and SecProv.
-     * @param {number} [params.ClinicNum] - Clinic. Default is all clinics. Use 0 for "Unassigned".
-     * @param {string} [params.RecallType] - Typically either "Prophy" or "Perio". Default is all RecallTypes stored in the preference.
-     * @param {"true" | "false"} [params.IncludeReminded] - Show patients that have already received reminders. Either "true" or "false". Default is false.
-     * @returns {Promise<RecallList[]>} - An array of recall list objects.
-     */
-    public async getRecallList({
-        DateStart,
-        DateEnd,
-        ProvNum,
-        ClinicNum,
-        RecallType,
-        IncludeReminded,
-        Offset,
-    }: RecallListParams = {}): Promise<RecallList[]> {
-        const params = {
-            DateStart,
-            DateEnd,
-            ProvNum,
-            ClinicNum,
-            RecallType,
-            IncludeReminded,
-            Offset,
-        };
-
-        return this.httpClient.get<RecallList[]>("/recalls/List", params);
-    }
-
-    /**
-     * Create a new recall.
-     * @param {Object} data - Data for the new appointment.
-     * @param {number} data.PatNum - Required. FK to patient.PatNum.
-     * @param {number} data.RecallTypeNum -  Required. FK to recalltype.RecallTypeNum. A patient may only have one recall for each RecallType.
-     * @param {string} [data.DateDue] - Optional. This is the date that is actually used when doing reports for recall. String in "yyyy-MM-dd" format.
-     * @param {string} [data.RecallInterval] - Optional.The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for
-     * @param {number} [data.RecallStatus=0] - Optional. FK to definition.DefNum where definition.Category=13. Default 0.
-     * @param {string} [data.Note] - Optional: An administrative note for staff use.
-     * @param {"true" | "false"} [params.IsDisabled="false"] - Optional. Either "true" or "false". Default "false".
-     * @param {number} [data.DisableUntilBalance] - Optional: Hygienist provider number. Default is 0.
-     * @param {string} [data.DisableUntilDate] - Optional. Recall will be disabled until this date. String in "yyyy-MM-dd" format.
-     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional. Either "Normal" or "ASAP". Default "Normal".
-     * @param {string} [data.TimePatternOverride] - Optional. Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
-     * @returns {Promise<Recall>} - The created recall object.
-     * @throws {Error} - If required fields are missing.
-     */
-    public async createRecall(data: CreateRecallParams): Promise<Recall> {
-        if (!data.PatNum || !data.RecallTypeNum) {
-            throw new Error("PatNum and RecallTypeNum are required.");
-        }
-
-        return this.httpClient.post<Recall>("/recalls", data);
-    }
-
-    /**
-     * Edit a recall.
-     * @param {Object} data - Data for the new appointment.
-     * @param {number} data.RecallNum - Required. Primary key of recall to edit.
-     * @param {string} [data.DateDue] - Optional. This is the date that is actually used when doing reports for recall. String in "yyyy-MM-dd" format.
-     * @param {string} [data.RecallInterval] - Optional.The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for
-     * @param {number} [data.RecallStatus=0] - Optional. FK to definition.DefNum where definition.Category=13. Default 0.
-     * @param {string} [data.Note] - Optional: An administrative note for staff use.
-     * @param {"true" | "false"} [params.IsDisabled="false"] - Optional. Either "true" or "false". Default "false".
-     * @param {number} [data.DisableUntilBalance] - Optional: Hygienist provider number. Default is 0.
-     * @param {string} [data.DisableUntilDate] - Optional. Recall will be disabled until this date. String in "yyyy-MM-dd" format.
-     * @param {"Normal" | "ASAP"} [data.Priority="Normal"] - Optional. Either "Normal" or "ASAP". Default "Normal".
-     * @param {string} [data.TimePatternOverride] - Optional. Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
-     * @returns {Promise<Recall>} - The created recall object.
-     * @throws {Error} - If required fields are missing.
-     */
-    public async updateRecall(data: UpdateRecallParams): Promise<Recall> {
-        if (!data.RecallNum) {
-            throw new Error("RecallNum is required.");
-        }
-
-        return this.httpClient.put<Recall>("/recalls", data);
-    }
-
-    /**
-    * Update recall status.
-    * @param {Object} data - Data for the new appointment.
-    * @param {number} data.PatNum - Required. FK to patient.PatNum.
-    * @param {string} data.recallType - Required. Typically either "Prophy" or "Perio". RecallType is dependent upon Setup Recall and Recall Types.
-    * @param {number} [data.RecallStatus=0] - Optional. FK to definition.DefNum where definition.Category=13. Default 0.
-    * @param {"None" | "Email" | "Mail" | "Phone" | "InPerson" | "Text" | "EmailAndText" | "PhoneAndText"} [data.commlogMode] - Optional: An administrative note for staff use.
-    * @param {string} [data.commlogNote] - Optional. This text will be used instead of the default commlog.Note.
-    * @returns {Promise<EditRecallStatusParams>} - The created recall object.
-    * @throws {Error} - If required fields are missing.
-    */
-    public async updateRecallStatus(data: UpdateRecallStatusParams): Promise<UpdateRecallStatusParams> {
-        if (!data.PatNum || !data.recallType) {
-            throw new Error("PatNum and RecallNum are required.");
-        }
-
-        return this.httpClient.put<UpdateRecallStatusParams>("/recalls/Status", data);
-    }
-
-    /**
-    * Switches a Recall's type similiar to clicking the 'Set Perio' or 'Set Prophy' button found in the Recall window.
-    * @param {Object} data - Data for the new appointment.
-    * @param {number} data.PatNum - Patient to switch recall type.
-    * @returns {Promise<{ status: number }>} - The API response containing the status code.
-    * @throws {Error} - If required fields are missing.
-    */
-    public async switchRecallType(data: { PatNum: number }): Promise<{ status: number }> {
-        if (!data.PatNum) {
-            throw new Error("PatNum is required.");
-        }
-
-        return this.httpClient.put<{ status: number }>("/recalls/SwitchType", data);
-    }
-
-
-}

package/src/api/refAttaches.ts

@@ -1,142 +0,0 @@
-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}`);
-  }
-}

package/src/api/referrals.ts

@@ -1,222 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  Referral,
-  GetReferralsParams,
-  CreateReferralParams,
-  UpdateReferralParams,
-} from "../types/referralTypes";
-
-export default class Referrals {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: 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.
-   */
-  public async getReferral(ReferralNum: number): Promise<Referral> {
-    if (!ReferralNum || typeof ReferralNum !== "number") {
-      throw new Error("Invalid data: ReferralNum is required.");
-    }
-    return this.httpClient.get<Referral>(`/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.
-    */
-  public async getReferrals({
-    IsHidden,
-    NotPerson,
-    IsDoctor,
-    IsPreferred,
-    isPatient,
-    BusinessName,
-    Offset,
-  }: GetReferralsParams = {}): Promise<Referral[]> {
-    const params = {
-      IsHidden,
-      NotPerson,
-      IsDoctor,
-      IsPreferred,
-      isPatient,
-      BusinessName,
-      Offset,
-    };
-  
-    return this.httpClient.get<Referral[]>("/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.
-   */
-  public async 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> {
-    if (!LName) {
-      throw new Error("Invalid data: LName is required.");
-    }
-
-    return this.httpClient.post<Referral>("/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.
-   */
-  public async 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> {
-    if (!ReferralNum || typeof ReferralNum !== "number") {
-      throw new Error("Invalid data: ReferralNum is required.");
-    }
-
-    return this.httpClient.put<Referral>(`/referrals/${ReferralNum}`, {
-      LName,
-      FName,
-      MName,
-      SSN,
-      UsingTIN,
-      Specialty,
-      ST,
-      Telephone,
-      Address,
-      Address2,
-      City,
-      Zip,
-      Note,
-      Phone2,
-      NotPerson,
-      Title,
-      EMail,
-      IsDoctor,
-      BusinessName,
-      DisplayNote,
-    });
-  }
-}

package/src/api/schedules.ts

@@ -1,64 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-    Schedule,
-    GetSchedulesParams,
-} from "../types/scheduleTypes";
-
-export default class Schedules {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-   * Fetch a single Schedule by its ID.
-   * @param {number} ScheduleNum - The ID of a schedule.
-   * @returns {Promise<Schedule>} - The schedule data.
-   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
-   */
-  public async getSchedule(ScheduleNum: number): Promise<Schedule> {
-    if (!ScheduleNum || typeof ScheduleNum !== "number") {
-        throw new Error("Invalid parameter: PatNum must be a valid number.");
-    }
-
-    return await this.httpClient.get<Schedule>(`/schedules/${ScheduleNum}`);
-  }
-
-  /**
-   * Fetch multiple schedules with optional filtering and pagination.
-   * @param {Object} params - Filtering and pagination parameters.
-   * @param {string} [params.date] - Optional: For a single day. Today's date by default.
-   * @param {string} [params.dateStart] - Optional: For a single day. Today's date by default.
-   * @param {string} [params.dateEnd] - Optional: For a single day. Today's date by default.
-   * @param {'Practice' | 'Provider' | 'Blockout' | 'Employee' | 'WebSchedASAP'} [params.SchedType] - Optional: Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
-   * @param {number} [params.BlockoutDefNum] - Definition.DefNum where definition.Category=25.
-   * @param {number} [params.ProvNum] - FK to provider.ProvNum.
-   * @param {number} [params.EmployeeNum] - FK to employee.EmployeeNum.
-   * @param {number} [params.Offset] - Pagination offset.
-   * @returns {Promise<Schedule[]>} - A list of schedules.
-   * @throws {Error} - If the API returns an error.
-   */
-  public async getSchedules({
-    date,
-    dateStart,
-    dateEnd,
-    SchedType,
-    BlockoutDefNum,
-    ProvNum,
-    EmployeeNum,
-    Offset,
-    
-  }: GetSchedulesParams = {}): Promise<Schedule[]> {
-      return await this.httpClient.get<Schedule[]>("/schedules", {
-        date,
-        dateStart,
-        dateEnd,
-        SchedType,
-        BlockoutDefNum,
-        ProvNum,
-        EmployeeNum,
-        Offset,
-      });
-    }
-}

package/src/api/securityLogs.ts

@@ -1,32 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  SecurityLog,
-  GetSecurityLogsParams,
-} from "../types/securityLogTypes";
-
-export default class SecurityLogs {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-/**
- * Fetch multiple SecurityLogs with optional filtering and pagination.
- * @param {Object} params - The parameters for filtering and pagination.
- * @param {string} [params.PermType] - Optional. Filter by permission type (see Audit Trail Permissions doc).
- * @param {number} [params.Offset] - Optional. Pagination offset for results.
- * @returns {Promise<SecurityLog[]>} - A list of securitylogs.
- */
-public async getSecurityLogs({
-    PermType,
-    Offset,
-  }: GetSecurityLogsParams = {}): Promise<SecurityLog[]> {
-    const params = {
-      PermType,
-      Offset,
-    };
-  
-    return this.httpClient.get<SecurityLog[]>("/securitylogs", params);
-  }
-}

package/src/api/treatplanattaches.ts

@@ -1,67 +0,0 @@
-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);
-    }
-}