@rinse-dental/open-dental 0.1.1 → 0.1.4

package/dist/types/treatPlanTypes.d.ts

@@ -0,0 +1,72 @@
+/**
+* GET TreatPlans object.
+* @see https://www.opendental.com/site/apitreatplans.html
+*/
+export interface TreatmentPlan {
+    TreatPlanNum?: number;
+    PatNum?: number;
+    DateTP?: string;
+    Heading?: string;
+    Note?: string;
+    SigIsTopaz?: "true" | "false";
+    ResponsParty?: number;
+    DocNum?: number;
+    TPStatus?: string;
+    SecUserNumEntry?: number;
+    SecDateEntry?: string;
+    SecDateTEdit?: string;
+    UserNumPresenter?: number;
+    TPType?: "Insurance" | "Discount";
+    DateTSigned?: string;
+    DateTPracticeSigned?: string;
+    SignatureText?: string;
+    SignaturePracticeText?: string;
+    isSigned?: "true" | "false";
+    isSignedPractice?: "true" | "false";
+}
+/**
+ * Get TreatPlans Params. Returns TreatPlan object
+ * @see https://www.opendental.com/site/apitreatplans.html
+ */
+export interface GetTreatmentPlanParams {
+    PatNum?: number;
+    SecDateTEdit?: string;
+    TPStatus?: "Saved" | "Active" | "Inactive";
+}
+/**
+ * POST TreatPlans Params. Returns TreatPlan object
+ * @see https://www.opendental.com/site/apitreatplans.html
+ */
+export interface CreateTreatmentPlanParams {
+    PatNum: number;
+    Heading?: string;
+    Note?: string;
+    TPType?: "Insurance" | "Discount";
+}
+/**
+ * POST Save TreatPlans Params. Returns TreatPlan object.
+ * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
+ * @see https://www.opendental.com/site/apitreatplans.html
+ */
+export interface SaveTreatmentPlanParams {
+    TreatPlanNum: number;
+    Heading?: string;
+    UserNumPresenter?: number;
+}
+/**
+* PUT TreatPlans object.
+* @see https://www.opendental.com/site/apitreatplans.html
+*/
+export interface UpdateTreatmentPlanParams {
+    TreatPlanNum: number;
+    DateTP?: string;
+    Heading?: string;
+    Note?: string;
+    ResponsParty?: number;
+    TPType?: "Insurance" | "Discount";
+    SignatureText?: string;
+    SignaturePracticeText?: string;
+    isSigned?: "true" | "false";
+    isSignedPractice?: "true" | "false";
+}
+//# sourceMappingURL=treatPlanTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"treatPlanTypes.d.ts","sourceRoot":"","sources":["../../src/types/treatPlanTypes.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,MAAM,WAAW,aAAa;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;EAGE;AACF,MAAM,WAAW,yBAAyB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC"}

package/dist/types/treatPlanTypes.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": "0.1.1",
+    "version": "0.1.4",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/appointments.ts

@@ -14,7 +14,7 @@ import {
   UpdateAppointmentParams,
   BreakAppointmentParams,
   ConfirmAppointmentParams,
-} from "../types/appointmentType";
+} from "../types/appointmentTypes";
 
 export default class Appointments {
   private httpClient: HttpClient;
@@ -333,5 +333,4 @@ public async getAppointments({
 
     return this.httpClient.put<void>(`/appointments/${data.AptNum}/confirm`, data);
   }
-
 }

package/src/api/chartModules.ts

@@ -0,0 +1,25 @@
+import HttpClient from "../utils/httpClient";
+import {
+  PlannedAppointment,
+} from "../types/chartModuleTypes"
+
+export default class ChartModules {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * 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) {
+      throw new Error("PatNum is required.");
+    }
+    return this.httpClient.get<PlannedAppointment>(`/chartmodules/${PatNum}/PlannedAppts`);
+  }
+}

