@rinse-dental/open-dental 1.0.0 → 1.0.2

package/deploy_notes.txt

@@ -10,6 +10,8 @@ git tag //confirm tag
 git push origin vX.Y.Z
 gh release create vX.Y.Z --title "Release vX.Y.Z" --notes ""
 
+gh release create v1.0.0 --title "Release v1.0.0" --notes "first major release"
+
 if the tag doesn't exist locally: 
 git tag vX.Y.Z
 git push origin vX.Y.Z

package/dist/api/appointments.js

@@ -269,7 +269,7 @@ class Appointments {
         if (!data.AptNum || (!data.confirmVal && !data.defNum)) {
             throw new Error("AptNum and either confirmVal or defNum are required.");
         }
-        return this.httpClient.put(`/appointments/${data.AptNum}/confirm`, data);
+        return this.httpClient.put(`/appointments/${data.AptNum}/Confirm`, data);
     }
 }
 exports.default = Appointments;

package/dist/api/definitions.d.ts

@@ -4,12 +4,12 @@ export default class Definitions {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
-     * Fetch multiple definitinos with optional filtering and pagination.
+     * 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 appointments.
+     * @returns {Promise<Definition[]>} - A list of definitions.
      */
     getDefinitions({ Category, includeHidden, Offset, }?: GetDefinitionsParams): Promise<Definition[]>;
 }

package/dist/api/definitions.js

