@rinse-dental/open-dental 0.1.7 → 1.0.1

package/dist/api/providers.js

@@ -23,7 +23,7 @@ class Providers {
      * @param {number} [params.ClinicNum] - Get providers by ClinicNum
      * @param {string} [params.DateTStamp] - Get providers altered after the specified date and time
      * @param {string} [params.Offset] - Pagination
-    * @returns {Promise<Provider[]>} - A list of summarized patient data.
+    * @returns {Promise<Provider[]>} - A list of providers.
      * @throws {Error} - If the API returns an error.
      */
     async getProviders({ ClinicNum, DateTStamp, Offset, } = {}) {
@@ -35,25 +35,25 @@ class Providers {
     }
     /**
      * Creates a provider. Cannot create PatFields associated with hidden PatFieldDefs.
-     * @param {Object} data - The data for the new patfield.
+     * @param {Object} data - The data for the new provider.
      * @param {string} data.Abbr - Required.
-     * @param {string} data.LName - Optional.
-     * @param {string} data.FName - Optional.
-     * @param {string} data.MI - Optional.
-     * @param {string} data.Suffix - Optional.
-     * @param {number} data.FeeSched - Optional.
-     * @param {number} data.Specialty - Optional.
-     * @param {string} data.SSN - Optional.
-     * @param {'true' | 'false'} data.IsSecondary - Optional.
-     * @param {'true' | 'false'} data.IsHidden - Optional.
-     * @param {'true' | 'false'} data.UsingTIN - Optional.
-     * @param {'true' | 'false'} data.SigOnFile - Optional.
-     * @param {'true' | 'false'} data.IsNotPerson - Optional.
-     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
-     * @param {string} data.Birthdate - Optional.
-     * @param {string} data.SchedNote - Optional.
-     * @param {string} data.PreferredName - Optional.
-     * @returns {Promise<Provider>} - The created PatField.
+     * @param {string} [data.LName] - Optional.
+     * @param {string} [data.FName] - Optional.
+     * @param {string} [data.MI] - Optional.
+     * @param {string} [data.Suffix] - Optional.
+     * @param {number} [data.FeeSched] - Optional.
+     * @param {number} [data.Specialty] - Optional.
+     * @param {string} [data.SSN] - Optional.
+     * @param {'true' | 'false'} [data.IsSecondary] - Optional.
+     * @param {'true' | 'false'} [data.IsHidden] - Optional.
+     * @param {'true' | 'false'} [data.UsingTIN] - Optional.
+     * @param {'true' | 'false'} [data.SigOnFile] - Optional.
+     * @param {'true' | 'false'} [data.IsNotPerson] - Optional.
+     * @param {'true' | 'false'} [data.IsHiddenReport] - Optional.
+     * @param {string} [data.Birthdate] - Optional.
+     * @param {string} [data.SchedNote] - Optional.
+     * @param {string} [data.PreferredName] - Optional.
+     * @returns {Promise<Provider>} - The created provider.
      * @throws {Error} - If the data is invalid or the API returns an error.
      */
     async createProvider({ Abbr, LName, FName, MI, Suffix, FeeSched, Specialty, SSN, IsSecondary, IsHidden, UsingTIN, SigOnFile, IsNotPerson, IsHiddenReport, Birthdate, SchedNote, PreferredName, }) {
@@ -83,25 +83,25 @@ class Providers {
     /**
      * Update a provider.
      * @param {number} ProvNum - The ID of the provider.
-     * @param {Object} data - The data for the new patfield.
-     * @param {string} data.Abbr - Optional but must not be blank.
-     * @param {string} data.LName - Optional.
-     * @param {string} data.FName - Optional.
-     * @param {string} data.MI - Optional.
-     * @param {string} data.Suffix - Optional.
-     * @param {number} data.FeeSched - Optional.
-     * @param {number} data.Specialty - Optional.
-     * @param {string} data.SSN - Optional.
-     * @param {'true' | 'false'} data.IsSecondary - Optional.
-     * @param {'true' | 'false'} data.IsHidden - Optional.
-     * @param {'true' | 'false'} data.UsingTIN - Optional.
-     * @param {'true' | 'false'} data.SigOnFile - Optional.
-     * @param {'true' | 'false'} data.IsNotPerson - Optional.
-     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
-     * @param {string} data.Birthdate - Optional.
-     * @param {string} data.SchedNote - Optional.
-     * @param {string} data.PreferredName - Optional.
-     * @returns {Promise<Provider>} - The created PatField.
+     * @param {Object} data - The data for a provider.
+     * @param {string} [data.Abbr] - Optional but must not be blank.
+     * @param {string} [data.LName] - Optional.
+     * @param {string} [data.FName] - Optional.
+     * @param {string} [data.MI] - Optional.
+     * @param {string} [data.Suffix] - Optional.
+     * @param {number} [data.FeeSched] - Optional.
+     * @param {number} [data.Specialty] - Optional.
+     * @param {string} [data.SSN] - Optional.
+     * @param {'true' | 'false'} [data.IsSecondary] - Optional.
+     * @param {'true' | 'false'} [data.IsHidden] - Optional.
+     * @param {'true' | 'false'} [data.UsingTIN] - Optional.
+     * @param {'true' | 'false'} [data.SigOnFile] - Optional.
+     * @param {'true' | 'false'} [data.IsNotPerson] - Optional.
+     * @param {'true' | 'false'} [data.IsHiddenReport] - Optional.
+     * @param {string} [data.Birthdate] - Optional.
+     * @param {string} [data.SchedNote] - Optional.
+     * @param {string} [data.PreferredName] - Optional.
+     * @returns {Promise<Provider>} - The updated Provider.
      * @throws {Error} - If the data is invalid or the API returns an error.
      */
     async updateProvider({ ProvNum, Abbr, LName, FName, MI, Suffix, Specialty, SSN, NationalProvID, StateLicense, UsingTIN, SigOnFile, PreferredName, }) {

package/dist/api/schedules.d.ts

@@ -5,13 +5,13 @@ export default class Schedules {
     constructor(httpClient: HttpClient);
     /**
      * Fetch a single Schedule by its ID.
-     * @param {number} ScheduleNum - The ID of the patfield.
-     * @returns {Promise<Schedule>} - The patient data.
+     * @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.
      */
     getSchedule(ScheduleNum: number): Promise<Schedule>;
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * 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.
@@ -21,7 +21,7 @@ export default class Schedules {
      * @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.
+     * @returns {Promise<Schedule[]>} - A list of schedules.
      * @throws {Error} - If the API returns an error.
      */
     getSchedules({ date, dateStart, dateEnd, SchedType, BlockoutDefNum, ProvNum, EmployeeNum, Offset, }?: GetSchedulesParams): Promise<Schedule[]>;

package/dist/api/schedules.js

@@ -7,8 +7,8 @@ class Schedules {
     }
     /**
      * Fetch a single Schedule by its ID.
-     * @param {number} ScheduleNum - The ID of the patfield.
-     * @returns {Promise<Schedule>} - The patient data.
+     * @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.
      */
     async getSchedule(ScheduleNum) {
@@ -18,7 +18,7 @@ class Schedules {
         return await this.httpClient.get(`/schedules/${ScheduleNum}`);
     }
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * 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.
@@ -28,7 +28,7 @@ class Schedules {
      * @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.
+     * @returns {Promise<Schedule[]>} - A list of schedules.
      * @throws {Error} - If the API returns an error.
      */
     async getSchedules({ date, dateStart, dateEnd, SchedType, BlockoutDefNum, ProvNum, EmployeeNum, Offset, } = {}) {

package/dist/api/treatplans.d.ts

@@ -9,35 +9,35 @@ export default class TreatmentPlans {
      * @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.
+     * @returns {Promise<TreatmentPlan[]>} - An array of treatplan objects.
      */
     getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, }?: GetTreatmentPlanParams): Promise<TreatmentPlan[]>;
     /**
     * Create a new TreatPlan.
-    * @param {Object} data - Data for the new appointment.
+    * @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 recall object.
+    * @returns {Promise<TreatmentPlan>} - The created treatment plan object.
     * @throws {Error} - If required fields are missing.
     */
     createTreatmentPlan(data: CreateTreatmentPlanParams): Promise<TreatmentPlan>;
     /**
      * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
-     * @param {Object} data - Data for the new appointment.
+     * @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 created recall object.
+     * @returns {Promise<TreatmentPlan>} - The saved treatment plan object.
      * @throws {Error} - If required fields are missing.
      */
     saveTreatmentPlan(data: SaveTreatmentPlanParams): Promise<TreatmentPlan>;
     /**
-    * Create a new TreatPlan.
-    * @param {Object} data - Data for the new appointment.
+    * Update a TreatPlan.
+    * @param {Object} data - Data for the treatplan.
     * @param {number} data.TreatPlanNum - Required.
-    * @param {string} [data.Heading] - The heading that shows at the top of the treatment plan.
+    * @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".
@@ -45,7 +45,7 @@ export default class TreatmentPlans {
     * @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.
+    * @returns {Promise<TreatmentPlan>} - The updated treatplan object.
     * @throws {Error} - If required fields are missing.
      */
     updateTreatmentPlan(data: UpdateTreatmentPlanParams): Promise<TreatmentPlan>;

package/dist/api/treatplans.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treatplans.d.ts","sourceRoot":"","sources":["../../src/api/treatplans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,aAAa,EACb,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EAC1B,MAAM,yBAAyB,CAAC;AAGjC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;;;;OAOG;IACU,iBAAiB,CAAC,EAC3B,MAAM,EACN,YAAY,EACZ,QAAQ,GACX,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAUxD;;;;;;;;;MASE;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQzF;;;;;;;;OAQG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQrF;;;;;;;;;;;;;;OAcG;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;CAO5F"}
+{"version":3,"file":"treatplans.d.ts","sourceRoot":"","sources":["../../src/api/treatplans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,aAAa,EACb,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEjB,UAAU,EAAE,UAAU;IAIlC;;;;;;;OAOG;IACU,iBAAiB,CAAC,EAC3B,MAAM,EACN,YAAY,EACZ,QAAQ,GACX,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAUxD;;;;;;;;;MASE;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQzF;;;;;;;;OAQG;IACU,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQrF;;;;;;;;;;;;;;OAcG;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;CAO5F"}

package/dist/api/treatplans.js

@@ -11,7 +11,7 @@ class TreatmentPlans {
      * @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.
+     * @returns {Promise<TreatmentPlan[]>} - An array of treatplan objects.
      */
     async getTreatmentPlans({ PatNum, SecDateTEdit, TPStatus, } = {}) {
         const params = {
@@ -23,12 +23,12 @@ class TreatmentPlans {
     }
     /**
     * Create a new TreatPlan.
-    * @param {Object} data - Data for the new appointment.
+    * @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 recall object.
+    * @returns {Promise<TreatmentPlan>} - The created treatment plan object.
     * @throws {Error} - If required fields are missing.
     */
     async createTreatmentPlan(data) {
@@ -39,11 +39,11 @@ class TreatmentPlans {
     }
     /**
      * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
-     * @param {Object} data - Data for the new appointment.
+     * @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 created recall object.
+     * @returns {Promise<TreatmentPlan>} - The saved treatment plan object.
      * @throws {Error} - If required fields are missing.
      */
     async saveTreatmentPlan(data) {
@@ -53,10 +53,10 @@ class TreatmentPlans {
         return this.httpClient.post("/treatplans/Saved", data);
     }
     /**
-    * Create a new TreatPlan.
-    * @param {Object} data - Data for the new appointment.
+    * Update a TreatPlan.
+    * @param {Object} data - Data for the treatplan.
     * @param {number} data.TreatPlanNum - Required.
-    * @param {string} [data.Heading] - The heading that shows at the top of the treatment plan.
+    * @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".
@@ -64,7 +64,7 @@ class TreatmentPlans {
     * @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.
+    * @returns {Promise<TreatmentPlan>} - The updated treatplan object.
     * @throws {Error} - If required fields are missing.
      */
     async updateTreatmentPlan(data) {

package/dist/openDental.d.ts

@@ -9,6 +9,9 @@ import TreatmentPlans from "./api/treatplans";
 import Schedules from "./api/schedules";
 import Providers from "./api/providers";
 import Operatories from "./api/operatories";
+import Payments from "./api/payments";
+import Definitions from "./api/definitions";
+import DiscountPlanSubs from "./api/discountPlanSubs";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -52,13 +55,25 @@ declare class OpenDental {
      */
     static Schedules(): Schedules;
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Providers API.
      */
     static Providers(): Providers;
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Operatories API.
      */
     static Operatories(): Operatories;
+    /**
+     * Create a new instance of the Payments API.
+     */
+    static Payments(): Payments;
+    /**
+     * Create a new instance of the Definitions API.
+     */
+    static Definitions(): Definitions;
+    /**
+     * Create a new instance of the DiscountPlanSubs API.
+     */
+    static DiscountPlanSubs(): DiscountPlanSubs;
 }
 export { OpenDental };
 //# sourceMappingURL=openDental.d.ts.map

package/dist/openDental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;CAM5B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AAEtD,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAMzB;;OAEG;WACW,gBAAgB;CAM/B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -16,6 +16,9 @@ const treatplans_1 = __importDefault(require("./api/treatplans"));
 const schedules_1 = __importDefault(require("./api/schedules"));
 const providers_1 = __importDefault(require("./api/providers"));
 const operatories_1 = __importDefault(require("./api/operatories"));
+const payments_1 = __importDefault(require("./api/payments"));
+const definitions_1 = __importDefault(require("./api/definitions"));
+const discountPlanSubs_1 = __importDefault(require("./api/discountPlanSubs"));
 class OpenDental {
     static httpClient;
     /**
@@ -111,7 +114,7 @@ class OpenDental {
         return new schedules_1.default(this.httpClient);
     }
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Providers API.
      */
     static Providers() {
         if (!this.httpClient) {
@@ -120,7 +123,7 @@ class OpenDental {
         return new providers_1.default(this.httpClient);
     }
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Operatories API.
      */
     static Operatories() {
         if (!this.httpClient) {
@@ -128,5 +131,32 @@ class OpenDental {
         }
         return new operatories_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the Payments API.
+     */
+    static Payments() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new payments_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Definitions API.
+     */
+    static Definitions() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new definitions_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the DiscountPlanSubs API.
+     */
+    static DiscountPlanSubs() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new discountPlanSubs_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/definitionTypes.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Represents a definition in the Open Dental system.
+ * Used in multiple definition-related endpoints.
+ * @see https://www.opendental.com/site/apidefinitions.html
+ */
+export interface Definition {
+    DefNum?: number;
+    ItemName?: string;
+    ItemValue?: string;
+    Category?: number;
+    category?: string;
+    isHidden?: 'true' | 'false';
+}
+/**
+ * Parameters for GET Definitions.
+ * @see https://www.opendental.com/site/apidefinitions.html
+ */
+export interface GetDefinitionsParams {
+    Category?: number;
+    includeHidden?: 'true' | 'false';
+    Offset?: number;
+}
+//# sourceMappingURL=definitionTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"definitionTypes.d.ts","sourceRoot":"","sources":["../../src/types/definitionTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/definitionTypes.js

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

package/dist/types/discountPlanSubTypes.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Represents a subscription to a discount plan in the Open Dental system.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface DiscountPlanSub {
+    DiscountSubNum?: number;
+    DiscountPlanNum?: number;
+    PatNum?: number;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubNote?: string;
+}
+/**
+ * Parameters for GET discount plan subs.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface GetDiscountPlanSubsParams {
+    PatNum?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a discount plan sub.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface CreateDiscountPlanSubParams {
+    PatNum: number;
+    DiscountPlanNum: number;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubNote?: string;
+}
+/**
+ * Parameters for updating a discount plan sub.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface UpdateDiscountPlanSubParams {
+    DiscountSubNum: number;
+    PatNum: string;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubNote?: string;
+}
+//# sourceMappingURL=discountPlanSubTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discountPlanSubTypes.d.ts","sourceRoot":"","sources":["../../src/types/discountPlanSubTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/discountPlanSubTypes.js

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

package/dist/types/paymentTypes.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface Payment {
+    PayNum?: number;
+    PayType?: number;
+    payType?: string;
+    PayDate?: string;
+    PayAmt?: string;
+    CheckNum?: string;
+    BankBranch?: string;
+    PayNote?: string;
+    PatNum?: number;
+    ClinicNum?: string;
+    DateEntry?: string;
+    DepositNum?: number;
+    Receipt?: string;
+    IsRecurringCC?: 'true' | 'false';
+    PaymentSource?: string;
+    ProcessStatus?: string;
+    RecurringChargeDate?: string;
+    IsCcCompleted?: 'true' | 'false';
+    serverDateTime?: string;
+}
+/**
+ * Parameters for GET Payments.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface GetPaymentsParams {
+    PayType?: number;
+    PatNum?: number;
+    DateEntry?: string;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a payment.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface CreatePaymentParams {
+    PatNum: number;
+    PayAmt: string;
+    PayType?: number;
+    PayDate?: string;
+    CheckNum?: string;
+    PayNote?: string;
+    BankBranch?: string;
+    ClinicNum?: string;
+    isPatientPreferred?: 'true' | 'false';
+    isPrepayment?: 'true' | 'false';
+    procNums?: number[];
+    payPlanNum?: number;
+}
+/**
+ * Parameters for updating a payment.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface UpdatePaymentParams {
+    PayNum: number;
+    PayType?: number;
+    CheckNum?: string;
+    BankBranch?: string;
+    PayNote?: string;
+    ProcessStatus?: 'OnlineProcessed' | 'OnlinePending';
+}
+//# sourceMappingURL=paymentTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paymentTypes.d.ts","sourceRoot":"","sources":["../../src/types/paymentTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAG,iBAAiB,GAAG,eAAe,CAAC;CACtD"}

package/dist/types/paymentTypes.js

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

package/dist/types/scheduleTypes.d.ts

@@ -8,7 +8,7 @@ export interface Schedule {
     StartTime?: string;
     StopTime?: string;
     SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP";
-    ProvNum?: number;
+    ProvNum?: string;
     BlockoutType?: string;
     blockoutType?: string;
     Note?: string;
@@ -16,7 +16,7 @@ export interface Schedule {
     EmployeeNum?: string;
 }
 /**
- * Parameters for fetching multiple patients.
+ * Parameters for fetching schedule records;
  * @see https://www.opendental.com/site/apischedules.html
  */
 export interface GetSchedulesParams {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "0.1.7",
+    "version": "1.0.1",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -15,8 +15,8 @@
         "url": "git+https://github.com/getrinsed/open-dental.git"
     },
     "dependencies": {
-        "axios": "^1.7.7",
-        "moment-timezone": "^0.5.46"
+        "axios": "^1.7.9",
+        "moment-timezone": "^0.5.47"
     },
     "devDependencies": {
         "@types/jest": "^29.5.14",

package/src/api/definitions.ts

@@ -0,0 +1,35 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Definition,
+  GetDefinitionsParams,
+} from "../types/definitionTypes";
+
+export default class Definitions {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+/**
+ * Fetch multiple definitions with optional filtering and pagination.
+ * @param {Object} params - The parameters for filtering and pagination.
+ * @param {number} [params.Category] - Filter by category.
+ * @param {"true" | "false"} [data.includeHidden="false"] - Optional parameter that defaults to false.
+ * @param {number} [params.Offset] - Pagination offset for results.
+ * @returns {Promise<Definition[]>} - A list of definitions.
+ */
+public async getDefinitions({
+    Category,
+    includeHidden,
+    Offset,
+  }: GetDefinitionsParams = {}): Promise<Definition[]> {
+    const params = {
+      Category,
+      includeHidden,
+      Offset,
+    };
+  
+    return this.httpClient.get<Definition[]>("/definitions", params);
+  }
+}