package/src/api/commlogs.ts

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { CommLog, CreateCommLogParams } from "../types/commlogType";
+import { CommLog, CreateCommLogParams } from "../types/commlogTypes";
 
 export default class CommLogs {
   private httpClient: HttpClient;

package/src/api/index.ts

@@ -1,4 +1,10 @@
-export { default as Patients } from "./patients";
 export { default as Appointments } from "./appointments";
-//export { default as ProcedureLogs } from "./procedureLogs";
+export { default as ChartModules } from "./chartModules";
+export { default as CommLogs } from "./commlogs";
+export { default as PatFields } from "./patFields";
+export { default as Patients } from "./patients";
+export { default as ProcedureLogs } from "./procedureLog"; 
+export { default as Recalls } from "./recalls";
+export { default as TreatmentPlans } from "./treatplans";
+export { default as Schedule } from "./schedules"; 
 // Add other APIs as needed

package/src/api/patFields.ts

@@ -0,0 +1,112 @@
+import HttpClient from "../utils/httpClient";
+import {
+    PatField,
+    GetPatFieldsParams,
+    AddUpdatePatFieldParams,
+} from "../types/patFieldTypes";
+
+export default class PatFields {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single patfield by its ID.
+   * @param {number} PatFieldNum - The ID of the patfield.
+   * @returns {Promise<PatField>} - The patient data.
+   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+   */
+  public async getPatField(PatFieldNum: number): Promise<PatField> {
+    if (!PatFieldNum || typeof PatFieldNum !== "number") {
+        throw new Error("Invalid parameter: PatNum must be a valid number.");
+    }
+
+    return await this.httpClient.get<PatField>(`/patfields/${PatFieldNum}`);
+  }
+
+  /**
+   * Fetch multiple patients with optional filtering and pagination.
+   * @param {Object} params - Filtering and pagination parameters.
+   * @param {string} [params.PatNum] - Filter by last name (case-insensitive, partial match).
+   * @param {string} [params.FieldName] - Filter by last name (case-insensitive, partial match).
+   * @param {string} [params.SecDateTEdit] - Filter by last name (case-insensitive, partial match).
+   * @returns {Promise<PatField[]>} - A list of summarized patient data.
+   * @throws {Error} - If the API returns an error.
+   */
+    public async getPatFields({
+      PatNum,
+      FieldName,
+      SecDateTEdit,
+    }: GetPatFieldsParams = {}): Promise<PatField[]> {
+
+      return await this.httpClient.get<PatField[]>("/patfields", {
+        PatNum,
+        FieldName,
+        SecDateTEdit,
+      });
+    }
+
+    /**
+     * Creates a patfield. Cannot create PatFields associated with hidden PatFieldDefs.
+     * @param {Object} data - The data for the new patfield.
+     * @param {number} data.PatNum - Required: The patient's PatNum.
+     * @param {string} data.FieldName - Required: FK to PatFieldDef.FieldName. Case sensitive.
+     * @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
+     * @returns {Promise<PatField>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    public async createPatField({
+        PatNum,
+        FieldName,
+        FieldValue,
+      }: AddUpdatePatFieldParams): Promise<PatField> {
+        if (!PatNum || !FieldName || !FieldValue) {
+            throw new Error("Invalid data: All fields are required.");
+        }
+        return await this.httpClient.post<PatField>("/patfields", {
+            PatNum,
+            FieldName,
+            FieldValue,
+        });
+      }
+
+    /**
+     * Updates an existing patfield.
+     * @param {Object} data - The data for the updated patfield.
+     * @param {number} data.PatNum - Required: The patient's PatNum.
+     * @param {string} data.FieldName - Required: FK to PatFieldDef.FieldName. Case sensitive.
+     * @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
+     * @returns {Promise<PatField>} - The updated PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    public async editPatField({
+        PatNum,
+        FieldName,
+        FieldValue,
+      }: AddUpdatePatFieldParams): Promise<PatField> {
+        if (!PatNum || !FieldName || !FieldValue) {
+            throw new Error("Invalid data: All fields are required.");
+        }
+        return await this.httpClient.put<PatField>("/patfields", {
+            PatNum,
+            FieldName,
+            FieldValue,
+        });
+      }
+
+    /**
+     * Delete a single patfield by its ID.
+     * @param {number} PatFieldNum - The ID of the patField.
+     * @returns {Promise<{ status: number }>} - The API response containing the status code.
+     * @throws {Error} - If `PatFieldNum` is not valid or the API returns an error.
+     */
+    public async deletePatField(PatFieldNum: number): Promise<{ status: number }> {
+        if (!PatFieldNum || typeof PatFieldNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+
+        return await this.httpClient.delete<{ status: number }>(`/patfields/${PatFieldNum}`);
+    }
+}

package/src/api/patients.ts

@@ -1,9 +1,9 @@
-import axios from "axios";
 import HttpClient from "../utils/httpClient";
 import {
   Patient,
   PatientSummary,
   GetPatientsParams,
+  GetPatientsSimpleParams,
   CreatePatientParams,
   UpdatePatientParams,
 } from "../types/patientTypes";
@@ -103,6 +103,55 @@ export default class Patients {
 
     }
 
+  /**
+   * Fetch multiple patients with optional filtering and pagination.
+   * @param {Object} params - Filtering and pagination parameters.
+   * @param {string} [params.LName] - Filter by last name (case-insensitive, partial match).
+   * @param {string} [params.FName] - Filter by first name (case-insensitive, partial match).
+   * @param {string} [params.Birthdate] - Filter by birthdate in "yyyy-MM-dd" format.
+   * @param {number} [params.ClinicNum] - Filter by clinic number (comma-separated list).
+   * @param {"Patient" | "NonPatient" | "Inactive" | "Archived" | "Deceased" | "Prospective".} [params.PatStatus] - Filter by Patient Status.
+   * @param {string} [params.DateTStamp] - In "yyyy-mm-dd HH:mm:ss" format.
+   * @param {number} [params.PriProv] - A single ProvNum. Leave blank if you want results for all primary providers.
+   * @param {"Male" | "Female" | "Unknown" | "Other"} [params.Gender] - Either "Male", "Female", "Unknown", or "Other".
+   * @param {"Single" | "Married" | "Child" | "Widowed" | "Divorced"} [params.Position] - Either "Single", "Married", "Child", "Widowed", or "Divorced".
+   * @param {number} [params.Guarantor] - A single PatNum. The person responsible for the account.
+   * @param {number} [params.SuperFamily] - A single PatNum. The head of a SuperFamily.
+   * @param {number} [params.Offset] - Pagination offset.
+   * @returns {Promise<Patient[]>} - A list of summarized patient data.
+   * @throws {Error} - If the API returns an error.
+   */
+  public async getPatientsSimple({
+    LName,
+    FName,
+    Birthdate,
+    ClinicNum,
+    PatStatus,
+    DateTStamp,
+    PriProv,
+    Gender,
+    Position,
+    Guarantor,
+    SuperFamily,
+    Offset,
+  }: GetPatientsSimpleParams = {}): Promise<Patient[]> {
+
+    return await this.httpClient.get<Patient[]>("/patients/Simple", {
+      LName,
+      FName,
+      Birthdate,
+      ClinicNum,
+      PatStatus,
+      DateTStamp,
+      PriProv,
+      Gender,
+      Position,
+      Guarantor,
+      SuperFamily,
+      Offset,
+    });
+  }
+
   /**
    * Create a new patient.
    * @param {Object} data - The data for the new patient.

package/src/api/recalls.ts

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

@@ -0,0 +1,65 @@
+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 the patfield.
+   * @returns {Promise<Schedule>} - The patient 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 patients 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 summarized patient data.
+   * @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/treatplans.ts

@@ -0,0 +1,97 @@
+import HttpClient from "../utils/httpClient";
+import {
+    TreatmentPlan,
+    GetTreatmentPlanParams,
+    CreateTreatmentPlanParams,
+    UpdateTreatmentPlanParams,
+    SaveTreatmentPlanParams,
+} from "../types/treatPlanTypes";
+import { updateProcedureLogParams } from "../types/procedurelogTypes";
+
+export default class TreatmentPlans {
+  private httpClient: HttpClient;
+
+    constructor(httpClient: HttpClient) {
+        this.httpClient = httpClient;
+    }
+
+    /**
+     * Get a list of TreatPlans that meet a set of search criteria.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {string} [params.PatNum] - patient.PatNum.
+     * @param {string} [params.SecDateTEdit] - Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
+     * @param {"Saved" | "Active" | "Inactive"} [params.TPStatus] - Either "Saved", "Active", or "Inactive". Default all.
+     * @returns {Promise<TreatmentPlan[]>} - An array of recall list objects.
+     */
+    public async getTreatmentPlans({
+        PatNum,
+        SecDateTEdit,
+        TPStatus,
+    }: GetTreatmentPlanParams = {}): Promise<TreatmentPlan[]> {
+        const params = {
+            PatNum,
+            SecDateTEdit,
+            TPStatus,
+        };
+
+        return this.httpClient.get<TreatmentPlan[]>("/treatplans", params);
+    }
+
+     /**
+     * Create a new TreatPlan.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {string} [data.Heading] - Optional. Defaults to the heading of the supplied Treatment Plan.
+     * @param {string} [data.Note] - Optional: An administrative note for staff use.
+     * @param {"Insurance" | "Discount"} [params.TPType] - Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
+     * @returns {Promise<TreatmentPlan>} - The created recall object.
+     * @throws {Error} - If required fields are missing.
+     */
+    public async createTreatmentPlan(data: CreateTreatmentPlanParams): Promise<TreatmentPlan> {
+        if (!data.PatNum) {
+            throw new Error("PatNum is required.");
+        }
+
+        return this.httpClient.post<TreatmentPlan>("/treatplans", data);
+    }
+
+    /**
+     * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
+     * @param {Object} data - Data for the new appointment.
+     * @param {number} data.TreatPlanNum - Required.
+     * @param {string} [data.Heading] - Optional. Defaults to the heading of the supplied Treatment Plan.
+     * @param {string} [data.UserNumPresenter=0] - Optional. FK to userod.UserNum. Default 0.
+     * @returns {Promise<TreatmentPlan>} - The created recall object.
+     * @throws {Error} - If required fields are missing.
+     */
+    public async saveTreatmentPlan(data: SaveTreatmentPlanParams): Promise<TreatmentPlan> {
+        if (!data.TreatPlanNum) {
+            throw new Error("TreatPlanNum is required.");
+        }
+
+        return this.httpClient.post<TreatmentPlan>("/treatplans/Saved", data);
+    }
+
+    /**
+    * Create a new TreatPlan.
+    * @param {Object} data - Data for the new appointment.
+    * @param {number} data.TreatPlanNum - Required.
+    * @param {string} [data.Heading] - The heading that shows at the top of the treatment plan.
+    * @param {string} [data.Note] - Optional: An administrative note for staff use.
+    * @param {number} [data.ResponsParty] - FK to patient.PatNum. The patient responsible for approving the treatment.
+    * @param {"Insurance" | "Discount"} [params.TPType] - Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
+    * @param {string} [data.SignatureText] - The typed name of the person who signed the patient signature.
+    * @param {string} [data.SignaturePracticeText] - The typed name of the person who signed the patient signature.
+    * @param {"true" | "false"} [data.isSigned] - The typed name of the person who signed the patient signature.
+    * @param {"true" | "false"} [data.isSignedPractice] - Either "true" or "false". True updates the treatplan SignaturePractice, digitally signs for the practice, and overwrites existing signature. False clears the exisiting treatplan SignaturePractice.
+    * @returns {Promise<TreatmentPlan>} - The created recall object.
+    * @throws {Error} - If required fields are missing.
+     */
+    public async updateTreatmentPlan(data: UpdateTreatmentPlanParams): Promise<TreatmentPlan> {
+        if (!data.TreatPlanNum) {
+            throw new Error("TreatPlanNum is required.");
+        }
+
+        return this.httpClient.put<TreatmentPlan>(`/treatplans/${data.TreatPlanNum}`, data);
+    }
+}