@rinse-dental/open-dental 0.0.6 → 0.1.0

package/dist/types/appointmentType.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface Appointment {
+    serverDateTime?: string;
+    AptNum?: number;
+    PatNum?: number;
+    AptStatus?: AptStatus;
+    Pattern?: string;
+    Confirmed?: number;
+    confirmed?: string;
+    TimeLocked?: "true" | "false";
+    Op?: number;
+    Note?: string;
+    ProvNum?: number;
+    provAbbr?: string;
+    ProvHyg?: number;
+    AptDateTime?: string;
+    NextAptNum?: number;
+    UnschedStatus?: number;
+    unschedStatus?: string;
+    IsNewPatient?: "true" | "false";
+    ProcDescript?: string;
+    ClinicNum?: number;
+    IsHygiene?: "true" | "false";
+    DateTStamp?: string;
+    DateTimeArrived?: string;
+    DateTimeSeated?: string;
+    DateTimeDismissed?: string;
+    InsPlan1?: number;
+    InsPlan2?: number;
+    DateTimeAskedToArrive?: string;
+    colorOverride?: string;
+    AppointmentTypeNum?: number;
+    eServiceLogType?: string;
+    SecDateTEntry?: string;
+    Priority?: Priority;
+    PatternSecondary?: string;
+    ItemOrderPlanned?: number;
+}
+/**
+ * Parameters for GET Appointments.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface GetAppointmentParams {
+    PatNum?: number;
+    AptStatus?: AptStatus;
+    Op?: number;
+    date?: string;
+    dateStart?: string;
+    dateEnd?: string;
+    ClinicNum?: number;
+    DateTStamp?: string;
+    Offset?: number;
+}
+/**
+ * Parameters for GET ASAP Appointments.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface GetASAPParams {
+    ClinicNum?: number;
+    ProvNum?: number;
+}
+/**
+ * Parameters for GET Slots.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface GetSlotsParams {
+    date?: string;
+    dateStart?: string;
+    dateEnd?: string;
+    lengthMinutes?: number;
+    ProvNum?: number;
+    OpNum?: number;
+}
+/**
+ * Parameters for GET SlotsWebSched.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface GetSlotsWebSchedParams {
+    date?: string;
+    dateStart?: string;
+    dateEnd?: string;
+    ClinicNum: number;
+    defNumApptType?: number;
+    isNewPatient?: 'true' | 'false';
+}
+/**
+ * Represents an appointment slot object, used to return GET Slots and GET SlotsWebSched.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface AppointmentSlot {
+    DateTimeStart?: string;
+    DateTimeEnd?: string;
+    ProvNum?: number;
+    OpNum?: number;
+}
+/**
+ * Parameters for GET WebSched Appointments. Returns an abridged appointment object.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface GetWebSchedAppointmentsParams {
+    date?: string;
+    dateStart?: string;
+    dateEnd?: string;
+    DateTStamp?: string;
+    ClinicNum?: number;
+}
+/**
+ * Parameters for creating a new appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface CreateNewAppointmentParams {
+    PatNum: number;
+    Op: number;
+    AptDateTime: string;
+    AptStatus?: AptStatus;
+    Pattern?: string;
+    Confirmed?: number;
+    Note?: string;
+    ProvNum?: number;
+    ProvHyg?: number;
+    ClinicNum?: number;
+    IsHygiene?: 'true' | 'false';
+    IsNewPatient?: 'true' | 'false';
+    Priority?: Priority;
+    AppointmentTypeNum?: number;
+    colorOverride?: string;
+    PatternSecondary?: string;
+}
+/**
+ * Parameters for creating a planned appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface CreatePlannedAppointmentParams {
+    PatNum: number;
+    AppointmentTypeNum?: number;
+    procNums?: number[];
+    Pattern?: string;
+    Confirmed?: number;
+    Note?: string;
+    ProvNum?: number;
+    ProvHyg?: number;
+    ClinicNum?: number;
+    IsHygiene?: 'true' | 'false';
+    IsNewPatient?: 'true' | 'false';
+    Priority?: Priority;
+    PatternSecondary?: string;
+}
+/**
+ * Parameters for scheduling a planned appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface SchedulePlannedAppointmentParams {
+    AptNum: number;
+    AptDateTime: string;
+    ProvNum: number;
+    Op: number;
+    Confirmed?: number;
+    Note?: string;
+}
+/**
+ * Parameters for scheduling a WebSched appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface ScheduleWebSchedAppointmentParams {
+    PatNum: number;
+    DateTimeStart: string;
+    DateTimeEnd: string;
+    ProvNum: number;
+    OpNum: number;
+    defNumApptType: number;
+}
+/**
+ * Parameters for updating an appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface UpdateAppointmentParams {
+    AptNum: number;
+    AptStatus?: AptStatus;
+    Pattern?: string;
+    Confirmed?: number;
+    Op?: number;
+    Note?: string;
+    ProvNum?: number;
+    ProvHyg?: number;
+    AptDateTime?: string;
+    ClinicNum?: number;
+    IsHygiene?: 'true' | 'false';
+    IsNewPatient?: 'true' | 'false';
+    Priority?: Priority;
+    AppointmentTypeNum?: number;
+    UnschedStatus?: number;
+    colorOverride?: string;
+    PatternSecondary?: string;
+}
+/**
+ * Breaks an appointment. Only appointments with an AptStatus of Scheduled can be broken. Creates a CommLog entry if the office has that preference turned on. To reschedule a broken appointment, use Appointments PUT (update) to update the Status, AptDateTime, and Op of the broken appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface BreakAppointmentParams {
+    AptNum: number;
+    sendToUnscheduledList: 'true' | 'false';
+    breakType?: 'Missed' | 'Cancelled';
+}
+/**
+ * Parameters for confirming an appointment.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface ConfirmAppointmentParams {
+    AptNum: number;
+    confirmVal?: 'None' | 'Sent' | 'Confirmed' | 'Not Accepted' | 'Failed';
+    defNum?: number;
+}
+/**
+ * Appointment status options.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export type AptStatus = "Scheduled" | "Complete" | "UnschedList" | "ASAP" | "Broken" | "Planned" | "PtNote" | "PtNoteCompleted";
+/**
+ * Appointment priority options.
+ */
+export type Priority = "Normal" | "ASAP";

