@rinse-dental/open-dental 3.4.2 → 4.0.2

package/src/api/treatplans.ts

@@ -1,96 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-    TreatmentPlan,
-    GetTreatmentPlanParams,
-    CreateTreatmentPlanParams,
-    UpdateTreatmentPlanParams,
-    SaveTreatmentPlanParams,
-} from "../types/treatPlanTypes";
-
-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 treatplan 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 treatment plan.
-     * @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 treatment plan 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 saved treatment plan.
-     * @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 saved treatment plan 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);
-    }
-
-    /**
-    * Update a TreatPlan.
-    * @param {Object} data - Data for the treatplan.
-    * @param {number} data.TreatPlanNum - Required.
-    * @param {string} [data.Heading] - Optional. 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 updated treatplan 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);
-    }
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export { OpenDental } from "./openDental";
-export * as Transformers from './transformers';

package/src/openDental.ts

@@ -1,506 +0,0 @@
-import HttpClient from "./utils/httpClient";
-import Appointments from "./api/appointments";
-import ChartModules from "./api/chartModules";
-import CommLogs from "./api/commlogs";
-import PatFields from "./api/patFields";
-import Patients from "./api/patients";
-import ProcedureLogs from "./api/procedureLog";
-import Recalls from "./api/recalls";
-import TreatmentPlans from "./api/treatplans";
-import TreatmentPlanAttaches from "./api/treatplanattaches";
-import Schedules from "./api/schedules";
-import Providers from "./api/providers";
-import Operatories from "./api/operatories";
-import Payments from "./api/payments";
-import PaySplits from "./api/paySplits";
-import PayPlans from "./api/payPlans";
-import PayPlanCharges from "./api/payPlanCharges";
-import Definitions from "./api/definitions";
-import DiscountPlans from "./api/discountPlans";
-import DiscountPlanSubs from "./api/discountPlanSubs";
-import FamilyModules from "./api/familyModules";
-import InsSubs from "./api/insSubs";
-import PatPlans from "./api/patPlans";
-import LabCases from "./api/labCases";
-import Referrals from "./api/referrals";
-import RefAttaches from "./api/refAttaches";
-import InsPlans from "./api/insPlans";
-import Benefits from "./api/benefits";
-import Claims from "./api/claims";
-import ClaimProcs from "./api/claimProcs";
-import Adjustments from "./api/adjustments";
-import ProcedureCodes from "./api/procedureCodes";
-import Fees from "./api/fees"; 
-import FeeScheds from "./api/feeScheds"; 
-import Diseases from "./api/diseases";
-import Allergies from "./api/allergies";
-import MedicationPats from "./api/medicationPats";
-import ProcTPs from "./api/procTPs";
-import ProcNotes from "./api/procNotes";
-import Queries from "./api/queries";
-import SecurityLogs from "./api/securityLogs";
-import AppointmentTypes from "./api/appointmentTypes";
-import InsVerifies from "./api/insVerifies"; 
-import AccountModules from "./api/accountModules";
-
-import * as Transformers from './transformers';
-
-class OpenDental {
-  private static httpClient: HttpClient;
-
-  /**
-   * Initialize the OpenDental library with the base URL and auth token.
-   */
-  public static initialize(baseURL: string, authToken: string): void {
-    if (!baseURL || !authToken) {
-      throw new Error("Both baseURL and authToken are required.");
-    }
-
-    //to manage future versions of the API
-    baseURL = baseURL + "/api/v1";
-
-    this.httpClient = new HttpClient(baseURL, authToken);
-  }
-
-  /**
-   * Create a new instance of the Appointments API.
-   */
-    public static Appointments() {
-      if (!this.httpClient) {
-        throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-      }
-      return new Appointments(this.httpClient);
-    }
-
-  
-  /**
-   * Create a new instance of the ChartModule API endpoint.
-   */
-    public static CommLogs() {
-      if (!this.httpClient) {
-        throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-      }
-      return new CommLogs(this.httpClient);
-    }
-
-  /**
-   * Create a new instance of the ChartModule API endpoint.
-   */
-  public static ChartModules() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new ChartModules(this.httpClient);
-  }
-
-  /**
-     * Create a new instance of the Patients API.
-     */
-  public static PatFields() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new PatFields(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Patients API.
-   */
-  public static Patients() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Patients(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the ProcedureLogs API endpoint.
-   */
-  public static ProcedureLogs() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new ProcedureLogs(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Patients API.
-   */
-  public static Recalls() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Recalls(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the TreatmentPlans API.
-   */
-  public static TreatmentPlans() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new TreatmentPlans(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the TreatmentPlanAttaches API.
-   */
-  public static TreatmentPlanAttaches() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new TreatmentPlanAttaches(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Schedules API.
-   */
-  public static Schedules() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Schedules(this.httpClient);
-  }
-  
-  /**
-   * Create a new instance of the Providers API.
-   */
-  public static Providers() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Providers(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Operatories API.
-   */
-  public static Operatories() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Operatories(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Payments API.
-   */
-  public static Payments() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Payments(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Definitions API.
-   */
-  public static Definitions() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Definitions(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the DiscountPlans API.
-   */
-  public static DiscountPlans() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new DiscountPlans(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the DiscountPlanSubs API.
-   */
-  public static DiscountPlanSubs() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new DiscountPlanSubs(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the FamilyModules API.
-   */
-  public static FamilyModules() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new FamilyModules(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the InsSub API.
-   */
-  public static InsSubs() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new InsSubs(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the PatPlan API.
-   */
-  public static PatPlans() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new PatPlans(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the LabCases API.
-   */
-  public static LabCases() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new LabCases(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Referrals API.
-   */
-  public static Referrals() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Referrals(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the RefAttaches API.
-   */
-  public static RefAttaches() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new RefAttaches(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the InsPlans API.
-   */
-  public static InsPlans() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new InsPlans(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Benefits API.
-   */
-  public static Benefits() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Benefits(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Claims API.
-   */
-  public static Claims() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Claims(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the ClaimProcs API.
-   */
-  public static ClaimProcs() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new ClaimProcs(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Adjustments API.
-   */
-  public static Adjustments() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Adjustments(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the ProcedureCodes API.
-   */
-  public static ProcedureCodes() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new ProcedureCodes(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the PaySplits API.
-   */
-  public static PaySplits() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new PaySplits(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the PayPlans API.
-   */
-  public static PayPlans() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new PayPlans(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the PayPlanCharges API.
-   */
-  public static PayPlanCharges() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new PayPlanCharges(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Fees API.
-   */
-  public static Fees() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Fees(this.httpClient);
-  }
-
-  /**
- * Create a new instance of the FeeScheds API.
- */
-  public static FeeScheds() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new FeeScheds(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Diseases API.
-   */
-  public static Diseases() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Diseases(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Allergies API.
-   */
-  public static Allergies() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Allergies(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the MedicationPats API.
-   */
-  public static MedicationPats() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new MedicationPats(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the ProcTPs API.
-   */
-  public static ProcTPs() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new ProcTPs(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the ProcNotes API.
-   */
-  public static ProcNotes() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new ProcNotes(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the Queries API.
-   */
-  public static Queries() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new Queries(this.httpClient);
-  }
-
-  /**
-   * Create a new instance of the SecurityLogs API.
-   */
-  public static SecurityLogs() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new SecurityLogs(this.httpClient);
-  }
-
-  /**
- * Create a new instance of the SecurityLogs API.
- */
-  public static AppointmentTypes() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new AppointmentTypes(this.httpClient);
-  }
-
-  /**
- * Create a new instance of the InsVerifies API.
- */
-  public static InsVerifies() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new InsVerifies(this.httpClient);
-  }
-
-   /**
- * Create a new instance of the InsVerifies API.
- */
-  public static AccountModules() {
-    if (!this.httpClient) {
-      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
-    }
-    return new AccountModules(this.httpClient);
-  }
-
-
-  /**
-   * Access stateless Transformers (no initialization needed)
-   */
-  public static Transformers() {
-    return Transformers;
-  }
-
-}
-
-export { OpenDental };

package/src/transformerTypes/visitTypes.ts

@@ -1,87 +0,0 @@
-/**
- * Represents an visit in firebase. 
- * Transformer for appointment
- */
-export interface Visit {
-    serverDateTime?: string; // Server timestamp of the appointment; returned by some endpoints
-    AptNum?: number; // Unique identifier for the appointment
-    PatNum?: number; // Unique identifier for the patient
-    AptStatus?: AptStatus; // Status of the appointment (Scheduled, Complete, etc.)
-    Pattern?: string; // Time pattern in 5-minute increments, e.g., "/XX/" for 20 minutes
-    Confirmed?: number; // Confirmation status code
-    confirmed?: string; // Description of the confirmation status
-    TimeLocked?: boolean; // Indicates if the appointment time is locked
-    Op?: number; // Operatory number
-    Note?: string; // Notes for the appointment
-    ProvNum?: number; // Provider number associated with the appointment
-    provAbbr?: string; // Abbreviation of the provider's name
-    ProvHyg?: number; // Hygienist provider number
-    AptDateTime?: string; // Appointment start time in "yyyy-MM-dd HH:mm:ss" format
-    NextAptNum?: number; // Appointment number of the next scheduled appointment
-    UnschedStatus?: number; // Status of an unscheduled appointment
-    unschedStatus?: string; // Description of the unscheduled status
-    IsNewPatient?: boolean; // Indicates if the appointment is for a new patient
-    ProcDescript?: string; // Description of procedures linked to the appointment
-    ClinicNum?: number; // Clinic number, optional if not using clinics
-    IsHygiene?: boolean; // Indicates if the appointment is for hygiene
-    DateTStamp?: string; // Timestamp of the last update in "yyyy-MM-dd HH:mm:ss" format
-    DateTimeArrived?: string; // Time the patient arrived, if available
-    DateTimeSeated?: string; // Time the patient was seated, if available
-    DateTimeDismissed?: string; // Time the patient was dismissed, if available
-    InsPlan1?: number; // Primary insurance plan number
-    InsPlan2?: number; // Secondary insurance plan number
-    DateTimeAskedToArrive?: string; // Requested arrival time in "yyyy-MM-dd HH:mm:ss" format
-    colorOverride?: string; // Custom color in "R,G,B" format
-    AppointmentTypeNum?: number; // Appointment type number
-    eServiceLogType?: string; //Used only for GET WebSched; eServiceLogType field as either "Recall", "NewPat", "ExistingPat", or "ASAP"
-    SecDateTEntry?: string; // Secondary date entry timestamp
-    Priority?: Priority; // Priority of the appointment (Normal, ASAP)
-    PatternSecondary?: string; // Secondary time pattern in 5-minute increments
-    ItemOrderPlanned?: number; // Order of the item in planned appointments
-    appendix: Appendix; // maps to the Appendix type
-  }
-
-  export type Appendix = {
-    status?: string; //
-    duration?: number; // pattern * 5
-    ProvNum?: number; // ProvNum or ProvHyg depending on IsHygiene
-    date?: string; //
-    dateTime?: string; //
-    unix?: number //
-    date_formats?: Date_Formats; //
-  }
-
-  export type Date_Formats = {
-    date_MMM_D?: string; //
-    month_M?: string; //
-    month_MMM?: string; //
-    month_MMMM?: string;
-    day_D?: string; //
-    day_ddd?: string; //
-    day_dddd?: string; //
-    year_YY?: string; //
-    year_YYYY?: string; //
-    time?: string; //
-    timezone?: string; // in 'America/Los_Angeles' format
-    timezone_z?: string; // in "PDT" format
-    duration_desc?: string; // 
-  }
-
-  /**
-   * 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/src/transformers/index.ts

@@ -1,4 +0,0 @@
-export * from './visit';
-// Add more as you grow:
-// export * from './patientToProfile';
-// export * from './claimToSummary';