@@ -6,12 +6,12 @@ class Definitions {
         this.httpClient = httpClient;
     }
     /**
-     * Fetch multiple definitinos with optional filtering and pagination.
+     * 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 appointments.
+     * @returns {Promise<Definition[]>} - A list of definitions.
      */
     async getDefinitions({ Category, includeHidden, Offset, } = {}) {
         const params = {

package/dist/api/discountPlanSubs.d.ts

@@ -13,31 +13,31 @@ export default class DiscountPlanSubs {
     getDiscountPlanSubs({ PatNum, Offset, }?: GetDiscountPlanSubsParams): Promise<DiscountPlanSub[]>;
     /**
      * Create a new discount plan sub.
-     * @param {Object} data - The details of the procedure log to create.
+     * @param {Object} data - The details of discount plan sub to create.
      * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
      * @param {number} data.PatNum - Required: Patient number.
-     * @param {number} data.DateEffective - Optional: Patient number.
-     * @param {number} data.DateTerm - Optional: Patient number.
-     * @param {number} data.SubNote - Optional: Patient number.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
      * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
     createDiscountPlanSub(data: CreateDiscountPlanSubParams): Promise<DiscountPlanSub>;
     /**
-     * Create a new procedure log entry.
-     * @param {Object} data - The details of the procedure log to create.
+     * Update a discount plan sub.
+     * @param {Object} data - The details of the discount sub to update.
      * @param {number} data.DiscountSubNum - Required: PK
      * @param {number} data.PatNum - Required: Patient number.
-     * @param {number} data.DateEffective - Optional: Patient number.
-     * @param {number} data.DateTerm - Optional: Patient number.
-     * @param {number} data.SubNote - Optional: Patient number.
-     * @returns {Promise<DiscountPlanSub>} - The created procedure log.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
     updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub>;
     /**
      * Delete a discount plan sub entry.
-     * @param {number} DiscountSubNum - Required: The unique identifier of the discount plan sub to delete.
+     * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
      * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
      * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
      */

package/dist/api/discountPlanSubs.js

@@ -21,12 +21,12 @@ class DiscountPlanSubs {
     }
     /**
      * Create a new discount plan sub.
-     * @param {Object} data - The details of the procedure log to create.
+     * @param {Object} data - The details of discount plan sub to create.
      * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
      * @param {number} data.PatNum - Required: Patient number.
-     * @param {number} data.DateEffective - Optional: Patient number.
-     * @param {number} data.DateTerm - Optional: Patient number.
-     * @param {number} data.SubNote - Optional: Patient number.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
      * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
@@ -37,14 +37,14 @@ class DiscountPlanSubs {
         return this.httpClient.post("/discountplansubs", data);
     }
     /**
-     * Create a new procedure log entry.
-     * @param {Object} data - The details of the procedure log to create.
+     * Update a discount plan sub.
+     * @param {Object} data - The details of the discount sub to update.
      * @param {number} data.DiscountSubNum - Required: PK
      * @param {number} data.PatNum - Required: Patient number.
-     * @param {number} data.DateEffective - Optional: Patient number.
-     * @param {number} data.DateTerm - Optional: Patient number.
-     * @param {number} data.SubNote - Optional: Patient number.
-     * @returns {Promise<DiscountPlanSub>} - The created procedure log.
+     * @param {number} [data.DateEffective] - Optional: Patient number.
+     * @param {number} [data.DateTerm] - Optional: Patient number.
+     * @param {number} [data.SubNote] - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
      * @throws {Error} - If required fields are missing or the API returns an error.
      */
     async updateDiscountPlanSub(data) {
@@ -55,7 +55,7 @@ class DiscountPlanSubs {
     }
     /**
      * Delete a discount plan sub entry.
-     * @param {number} DiscountSubNum - Required: The unique identifier of the discount plan sub to delete.
+     * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
      * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
      * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
      */

package/dist/api/operatories.d.ts

@@ -5,9 +5,9 @@ export default class Operatories {
     constructor(httpClient: HttpClient);
     /**
      * Fetch a single operatory by its ID.
-     * @param {number} OperatoryNum - The ID of the patfield.
-     * @returns {Promise<Operatory>} - The patient data.
-     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     * @param {number} OperatoryNum - The ID of the operatory.
+     * @returns {Promise<Operatory>} - The operatory data.
+     * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
      */
     getOperatory(OperatoryNum: number): Promise<Operatory>;
     /**
@@ -15,7 +15,7 @@ export default class Operatories {
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.ClinicNum] - Filter by clinicnum
      * @param {string} [params.Offset] - Filter by clinicnum
-    * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+    * @returns {Promise<Operatory[]>} - A list of operatories.
      * @throws {Error} - If the API returns an error.
      */
     getOperatories({ ClinicNum, Offset, }?: GetOperatoriesParams): Promise<Operatory[]>;

package/dist/api/operatories.js

@@ -7,9 +7,9 @@ class Operatories {
     }
     /**
      * Fetch a single operatory by its ID.
-     * @param {number} OperatoryNum - The ID of the patfield.
-     * @returns {Promise<Operatory>} - The patient data.
-     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     * @param {number} OperatoryNum - The ID of the operatory.
+     * @returns {Promise<Operatory>} - The operatory data.
+     * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
      */
     async getOperatory(OperatoryNum) {
         if (!OperatoryNum || typeof OperatoryNum !== "number") {
@@ -22,7 +22,7 @@ class Operatories {
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.ClinicNum] - Filter by clinicnum
      * @param {string} [params.Offset] - Filter by clinicnum
-    * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+    * @returns {Promise<Operatory[]>} - A list of operatories.
      * @throws {Error} - If the API returns an error.
      */
     async getOperatories({ ClinicNum, Offset, } = {}) {

package/dist/api/patFields.d.ts

@@ -6,17 +6,17 @@ export default class PatFields {
     /**
      * Fetch a single patfield by its ID.
      * @param {number} PatFieldNum - The ID of the patfield.
-     * @returns {Promise<PatField>} - The patient data.
+     * @returns {Promise<PatField>} - The patfield data.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
     getPatField(PatFieldNum: number): Promise<PatField>;
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * Fetch multiple patfields 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.
+     * @returns {Promise<PatField[]>} - A list of patfields.
      * @throws {Error} - If the API returns an error.
      */
     getPatFields({ PatNum, FieldName, SecDateTEdit, }?: GetPatFieldsParams): Promise<PatField[]>;

package/dist/api/patFields.js

@@ -8,7 +8,7 @@ class PatFields {
     /**
      * Fetch a single patfield by its ID.
      * @param {number} PatFieldNum - The ID of the patfield.
-     * @returns {Promise<PatField>} - The patient data.
+     * @returns {Promise<PatField>} - The patfield data.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
     async getPatField(PatFieldNum) {
@@ -18,12 +18,12 @@ class PatFields {
         return await this.httpClient.get(`/patfields/${PatFieldNum}`);
     }
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * Fetch multiple patfields 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.
+     * @returns {Promise<PatField[]>} - A list of patfields.
      * @throws {Error} - If the API returns an error.
      */
     async getPatFields({ PatNum, FieldName, SecDateTEdit, } = {}) {

package/dist/api/payments.d.ts

@@ -15,10 +15,10 @@ export default class Payments {
     getPayments({ PayType, PatNum, DateEntry, Offset, }?: GetPaymentsParams): Promise<Payment[]>;
     /**
      * Create a payment.
-     * @param {Object} data - Data for the new appointment.
+     * @param {Object} data - Data for the new payment.
      * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
      * @param {number} data.PatNum - Required: FK to Patient
-     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
      * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
      * @param {string} [data.CheckNum] - Optional.
      * @param {string} [data.PayNote] - Optional.
@@ -34,9 +34,9 @@ export default class Payments {
     createPayment(data: CreatePaymentParams): Promise<Payment>;
     /**
      * Update a payment.
-     * @param {Object} data - Data for the new appointment.
+     * @param {Object} data - Data for the new payment.
      * @param {string} data.PayNum - Required: PK of Payment to update.
-     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
      * @param {string} [data.CheckNum] - Optional.
      * @param {string} [data.PayNote] - Optional.
      * @param {string} [data.BankBranch] - Optional.

package/dist/api/payments.js

@@ -25,10 +25,10 @@ class Payments {
     }
     /**
      * Create a payment.
-     * @param {Object} data - Data for the new appointment.
+     * @param {Object} data - Data for the new payment.
      * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
      * @param {number} data.PatNum - Required: FK to Patient
-     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
      * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
      * @param {string} [data.CheckNum] - Optional.
      * @param {string} [data.PayNote] - Optional.
@@ -49,9 +49,9 @@ class Payments {
     }
     /**
      * Update a payment.
-     * @param {Object} data - Data for the new appointment.
+     * @param {Object} data - Data for the new payment.
      * @param {string} data.PayNum - Required: PK of Payment to update.
-     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
      * @param {string} [data.CheckNum] - Optional.
      * @param {string} [data.PayNote] - Optional.
      * @param {string} [data.BankBranch] - Optional.

package/dist/api/providers.d.ts

@@ -16,56 +16,56 @@ export default 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.
      */
     getProviders({ ClinicNum, DateTStamp, Offset, }?: GetProviderParams): Promise<Provider[]>;
     /**
      * 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.
      */
     createProvider({ Abbr, LName, FName, MI, Suffix, FeeSched, Specialty, SSN, IsSecondary, IsHidden, UsingTIN, SigOnFile, IsNotPerson, IsHiddenReport, Birthdate, SchedNote, PreferredName, }: createProviderParams): Promise<Provider>;
     /**
      * 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.
      */
     updateProvider({ ProvNum, Abbr, LName, FName, MI, Suffix, Specialty, SSN, NationalProvID, StateLicense, UsingTIN, SigOnFile, PreferredName, }: updateProviderParams): Promise<Provider>;

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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/appointments.ts

@@ -331,6 +331,6 @@ public async getAppointments({
       throw new Error("AptNum and either confirmVal or defNum are required.");
     }
 
-    return this.httpClient.put<void>(`/appointments/${data.AptNum}/confirm`, data);
+    return this.httpClient.put<void>(`/appointments/${data.AptNum}/Confirm`, data);
   }
 }

package/src/api/definitions.ts

@@ -12,12 +12,12 @@ export default class Definitions {
   }
 
 /**
- * Fetch multiple definitinos with optional filtering and pagination.
+ * 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 appointments.
+ * @returns {Promise<Definition[]>} - A list of definitions.
  */
 public async getDefinitions({
     Category,

package/src/api/discountPlanSubs.ts

@@ -34,12 +34,12 @@ export default class DiscountPlanSubs {
 
   /**
    * Create a new discount plan sub.
-   * @param {Object} data - The details of the procedure log to create.
+   * @param {Object} data - The details of discount plan sub to create.
    * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
    * @param {number} data.PatNum - Required: Patient number.
-   * @param {number} data.DateEffective - Optional: Patient number.
-   * @param {number} data.DateTerm - Optional: Patient number.
-   * @param {number} data.SubNote - Optional: Patient number.
+   * @param {number} [data.DateEffective] - Optional: Patient number.
+   * @param {number} [data.DateTerm] - Optional: Patient number.
+   * @param {number} [data.SubNote] - Optional: Patient number.
    * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
@@ -52,14 +52,14 @@ export default class DiscountPlanSubs {
   }
 
   /**
-   * Create a new procedure log entry.
-   * @param {Object} data - The details of the procedure log to create.
+   * Update a discount plan sub.
+   * @param {Object} data - The details of the discount sub to update.
    * @param {number} data.DiscountSubNum - Required: PK
    * @param {number} data.PatNum - Required: Patient number.
-   * @param {number} data.DateEffective - Optional: Patient number.
-   * @param {number} data.DateTerm - Optional: Patient number.
-   * @param {number} data.SubNote - Optional: Patient number.
-   * @returns {Promise<DiscountPlanSub>} - The created procedure log.
+   * @param {number} [data.DateEffective] - Optional: Patient number.
+   * @param {number} [data.DateTerm] - Optional: Patient number.
+   * @param {number} [data.SubNote] - Optional: Patient number.
+   * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
    * @throws {Error} - If required fields are missing or the API returns an error.
    */
   public async updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub> {
@@ -72,7 +72,7 @@ export default class DiscountPlanSubs {
 
   /**
    * Delete a discount plan sub entry.
-   * @param {number} DiscountSubNum - Required: The unique identifier of the discount plan sub to delete.
+   * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
    * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
    * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
    */

package/src/api/operatories.ts

@@ -13,9 +13,9 @@ export default class Operatories {
 
   /**
    * Fetch a single operatory by its ID.
-   * @param {number} OperatoryNum - The ID of the patfield.
-   * @returns {Promise<Operatory>} - The patient data.
-   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+   * @param {number} OperatoryNum - The ID of the operatory.
+   * @returns {Promise<Operatory>} - The operatory data.
+   * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
    */
   public async getOperatory(OperatoryNum: number): Promise<Operatory> {
     if (!OperatoryNum || typeof OperatoryNum !== "number") {
@@ -30,7 +30,7 @@ export default class Operatories {
    * @param {Object} params - Filtering and pagination parameters.
    * @param {string} [params.ClinicNum] - Filter by clinicnum
    * @param {string} [params.Offset] - Filter by clinicnum
-  * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+  * @returns {Promise<Operatory[]>} - A list of operatories.
    * @throws {Error} - If the API returns an error.
    */
     public async getOperatories({

package/src/api/patFields.ts

@@ -15,7 +15,7 @@ export default class PatFields {
   /**
    * Fetch a single patfield by its ID.
    * @param {number} PatFieldNum - The ID of the patfield.
-   * @returns {Promise<PatField>} - The patient data.
+   * @returns {Promise<PatField>} - The patfield data.
    * @throws {Error} - If `PatNum` is not valid or the API returns an error.
    */
   public async getPatField(PatFieldNum: number): Promise<PatField> {
@@ -27,12 +27,12 @@ export default class PatFields {
   }
 
   /**
-   * Fetch multiple patients with optional filtering and pagination.
+   * Fetch multiple patfields 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.
+   * @returns {Promise<PatField[]>} - A list of patfields.
    * @throws {Error} - If the API returns an error.
    */
     public async getPatFields({

package/src/api/payments.ts

@@ -40,10 +40,10 @@ public async getPayments({
 
   /**
    * Create a payment.
-   * @param {Object} data - Data for the new appointment.
+   * @param {Object} data - Data for the new payment.
    * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
    * @param {number} data.PatNum - Required: FK to Patient
-   * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+   * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
    * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
    * @param {string} [data.CheckNum] - Optional.
    * @param {string} [data.PayNote] - Optional.
@@ -66,9 +66,9 @@ public async getPayments({
 
   /**
    * Update a payment.
-   * @param {Object} data - Data for the new appointment.
+   * @param {Object} data - Data for the new payment.
    * @param {string} data.PayNum - Required: PK of Payment to update.
-   * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+   * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
    * @param {string} [data.CheckNum] - Optional.
    * @param {string} [data.PayNote] - Optional.
    * @param {string} [data.BankBranch] - Optional.

package/src/api/providers.ts

@@ -33,7 +33,7 @@ export default 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.
    */
     public async getProviders({
@@ -51,25 +51,25 @@ export default 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.
      */
     public async createProvider({
@@ -118,25 +118,25 @@ export default 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.
      */
     public async updateProvider({

package/src/api/schedules.ts

@@ -13,8 +13,8 @@ export default 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.
    */
   public async getSchedule(ScheduleNum: number): Promise<Schedule> {
@@ -26,7 +26,7 @@ export default class Schedules {
   }
 
   /**
-   * 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.
@@ -36,7 +36,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.
    */
   public async getSchedules({

package/src/api/treatplans.ts

@@ -6,7 +6,6 @@ import {
     UpdateTreatmentPlanParams,
     SaveTreatmentPlanParams,
 } from "../types/treatPlanTypes";
-import { updateProcedureLogParams } from "../types/procedurelogTypes";
 
 export default class TreatmentPlans {
   private httpClient: HttpClient;
@@ -21,7 +20,7 @@ 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.
      */
     public async getTreatmentPlans({
         PatNum,
@@ -39,12 +38,12 @@ export default 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.
      */
     public async createTreatmentPlan(data: CreateTreatmentPlanParams): Promise<TreatmentPlan> {
@@ -57,11 +56,11 @@ export default 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.
      */
     public async saveTreatmentPlan(data: SaveTreatmentPlanParams): Promise<TreatmentPlan> {
@@ -73,10 +72,10 @@ export default class TreatmentPlans {
     }
 
     /**
-    * 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".
@@ -84,7 +83,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.
      */
     public async updateTreatmentPlan(data: UpdateTreatmentPlanParams): Promise<TreatmentPlan> {