package/dist/types/appointmentType.js

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

package/dist/types/patientTypes.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface GetPatientsParams {
+    LName?: string;
+    FName?: string;
+    Phone?: string;
+    Address?: string;
+    hideInactive?: 'true' | 'false';
+    City?: string;
+    State?: string;
+    SSN?: string;
+    ChartNumber?: string;
+    guarOnly?: 'true' | 'false';
+    showArchived?: 'true' | 'false';
+    Birthdate?: string;
+    SiteNum?: number;
+    SubscriberId?: string;
+    Email?: string;
+    Country?: string;
+    ClinicNum?: number;
+    clinicAbbr?: string;
+    invoiceNumber?: string;
+    Offset?: number;
+}
+/**
+ * Parameters for fetching comprehensive patient data.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface GetPatientsSimpleParams extends GetPatientsParams {
+    LName?: string;
+    FName?: string;
+    Birthdate?: string;
+    ClinicNum?: number;
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective';
+    DateTStamp?: string;
+    PriProv?: number;
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other';
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced';
+    Guarantor?: number;
+    SuperFamily?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a new patient.
+ * Required fields depend on Open Dental's configuration.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface CreatePatientParams {
+    LName: string;
+    FName: string;
+    MiddleI?: string;
+    Preferred?: string;
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective';
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other';
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced';
+    Birthdate?: string;
+    SSN?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    State?: string;
+    Zip?: string;
+    HmPhone?: string;
+    WkPhone?: string;
+    WirelessPhone?: string;
+    Guarantor?: number;
+    Email?: string;
+    PriProv?: number;
+    SecProv?: number;
+    BillingType?: string;
+    FamFinUrgNote?: string;
+    ChartNumber?: string;
+    DateFirstVisit?: string;
+    ClinicNum?: number;
+    Ward?: string;
+    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall';
+    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail';
+    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail';
+    Language?: string;
+    AdmitDate?: string;
+    SuperFamily?: number;
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No';
+}
+export interface UpdatePatientParams {
+    LName?: string;
+    FName?: string;
+    MiddleI?: string;
+    Preferred?: string;
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective';
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other';
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced';
+    Birthdate?: string;
+    SSN?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    State?: string;
+    Zip?: string;
+    HmPhone?: string;
+    WkPhone?: string;
+    WirelessPhone?: string;
+    Guarantor?: number;
+    Email?: string;
+    PriProv?: number;
+    SecProv?: number;
+    BillingType?: string;
+    FamFinUrgNote?: string;
+    ChartNumber?: string;
+    DateFirstVisit?: string;
+    ClinicNum?: number;
+    Ward?: string;
+    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall';
+    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail';
+    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail';
+    Language?: string;
+    AdmitDate?: string;
+    SuperFamily?: number;
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No';
+}
+/**
+ * Represents a patient in the Open Dental system.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface Patient {
+    serverDateTime?: string;
+    PatNum?: number;
+    LName?: string;
+    FName?: string;
+    MiddleI?: string;
+    Preferred?: string;
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective';
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other';
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced';
+    Birthdate?: string;
+    SSN?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    State?: string;
+    Zip?: string;
+    HmPhone?: string;
+    WkPhone?: string;
+    WirelessPhone?: string;
+    Guarantor?: number;
+    Email?: string;
+    EstBalance?: number;
+    PriProv?: number;
+    priProvAbbr?: string;
+    SecProv?: number;
+    secProvAbbr?: string;
+    BillingType?: string;
+    ImageFolder?: string;
+    FamFinUrgNote?: string;
+    ChartNumber?: string;
+    MedicaidID?: string;
+    BalTotal?: number;
+    DateFirstVisit?: string;
+    ClinicNum?: number;
+    clinicAbbr?: string;
+    Ward?: string;
+    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall';
+    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail';
+    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail';
+    Language?: string;
+    AdmitDate?: string;
+    siteDesc?: string;
+    DateTStamp?: string;
+    SuperFamily?: number;
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No';
+    SecDateEntry?: string;
+}
+/**
+ * Simplified representation of a patient in the Open Dental system.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface PatientSummary {
+    PatNum?: number;
+    LName?: string;
+    FName?: string;
+    MiddleI?: string;
+    Preferred?: string;
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective';
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other';
+    Birthdate?: string;
+    SSN?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    State?: string;
+    Zip?: string;
+    HmPhone?: string;
+    WkPhone?: string;
+    WirelessPhone?: string;
+    Email?: string;
+    priProvAbbr?: string;
+    secProvAbbr?: string;
+    BillingType?: string;
+    ChartNumber?: string;
+    ClinicNum?: number;
+    clinicAbbr?: string;
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No';
+}

package/dist/types/patientTypes.js

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

package/dist/types/procedurelogTypes.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Represents a procedure log entry in the Open Dental system.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface ProcedureLog {
+    ProcNum?: number;
+    PatNum?: number;
+    AptNum?: number;
+    ProcDate?: string;
+    ProcFee?: number;
+    Surf?: Surf;
+    ToothNum?: string;
+    ToothRange?: string;
+    Priority?: number;
+    priority?: string;
+    ProcStatus?: 'TP' | 'C' | 'EO' | 'R' | 'D' | 'E';
+    ProvNum?: number;
+    provAbbr?: string;
+    Dx?: string;
+    dxName?: string;
+    PlannedAptNum?: number;
+    Prosthesis?: string;
+    DateOriginalProsth?: string;
+    ClinicNum?: number;
+    CodeNum?: number;
+    procCode?: string;
+    descript?: string;
+    ProcTime?: string;
+    UnitQty?: number;
+    DateTStamp?: string;
+    IsDateProsthEst?: 'true' | 'false';
+    serverDateTime?: string;
+}
+/**
+ * Create procedure log parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface createProcedureLogParams {
+    PatNum: number;
+    ProcDate: string;
+    ProcStatus: 'TP' | 'C' | 'EO';
+    procCode: string;
+    AptNum?: number;
+    ProcFee?: number;
+    Surf?: Surf;
+    ToothNum?: string;
+    ToothRange?: string;
+    Priority?: number;
+    priority?: string;
+    ProvNum?: number;
+    Dx?: string;
+    dxName?: string;
+    PlannedAptNum?: number;
+    ClinicNum?: number;
+}
+/**
+ * Update procedure log parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface updateProcedureLogParams {
+    ProcNum: number;
+    AptNum?: number;
+    ProcDate?: string;
+    ProcFee?: number;
+    Priority?: number;
+    ProcStatus?: 'TP' | 'C' | 'EO';
+    ProvNum?: number;
+    Dx?: string;
+    PlannedAptNum?: number;
+    ClinicNum?: number;
+    procCode?: string;
+    ToothNum?: string;
+    Surf?: Surf;
+    ToothRange?: string;
+}
+/**
+ * Insurance History object in Open Dental.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface InsuranceHistory {
+    insHistPrefName?: string;
+    procDate?: string;
+    ProcNum?: number;
+}
+/**
+ * get Insurance History parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface getInsuranceHistoryParams {
+    PatNum: number;
+    InsSubNum: number;
+}
+/**
+ * post Insurance History parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface postInsuranceHistoryParams {
+    PatNum: number;
+    InsSubNum: number;
+    insHistPrefName: "InsHistBWCodes" | "InsHistPanoCodes" | "InsHistExamCodes" | "InsHistProphyCodes" | "InsHistPerioURCodes" | "InsHistPerioULCodes" | "InsHistPerioLRCodes" | "InsHistPerioLLCodes" | "InsHistPerioMaintCodes" | "InsHistDebridementCodes";
+    ProcDate: string;
+}
+/**
+ * Surf: Required for the treatment areas of some procCodes. Can be tooth Surfaces (B/F,V,M,O/I,D,L), mouth Quadrants (UL,UR,LR,LL), Sextants (1,2,3,4,5,6), or Arches (U or L).
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export type Surf = "B/F" | "V" | "M" | "O/I" | "D" | "L" | "UL" | "UR" | "LR" | "LL" | "1" | "2" | "3" | "4" | "5" | "6" | "U" | "L";

package/dist/types/procedurelogTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+//NEED TO COMPLETE FOR PUT/POST/DELETE GROUP NOTES AND INSURANCE HISTORY
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/httpClient.d.ts

@@ -0,0 +1,45 @@
+declare class HttpClient {
+    private client;
+    constructor(baseURL: string, authToken: string);
+    /**
+     * GET request
+     * @param {string} url - The endpoint URL
+     * @param {object} [params] - Optional query parameters
+     * @returns {Promise<T>} - The API response
+     */
+    get<T>(url: string, params?: object): Promise<T>;
+    /**
+     * POST request
+     * @param {string} url - The endpoint URL
+     * @param {object} data - The payload to send
+     * @returns {Promise<T>} - The API response
+     */
+    post<T>(url: string, data: object): Promise<T>;
+    /**
+     * PUT request
+     * @param {string} url - The endpoint URL
+     * @param {object} data - The payload to update
+     * @returns {Promise<T>} - The API response
+     */
+    put<T>(url: string, data: object): Promise<T>;
+    /**
+     * DELETE request
+     * @param {string} url - The endpoint URL
+     * @returns {Promise<T>} - The API response
+     */
+    delete<T>(url: string): Promise<T>;
+    /**
+     * Handles requests and errors consistently across methods.
+     * @param {Function} requestFn - The Axios request function to execute.
+     * @returns {Promise<T>} - The API response or an error message.
+     * @throws {Error} - Throws an error with a formatted message.
+     */
+    private handleRequest;
+    /**
+     * Error handler to provide detailed error information.
+     * @param {unknown} error - The error object from Axios or another source.
+     * @throws {Error} - A formatted error with API details or a general message.
+     */
+    private handleError;
+}
+export default HttpClient;