@rinse-dental/open-dental 3.4.2 → 4.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +388 -16
- package/dist/api/accountModules.d.ts +23 -3
- package/dist/api/accountModules.d.ts.map +1 -1
- package/dist/api/accountModules.js +17 -6
- package/dist/api/adjustments.d.ts +5 -2
- package/dist/api/adjustments.d.ts.map +1 -1
- package/dist/api/adjustments.js +11 -5
- package/dist/api/allergies.d.ts +5 -2
- package/dist/api/allergies.d.ts.map +1 -1
- package/dist/api/allergies.js +11 -5
- package/dist/api/allergydefs.d.ts +27 -0
- package/dist/api/allergydefs.d.ts.map +1 -0
- package/dist/api/allergydefs.js +40 -0
- package/dist/api/appointmentTypes.d.ts +12 -2
- package/dist/api/appointmentTypes.d.ts.map +1 -1
- package/dist/api/appointmentTypes.js +12 -2
- package/dist/api/appointments.d.ts +5 -2
- package/dist/api/appointments.d.ts.map +1 -1
- package/dist/api/appointments.js +19 -13
- package/dist/api/apptFieldDefs.d.ts +54 -0
- package/dist/api/apptFieldDefs.d.ts.map +1 -0
- package/dist/api/apptFieldDefs.js +79 -0
- package/dist/api/apptFields.d.ts +60 -0
- package/dist/api/apptFields.d.ts.map +1 -0
- package/dist/api/apptFields.js +102 -0
- package/dist/api/asapComms.d.ts +44 -0
- package/dist/api/asapComms.d.ts.map +1 -0
- package/dist/api/asapComms.js +64 -0
- package/dist/api/autoNoteControls.d.ts +48 -0
- package/dist/api/autoNoteControls.d.ts.map +1 -0
- package/dist/api/autoNoteControls.js +74 -0
- package/dist/api/autoNotes.d.ts +42 -0
- package/dist/api/autoNotes.d.ts.map +1 -0
- package/dist/api/autoNotes.js +70 -0
- package/dist/api/benefits.d.ts +14 -3
- package/dist/api/benefits.d.ts.map +1 -1
- package/dist/api/benefits.js +24 -5
- package/dist/api/carriers.d.ts +68 -0
- package/dist/api/carriers.d.ts.map +1 -0
- package/dist/api/carriers.js +107 -0
- package/dist/api/chartModules.d.ts +1 -1
- package/dist/api/chartModules.d.ts.map +1 -1
- package/dist/api/chartModules.js +4 -4
- package/dist/api/claimPayments.d.ts +93 -0
- package/dist/api/claimPayments.d.ts.map +1 -0
- package/dist/api/claimPayments.js +163 -0
- package/dist/api/claimProcs.d.ts +42 -2
- package/dist/api/claimProcs.d.ts.map +1 -1
- package/dist/api/claimProcs.js +65 -2
- package/dist/api/claimTrackings.d.ts +44 -0
- package/dist/api/claimTrackings.d.ts.map +1 -0
- package/dist/api/claimTrackings.js +70 -0
- package/dist/api/claims.d.ts +33 -0
- package/dist/api/claims.d.ts.map +1 -1
- package/dist/api/claims.js +60 -6
- package/dist/api/clinics.d.ts +47 -0
- package/dist/api/clinics.d.ts.map +1 -0
- package/dist/api/clinics.js +70 -0
- package/dist/api/clockEvents.d.ts +33 -0
- package/dist/api/clockEvents.d.ts.map +1 -0
- package/dist/api/clockEvents.js +42 -0
- package/dist/api/codeGroups.d.ts +64 -0
- package/dist/api/codeGroups.d.ts.map +1 -0
- package/dist/api/codeGroups.js +84 -0
- package/dist/api/commlogs.d.ts +14 -2
- package/dist/api/commlogs.d.ts.map +1 -1
- package/dist/api/commlogs.js +11 -4
- package/dist/api/computers.d.ts +25 -0
- package/dist/api/computers.d.ts.map +1 -0
- package/dist/api/computers.js +29 -0
- package/dist/api/covCats.d.ts +58 -0
- package/dist/api/covCats.d.ts.map +1 -0
- package/dist/api/covCats.js +78 -0
- package/dist/api/covSpans.d.ts +60 -0
- package/dist/api/covSpans.d.ts.map +1 -0
- package/dist/api/covSpans.js +91 -0
- package/dist/api/definitions.d.ts +19 -3
- package/dist/api/definitions.d.ts.map +1 -1
- package/dist/api/definitions.js +26 -2
- package/dist/api/discountPlanSubs.js +3 -3
- package/dist/api/discountPlans.d.ts +4 -1
- package/dist/api/discountPlans.d.ts.map +1 -1
- package/dist/api/discountPlans.js +9 -3
- package/dist/api/diseaseDefs.d.ts +35 -0
- package/dist/api/diseaseDefs.d.ts.map +1 -0
- package/dist/api/diseaseDefs.js +49 -0
- package/dist/api/diseases.d.ts +4 -1
- package/dist/api/diseases.d.ts.map +1 -1
- package/dist/api/diseases.js +6 -3
- package/dist/api/documents.d.ts +137 -0
- package/dist/api/documents.d.ts.map +1 -0
- package/dist/api/documents.js +235 -0
- package/dist/api/eTrans.d.ts +20 -0
- package/dist/api/eTrans.d.ts.map +1 -0
- package/dist/api/eTrans.js +36 -0
- package/dist/api/eTransMessageTexts.d.ts +15 -0
- package/dist/api/eTransMessageTexts.d.ts.map +1 -0
- package/dist/api/eTransMessageTexts.js +22 -0
- package/dist/api/eTranss.d.ts +22 -0
- package/dist/api/eTranss.d.ts.map +1 -0
- package/dist/api/eTranss.js +29 -0
- package/dist/api/ehrPatients.d.ts +29 -0
- package/dist/api/ehrPatients.d.ts.map +1 -0
- package/dist/api/ehrPatients.js +42 -0
- package/dist/api/employees.d.ts +66 -0
- package/dist/api/employees.d.ts.map +1 -0
- package/dist/api/employees.js +86 -0
- package/dist/api/employers.d.ts +53 -0
- package/dist/api/employers.d.ts.map +1 -0
- package/dist/api/employers.js +81 -0
- package/dist/api/eobAttaches.d.ts +56 -0
- package/dist/api/eobAttaches.d.ts.map +1 -0
- package/dist/api/eobAttaches.js +96 -0
- package/dist/api/events.d.ts +26 -0
- package/dist/api/events.d.ts.map +1 -0
- package/dist/api/events.js +26 -0
- package/dist/api/familyModules.d.ts +12 -2
- package/dist/api/familyModules.d.ts.map +1 -1
- package/dist/api/familyModules.js +9 -4
- package/dist/api/feeScheds.d.ts +8 -2
- package/dist/api/feeScheds.d.ts.map +1 -1
- package/dist/api/feeScheds.js +14 -2
- package/dist/api/fees.d.ts +41 -3
- package/dist/api/fees.d.ts.map +1 -1
- package/dist/api/fees.js +58 -2
- package/dist/api/histAppointments.d.ts +29 -0
- package/dist/api/histAppointments.d.ts.map +1 -0
- package/dist/api/histAppointments.js +33 -0
- package/dist/api/index.d.ts +89 -13
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +180 -28
- package/dist/api/insPlans.d.ts +11 -4
- package/dist/api/insPlans.d.ts.map +1 -1
- package/dist/api/insPlans.js +17 -7
- package/dist/api/insSubs.d.ts +13 -5
- package/dist/api/insSubs.d.ts.map +1 -1
- package/dist/api/insSubs.js +19 -8
- package/dist/api/insVerifies.d.ts +9 -6
- package/dist/api/insVerifies.d.ts.map +1 -1
- package/dist/api/insVerifies.js +15 -9
- package/dist/api/labCases.d.ts +22 -7
- package/dist/api/labCases.d.ts.map +1 -1
- package/dist/api/labCases.js +34 -11
- package/dist/api/labTurnarounds.d.ts +52 -0
- package/dist/api/labTurnarounds.d.ts.map +1 -0
- package/dist/api/labTurnarounds.js +78 -0
- package/dist/api/laboratories.d.ts +71 -0
- package/dist/api/laboratories.d.ts.map +1 -0
- package/dist/api/laboratories.js +91 -0
- package/dist/api/medicationPats.d.ts +5 -2
- package/dist/api/medicationPats.d.ts.map +1 -1
- package/dist/api/medicationPats.js +11 -5
- package/dist/api/medications.d.ts +37 -0
- package/dist/api/medications.d.ts.map +1 -0
- package/dist/api/medications.js +46 -0
- package/dist/api/operatories.d.ts +4 -3
- package/dist/api/operatories.d.ts.map +1 -1
- package/dist/api/operatories.js +8 -4
- package/dist/api/patFieldDefs.d.ts +57 -0
- package/dist/api/patFieldDefs.d.ts.map +1 -0
- package/dist/api/patFieldDefs.js +83 -0
- package/dist/api/patFields.d.ts +11 -6
- package/dist/api/patFields.d.ts.map +1 -1
- package/dist/api/patFields.js +23 -14
- package/dist/api/patPlans.d.ts +13 -6
- package/dist/api/patPlans.d.ts.map +1 -1
- package/dist/api/patPlans.js +18 -8
- package/dist/api/patientNotes.d.ts +48 -0
- package/dist/api/patientNotes.d.ts.map +1 -0
- package/dist/api/patientNotes.js +70 -0
- package/dist/api/patientRaces.d.ts +21 -0
- package/dist/api/patientRaces.d.ts.map +1 -0
- package/dist/api/patientRaces.js +28 -0
- package/dist/api/patients.d.ts +6 -3
- package/dist/api/patients.d.ts.map +1 -1
- package/dist/api/patients.js +15 -6
- package/dist/api/payPlanCharges.d.ts +4 -0
- package/dist/api/payPlanCharges.d.ts.map +1 -1
- package/dist/api/payPlanCharges.js +4 -0
- package/dist/api/payPlans.d.ts +10 -1
- package/dist/api/payPlans.d.ts.map +1 -1
- package/dist/api/payPlans.js +17 -18
- package/dist/api/paySplits.d.ts +12 -7
- package/dist/api/paySplits.d.ts.map +1 -1
- package/dist/api/paySplits.js +14 -6
- package/dist/api/payments.d.ts +18 -3
- package/dist/api/payments.d.ts.map +1 -1
- package/dist/api/payments.js +30 -4
- package/dist/api/perioExams.d.ts +67 -0
- package/dist/api/perioExams.d.ts.map +1 -0
- package/dist/api/perioExams.js +104 -0
- package/dist/api/perioMeasures.d.ts +74 -0
- package/dist/api/perioMeasures.d.ts.map +1 -0
- package/dist/api/perioMeasures.js +118 -0
- package/dist/api/pharmacies.d.ts +29 -0
- package/dist/api/pharmacies.d.ts.map +1 -0
- package/dist/api/pharmacies.js +38 -0
- package/dist/api/popups.d.ts +42 -0
- package/dist/api/popups.d.ts.map +1 -0
- package/dist/api/popups.js +71 -0
- package/dist/api/preferences.d.ts +31 -0
- package/dist/api/preferences.d.ts.map +1 -0
- package/dist/api/preferences.js +46 -0
- package/dist/api/procNotes.d.ts +5 -2
- package/dist/api/procNotes.d.ts.map +1 -1
- package/dist/api/procNotes.js +9 -3
- package/dist/api/procTPs.d.ts +6 -3
- package/dist/api/procTPs.d.ts.map +1 -1
- package/dist/api/procTPs.js +10 -4
- package/dist/api/procedureCodes.d.ts +9 -7
- package/dist/api/procedureCodes.d.ts.map +1 -1
- package/dist/api/procedureCodes.js +13 -8
- package/dist/api/procedureLog.d.ts +5 -2
- package/dist/api/procedureLog.d.ts.map +1 -1
- package/dist/api/procedureLog.js +15 -6
- package/dist/api/providers.d.ts +4 -1
- package/dist/api/providers.d.ts.map +1 -1
- package/dist/api/providers.js +10 -4
- package/dist/api/queries.d.ts +24 -1
- package/dist/api/queries.d.ts.map +1 -1
- package/dist/api/queries.js +35 -0
- package/dist/api/quickPasteCats.d.ts +24 -0
- package/dist/api/quickPasteCats.d.ts.map +1 -0
- package/dist/api/quickPasteCats.js +33 -0
- package/dist/api/quickPasteNotes.d.ts +27 -0
- package/dist/api/quickPasteNotes.d.ts.map +1 -0
- package/dist/api/quickPasteNotes.js +36 -0
- package/dist/api/recallTypes.d.ts +31 -0
- package/dist/api/recallTypes.d.ts.map +1 -0
- package/dist/api/recallTypes.js +40 -0
- package/dist/api/recalls.d.ts +20 -4
- package/dist/api/recalls.d.ts.map +1 -1
- package/dist/api/recalls.js +26 -14
- package/dist/api/refAttaches.d.ts +6 -3
- package/dist/api/refAttaches.d.ts.map +1 -1
- package/dist/api/refAttaches.js +11 -5
- package/dist/api/referrals.d.ts +4 -1
- package/dist/api/referrals.d.ts.map +1 -1
- package/dist/api/referrals.js +10 -4
- package/dist/api/reports.d.ts +34 -0
- package/dist/api/reports.d.ts.map +1 -0
- package/dist/api/reports.js +40 -0
- package/dist/api/rxPats.d.ts +27 -0
- package/dist/api/rxPats.d.ts.map +1 -0
- package/dist/api/rxPats.js +41 -0
- package/dist/api/scheduleOps.d.ts +20 -0
- package/dist/api/scheduleOps.d.ts.map +1 -0
- package/dist/api/scheduleOps.js +30 -0
- package/dist/api/schedules.d.ts +23 -2
- package/dist/api/schedules.d.ts.map +1 -1
- package/dist/api/schedules.js +31 -2
- package/dist/api/security.d.ts +25 -0
- package/dist/api/security.d.ts.map +1 -0
- package/dist/api/security.js +29 -0
- package/dist/api/securityLogs.d.ts +5 -2
- package/dist/api/securityLogs.d.ts.map +1 -1
- package/dist/api/securityLogs.js +8 -2
- package/dist/api/sheetDefs.d.ts +27 -0
- package/dist/api/sheetDefs.d.ts.map +1 -0
- package/dist/api/sheetDefs.js +36 -0
- package/dist/api/sheetFields.d.ts +38 -0
- package/dist/api/sheetFields.d.ts.map +1 -0
- package/dist/api/sheetFields.js +53 -0
- package/dist/api/sheets.d.ts +47 -0
- package/dist/api/sheets.d.ts.map +1 -0
- package/dist/api/sheets.js +64 -0
- package/dist/api/signalODs.d.ts +23 -0
- package/dist/api/signalODs.d.ts.map +1 -0
- package/dist/api/signalODs.js +30 -0
- package/dist/api/statements.d.ts +48 -0
- package/dist/api/statements.d.ts.map +1 -0
- package/dist/api/statements.js +72 -0
- package/dist/api/subscriptions.d.ts +67 -0
- package/dist/api/subscriptions.d.ts.map +1 -0
- package/dist/api/subscriptions.js +93 -0
- package/dist/api/substitutionLinks.d.ts +51 -0
- package/dist/api/substitutionLinks.d.ts.map +1 -0
- package/dist/api/substitutionLinks.js +74 -0
- package/dist/api/taskLists.d.ts +20 -0
- package/dist/api/taskLists.d.ts.map +1 -0
- package/dist/api/taskLists.js +24 -0
- package/dist/api/taskNotes.d.ts +50 -0
- package/dist/api/taskNotes.d.ts.map +1 -0
- package/dist/api/taskNotes.js +81 -0
- package/dist/api/tasks.d.ts +69 -0
- package/dist/api/tasks.d.ts.map +1 -0
- package/dist/api/tasks.js +89 -0
- package/dist/api/toothInitials.d.ts +39 -0
- package/dist/api/toothInitials.d.ts.map +1 -0
- package/dist/api/toothInitials.js +64 -0
- package/dist/api/treatplanattaches.d.ts +5 -2
- package/dist/api/treatplanattaches.d.ts.map +1 -1
- package/dist/api/treatplanattaches.js +10 -4
- package/dist/api/treatplans.d.ts +15 -1
- package/dist/api/treatplans.d.ts.map +1 -1
- package/dist/api/treatplans.js +26 -4
- package/dist/api/userGroupAttaches.d.ts +20 -0
- package/dist/api/userGroupAttaches.d.ts.map +1 -0
- package/dist/api/userGroupAttaches.js +30 -0
- package/dist/api/userGroups.d.ts +20 -0
- package/dist/api/userGroups.d.ts.map +1 -0
- package/dist/api/userGroups.js +29 -0
- package/dist/api/userODs.d.ts +49 -0
- package/dist/api/userODs.d.ts.map +1 -0
- package/dist/api/userODs.js +64 -0
- package/dist/openDental.d.ts +624 -115
- package/dist/openDental.d.ts.map +1 -1
- package/dist/openDental.js +800 -291
- package/dist/types/DiscountPlanTypes.d.ts +3 -0
- package/dist/types/DiscountPlanTypes.d.ts.map +1 -1
- package/dist/types/adjustmentTypes.d.ts +3 -0
- package/dist/types/adjustmentTypes.d.ts.map +1 -1
- package/dist/types/allergyDefTypes.d.ts +25 -0
- package/dist/types/allergyDefTypes.d.ts.map +1 -0
- package/dist/types/allergyTypes.d.ts +3 -0
- package/dist/types/allergyTypes.d.ts.map +1 -1
- package/dist/types/{appoinmentTypesType.d.ts → appointmentTypeTypes.d.ts} +1 -1
- package/dist/types/appointmentTypeTypes.d.ts.map +1 -0
- package/dist/types/appointmentTypeTypes.js +2 -0
- package/dist/types/appointmentTypes.d.ts +19 -0
- package/dist/types/appointmentTypes.d.ts.map +1 -1
- package/dist/types/apptFieldDefTypes.d.ts +25 -0
- package/dist/types/apptFieldDefTypes.d.ts.map +1 -0
- package/dist/types/apptFieldDefTypes.js +2 -0
- package/dist/types/apptFieldTypes.d.ts +34 -0
- package/dist/types/apptFieldTypes.d.ts.map +1 -0
- package/dist/types/apptFieldTypes.js +2 -0
- package/dist/types/asapCommTypes.d.ts +63 -0
- package/dist/types/asapCommTypes.d.ts.map +1 -0
- package/dist/types/asapCommTypes.js +2 -0
- package/dist/types/autoNoteControlTypes.d.ts +27 -0
- package/dist/types/autoNoteControlTypes.d.ts.map +1 -0
- package/dist/types/autoNoteControlTypes.js +2 -0
- package/dist/types/autoNoteTypes.d.ts +33 -0
- package/dist/types/autoNoteTypes.d.ts.map +1 -0
- package/dist/types/autoNoteTypes.js +2 -0
- package/dist/types/benefitTypes.d.ts +6 -0
- package/dist/types/benefitTypes.d.ts.map +1 -1
- package/dist/types/carrierTypes.d.ts +45 -0
- package/dist/types/carrierTypes.d.ts.map +1 -0
- package/dist/types/carrierTypes.js +2 -0
- package/dist/types/claimPaymentTypes.d.ts +72 -0
- package/dist/types/claimPaymentTypes.d.ts.map +1 -0
- package/dist/types/claimPaymentTypes.js +2 -0
- package/dist/types/claimProcTypes.d.ts +3 -0
- package/dist/types/claimProcTypes.d.ts.map +1 -1
- package/dist/types/claimTrackingTypes.d.ts +37 -0
- package/dist/types/claimTrackingTypes.d.ts.map +1 -0
- package/dist/types/claimTrackingTypes.js +2 -0
- package/dist/types/claimTypes.d.ts +3 -0
- package/dist/types/claimTypes.d.ts.map +1 -1
- package/dist/types/clinicTypes.d.ts +45 -0
- package/dist/types/clinicTypes.d.ts.map +1 -0
- package/dist/types/clinicTypes.js +2 -0
- package/dist/types/clockEventTypes.d.ts +52 -0
- package/dist/types/clockEventTypes.d.ts.map +1 -0
- package/dist/types/clockEventTypes.js +2 -0
- package/dist/types/codeGroupTypes.d.ts +67 -0
- package/dist/types/codeGroupTypes.d.ts.map +1 -0
- package/dist/types/codeGroupTypes.js +2 -0
- package/dist/types/computerTypes.d.ts +10 -0
- package/dist/types/computerTypes.d.ts.map +1 -0
- package/dist/types/computerTypes.js +2 -0
- package/dist/types/covCatTypes.d.ts +53 -0
- package/dist/types/covCatTypes.d.ts.map +1 -0
- package/dist/types/covCatTypes.js +2 -0
- package/dist/types/covSpanTypes.d.ts +52 -0
- package/dist/types/covSpanTypes.d.ts.map +1 -0
- package/dist/types/covSpanTypes.js +2 -0
- package/dist/types/definitionTypes.d.ts +12 -0
- package/dist/types/definitionTypes.d.ts.map +1 -1
- package/dist/types/discountPlanSubTypes.d.ts +5 -1
- package/dist/types/discountPlanSubTypes.d.ts.map +1 -1
- package/dist/types/diseaseDefTypes.d.ts +33 -0
- package/dist/types/diseaseDefTypes.d.ts.map +1 -0
- package/dist/types/diseaseDefTypes.js +2 -0
- package/dist/types/diseaseTypes.d.ts +3 -0
- package/dist/types/diseaseTypes.d.ts.map +1 -1
- package/dist/types/documentTypes.d.ts +191 -0
- package/dist/types/documentTypes.d.ts.map +1 -0
- package/dist/types/documentTypes.js +2 -0
- package/dist/types/eTransMessageTextTypes.d.ts +9 -0
- package/dist/types/eTransMessageTextTypes.d.ts.map +1 -0
- package/dist/types/eTransMessageTextTypes.js +2 -0
- package/dist/types/eTransTypes.d.ts +15 -0
- package/dist/types/eTransTypes.d.ts.map +1 -0
- package/dist/types/eTransTypes.js +2 -0
- package/dist/types/eTranssTypes.d.ts +46 -0
- package/dist/types/eTranssTypes.d.ts.map +1 -0
- package/dist/types/eTranssTypes.js +2 -0
- package/dist/types/ehrPatientTypes.d.ts +34 -0
- package/dist/types/ehrPatientTypes.d.ts.map +1 -0
- package/dist/types/ehrPatientTypes.js +2 -0
- package/dist/types/employeeTypes.d.ts +88 -0
- package/dist/types/employeeTypes.d.ts.map +1 -0
- package/dist/types/employeeTypes.js +2 -0
- package/dist/types/employerTypes.d.ts +38 -0
- package/dist/types/employerTypes.d.ts.map +1 -0
- package/dist/types/employerTypes.js +2 -0
- package/dist/types/eobAttachTypes.d.ts +62 -0
- package/dist/types/eobAttachTypes.d.ts.map +1 -0
- package/dist/types/eobAttachTypes.js +2 -0
- package/dist/types/eventTypes.d.ts +52 -0
- package/dist/types/eventTypes.d.ts.map +1 -0
- package/dist/types/eventTypes.js +2 -0
- package/dist/types/feeTypes.d.ts +3 -0
- package/dist/types/feeTypes.d.ts.map +1 -1
- package/dist/types/histAppointmentTypes.d.ts +77 -0
- package/dist/types/histAppointmentTypes.d.ts.map +1 -0
- package/dist/types/histAppointmentTypes.js +2 -0
- package/dist/types/insPlanTypes.d.ts +4 -1
- package/dist/types/insPlanTypes.d.ts.map +1 -1
- package/dist/types/insSubTypes.d.ts +4 -1
- package/dist/types/insSubTypes.d.ts.map +1 -1
- package/dist/types/insVerifiesTypes.d.ts +3 -0
- package/dist/types/insVerifiesTypes.d.ts.map +1 -1
- package/dist/types/labCaseTypes.d.ts +4 -0
- package/dist/types/labCaseTypes.d.ts.map +1 -1
- package/dist/types/labTurnaroundTypes.d.ts +55 -0
- package/dist/types/labTurnaroundTypes.d.ts.map +1 -0
- package/dist/types/labTurnaroundTypes.js +2 -0
- package/dist/types/laboratoryTypes.d.ts +80 -0
- package/dist/types/laboratoryTypes.d.ts.map +1 -0
- package/dist/types/laboratoryTypes.js +2 -0
- package/dist/types/medicationPatTypes.d.ts +3 -0
- package/dist/types/medicationPatTypes.d.ts.map +1 -1
- package/dist/types/medicationTypes.d.ts +28 -0
- package/dist/types/medicationTypes.d.ts.map +1 -0
- package/dist/types/medicationTypes.js +2 -0
- package/dist/types/operatoryTypes.d.ts +5 -2
- package/dist/types/operatoryTypes.d.ts.map +1 -1
- package/dist/types/patFieldDefTypes.d.ts +64 -0
- package/dist/types/patFieldDefTypes.d.ts.map +1 -0
- package/dist/types/patFieldDefTypes.js +2 -0
- package/dist/types/patFieldTypes.d.ts +4 -0
- package/dist/types/patFieldTypes.d.ts.map +1 -1
- package/dist/types/patPlanTypes.d.ts +3 -0
- package/dist/types/patPlanTypes.d.ts.map +1 -1
- package/dist/types/patientNoteTypes.d.ts +32 -0
- package/dist/types/patientNoteTypes.d.ts.map +1 -0
- package/dist/types/patientNoteTypes.js +2 -0
- package/dist/types/patientRaceTypes.d.ts +25 -0
- package/dist/types/patientRaceTypes.d.ts.map +1 -0
- package/dist/types/patientRaceTypes.js +2 -0
- package/dist/types/patientTypes.d.ts +7 -1
- package/dist/types/patientTypes.d.ts.map +1 -1
- package/dist/types/payPlanChargeTypes.d.ts +4 -0
- package/dist/types/payPlanChargeTypes.d.ts.map +1 -1
- package/dist/types/paySplitTypes.d.ts +3 -0
- package/dist/types/paySplitTypes.d.ts.map +1 -1
- package/dist/types/paymentTypes.d.ts +11 -0
- package/dist/types/paymentTypes.d.ts.map +1 -1
- package/dist/types/perioExamTypes.d.ts +54 -0
- package/dist/types/perioExamTypes.d.ts.map +1 -0
- package/dist/types/perioExamTypes.js +2 -0
- package/dist/types/perioMeasureTypes.d.ts +80 -0
- package/dist/types/perioMeasureTypes.d.ts.map +1 -0
- package/dist/types/perioMeasureTypes.js +2 -0
- package/dist/types/pharmacyTypes.d.ts +18 -0
- package/dist/types/pharmacyTypes.d.ts.map +1 -0
- package/dist/types/pharmacyTypes.js +2 -0
- package/dist/types/popupTypes.d.ts +55 -0
- package/dist/types/popupTypes.d.ts.map +1 -0
- package/dist/types/popupTypes.js +2 -0
- package/dist/types/preferenceTypes.d.ts +32 -0
- package/dist/types/preferenceTypes.d.ts.map +1 -0
- package/dist/types/preferenceTypes.js +2 -0
- package/dist/types/procNoteTypes.d.ts +3 -0
- package/dist/types/procNoteTypes.d.ts.map +1 -1
- package/dist/types/procTPTypes.d.ts +3 -0
- package/dist/types/procTPTypes.d.ts.map +1 -1
- package/dist/types/procedureCodeTypes.d.ts +3 -0
- package/dist/types/procedureCodeTypes.d.ts.map +1 -1
- package/dist/types/procedurelogTypes.d.ts +7 -0
- package/dist/types/procedurelogTypes.d.ts.map +1 -1
- package/dist/types/providerTypes.d.ts +3 -0
- package/dist/types/providerTypes.d.ts.map +1 -1
- package/dist/types/queryTypes.d.ts +10 -0
- package/dist/types/queryTypes.d.ts.map +1 -1
- package/dist/types/quickPasteCatTypes.d.ts +23 -0
- package/dist/types/quickPasteCatTypes.d.ts.map +1 -0
- package/dist/types/quickPasteCatTypes.js +2 -0
- package/dist/types/quickPasteNoteTypes.d.ts +26 -0
- package/dist/types/quickPasteNoteTypes.d.ts.map +1 -0
- package/dist/types/quickPasteNoteTypes.js +2 -0
- package/dist/types/recallTypeTypes.d.ts +13 -0
- package/dist/types/recallTypeTypes.d.ts.map +1 -0
- package/dist/types/recallTypeTypes.js +2 -0
- package/dist/types/recallTypes.d.ts +6 -3
- package/dist/types/recallTypes.d.ts.map +1 -1
- package/dist/types/refAttachTypes.d.ts +3 -0
- package/dist/types/refAttachTypes.d.ts.map +1 -1
- package/dist/types/referralTypes.d.ts +7 -4
- package/dist/types/referralTypes.d.ts.map +1 -1
- package/dist/types/reportTypes.d.ts +56 -0
- package/dist/types/reportTypes.d.ts.map +1 -0
- package/dist/types/reportTypes.js +2 -0
- package/dist/types/rxPatTypes.d.ts +43 -0
- package/dist/types/rxPatTypes.d.ts.map +1 -0
- package/dist/types/rxPatTypes.js +2 -0
- package/dist/types/scheduleOpTypes.d.ts +22 -0
- package/dist/types/scheduleOpTypes.d.ts.map +1 -0
- package/dist/types/scheduleOpTypes.js +2 -0
- package/dist/types/scheduleTypes.d.ts +17 -0
- package/dist/types/scheduleTypes.d.ts.map +1 -1
- package/dist/types/securityLogTypes.d.ts +3 -0
- package/dist/types/securityLogTypes.d.ts.map +1 -1
- package/dist/types/securityTypes.d.ts +13 -0
- package/dist/types/securityTypes.d.ts.map +1 -0
- package/dist/types/securityTypes.js +2 -0
- package/dist/types/sheetDefTypes.d.ts +22 -0
- package/dist/types/sheetDefTypes.d.ts.map +1 -0
- package/dist/types/sheetDefTypes.js +2 -0
- package/dist/types/sheetFieldTypes.d.ts +48 -0
- package/dist/types/sheetFieldTypes.d.ts.map +1 -0
- package/dist/types/sheetFieldTypes.js +2 -0
- package/dist/types/sheetTypes.d.ts +62 -0
- package/dist/types/sheetTypes.d.ts.map +1 -0
- package/dist/types/sheetTypes.js +2 -0
- package/dist/types/signalODTypes.d.ts +48 -0
- package/dist/types/signalODTypes.d.ts.map +1 -0
- package/dist/types/signalODTypes.js +2 -0
- package/dist/types/statementTypes.d.ts +60 -0
- package/dist/types/statementTypes.d.ts.map +1 -0
- package/dist/types/statementTypes.js +2 -0
- package/dist/types/subscriptionTypes.d.ts +99 -0
- package/dist/types/subscriptionTypes.d.ts.map +1 -0
- package/dist/types/subscriptionTypes.js +2 -0
- package/dist/types/substitutionLinkTypes.d.ts +46 -0
- package/dist/types/substitutionLinkTypes.d.ts.map +1 -0
- package/dist/types/substitutionLinkTypes.js +2 -0
- package/dist/types/taskListTypes.d.ts +67 -0
- package/dist/types/taskListTypes.d.ts.map +1 -0
- package/dist/types/taskListTypes.js +2 -0
- package/dist/types/taskNoteTypes.d.ts +42 -0
- package/dist/types/taskNoteTypes.d.ts.map +1 -0
- package/dist/types/taskNoteTypes.js +2 -0
- package/dist/types/taskTypes.d.ts +153 -0
- package/dist/types/taskTypes.d.ts.map +1 -0
- package/dist/types/taskTypes.js +2 -0
- package/dist/types/toothInitialTypes.d.ts +44 -0
- package/dist/types/toothInitialTypes.d.ts.map +1 -0
- package/dist/types/toothInitialTypes.js +2 -0
- package/dist/types/treatPlanAttachTypes.d.ts +3 -0
- package/dist/types/treatPlanAttachTypes.d.ts.map +1 -1
- package/dist/types/treatPlanTypes.d.ts +4 -0
- package/dist/types/treatPlanTypes.d.ts.map +1 -1
- package/dist/types/userGroupAttachTypes.d.ts +22 -0
- package/dist/types/userGroupAttachTypes.d.ts.map +1 -0
- package/dist/types/userGroupAttachTypes.js +2 -0
- package/dist/types/userGroupTypes.d.ts +21 -0
- package/dist/types/userGroupTypes.d.ts.map +1 -0
- package/dist/types/userGroupTypes.js +2 -0
- package/dist/types/userODTypes.d.ts +97 -0
- package/dist/types/userODTypes.d.ts.map +1 -0
- package/dist/types/userODTypes.js +2 -0
- package/dist/utils/errorHandler.d.ts +5 -0
- package/dist/utils/errorHandler.d.ts.map +1 -1
- package/dist/utils/errorHandler.js +11 -0
- package/dist/utils/httpClient.d.ts +24 -6
- package/dist/utils/httpClient.d.ts.map +1 -1
- package/dist/utils/httpClient.js +28 -24
- package/docs/Open Dental 2026-04-22/api-url-list.md +110 -0
- package/docs/Open Dental 2026-04-22/apiaccountmodules.md +116 -0
- package/docs/Open Dental 2026-04-22/apiadjustments.md +133 -0
- package/docs/Open Dental 2026-04-22/apiallergies.md +132 -0
- package/docs/Open Dental 2026-04-22/apiallergydefs.md +74 -0
- package/docs/Open Dental 2026-04-22/apiappointments.md +510 -0
- package/docs/Open Dental 2026-04-22/apiappointmenttypes.md +86 -0
- package/docs/Open Dental 2026-04-22/apiapptfielddefs.md +130 -0
- package/docs/Open Dental 2026-04-22/apiapptfields.md +147 -0
- package/docs/Open Dental 2026-04-22/apiasapcomms.md +141 -0
- package/docs/Open Dental 2026-04-22/apiautonotecontrols.md +111 -0
- package/docs/Open Dental 2026-04-22/apiautonotes.md +103 -0
- package/docs/Open Dental 2026-04-22/apibenefits.md +515 -0
- package/docs/Open Dental 2026-04-22/apicarriers.md +150 -0
- package/docs/Open Dental 2026-04-22/apichartmodules.md +135 -0
- package/docs/Open Dental 2026-04-22/apiclaimpayments.md +206 -0
- package/docs/Open Dental 2026-04-22/apiclaimprocs.md +256 -0
- package/docs/Open Dental 2026-04-22/apiclaims.md +339 -0
- package/docs/Open Dental 2026-04-22/apiclaimtrackings.md +110 -0
- package/docs/Open Dental 2026-04-22/apiclinics.md +95 -0
- package/docs/Open Dental 2026-04-22/apiclockevents.md +98 -0
- package/docs/Open Dental 2026-04-22/apicodegroups.md +140 -0
- package/docs/Open Dental 2026-04-22/apicommlogs.md +161 -0
- package/docs/Open Dental 2026-04-22/apicomputers.md +39 -0
- package/docs/Open Dental 2026-04-22/apicovcats.md +139 -0
- package/docs/Open Dental 2026-04-22/apicovspans.md +140 -0
- package/docs/Open Dental 2026-04-22/apidefinitions.md +90 -0
- package/docs/Open Dental 2026-04-22/apidiscountplans.md +154 -0
- package/docs/Open Dental 2026-04-22/apidiscountplansubs.md +125 -0
- package/docs/Open Dental 2026-04-22/apidiseasedefs.md +88 -0
- package/docs/Open Dental 2026-04-22/apidiseases.md +168 -0
- package/docs/Open Dental 2026-04-22/apidocuments.md +319 -0
- package/docs/Open Dental 2026-04-22/apiehrpatients.md +87 -0
- package/docs/Open Dental 2026-04-22/apiemployees.md +145 -0
- package/docs/Open Dental 2026-04-22/apiemployers.md +129 -0
- package/docs/Open Dental 2026-04-22/apieobattaches.md +132 -0
- package/docs/Open Dental 2026-04-22/apietrans.md +44 -0
- package/docs/Open Dental 2026-04-22/apietransmessagetexts.md +56 -0
- package/docs/Open Dental 2026-04-22/apietranss.md +79 -0
- package/docs/Open Dental 2026-04-22/apievents.md +96 -0
- package/docs/Open Dental 2026-04-22/apifamilymodules.md +108 -0
- package/docs/Open Dental 2026-04-22/apifees.md +146 -0
- package/docs/Open Dental 2026-04-22/apifeescheds.md +116 -0
- package/docs/Open Dental 2026-04-22/apihistappointments.md +121 -0
- package/docs/Open Dental 2026-04-22/apiimplementation.md +128 -0
- package/docs/Open Dental 2026-04-22/apiinsplans.md +236 -0
- package/docs/Open Dental 2026-04-22/apiinssubs.md +171 -0
- package/docs/Open Dental 2026-04-22/apiinsverifies.md +123 -0
- package/docs/Open Dental 2026-04-22/apilabcases.md +174 -0
- package/docs/Open Dental 2026-04-22/apilaboratories.md +147 -0
- package/docs/Open Dental 2026-04-22/apilabturnarounds.md +128 -0
- package/docs/Open Dental 2026-04-22/apimedicationpats.md +170 -0
- package/docs/Open Dental 2026-04-22/apimedications.md +74 -0
- package/docs/Open Dental 2026-04-22/apioperatories.md +78 -0
- package/docs/Open Dental 2026-04-22/apipatfielddefs.md +139 -0
- package/docs/Open Dental 2026-04-22/apipatfields.md +166 -0
- package/docs/Open Dental 2026-04-22/apipatientnotes.md +102 -0
- package/docs/Open Dental 2026-04-22/apipatientraces.md +51 -0
- package/docs/Open Dental 2026-04-22/apipatients.md +346 -0
- package/docs/Open Dental 2026-04-22/apipatplans.md +147 -0
- package/docs/Open Dental 2026-04-22/apipayments.md +236 -0
- package/docs/Open Dental 2026-04-22/apipayplancharges.md +59 -0
- package/docs/Open Dental 2026-04-22/apipayplans.md +256 -0
- package/docs/Open Dental 2026-04-22/apipaysplits.md +112 -0
- package/docs/Open Dental 2026-04-22/apiperioexams.md +155 -0
- package/docs/Open Dental 2026-04-22/apiperiomeasures.md +162 -0
- package/docs/Open Dental 2026-04-22/apipharmacies.md +78 -0
- package/docs/Open Dental 2026-04-22/apipopups.md +127 -0
- package/docs/Open Dental 2026-04-22/apipreferences.md +47 -0
- package/docs/Open Dental 2026-04-22/apiprocedurecodes.md +260 -0
- package/docs/Open Dental 2026-04-22/apiprocedurelogs.md +477 -0
- package/docs/Open Dental 2026-04-22/apiprocnotes.md +86 -0
- package/docs/Open Dental 2026-04-22/apiproctps.md +141 -0
- package/docs/Open Dental 2026-04-22/apiproviders.md +189 -0
- package/docs/Open Dental 2026-04-22/apiqueries.md +74 -0
- package/docs/Open Dental 2026-04-22/apiquickpastecats.md +130 -0
- package/docs/Open Dental 2026-04-22/apiquickpastenotes.md +75 -0
- package/docs/Open Dental 2026-04-22/apirecalls.md +239 -0
- package/docs/Open Dental 2026-04-22/apirecalltypes.md +65 -0
- package/docs/Open Dental 2026-04-22/apirefattaches.md +179 -0
- package/docs/Open Dental 2026-04-22/apireferrals.md +198 -0
- package/docs/Open Dental 2026-04-22/apireports.md +85 -0
- package/docs/Open Dental 2026-04-22/apirxpats.md +113 -0
- package/docs/Open Dental 2026-04-22/apischeduleops.md +58 -0
- package/docs/Open Dental 2026-04-22/apischedules.md +106 -0
- package/docs/Open Dental 2026-04-22/apisecurity.md +53 -0
- package/docs/Open Dental 2026-04-22/apisecuritylogs.md +59 -0
- package/docs/Open Dental 2026-04-22/apisheetdefs.md +118 -0
- package/docs/Open Dental 2026-04-22/apisheetfields.md +140 -0
- package/docs/Open Dental 2026-04-22/apisheets.md +156 -0
- package/docs/Open Dental 2026-04-22/apisignalods.md +118 -0
- package/docs/Open Dental 2026-04-22/apispecification.md +47 -0
- package/docs/Open Dental 2026-04-22/apistatements.md +160 -0
- package/docs/Open Dental 2026-04-22/apisubscriptions.md +133 -0
- package/docs/Open Dental 2026-04-22/apisubstitutionlinks.md +143 -0
- package/docs/Open Dental 2026-04-22/apitasklists.md +89 -0
- package/docs/Open Dental 2026-04-22/apitasknotes.md +130 -0
- package/docs/Open Dental 2026-04-22/apitasks.md +192 -0
- package/docs/Open Dental 2026-04-22/apitoothinitials.md +119 -0
- package/docs/Open Dental 2026-04-22/apitreatplanattaches.md +111 -0
- package/docs/Open Dental 2026-04-22/apitreatplans.md +201 -0
- package/docs/Open Dental 2026-04-22/apiusergroupattaches.md +57 -0
- package/docs/Open Dental 2026-04-22/apiusergroups.md +56 -0
- package/docs/Open Dental 2026-04-22/apiuserods.md +128 -0
- package/docs/Open Dental 2026-04-22/context/Open Dental _ Benefits Guide.md +294 -0
- package/docs/Open Dental 2026-04-22/context/OpenDental_DB_Documentation_v26-1.xml +20118 -0
- package/docs/Open Dental 2026-04-22/context/sitemap.xml +4617 -0
- package/package.json +8 -7
- package/release.sh +3 -5
- package/tsconfig.test.json +8 -0
- package/__tests__/example.test.ts +0 -6
- package/dist/types/appoinmentTypesType.d.ts.map +0 -1
- package/src/api/accountModules.ts +0 -61
- package/src/api/adjustments.ts +0 -126
- package/src/api/allergies.ts +0 -114
- package/src/api/appointmentTypes.ts +0 -21
- package/src/api/appointments.ts +0 -343
- package/src/api/benefits.ts +0 -155
- package/src/api/chartModules.ts +0 -53
- package/src/api/claimProcs.ts +0 -117
- package/src/api/claims.ts +0 -173
- package/src/api/commlogs.ts +0 -63
- package/src/api/definitions.ts +0 -35
- package/src/api/discountPlanSubs.ts +0 -106
- package/src/api/discountPlans.ts +0 -159
- package/src/api/diseases.ts +0 -130
- package/src/api/familyModules.ts +0 -29
- package/src/api/feeScheds.ts +0 -30
- package/src/api/fees.ts +0 -43
- package/src/api/index.ts +0 -25
- package/src/api/insPlans.ts +0 -158
- package/src/api/insSubs.ts +0 -155
- package/src/api/insVerifies.ts +0 -85
- package/src/api/labCases.ts +0 -183
- package/src/api/medicationPats.ts +0 -120
- package/src/api/operatories.ts +0 -46
- package/src/api/patFields.ts +0 -112
- package/src/api/patPlans.ts +0 -113
- package/src/api/patients.ts +0 -254
- package/src/api/payPlanCharges.ts +0 -49
- package/src/api/payPlans.ts +0 -274
- package/src/api/paySplits.ts +0 -56
- package/src/api/payments.ts +0 -86
- package/src/api/procNotes.ts +0 -67
- package/src/api/procTPs.ts +0 -112
- package/src/api/procedureCodes.ts +0 -45
- package/src/api/procedureLog.ts +0 -377
- package/src/api/providers.ts +0 -175
- package/src/api/queries.ts +0 -43
- package/src/api/recalls.ts +0 -148
- package/src/api/refAttaches.ts +0 -142
- package/src/api/referrals.ts +0 -222
- package/src/api/schedules.ts +0 -64
- package/src/api/securityLogs.ts +0 -32
- package/src/api/treatplanattaches.ts +0 -67
- package/src/api/treatplans.ts +0 -96
- package/src/index.ts +0 -2
- package/src/openDental.ts +0 -506
- package/src/transformerTypes/visitTypes.ts +0 -87
- package/src/transformers/index.ts +0 -4
- package/src/transformers/visit.ts +0 -83
- package/src/types/DiscountPlanTypes.ts +0 -70
- package/src/types/accountModuleTypes.ts +0 -46
- package/src/types/adjustmentTypes.ts +0 -63
- package/src/types/allergyTypes.ts +0 -48
- package/src/types/appoinmentTypesType.ts +0 -16
- package/src/types/appointmentTypes.ts +0 -256
- package/src/types/benefitTypes.ts +0 -70
- package/src/types/chartModuleTypes.ts +0 -65
- package/src/types/claimProcTypes.ts +0 -99
- package/src/types/claimTypes.ts +0 -227
- package/src/types/commlogTypes.ts +0 -28
- package/src/types/definitionTypes.ts +0 -24
- package/src/types/discountPlanSubTypes.ts +0 -45
- package/src/types/diseaseTypes.ts +0 -50
- package/src/types/familyModuleTypes.ts +0 -33
- package/src/types/feeSchedsTypes.ts +0 -38
- package/src/types/feeTypes.ts +0 -49
- package/src/types/insPlanTypes.ts +0 -72
- package/src/types/insSubTypes.ts +0 -65
- package/src/types/insVerifiesTypes.ts +0 -38
- package/src/types/labCaseTypes.ts +0 -71
- package/src/types/medicationPatTypes.ts +0 -50
- package/src/types/operatoryTypes.ts +0 -24
- package/src/types/patFieldTypes.ts +0 -24
- package/src/types/patPlanTypes.ts +0 -55
- package/src/types/patientTypes.ts +0 -236
- package/src/types/payPlanChargeTypes.ts +0 -77
- package/src/types/payPlanTypes.ts +0 -171
- package/src/types/paySplitTypes.ts +0 -44
- package/src/types/paymentTypes.ts +0 -69
- package/src/types/procNoteTypes.ts +0 -38
- package/src/types/procTPTypes.ts +0 -79
- package/src/types/procedureCodeTypes.ts +0 -48
- package/src/types/procedurelogTypes.ts +0 -184
- package/src/types/providerTypes.ts +0 -73
- package/src/types/queryTypes.ts +0 -17
- package/src/types/recallTypes.ts +0 -102
- package/src/types/refAttachTypes.ts +0 -63
- package/src/types/referralTypes.ts +0 -102
- package/src/types/scheduleTypes.ts +0 -32
- package/src/types/securityLogTypes.ts +0 -24
- package/src/types/treatPlanAttachTypes.ts +0 -39
- package/src/types/treatPlanTypes.ts +0 -75
- package/src/utils/errorHandler.ts +0 -0
- package/src/utils/httpClient.ts +0 -111
- package/tsconfig.json +0 -16
- /package/dist/types/{appoinmentTypesType.js → allergyDefTypes.js} +0 -0
package/dist/api/insPlans.d.ts
CHANGED
|
@@ -6,8 +6,12 @@ export default class InsPlans {
|
|
|
6
6
|
/**
|
|
7
7
|
* Fetch a single insplan by its ID.
|
|
8
8
|
* @param {number} PlanNum - The ID of the insplan.
|
|
9
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
10
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
11
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
9
12
|
* @returns {Promise<InsPlan>} - The insplan data.
|
|
10
|
-
* @throws {Error} - If
|
|
13
|
+
* @throws {Error} - If PlanNum is not a valid number.
|
|
14
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
11
15
|
*/
|
|
12
16
|
getInsPlan(PlanNum: number): Promise<InsPlan>;
|
|
13
17
|
/**
|
|
@@ -17,10 +21,11 @@ export default class InsPlans {
|
|
|
17
21
|
* @param {number} [params.CarrierNum] - FK to carrier.CarrierNum.
|
|
18
22
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
19
23
|
* @returns {Promise<InsPlan[]>} - A list of InsPlans.
|
|
24
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
20
25
|
*/
|
|
21
|
-
getInsPlans({ PlanType, CarrierNum, Offset, }?: GetInsPlansParams): Promise<InsPlan[]>;
|
|
26
|
+
getInsPlans({ PlanType, CarrierNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetInsPlansParams): Promise<InsPlan[]>;
|
|
22
27
|
/**
|
|
23
|
-
*
|
|
28
|
+
* Create a new insurance plan and add it to the database.
|
|
24
29
|
* @param {Object} data - The details of the insplan to create.
|
|
25
30
|
* @param {number} data.CarrierNum - Required. FK to carrier.CarrierNum.
|
|
26
31
|
* @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
|
|
@@ -36,6 +41,7 @@ export default class InsPlans {
|
|
|
36
41
|
* @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
|
|
37
42
|
* @returns {Promise<InsPlan>} - The created insplan.
|
|
38
43
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
44
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
39
45
|
*/
|
|
40
46
|
createInsPlan({ CarrierNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }: CreateInsPlanParams): Promise<InsPlan>;
|
|
41
47
|
/**
|
|
@@ -54,8 +60,9 @@ export default class InsPlans {
|
|
|
54
60
|
* @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
|
|
55
61
|
* @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
|
|
56
62
|
* @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
|
|
57
|
-
|
|
63
|
+
* @returns {Promise<InsPlan>} - The updated InsPlan.
|
|
58
64
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
65
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
59
66
|
*/
|
|
60
67
|
updateInsPlan({ PlanNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CarrierNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }: UpdateInsPlanParams): Promise<InsPlan>;
|
|
61
68
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"insPlans.d.ts","sourceRoot":"","sources":["../../src/api/insPlans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"insPlans.d.ts","sourceRoot":"","sources":["../../src/api/insPlans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1D;;;;;;;;QAQI;IACS,WAAW,CAAC,EACvB,QAAQ,EACR,UAAU,EACV,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAc5C;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,QAAQ,EACR,UAAU,EACV,iBAAiB,GAClB,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB1C;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,EACzB,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EACb,QAAQ,EACR,UAAU,EACV,iBAAiB,GAClB,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAoB3C"}
|
package/dist/api/insPlans.js
CHANGED
|
@@ -8,14 +8,18 @@ class InsPlans {
|
|
|
8
8
|
/**
|
|
9
9
|
* Fetch a single insplan by its ID.
|
|
10
10
|
* @param {number} PlanNum - The ID of the insplan.
|
|
11
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
12
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
13
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
11
14
|
* @returns {Promise<InsPlan>} - The insplan data.
|
|
12
|
-
* @throws {Error} - If
|
|
15
|
+
* @throws {Error} - If PlanNum is not a valid number.
|
|
16
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
13
17
|
*/
|
|
14
18
|
async getInsPlan(PlanNum) {
|
|
15
19
|
if (!PlanNum || typeof PlanNum !== "number") {
|
|
16
20
|
throw new Error("Invalid parameter: PlanNum must be a valid number.");
|
|
17
21
|
}
|
|
18
|
-
return
|
|
22
|
+
return this.httpClient.get(`/insplans/${PlanNum}`);
|
|
19
23
|
}
|
|
20
24
|
/**
|
|
21
25
|
* Fetch multiple insplans with optional filtering and pagination.
|
|
@@ -24,17 +28,21 @@ class InsPlans {
|
|
|
24
28
|
* @param {number} [params.CarrierNum] - FK to carrier.CarrierNum.
|
|
25
29
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
26
30
|
* @returns {Promise<InsPlan[]>} - A list of InsPlans.
|
|
31
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
27
32
|
*/
|
|
28
|
-
async getInsPlans({ PlanType, CarrierNum, Offset, } = {}) {
|
|
33
|
+
async getInsPlans({ PlanType, CarrierNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
29
34
|
const params = {
|
|
30
35
|
PlanType,
|
|
31
36
|
CarrierNum,
|
|
32
37
|
Offset,
|
|
38
|
+
Limit,
|
|
39
|
+
DateFormatString,
|
|
40
|
+
DateTimeFormatString,
|
|
33
41
|
};
|
|
34
42
|
return this.httpClient.get("/insplans", params);
|
|
35
43
|
}
|
|
36
44
|
/**
|
|
37
|
-
*
|
|
45
|
+
* Create a new insurance plan and add it to the database.
|
|
38
46
|
* @param {Object} data - The details of the insplan to create.
|
|
39
47
|
* @param {number} data.CarrierNum - Required. FK to carrier.CarrierNum.
|
|
40
48
|
* @param {string} [data.GroupName] - Optional. Typically the same as the employer. Used to identify difference in plans.
|
|
@@ -50,10 +58,11 @@ class InsPlans {
|
|
|
50
58
|
* @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
|
|
51
59
|
* @returns {Promise<InsPlan>} - The created insplan.
|
|
52
60
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
61
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
53
62
|
*/
|
|
54
63
|
async createInsPlan({ CarrierNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }) {
|
|
55
64
|
if (!CarrierNum) {
|
|
56
|
-
throw new Error("Invalid
|
|
65
|
+
throw new Error("Invalid parameter: CarrierNum is required.");
|
|
57
66
|
}
|
|
58
67
|
return this.httpClient.post("/insplans", {
|
|
59
68
|
CarrierNum,
|
|
@@ -86,12 +95,13 @@ class InsPlans {
|
|
|
86
95
|
* @param {"true" | "false"} [data.IsHidden] - ?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
|
|
87
96
|
* @param {number} [data.MonthRenew] - Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
|
|
88
97
|
* @param {"true" | "false"} [data.IsBlueBookEnabled] - Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
|
|
89
|
-
|
|
98
|
+
* @returns {Promise<InsPlan>} - The updated InsPlan.
|
|
90
99
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
100
|
+
* @see https://www.opendental.com/site/apiinsplans.html
|
|
91
101
|
*/
|
|
92
102
|
async updateInsPlan({ PlanNum, GroupName, GroupNum, PlanNote, FeeSched, PlanType, CopayFeeSched, EmployerNum, CarrierNum, CodeSubstNone, IsHidden, MonthRenew, IsBlueBookEnabled, }) {
|
|
93
103
|
if (!PlanNum || typeof PlanNum !== "number") {
|
|
94
|
-
throw new Error("Invalid
|
|
104
|
+
throw new Error("Invalid parameter: PlanNum must be a valid number.");
|
|
95
105
|
}
|
|
96
106
|
return this.httpClient.put(`/insplans/${PlanNum}`, {
|
|
97
107
|
GroupName,
|
package/dist/api/insSubs.d.ts
CHANGED
|
@@ -6,8 +6,12 @@ export default class InsSubs {
|
|
|
6
6
|
/**
|
|
7
7
|
* Fetch a single inssub by its ID.
|
|
8
8
|
* @param {number} InsSubNum - The unique identifier for the inssub.
|
|
9
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
10
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
11
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
9
12
|
* @returns {Promise<InsSub>} - The inssub object.
|
|
10
|
-
* @throws {Error} - If
|
|
13
|
+
* @throws {Error} - If InsSubNum is not provided.
|
|
14
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
11
15
|
*/
|
|
12
16
|
getInsSub(InsSubNum: number): Promise<InsSub>;
|
|
13
17
|
/**
|
|
@@ -18,8 +22,9 @@ export default class InsSubs {
|
|
|
18
22
|
* @param {string} [params.SecDateTEdit] - The last date the InsPlan was edited. Returns all InsSubs on or after this date.
|
|
19
23
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
20
24
|
* @returns {Promise<InsSub[]>} - A list of inssubs.
|
|
25
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
21
26
|
*/
|
|
22
|
-
getInsSubs({ PlanNum, Subscriber, SecDateTEdit, Offset, }?: GetInsSubsParams): Promise<InsSub[]>;
|
|
27
|
+
getInsSubs({ PlanNum, Subscriber, SecDateTEdit, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetInsSubsParams): Promise<InsSub[]>;
|
|
23
28
|
/**
|
|
24
29
|
* Create a new inssub.
|
|
25
30
|
* @param {Object} data - The details of InsSub to create.
|
|
@@ -32,8 +37,9 @@ export default class InsSubs {
|
|
|
32
37
|
* @param {"true" | "false"} [data.ReleaseInfo] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
33
38
|
* @param {"true" | "false"} [data.AssignBen] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
34
39
|
* @param {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
|
|
35
|
-
|
|
40
|
+
* @returns {Promise<InsSub>} - The created inssub.
|
|
36
41
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
42
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
37
43
|
*/
|
|
38
44
|
createInsSub({ PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }: CreateInsSubParams): Promise<InsSub>;
|
|
39
45
|
/**
|
|
@@ -49,15 +55,17 @@ export default class InsSubs {
|
|
|
49
55
|
* @param {"true" | "false"} [data.ReleaseInfo] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
50
56
|
* @param {"true" | "false"} [data.AssignBen] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
51
57
|
* @param {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
|
|
52
|
-
|
|
58
|
+
* @returns {Promise<InsSub>} - The updated inssub.
|
|
53
59
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
60
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
54
61
|
*/
|
|
55
62
|
updateInsSub({ InsSubNum, PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }: UpdateInsSubParams): Promise<InsSub>;
|
|
56
63
|
/**
|
|
57
64
|
* Delete an inssub entry. Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.
|
|
58
65
|
* @param {number} InsSubNum - Required: The unique identifier of the inssub to delete.
|
|
59
66
|
* @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
|
|
60
|
-
* @throws {Error} - If
|
|
67
|
+
* @throws {Error} - If InsSubNum is not a valid number or the API returns an error.
|
|
68
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
61
69
|
*/
|
|
62
70
|
deleteInsSub(InsSubNum: number): Promise<void>;
|
|
63
71
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"insSubs.d.ts","sourceRoot":"","sources":["../../src/api/insSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"insSubs.d.ts","sourceRoot":"","sources":["../../src/api/insSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO1D;;;;;;;;;QASI;IACS,UAAU,CAAC,EACtB,OAAO,EACP,UAAU,EACV,YAAY,EACZ,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAe1C;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,EACxB,OAAO,EACP,UAAU,EACV,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,EACT,SAAS,GACV,EAAG,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxC;;;;;;;;;;;;;;;;OAgBG;IACU,YAAY,CAAC,EACxB,SAAS,EACT,OAAO,EACP,UAAU,EACV,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,EACT,SAAS,GACV,EAAG,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxC;;;;;;OAMG;IACU,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO5D"}
|
package/dist/api/insSubs.js
CHANGED
|
@@ -8,12 +8,16 @@ class InsSubs {
|
|
|
8
8
|
/**
|
|
9
9
|
* Fetch a single inssub by its ID.
|
|
10
10
|
* @param {number} InsSubNum - The unique identifier for the inssub.
|
|
11
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
12
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
13
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
11
14
|
* @returns {Promise<InsSub>} - The inssub object.
|
|
12
|
-
* @throws {Error} - If
|
|
15
|
+
* @throws {Error} - If InsSubNum is not provided.
|
|
16
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
13
17
|
*/
|
|
14
18
|
async getInsSub(InsSubNum) {
|
|
15
19
|
if (!InsSubNum) {
|
|
16
|
-
throw new Error("InsSubNum is required.");
|
|
20
|
+
throw new Error("Invalid parameter: InsSubNum is required.");
|
|
17
21
|
}
|
|
18
22
|
return this.httpClient.get(`/inssubs/${InsSubNum}`);
|
|
19
23
|
}
|
|
@@ -25,13 +29,17 @@ class InsSubs {
|
|
|
25
29
|
* @param {string} [params.SecDateTEdit] - The last date the InsPlan was edited. Returns all InsSubs on or after this date.
|
|
26
30
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
27
31
|
* @returns {Promise<InsSub[]>} - A list of inssubs.
|
|
32
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
28
33
|
*/
|
|
29
|
-
async getInsSubs({ PlanNum, Subscriber, SecDateTEdit, Offset, } = {}) {
|
|
34
|
+
async getInsSubs({ PlanNum, Subscriber, SecDateTEdit, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
30
35
|
const params = {
|
|
31
36
|
PlanNum,
|
|
32
37
|
Subscriber,
|
|
33
38
|
SecDateTEdit,
|
|
34
39
|
Offset,
|
|
40
|
+
Limit,
|
|
41
|
+
DateFormatString,
|
|
42
|
+
DateTimeFormatString,
|
|
35
43
|
};
|
|
36
44
|
return this.httpClient.get("/inssubs", params);
|
|
37
45
|
}
|
|
@@ -47,12 +55,13 @@ class InsSubs {
|
|
|
47
55
|
* @param {"true" | "false"} [data.ReleaseInfo] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
48
56
|
* @param {"true" | "false"} [data.AssignBen] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
49
57
|
* @param {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
|
|
50
|
-
|
|
58
|
+
* @returns {Promise<InsSub>} - The created inssub.
|
|
51
59
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
60
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
52
61
|
*/
|
|
53
62
|
async createInsSub({ PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }) {
|
|
54
63
|
if (!PlanNum || !Subscriber || !SubscriberID) {
|
|
55
|
-
throw new Error("Invalid
|
|
64
|
+
throw new Error("Invalid parameter: PlanNum, Subscriber, and SubscriberID are required.");
|
|
56
65
|
}
|
|
57
66
|
return this.httpClient.post("/inssubs", {
|
|
58
67
|
PlanNum,
|
|
@@ -79,12 +88,13 @@ class InsSubs {
|
|
|
79
88
|
* @param {"true" | "false"} [data.ReleaseInfo] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
80
89
|
* @param {"true" | "false"} [data.AssignBen] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
|
|
81
90
|
* @param {string} [data.SubscNote] - Optional. Use to store any other info that affects coverage.
|
|
82
|
-
|
|
91
|
+
* @returns {Promise<InsSub>} - The updated inssub.
|
|
83
92
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
93
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
84
94
|
*/
|
|
85
95
|
async updateInsSub({ InsSubNum, PlanNum, Subscriber, SubscriberID, DateEffective, DateTerm, BenefitNotes, ReleaseInfo, AssignBen, SubscNote, }) {
|
|
86
96
|
if (!InsSubNum || typeof InsSubNum !== "number") {
|
|
87
|
-
throw new Error("Invalid
|
|
97
|
+
throw new Error("Invalid parameter: InsSubNum must be a valid number.");
|
|
88
98
|
}
|
|
89
99
|
return this.httpClient.put(`/inssubs/${InsSubNum}`, {
|
|
90
100
|
PlanNum,
|
|
@@ -102,7 +112,8 @@ class InsSubs {
|
|
|
102
112
|
* Delete an inssub entry. Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.
|
|
103
113
|
* @param {number} InsSubNum - Required: The unique identifier of the inssub to delete.
|
|
104
114
|
* @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
|
|
105
|
-
* @throws {Error} - If
|
|
115
|
+
* @throws {Error} - If InsSubNum is not a valid number or the API returns an error.
|
|
116
|
+
* @see https://www.opendental.com/site/apiinssubs.html
|
|
106
117
|
*/
|
|
107
118
|
async deleteInsSub(InsSubNum) {
|
|
108
119
|
if (!InsSubNum || typeof InsSubNum !== "number") {
|
|
@@ -4,10 +4,11 @@ export default class InsVerifies {
|
|
|
4
4
|
private httpClient;
|
|
5
5
|
constructor(httpClient: HttpClient);
|
|
6
6
|
/**
|
|
7
|
-
* Fetch a single
|
|
8
|
-
* @param {number} InsVerifyNum - The ID of the
|
|
9
|
-
* @returns {Promise<InsVerify>} - The
|
|
10
|
-
* @throws {Error} - If
|
|
7
|
+
* Fetch a single InsVerify by its ID.
|
|
8
|
+
* @param {number} InsVerifyNum - The ID of the InsVerify.
|
|
9
|
+
* @returns {Promise<InsVerify>} - The InsVerify data.
|
|
10
|
+
* @throws {Error} - If InsVerifyNum is not a valid number or the API returns an error.
|
|
11
|
+
* @see https://www.opendental.com/site/apiinsverifies.html
|
|
11
12
|
*/
|
|
12
13
|
getInsVerify(InsVerifyNum: number): Promise<InsVerify>;
|
|
13
14
|
/**
|
|
@@ -18,10 +19,11 @@ export default class InsVerifies {
|
|
|
18
19
|
* @param {number} [params.SecDateTEdit] - Only include InsVerifies with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
|
|
19
20
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
20
21
|
* @returns {Promise<InsVerify[]>} - A list of InsVerifies.
|
|
22
|
+
* @see https://www.opendental.com/site/apiinsverifies.html
|
|
21
23
|
*/
|
|
22
|
-
getInsVerifies({ VerifyType, FKey, SecDateTEdit, Offset, }?: GetInsVerifiesParams): Promise<InsVerify[]>;
|
|
24
|
+
getInsVerifies({ VerifyType, FKey, SecDateTEdit, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetInsVerifiesParams): Promise<InsVerify[]>;
|
|
23
25
|
/**
|
|
24
|
-
*
|
|
26
|
+
* Create a new InsVerify record and add it to the database.
|
|
25
27
|
* @param {Object} data - The details of the InsVerify to create.
|
|
26
28
|
* @param {string} [data.DateLastVerified] - (Optional after version 24.1.17) String in "yyyy-MM-dd" format.
|
|
27
29
|
* @param {"PatientEnrollment" | "InsuranceBenefit" } data.VerifyType - Required. Can be either "PatientEnrollment" to verify a patient's insurance eligibility, or "InsuranceBenefit" to verify an insurance plan's benefits.
|
|
@@ -30,6 +32,7 @@ export default class InsVerifies {
|
|
|
30
32
|
* @param {"string"} [data.Note] - (Added in version 24.1.17) Optional. Status note for this insurance verification.
|
|
31
33
|
* @returns {Promise<InsVerify>} - The created InsVerify.
|
|
32
34
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
35
|
+
* @see https://www.opendental.com/site/apiinsverifies.html
|
|
33
36
|
*/
|
|
34
37
|
createInsVerifies({ DateLastVerified, VerifyType, FKey, DefNum, Note, }: UpdateInsVerifiesParams): Promise<InsVerify>;
|
|
35
38
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"insVerifies.d.ts","sourceRoot":"","sources":["../../src/api/insVerifies.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"insVerifies.d.ts","sourceRoot":"","sources":["../../src/api/insVerifies.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IASnE;;;;;;;;;QASI;IACS,cAAc,CAAC,EAC1B,UAAU,EACV,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAejD;;;;;;;;;;;OAWG;IACU,iBAAiB,CAAC,EAC7B,gBAAgB,EAChB,UAAU,EACV,IAAI,EACJ,MAAM,EACN,IAAI,GACL,EAAG,uBAAuB,GAAG,OAAO,CAAC,SAAS,CAAC;CAajD"}
|
package/dist/api/insVerifies.js
CHANGED
|
@@ -6,16 +6,17 @@ class InsVerifies {
|
|
|
6
6
|
this.httpClient = httpClient;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
|
-
* Fetch a single
|
|
10
|
-
* @param {number} InsVerifyNum - The ID of the
|
|
11
|
-
* @returns {Promise<InsVerify>} - The
|
|
12
|
-
* @throws {Error} - If
|
|
9
|
+
* Fetch a single InsVerify by its ID.
|
|
10
|
+
* @param {number} InsVerifyNum - The ID of the InsVerify.
|
|
11
|
+
* @returns {Promise<InsVerify>} - The InsVerify data.
|
|
12
|
+
* @throws {Error} - If InsVerifyNum is not a valid number or the API returns an error.
|
|
13
|
+
* @see https://www.opendental.com/site/apiinsverifies.html
|
|
13
14
|
*/
|
|
14
15
|
async getInsVerify(InsVerifyNum) {
|
|
15
16
|
if (!InsVerifyNum || typeof InsVerifyNum !== "number") {
|
|
16
17
|
throw new Error("Invalid parameter: InsVerifyNum must be a valid number.");
|
|
17
18
|
}
|
|
18
|
-
return
|
|
19
|
+
return this.httpClient.get(`/insverifies/${InsVerifyNum}`);
|
|
19
20
|
}
|
|
20
21
|
/**
|
|
21
22
|
* Fetch multiple InsVerifies with optional filtering and pagination.
|
|
@@ -25,18 +26,22 @@ class InsVerifies {
|
|
|
25
26
|
* @param {number} [params.SecDateTEdit] - Only include InsVerifies with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
|
|
26
27
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
27
28
|
* @returns {Promise<InsVerify[]>} - A list of InsVerifies.
|
|
29
|
+
* @see https://www.opendental.com/site/apiinsverifies.html
|
|
28
30
|
*/
|
|
29
|
-
async getInsVerifies({ VerifyType, FKey, SecDateTEdit, Offset, } = {}) {
|
|
31
|
+
async getInsVerifies({ VerifyType, FKey, SecDateTEdit, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
30
32
|
const params = {
|
|
31
33
|
VerifyType,
|
|
32
34
|
FKey,
|
|
33
35
|
SecDateTEdit,
|
|
34
36
|
Offset,
|
|
37
|
+
Limit,
|
|
38
|
+
DateFormatString,
|
|
39
|
+
DateTimeFormatString,
|
|
35
40
|
};
|
|
36
41
|
return this.httpClient.get("/insverifies", params);
|
|
37
42
|
}
|
|
38
43
|
/**
|
|
39
|
-
*
|
|
44
|
+
* Create a new InsVerify record and add it to the database.
|
|
40
45
|
* @param {Object} data - The details of the InsVerify to create.
|
|
41
46
|
* @param {string} [data.DateLastVerified] - (Optional after version 24.1.17) String in "yyyy-MM-dd" format.
|
|
42
47
|
* @param {"PatientEnrollment" | "InsuranceBenefit" } data.VerifyType - Required. Can be either "PatientEnrollment" to verify a patient's insurance eligibility, or "InsuranceBenefit" to verify an insurance plan's benefits.
|
|
@@ -45,12 +50,13 @@ class InsVerifies {
|
|
|
45
50
|
* @param {"string"} [data.Note] - (Added in version 24.1.17) Optional. Status note for this insurance verification.
|
|
46
51
|
* @returns {Promise<InsVerify>} - The created InsVerify.
|
|
47
52
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
53
|
+
* @see https://www.opendental.com/site/apiinsverifies.html
|
|
48
54
|
*/
|
|
49
55
|
async createInsVerifies({ DateLastVerified, VerifyType, FKey, DefNum, Note, }) {
|
|
50
56
|
if (!VerifyType || !FKey) {
|
|
51
|
-
throw new Error("Invalid
|
|
57
|
+
throw new Error("Invalid parameter: VerifyType and FKey are required.");
|
|
52
58
|
}
|
|
53
|
-
return this.httpClient.
|
|
59
|
+
return this.httpClient.post("/insverifies", {
|
|
54
60
|
DateLastVerified,
|
|
55
61
|
VerifyType,
|
|
56
62
|
FKey,
|
package/dist/api/labCases.d.ts
CHANGED
|
@@ -6,8 +6,12 @@ export default class LabCases {
|
|
|
6
6
|
/**
|
|
7
7
|
* Fetch a single lab case by its ID.
|
|
8
8
|
* @param {number} LabCaseNum - The unique identifier for the LabCase.
|
|
9
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
10
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
11
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
9
12
|
* @returns {Promise<LabCase>} - The LabCase object.
|
|
10
|
-
* @throws {Error} - If
|
|
13
|
+
* @throws {Error} - If LabCaseNum is not provided.
|
|
14
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
11
15
|
*/
|
|
12
16
|
getLabCase(LabCaseNum: number): Promise<LabCase>;
|
|
13
17
|
/**
|
|
@@ -20,11 +24,12 @@ export default class LabCases {
|
|
|
20
24
|
* @param {number} [params.ProvNum] - FK to provider.ProvNum.
|
|
21
25
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
22
26
|
* @returns {Promise<LabCase[]>} - A list of lab cases.
|
|
27
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
23
28
|
*/
|
|
24
|
-
getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum }?: GetLabCasesParams): Promise<LabCase[]>;
|
|
29
|
+
getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum, Limit, DateFormatString, DateTimeFormatString, }?: GetLabCasesParams): Promise<LabCase[]>;
|
|
25
30
|
/**
|
|
26
|
-
* Create a new
|
|
27
|
-
* @param {Object} data - The details of
|
|
31
|
+
* Create a new lab case.
|
|
32
|
+
* @param {Object} data - The details of the lab case to create.
|
|
28
33
|
* @param {number} data.PatNum - Required. FK to patient.PatNum.
|
|
29
34
|
* @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
|
|
30
35
|
* @param {number} data.ProvNum - Required. FK to provider.ProvNum.
|
|
@@ -38,12 +43,13 @@ export default class LabCases {
|
|
|
38
43
|
* @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
|
|
39
44
|
* @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
|
|
40
45
|
* @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
|
|
41
|
-
|
|
46
|
+
* @returns {Promise<LabCase>} - The created lab case.
|
|
42
47
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
48
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
43
49
|
*/
|
|
44
50
|
createLabCase({ PatNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }: CreateLabCaseParams): Promise<LabCase>;
|
|
45
51
|
/**
|
|
46
|
-
* Update an
|
|
52
|
+
* Update an existing lab case.
|
|
47
53
|
* @param {Object} data - The details of lab case to update.
|
|
48
54
|
* @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
|
|
49
55
|
* @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
|
|
@@ -58,9 +64,18 @@ export default class LabCases {
|
|
|
58
64
|
* @param {string} [data.Instructions] - The text instructions for this labcase.
|
|
59
65
|
* @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
|
|
60
66
|
* @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
|
|
61
|
-
|
|
67
|
+
* @returns {Promise<LabCase>} - The updated lab case.
|
|
62
68
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
69
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
63
70
|
*/
|
|
64
71
|
updateLabCase({ LabCaseNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }: UpdateLabCaseParams): Promise<LabCase>;
|
|
72
|
+
/**
|
|
73
|
+
* Delete a LabCase record. Will fail if related records prevent deletion.
|
|
74
|
+
* @param {number} LabCaseNum - Required: The unique identifier of the LabCase to delete.
|
|
75
|
+
* @returns {Promise<void>} - Resolves when the LabCase is deleted.
|
|
76
|
+
* @throws {Error} - If LabCaseNum is not a valid number or the API returns an error.
|
|
77
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
78
|
+
*/
|
|
79
|
+
deleteLabCase(LabCaseNum: number): Promise<void>;
|
|
65
80
|
}
|
|
66
81
|
//# sourceMappingURL=labCases.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"labCases.d.ts","sourceRoot":"","sources":["../../src/api/labCases.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"labCases.d.ts","sourceRoot":"","sources":["../../src/api/labCases.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;OASG;IACU,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;;;;QAWI;IACS,WAAW,CAAC,EACvB,MAAM,EACN,aAAa,EACb,MAAM,EACN,aAAa,EACb,OAAO,EACP,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAgB5C;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,aAAa,EACb,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,MAAM,EACN,UAAU,GACX,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1C;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,aAAa,EACb,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,MAAM,EACN,UAAU,GACX,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1C;;;;;;OAMG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO9D"}
|
package/dist/api/labCases.js
CHANGED
|
@@ -8,12 +8,16 @@ class LabCases {
|
|
|
8
8
|
/**
|
|
9
9
|
* Fetch a single lab case by its ID.
|
|
10
10
|
* @param {number} LabCaseNum - The unique identifier for the LabCase.
|
|
11
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
12
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
13
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
11
14
|
* @returns {Promise<LabCase>} - The LabCase object.
|
|
12
|
-
* @throws {Error} - If
|
|
15
|
+
* @throws {Error} - If LabCaseNum is not provided.
|
|
16
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
13
17
|
*/
|
|
14
18
|
async getLabCase(LabCaseNum) {
|
|
15
19
|
if (!LabCaseNum) {
|
|
16
|
-
throw new Error("LabCaseNum is required.");
|
|
20
|
+
throw new Error("Invalid parameter: LabCaseNum is required.");
|
|
17
21
|
}
|
|
18
22
|
return this.httpClient.get(`/labcases/${LabCaseNum}`);
|
|
19
23
|
}
|
|
@@ -27,20 +31,24 @@ class LabCases {
|
|
|
27
31
|
* @param {number} [params.ProvNum] - FK to provider.ProvNum.
|
|
28
32
|
* @param {number} [params.Offset] - Pagination offset for results.
|
|
29
33
|
* @returns {Promise<LabCase[]>} - A list of lab cases.
|
|
34
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
30
35
|
*/
|
|
31
|
-
async getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum } = {}) {
|
|
36
|
+
async getLabCases({ PatNum, LaboratoryNum, AptNum, PlannedAptNum, ProvNum, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
32
37
|
const params = {
|
|
33
38
|
PatNum,
|
|
34
39
|
LaboratoryNum,
|
|
35
40
|
AptNum,
|
|
36
41
|
PlannedAptNum,
|
|
37
|
-
ProvNum
|
|
42
|
+
ProvNum,
|
|
43
|
+
Limit,
|
|
44
|
+
DateFormatString,
|
|
45
|
+
DateTimeFormatString,
|
|
38
46
|
};
|
|
39
47
|
return this.httpClient.get("/labcases", params);
|
|
40
48
|
}
|
|
41
49
|
/**
|
|
42
|
-
* Create a new
|
|
43
|
-
* @param {Object} data - The details of
|
|
50
|
+
* Create a new lab case.
|
|
51
|
+
* @param {Object} data - The details of the lab case to create.
|
|
44
52
|
* @param {number} data.PatNum - Required. FK to patient.PatNum.
|
|
45
53
|
* @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
|
|
46
54
|
* @param {number} data.ProvNum - Required. FK to provider.ProvNum.
|
|
@@ -54,12 +62,13 @@ class LabCases {
|
|
|
54
62
|
* @param {string} [data.Instructions] - Optional. The text instructions for this labcase.
|
|
55
63
|
* @param {number} [data.LabFee] - Optional. This is used for tracking and informational purposes only. The fee is not used in any calculation.
|
|
56
64
|
* @param {string} [data.InvoiceNum] - Optional. This is an optional invoice number used for tracking and informational purposes only.
|
|
57
|
-
|
|
65
|
+
* @returns {Promise<LabCase>} - The created lab case.
|
|
58
66
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
67
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
59
68
|
*/
|
|
60
69
|
async createLabCase({ PatNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }) {
|
|
61
70
|
if (!PatNum || !LaboratoryNum || !ProvNum) {
|
|
62
|
-
throw new Error("Invalid
|
|
71
|
+
throw new Error("Invalid parameter: PatNum, LaboratoryNum, and ProvNum are required.");
|
|
63
72
|
}
|
|
64
73
|
return this.httpClient.post("/labcases", {
|
|
65
74
|
PatNum,
|
|
@@ -78,7 +87,7 @@ class LabCases {
|
|
|
78
87
|
});
|
|
79
88
|
}
|
|
80
89
|
/**
|
|
81
|
-
* Update an
|
|
90
|
+
* Update an existing lab case.
|
|
82
91
|
* @param {Object} data - The details of lab case to update.
|
|
83
92
|
* @param {number} data.LabCaseNum - Required in the URL. The PK of the lab case.
|
|
84
93
|
* @param {number} [data.LaboratoryNum] - FK to laboratory.LaboratoryNum. The lab that the case gets sent to.
|
|
@@ -93,12 +102,13 @@ class LabCases {
|
|
|
93
102
|
* @param {string} [data.Instructions] - The text instructions for this labcase.
|
|
94
103
|
* @param {number} [data.LabFee] - This is used for tracking and informational purposes only. The fee is not used in any calculation.
|
|
95
104
|
* @param {string} [data.InvoiceNum] - This is an optional invoice number used for tracking and informational purposes only.
|
|
96
|
-
|
|
105
|
+
* @returns {Promise<LabCase>} - The updated lab case.
|
|
97
106
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
107
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
98
108
|
*/
|
|
99
109
|
async updateLabCase({ LabCaseNum, LaboratoryNum, ProvNum, AptNum, PlannedAptNum, DateTimeDue, DateTimeCreated, DateTimeSent, DateTimeRecd, DateTimeChecked, Instructions, LabFee, InvoiceNum, }) {
|
|
100
110
|
if (!LabCaseNum || typeof LabCaseNum !== "number") {
|
|
101
|
-
throw new Error("Invalid
|
|
111
|
+
throw new Error("Invalid parameter: LabCaseNum must be a valid number.");
|
|
102
112
|
}
|
|
103
113
|
return this.httpClient.put(`/labcases/${LabCaseNum}`, {
|
|
104
114
|
LaboratoryNum,
|
|
@@ -115,5 +125,18 @@ class LabCases {
|
|
|
115
125
|
InvoiceNum,
|
|
116
126
|
});
|
|
117
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* Delete a LabCase record. Will fail if related records prevent deletion.
|
|
130
|
+
* @param {number} LabCaseNum - Required: The unique identifier of the LabCase to delete.
|
|
131
|
+
* @returns {Promise<void>} - Resolves when the LabCase is deleted.
|
|
132
|
+
* @throws {Error} - If LabCaseNum is not a valid number or the API returns an error.
|
|
133
|
+
* @see https://www.opendental.com/site/apilabcases.html
|
|
134
|
+
*/
|
|
135
|
+
async deleteLabCase(LabCaseNum) {
|
|
136
|
+
if (!LabCaseNum || typeof LabCaseNum !== "number") {
|
|
137
|
+
throw new Error("Invalid parameter: LabCaseNum must be a valid number.");
|
|
138
|
+
}
|
|
139
|
+
return this.httpClient.delete(`/labcases/${LabCaseNum}`);
|
|
140
|
+
}
|
|
118
141
|
}
|
|
119
142
|
exports.default = LabCases;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import HttpClient from "../utils/httpClient";
|
|
2
|
+
import { LabTurnaround, GetLabTurnaroundsParams, CreateLabTurnaroundParams, UpdateLabTurnaroundParams } from "../types/labTurnaroundTypes";
|
|
3
|
+
export default class LabTurnarounds {
|
|
4
|
+
private httpClient;
|
|
5
|
+
constructor(httpClient: HttpClient);
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a single lab turnaround record by primary key.
|
|
8
|
+
* @param {number} LabTurnaroundNum - Required. Primary key of the lab turnaround record.
|
|
9
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
10
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
11
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
12
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
13
|
+
* @returns {Promise<LabTurnaround>} - The lab turnaround record.
|
|
14
|
+
* @throws {Error} - If LabTurnaroundNum is not a valid number.
|
|
15
|
+
* @see https://www.opendental.com/site/apilabturnarounds.html
|
|
16
|
+
*/
|
|
17
|
+
getLabTurnaround(LabTurnaroundNum: number): Promise<LabTurnaround>;
|
|
18
|
+
/**
|
|
19
|
+
* Retrieves multiple lab turnaround records, optionally filtered by laboratory.
|
|
20
|
+
* @param {Object} [params] - Optional filter parameters.
|
|
21
|
+
* @param {number} [params.LaboratoryNum] - Optional. FK to laboratory.LaboratoryNum; filters to a single lab.
|
|
22
|
+
* @returns {Promise<LabTurnaround[]>} - Array of lab turnaround records.
|
|
23
|
+
* @see https://www.opendental.com/site/apilabturnarounds.html
|
|
24
|
+
*/
|
|
25
|
+
getLabTurnarounds(params?: GetLabTurnaroundsParams): Promise<LabTurnaround[]>;
|
|
26
|
+
/**
|
|
27
|
+
* Creates a new lab turnaround record for a laboratory.
|
|
28
|
+
* @param {Object} data - The details of the lab turnaround to create.
|
|
29
|
+
* @param {number} data.LaboratoryNum - Required. FK to laboratory.LaboratoryNum.
|
|
30
|
+
* @param {string} data.Description - Required. Description of the service the lab is performing.
|
|
31
|
+
* @param {number} data.DaysActual - Required. Actual turnaround days including travel; used for due-date calculations.
|
|
32
|
+
* @param {number} [data.DaysPublished] - Optional. Days the lab publishes as turnaround time.
|
|
33
|
+
* @returns {Promise<LabTurnaround>} - The created lab turnaround record with assigned LabTurnaroundNum.
|
|
34
|
+
* @throws {Error} - If LaboratoryNum is not a valid number, Description is missing, or DaysActual is not provided.
|
|
35
|
+
* @see https://www.opendental.com/site/apilabturnarounds.html
|
|
36
|
+
*/
|
|
37
|
+
createLabTurnaround(data: CreateLabTurnaroundParams): Promise<LabTurnaround>;
|
|
38
|
+
/**
|
|
39
|
+
* Updates an existing lab turnaround record. All body fields are optional.
|
|
40
|
+
* LaboratoryNum cannot be changed; to reassign to a different lab, delete and recreate.
|
|
41
|
+
* @param {Object} data - The details of the lab turnaround to update.
|
|
42
|
+
* @param {number} data.LabTurnaroundNum - Required. Primary key of the record to update.
|
|
43
|
+
* @param {string} [data.Description] - Optional. Service description; overwrites existing value.
|
|
44
|
+
* @param {number} [data.DaysPublished] - Optional. Published turnaround days.
|
|
45
|
+
* @param {number} [data.DaysActual] - Optional. Actual turnaround days including travel; used for due-date calculations.
|
|
46
|
+
* @returns {Promise<LabTurnaround>} - The updated lab turnaround record.
|
|
47
|
+
* @throws {Error} - If LabTurnaroundNum is not a valid number.
|
|
48
|
+
* @see https://www.opendental.com/site/apilabturnarounds.html
|
|
49
|
+
*/
|
|
50
|
+
updateLabTurnaround(data: UpdateLabTurnaroundParams): Promise<LabTurnaround>;
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=labTurnarounds.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"labTurnarounds.d.ts","sourceRoot":"","sources":["../../src/api/labTurnarounds.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ/E;;;;;;OAMG;IACU,iBAAiB,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI1F;;;;;;;;;;OAUG;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;IAczF;;;;;;;;;;;OAWG;IACU,mBAAmB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC;CAQ1F"}
|