@ovok/core 0.4.49-rc.3 → 0.4.49-rc.5

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.
Files changed (421) hide show
  1. package/README.md +23 -666
  2. package/dist/client/ai-fhir/methods/AIFhirResources.d.ts +3 -1
  3. package/dist/client/ai-fhir/methods/AIFhirResources.js +3 -1
  4. package/dist/client/ai-fhir/types/AIFhirPlan.d.ts +8 -0
  5. package/dist/client/ai-fhir/types/AIFhirPlanRequest.d.ts +8 -0
  6. package/dist/client/ai-fhir/types/AIFhirRequest.d.ts +5 -0
  7. package/dist/client/ai-fhir/types/AIFhirResponse.d.ts +6 -0
  8. package/dist/client/auth/errors.d.ts +15 -2
  9. package/dist/client/auth/errors.js +12 -2
  10. package/dist/client/auth/methods/appleLogin.d.ts +1 -0
  11. package/dist/client/auth/methods/appleLogin.js +1 -0
  12. package/dist/client/auth/methods/changePassword.d.ts +1 -0
  13. package/dist/client/auth/methods/changePassword.js +1 -0
  14. package/dist/client/auth/methods/googleLogin.d.ts +1 -0
  15. package/dist/client/auth/methods/googleLogin.js +1 -0
  16. package/dist/client/auth/methods/login.d.ts +6 -0
  17. package/dist/client/auth/methods/login.js +6 -0
  18. package/dist/client/auth/methods/register.d.ts +5 -0
  19. package/dist/client/auth/methods/register.js +5 -0
  20. package/dist/client/auth/methods/registerPractitioner.d.ts +5 -0
  21. package/dist/client/auth/methods/registerPractitioner.js +5 -0
  22. package/dist/client/auth/methods/reloadSession.d.ts +3 -0
  23. package/dist/client/auth/methods/requestDeleteUser.d.ts +4 -5
  24. package/dist/client/auth/methods/requestDeleteUser.js +4 -5
  25. package/dist/client/auth/methods/setPasswordFromReset.d.ts +1 -0
  26. package/dist/client/auth/methods/setPasswordFromReset.js +1 -0
  27. package/dist/client/auth/session-fetch.d.ts +11 -0
  28. package/dist/client/auth/types/Account.d.ts +8 -1
  29. package/dist/client/auth/types/AppleLoginBody.d.ts +16 -0
  30. package/dist/client/auth/types/AppleLoginBody.js +5 -0
  31. package/dist/client/auth/types/AuthResponse.d.ts +12 -0
  32. package/dist/client/auth/types/ChangePasswordBody.d.ts +7 -0
  33. package/dist/client/auth/types/ChangePasswordResponse.d.ts +5 -0
  34. package/dist/client/auth/types/CompletePasswordResetBody.d.ts +8 -0
  35. package/dist/client/auth/types/GoogleLoginBody.d.ts +5 -0
  36. package/dist/client/auth/types/LoginBody.d.ts +15 -1
  37. package/dist/client/auth/types/LoginError.d.ts +21 -2
  38. package/dist/client/auth/types/LoginError.js +8 -2
  39. package/dist/client/auth/types/LoginResponse.d.ts +8 -1
  40. package/dist/client/auth/types/RegisterBody.d.ts +12 -0
  41. package/dist/client/auth/types/RegisterPractitionerBody.d.ts +5 -0
  42. package/dist/client/auth/types/RegisterResponse.d.ts +7 -0
  43. package/dist/client/auth/types/RequestDeleteUserBody.d.ts +7 -7
  44. package/dist/client/auth/types/RequestDeleteUserResponse.d.ts +14 -0
  45. package/dist/client/auth/types/ResetPasswordBody.d.ts +5 -0
  46. package/dist/client/auth/types/Session.d.ts +14 -2
  47. package/dist/client/change-history/methods.d.ts +6 -0
  48. package/dist/client/change-history/methods.js +6 -0
  49. package/dist/client/change-history/types.d.ts +82 -0
  50. package/dist/client/chat/ai/methods/createAiSession.d.ts +6 -0
  51. package/dist/client/chat/ai/methods/createAiSession.js +6 -0
  52. package/dist/client/chat/ai/types/CreateAiSessionResponse.d.ts +17 -0
  53. package/dist/client/chat/ai/types/SessionMessagesResponse.d.ts +9 -0
  54. package/dist/client/cms/locale.d.ts +12 -2
  55. package/dist/client/cms/locale.js +9 -2
  56. package/dist/client/cms/methods.d.ts +6 -2
  57. package/dist/client/cms/methods.js +7 -3
  58. package/dist/client/cms/types.d.ts +44 -4
  59. package/dist/client/consent/methods.d.ts +16 -0
  60. package/dist/client/consent/methods.js +16 -0
  61. package/dist/client/consent/types.d.ts +53 -1
  62. package/dist/client/consent/types.js +10 -1
  63. package/dist/client/email/methods.d.ts +3 -0
  64. package/dist/client/email/methods.js +3 -0
  65. package/dist/client/email/types.d.ts +33 -0
  66. package/dist/client/errors/field-errors.d.ts +3 -0
  67. package/dist/client/errors/field-errors.js +3 -0
  68. package/dist/client/errors/ovok-error-utils.d.ts +6 -0
  69. package/dist/client/errors/ovok-error-utils.js +6 -0
  70. package/dist/client/errors/ovok-error.d.ts +36 -4
  71. package/dist/client/errors/ovok-error.js +15 -4
  72. package/dist/client/errors/rate-limit-error.d.ts +11 -2
  73. package/dist/client/errors/rate-limit-error.js +10 -2
  74. package/dist/client/errors/sign-in-required-error.d.ts +5 -2
  75. package/dist/client/errors/sign-in-required-error.js +5 -2
  76. package/dist/client/experience/methods.d.ts +38 -0
  77. package/dist/client/experience/methods.js +35 -0
  78. package/dist/client/experience/types.d.ts +316 -0
  79. package/dist/client/experience/types.js +1 -0
  80. package/dist/client/invites/methods.d.ts +27 -9
  81. package/dist/client/invites/methods.js +27 -9
  82. package/dist/client/invites/parse-accept-invite-link.d.ts +3 -1
  83. package/dist/client/invites/parse-accept-invite-link.js +3 -1
  84. package/dist/client/invites/types.d.ts +55 -0
  85. package/dist/client/invites/types.js +12 -0
  86. package/dist/client/notifications/methods.d.ts +15 -0
  87. package/dist/client/notifications/methods.js +15 -0
  88. package/dist/client/notifications/types.d.ts +249 -2
  89. package/dist/client/observation/bundle-entry-status.d.ts +3 -0
  90. package/dist/client/observation/bundle-entry-status.js +13 -0
  91. package/dist/client/observation/fhir-systems.d.ts +7 -0
  92. package/dist/client/observation/fhir-systems.js +8 -1
  93. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.d.ts +3 -0
  94. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js +10 -65
  95. package/dist/client/observation/methods/getLatestObservationsByCodes.d.ts +3 -0
  96. package/dist/client/observation/methods/getLatestObservationsByCodes.js +3 -0
  97. package/dist/client/observation/methods/observationsToMeasurements.d.ts +23 -1
  98. package/dist/client/observation/methods/observationsToMeasurements.js +72 -12
  99. package/dist/client/observation/methods/saveMeasurement.d.ts +3 -1
  100. package/dist/client/observation/methods/saveMeasurement.js +3 -1
  101. package/dist/client/observation/observation-bundle-utils.d.ts +11 -7
  102. package/dist/client/observation/observation-bundle-utils.js +61 -71
  103. package/dist/client/observation/observation-coding.d.ts +12 -0
  104. package/dist/client/observation/observation-coding.js +69 -0
  105. package/dist/client/observation/observation-groups.d.ts +12 -0
  106. package/dist/client/observation/observation-groups.js +51 -0
  107. package/dist/client/observation/reading-group-backfill.d.ts +13 -0
  108. package/dist/client/observation/reading-group-backfill.js +79 -0
  109. package/dist/client/observation/reading-group.d.ts +14 -0
  110. package/dist/client/observation/reading-group.js +85 -0
  111. package/dist/client/observation/series.d.ts +28 -5
  112. package/dist/client/observation/series.js +16 -6
  113. package/dist/client/observation/services/base-observation-service.d.ts +1 -1
  114. package/dist/client/observation/services/base-observation-service.js +6 -12
  115. package/dist/client/observation/services/blood-pressure.d.ts +2 -0
  116. package/dist/client/observation/services/blood-pressure.js +9 -5
  117. package/dist/client/observation/services/component-observation-services.js +2 -2
  118. package/dist/client/observation/services/creator.d.ts +5 -0
  119. package/dist/client/observation/services/creator.js +5 -0
  120. package/dist/client/observation/services/ecg-observation-fragments.d.ts +4 -0
  121. package/dist/client/observation/services/ecg-observation-fragments.js +30 -37
  122. package/dist/client/observation/services/ecg.d.ts +3 -1
  123. package/dist/client/observation/services/ecg.js +19 -19
  124. package/dist/client/observation/services/uric-acid-service.js +2 -13
  125. package/dist/client/observation/services/urine-analyte-values.d.ts +4 -0
  126. package/dist/client/observation/services/urine-analyte-values.js +27 -0
  127. package/dist/client/observation/types/GetLatestObservationsByCodeParams.d.ts +10 -0
  128. package/dist/client/observation/types/MeasurementTypeKey.d.ts +26 -0
  129. package/dist/client/observation/types/MeasurementTypeKey.js +26 -0
  130. package/dist/client/observation/types/ObservationCode.d.ts +64 -1
  131. package/dist/client/observation/types/ObservationCode.js +64 -1
  132. package/dist/client/observation/types/UrineAnalytes.d.ts +29 -0
  133. package/dist/client/observation/types/UrineAnalytes.js +18 -9
  134. package/dist/client/observation/types/generate-measurement/Sample.d.ts +33 -0
  135. package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts +9 -0
  136. package/dist/client/observation/types/measurement/BabySleepMeasurement.d.ts +3 -0
  137. package/dist/client/observation/types/measurement/BloodGlucoseMeasurement.d.ts +7 -0
  138. package/dist/client/observation/types/measurement/BloodPressureMeasurement.d.ts +10 -0
  139. package/dist/client/observation/types/measurement/BloodPressureStates.d.ts +10 -0
  140. package/dist/client/observation/types/measurement/BloodPressureStates.js +10 -0
  141. package/dist/client/observation/types/measurement/BodyTemperatureMeasurement.d.ts +7 -0
  142. package/dist/client/observation/types/measurement/BodyWeightMeasurmement.d.ts +8 -0
  143. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.d.ts +18 -0
  144. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.js +18 -0
  145. package/dist/client/observation/types/measurement/EcgMeasurement.d.ts +9 -0
  146. package/dist/client/observation/types/measurement/HeartRateMeasurement.d.ts +7 -0
  147. package/dist/client/observation/types/measurement/HeartRateVariabilityMeasurement.d.ts +7 -0
  148. package/dist/client/observation/types/measurement/LipidPanelMeasurement.d.ts +12 -0
  149. package/dist/client/observation/types/measurement/Measurement.d.ts +9 -0
  150. package/dist/client/observation/types/measurement/MeasurementDevice.d.ts +10 -0
  151. package/dist/client/observation/types/measurement/MeasurementSeries.d.ts +2 -0
  152. package/dist/client/observation/types/measurement/PulseOximeterMeasurement.d.ts +10 -0
  153. package/dist/client/observation/types/measurement/RespiratoryRateMeasurement.d.ts +7 -0
  154. package/dist/client/observation/types/measurement/RespiratoryTherapyMeasurement.d.ts +3 -0
  155. package/dist/client/observation/types/measurement/RestingHeartRateMeasurement.d.ts +7 -0
  156. package/dist/client/observation/types/measurement/SpirometryMeasurement.d.ts +23 -0
  157. package/dist/client/observation/types/measurement/StepCountMeasurement.d.ts +9 -0
  158. package/dist/client/observation/types/measurement/UrineAnalyzeMeasurement.d.ts +29 -0
  159. package/dist/client/observation/types/measurement/Vo2MaxMeasurement.d.ts +7 -0
  160. package/dist/client/observation/types/measurement/WalkingHeartRateAverageMeasurement.d.ts +7 -0
  161. package/dist/client/observation/types/service/MeasurementField.d.ts +5 -1
  162. package/dist/client/observation/utils/getDeviceObject.js +15 -32
  163. package/dist/client/observation/utils/getObservationValueDisplay.d.ts +2 -0
  164. package/dist/client/offline/offline-measurement-queue.d.ts +56 -1
  165. package/dist/client/offline/offline-measurement-queue.js +23 -8
  166. package/dist/client/offline/shared-measurement-queue.d.ts +16 -1
  167. package/dist/client/offline/shared-measurement-queue.js +3 -1
  168. package/dist/client/ovok-client.d.ts +28 -6
  169. package/dist/client/ovok-client.js +19 -11
  170. package/dist/client/patient/methods.d.ts +21 -0
  171. package/dist/client/patient/methods.js +21 -0
  172. package/dist/client/patient/types.d.ts +131 -0
  173. package/dist/client/patient-sharing/methods.d.ts +18 -0
  174. package/dist/client/patient-sharing/methods.js +18 -0
  175. package/dist/client/patient-sharing/types.d.ts +89 -1
  176. package/dist/client/platform/methods.d.ts +22 -0
  177. package/dist/client/platform/methods.js +20 -0
  178. package/dist/client/platform/types.d.ts +194 -1
  179. package/dist/client/platform/types.js +24 -0
  180. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.d.ts +3 -0
  181. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.js +3 -0
  182. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.d.ts +3 -0
  183. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.js +3 -0
  184. package/dist/client/questionnaire-response/methods/populateQuestionnaire.d.ts +3 -0
  185. package/dist/client/questionnaire-response/methods/populateQuestionnaire.js +3 -0
  186. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.d.ts +3 -0
  187. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.js +3 -0
  188. package/dist/client/questionnaire-response/types.d.ts +6 -0
  189. package/dist/client/signals/errors.d.ts +13 -2
  190. package/dist/client/signals/errors.js +9 -2
  191. package/dist/client/signals/methods.d.ts +9 -0
  192. package/dist/client/signals/methods.js +9 -0
  193. package/dist/client/signals/types.d.ts +31 -0
  194. package/dist/client/slim/methods.d.ts +268 -21
  195. package/dist/client/slim/methods.js +264 -21
  196. package/dist/client/slim/paging.d.ts +22 -2
  197. package/dist/client/slim/paging.js +6 -2
  198. package/dist/client/slim/types.d.ts +920 -1
  199. package/dist/client/storage.d.ts +15 -1
  200. package/dist/client/storage.js +7 -1
  201. package/dist/client/wearables/methods.d.ts +24 -0
  202. package/dist/client/wearables/methods.js +24 -0
  203. package/dist/client/wearables/types.d.ts +74 -0
  204. package/dist/conformance/api-requirements.d.ts +31 -5
  205. package/dist/conformance/api-requirements.js +47 -10
  206. package/dist/conformance/capability-requirements.d.ts +4 -26
  207. package/dist/conformance/capability-requirements.js +5 -27
  208. package/dist/conformance/capability.d.ts +9 -1
  209. package/dist/conformance/capability.js +3 -1
  210. package/dist/hooks/account-hooks.d.ts +35 -0
  211. package/dist/hooks/account-hooks.js +33 -0
  212. package/dist/hooks/api-hooks.d.ts +74 -4
  213. package/dist/hooks/api-hooks.js +56 -4
  214. package/dist/hooks/cms-hooks.d.ts +9 -3
  215. package/dist/hooks/cms-hooks.js +9 -3
  216. package/dist/hooks/email-hooks.d.ts +3 -0
  217. package/dist/hooks/email-hooks.js +3 -0
  218. package/dist/hooks/experience-hooks.d.ts +26 -0
  219. package/dist/hooks/experience-hooks.js +24 -0
  220. package/dist/hooks/index.d.ts +18 -0
  221. package/dist/hooks/index.js +18 -0
  222. package/dist/hooks/invites-hooks.d.ts +21 -2
  223. package/dist/hooks/invites-hooks.js +21 -2
  224. package/dist/hooks/notification-ack-hooks.d.ts +6 -2
  225. package/dist/hooks/notification-ack-hooks.js +6 -2
  226. package/dist/hooks/notification-hooks.d.ts +27 -3
  227. package/dist/hooks/notification-hooks.js +27 -3
  228. package/dist/hooks/notification-note-hooks.d.ts +41 -0
  229. package/dist/hooks/notification-note-hooks.js +33 -0
  230. package/dist/hooks/observation-hooks.d.ts +30 -0
  231. package/dist/hooks/observation-hooks.js +26 -3
  232. package/dist/hooks/patient-hooks.d.ts +53 -0
  233. package/dist/hooks/patient-hooks.js +48 -0
  234. package/dist/hooks/patient-sharing-hooks.d.ts +18 -0
  235. package/dist/hooks/patient-sharing-hooks.js +18 -0
  236. package/dist/hooks/platform-hooks.d.ts +32 -0
  237. package/dist/hooks/platform-hooks.js +23 -0
  238. package/dist/hooks/poll-hooks.d.ts +17 -1
  239. package/dist/hooks/poll-hooks.js +3 -1
  240. package/dist/hooks/signals-hooks.d.ts +3 -0
  241. package/dist/hooks/signals-hooks.js +3 -0
  242. package/dist/hooks/wearables-hooks.d.ts +23 -0
  243. package/dist/hooks/wearables-hooks.js +21 -0
  244. package/dist/index.d.ts +1 -965
  245. package/dist/index.js +1 -71
  246. package/dist/next/auth/saved-accounts-store.d.ts +10 -0
  247. package/dist/next/auth/session.d.ts +17 -0
  248. package/dist/next/auth/user-session.d.ts +5 -0
  249. package/dist/next/config/ovok-config.d.ts +45 -0
  250. package/dist/next/errors/ovok-account-error.d.ts +14 -1
  251. package/dist/next/errors/ovok-account-error.js +8 -1
  252. package/dist/next/errors/ovok-errors.d.ts +88 -0
  253. package/dist/next/errors/ovok-errors.js +67 -0
  254. package/dist/next/http/http-client.d.ts +5 -0
  255. package/dist/next/http/transmit.d.ts +7 -0
  256. package/dist/next/http/url.d.ts +10 -0
  257. package/dist/next/ovok.d.ts +31 -1
  258. package/dist/next/ovok.js +5 -1
  259. package/dist/next/paging/page.d.ts +13 -1
  260. package/dist/next/react/context.d.ts +7 -0
  261. package/dist/next/react/context.js +7 -0
  262. package/dist/next/react/index.d.ts +24 -0
  263. package/dist/next/react/index.js +18 -0
  264. package/dist/next/react/query-hooks.d.ts +69 -0
  265. package/dist/next/react/query-hooks.js +31 -0
  266. package/dist/next/resources/accounts/accounts-resource.d.ts +6 -0
  267. package/dist/next/resources/accounts/accounts-resource.js +6 -0
  268. package/dist/next/resources/ai/ai-chat-resource.d.ts +7 -0
  269. package/dist/next/resources/ai/ai-chat-resource.js +5 -0
  270. package/dist/next/resources/ai/ai-resource.d.ts +13 -0
  271. package/dist/next/resources/ai/ai-resource.js +6 -0
  272. package/dist/next/resources/ai/chat-messages-resource.d.ts +7 -0
  273. package/dist/next/resources/ai/chat-messages-resource.js +7 -0
  274. package/dist/next/resources/ai/chat-sessions-resource.d.ts +14 -0
  275. package/dist/next/resources/ai/chat-sessions-resource.js +8 -0
  276. package/dist/next/resources/auth/auth-sessions-resource.d.ts +6 -1
  277. package/dist/next/resources/auth/auth-sessions-resource.js +6 -1
  278. package/dist/next/resources/auth/registration.d.ts +18 -1
  279. package/dist/next/resources/auth/social-login.d.ts +12 -0
  280. package/dist/next/resources/auth-resource.d.ts +54 -1
  281. package/dist/next/resources/auth-resource.js +23 -0
  282. package/dist/next/resources/bots/bots-resource.d.ts +15 -0
  283. package/dist/next/resources/bots/bots-resource.js +5 -0
  284. package/dist/next/resources/cms/cms-delivery.d.ts +14 -2
  285. package/dist/next/resources/cms/cms-documents-resource.d.ts +7 -1
  286. package/dist/next/resources/cms/cms-documents-resource.js +7 -1
  287. package/dist/next/resources/cms/cms-resource.d.ts +7 -0
  288. package/dist/next/resources/cms/cms-resource.js +5 -0
  289. package/dist/next/resources/cms/release-notes-resource.d.ts +6 -0
  290. package/dist/next/resources/cms/release-notes-resource.js +6 -0
  291. package/dist/next/resources/consent/consent-resource.d.ts +22 -0
  292. package/dist/next/resources/consent/consent-resource.js +20 -0
  293. package/dist/next/resources/content/content-resource.d.ts +18 -0
  294. package/dist/next/resources/content/content-resource.js +12 -0
  295. package/dist/next/resources/documents/documents-resource.d.ts +24 -0
  296. package/dist/next/resources/documents/documents-resource.js +10 -0
  297. package/dist/next/resources/email/email-resource.d.ts +6 -0
  298. package/dist/next/resources/email/email-resource.js +5 -0
  299. package/dist/next/resources/email/email-templates-resource.d.ts +6 -0
  300. package/dist/next/resources/email/email-templates-resource.js +6 -0
  301. package/dist/next/resources/fhir-resource.d.ts +36 -0
  302. package/dist/next/resources/fhir-resource.js +21 -0
  303. package/dist/next/resources/health-resource.d.ts +16 -0
  304. package/dist/next/resources/health-resource.js +5 -0
  305. package/dist/next/resources/invites/invite-flow-resource.d.ts +7 -1
  306. package/dist/next/resources/invites/invite-flow-resource.js +7 -1
  307. package/dist/next/resources/invites/invites-resource.d.ts +15 -0
  308. package/dist/next/resources/invites/invites-resource.js +5 -0
  309. package/dist/next/resources/localization/i18next-resource.d.ts +6 -0
  310. package/dist/next/resources/localization/i18next-resource.js +6 -0
  311. package/dist/next/resources/localization/locales-resource.d.ts +7 -0
  312. package/dist/next/resources/localization/locales-resource.js +7 -0
  313. package/dist/next/resources/localization/localizations-resource.d.ts +17 -0
  314. package/dist/next/resources/localization/localizations-resource.js +9 -0
  315. package/dist/next/resources/measurements/measurements-resource.d.ts +64 -3
  316. package/dist/next/resources/measurements/measurements-resource.js +45 -6
  317. package/dist/next/resources/measurements/observation-builder.d.ts +6 -1
  318. package/dist/next/resources/measurements/observation-builder.js +16 -7
  319. package/dist/next/resources/measurements/offline-measurement-queue-types.d.ts +32 -0
  320. package/dist/next/resources/measurements/save-error.js +3 -4
  321. package/dist/next/resources/patient/fhir-records.d.ts +19 -1
  322. package/dist/next/resources/patient/fhir-records.js +19 -1
  323. package/dist/next/resources/patient/patient-resource.d.ts +15 -0
  324. package/dist/next/resources/patient/patient-resource.js +6 -0
  325. package/dist/next/resources/projects/project-features-resource.d.ts +7 -0
  326. package/dist/next/resources/projects/project-features-resource.js +7 -0
  327. package/dist/next/resources/projects/project-members-resource.d.ts +19 -0
  328. package/dist/next/resources/projects/project-members-resource.js +9 -0
  329. package/dist/next/resources/projects/project-settings-resource.d.ts +8 -0
  330. package/dist/next/resources/projects/project-settings-resource.js +8 -0
  331. package/dist/next/resources/projects/projects-resource.d.ts +15 -0
  332. package/dist/next/resources/projects/projects-resource.js +5 -0
  333. package/dist/next/resources/questionnaires/questionnaires-resource.d.ts +13 -0
  334. package/dist/next/resources/questionnaires/questionnaires-resource.js +13 -0
  335. package/dist/next/resources/realtime/realtime-resource.d.ts +11 -0
  336. package/dist/next/resources/realtime/realtime-resource.js +11 -0
  337. package/dist/next/resources/realtime/realtime-socket.js +12 -5
  338. package/dist/next/resources/realtime/realtime-types.d.ts +19 -1
  339. package/dist/next/resources/session/saved-accounts-resource.d.ts +16 -0
  340. package/dist/next/resources/session/saved-accounts-resource.js +16 -0
  341. package/dist/next/resources/session/session-resource.d.ts +8 -0
  342. package/dist/next/resources/session/session-resource.js +7 -0
  343. package/dist/next/resources/sharing/sharing-invites-resource.d.ts +7 -0
  344. package/dist/next/resources/sharing/sharing-invites-resource.js +7 -0
  345. package/dist/next/resources/sharing/sharing-resource.d.ts +8 -0
  346. package/dist/next/resources/sharing/sharing-resource.js +5 -0
  347. package/dist/next/resources/sharing/sharing-settings-resource.d.ts +7 -0
  348. package/dist/next/resources/sharing/sharing-settings-resource.js +7 -0
  349. package/dist/next/resources/sharing/sharing-shares-resource.d.ts +7 -0
  350. package/dist/next/resources/sharing/sharing-shares-resource.js +7 -0
  351. package/dist/next/resources/signals/signals-gateway-resource.d.ts +15 -0
  352. package/dist/next/resources/signals/signals-gateway-resource.js +6 -0
  353. package/dist/next/resources/signals/signals-resource.d.ts +7 -0
  354. package/dist/next/resources/signals/signals-resource.js +5 -0
  355. package/dist/next/resources/signals/undeliverable-resource.d.ts +35 -0
  356. package/dist/next/resources/signals/undeliverable-resource.js +6 -0
  357. package/dist/next/resources/slim/slim-alarms-resource.d.ts +7 -0
  358. package/dist/next/resources/slim/slim-alarms-resource.js +7 -0
  359. package/dist/next/resources/slim/slim-change-history-resource.d.ts +6 -0
  360. package/dist/next/resources/slim/slim-change-history-resource.js +6 -0
  361. package/dist/next/resources/slim/slim-child-projects-resource.d.ts +21 -0
  362. package/dist/next/resources/slim/slim-child-projects-resource.js +8 -0
  363. package/dist/next/resources/slim/slim-devices-resource.d.ts +31 -0
  364. package/dist/next/resources/slim/slim-devices-resource.js +16 -0
  365. package/dist/next/resources/slim/slim-exports-resource.d.ts +6 -0
  366. package/dist/next/resources/slim/slim-exports-resource.js +6 -0
  367. package/dist/next/resources/slim/slim-locations-resource.d.ts +9 -0
  368. package/dist/next/resources/slim/slim-locations-resource.js +9 -0
  369. package/dist/next/resources/slim/slim-medical-notifications-resource.d.ts +6 -0
  370. package/dist/next/resources/slim/slim-medical-notifications-resource.js +6 -0
  371. package/dist/next/resources/slim/slim-notification-notes-resource.d.ts +10 -0
  372. package/dist/next/resources/slim/slim-notification-notes-resource.js +10 -0
  373. package/dist/next/resources/slim/slim-notifications-resource.d.ts +10 -0
  374. package/dist/next/resources/slim/slim-notifications-resource.js +6 -0
  375. package/dist/next/resources/slim/slim-organizations-resource.d.ts +9 -0
  376. package/dist/next/resources/slim/slim-organizations-resource.js +9 -0
  377. package/dist/next/resources/slim/slim-out-of-bed-resource.d.ts +12 -0
  378. package/dist/next/resources/slim/slim-out-of-bed-resource.js +7 -0
  379. package/dist/next/resources/slim/slim-patient-thresholds-resource.d.ts +6 -0
  380. package/dist/next/resources/slim/slim-patient-thresholds-resource.js +6 -0
  381. package/dist/next/resources/slim/slim-patients-resource.d.ts +11 -0
  382. package/dist/next/resources/slim/slim-patients-resource.js +10 -0
  383. package/dist/next/resources/slim/slim-policies-resource.d.ts +10 -0
  384. package/dist/next/resources/slim/slim-policies-resource.js +10 -0
  385. package/dist/next/resources/slim/slim-practitioners-resource.d.ts +6 -0
  386. package/dist/next/resources/slim/slim-practitioners-resource.js +6 -0
  387. package/dist/next/resources/slim/slim-projects-resource.d.ts +12 -0
  388. package/dist/next/resources/slim/slim-projects-resource.js +11 -0
  389. package/dist/next/resources/slim/slim-queries.d.ts +51 -0
  390. package/dist/next/resources/slim/slim-resource.d.ts +21 -0
  391. package/dist/next/resources/slim/slim-resource.js +6 -0
  392. package/dist/next/resources/slim/slim-sleep-resource.d.ts +6 -0
  393. package/dist/next/resources/slim/slim-sleep-resource.js +6 -0
  394. package/dist/next/resources/slim/slim-thresholds-resource.d.ts +5 -0
  395. package/dist/next/resources/slim/slim-thresholds-resource.js +5 -0
  396. package/dist/next/resources/slim/slim-trends-resource.d.ts +6 -0
  397. package/dist/next/resources/slim/slim-trends-resource.js +6 -0
  398. package/dist/next/resources/slim/slim-users-resource.d.ts +12 -0
  399. package/dist/next/resources/slim/slim-users-resource.js +6 -0
  400. package/dist/next/resources/slim/slim-zones-resource.d.ts +8 -0
  401. package/dist/next/resources/slim/slim-zones-resource.js +8 -0
  402. package/dist/next/resources/video-calls/video-call-access-resource.d.ts +13 -0
  403. package/dist/next/resources/video-calls/video-call-access-resource.js +8 -0
  404. package/dist/next/resources/video-calls/video-call-appointments-resource.d.ts +8 -0
  405. package/dist/next/resources/video-calls/video-call-appointments-resource.js +8 -0
  406. package/dist/next/resources/video-calls/video-call-emails-resource.d.ts +8 -0
  407. package/dist/next/resources/video-calls/video-call-emails-resource.js +8 -0
  408. package/dist/next/resources/video-calls/video-calls-resource.d.ts +14 -0
  409. package/dist/next/resources/video-calls/video-calls-resource.js +6 -0
  410. package/dist/next/resources/wearables/wearable-connections-resource.d.ts +8 -0
  411. package/dist/next/resources/wearables/wearable-connections-resource.js +8 -0
  412. package/dist/next/resources/wearables/wearable-providers-resource.d.ts +10 -0
  413. package/dist/next/resources/wearables/wearable-providers-resource.js +10 -0
  414. package/dist/next/resources/wearables/wearables-resource.d.ts +7 -0
  415. package/dist/next/resources/wearables/wearables-resource.js +5 -0
  416. package/dist/next/storage/ovok-storage.d.ts +16 -0
  417. package/dist/next/storage/ovok-storage.js +8 -0
  418. package/dist/types/ValidationError.d.ts +9 -0
  419. package/dist/utils/patch/getPatchOperationType.d.ts +3 -0
  420. package/dist/utils/patch/getPatchOperationType.js +3 -0
  421. package/package.json +52 -13
@@ -1,8 +1,14 @@
1
1
  import type { SlimExportPdf, SlimExportPdfRequest } from "../../../client/slim/types";
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
+ /**
5
+ * Exports of slim data.
6
+ *
7
+ * @category slim
8
+ */
4
9
  export declare class SlimExportsResource {
5
10
  private readonly http;
6
11
  constructor(http: HttpClient);
12
+ /** Generates a patient PDF export. Calls `POST v1/slim/export/pdf`. */
7
13
  patientPdf(body: SlimExportPdfRequest, options?: RequestOptions): Promise<SlimExportPdf>;
8
14
  }
@@ -3,10 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SlimExportsResource = void 0;
4
4
  const slim_paths_1 = require("./slim-paths");
5
5
  const PATIENT_PDF_PATH = `${slim_paths_1.SLIM_PATH}/export/pdf`;
6
+ /**
7
+ * Exports of slim data.
8
+ *
9
+ * @category slim
10
+ */
6
11
  class SlimExportsResource {
7
12
  constructor(http) {
8
13
  this.http = http;
9
14
  }
15
+ /** Generates a patient PDF export. Calls `POST v1/slim/export/pdf`. */
10
16
  patientPdf(body, options) {
11
17
  return this.http.post(PATIENT_PDF_PATH, body, options);
12
18
  }
@@ -2,13 +2,22 @@ import type { SlimCreateLocation, SlimLocation, SlimLocationQuery, SlimUpdateLoc
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
4
  import { PagePromise } from "../../paging/page";
5
+ /**
6
+ * Locations such as rooms and zones.
7
+ *
8
+ * @category slim
9
+ */
5
10
  export declare class SlimLocationsResource {
6
11
  private readonly http;
7
12
  constructor(http: HttpClient);
13
+ /** Lists locations page by page. Calls `GET v1/slim/location`. */
8
14
  list(params?: SlimLocationQuery, options?: RequestOptions): PagePromise<SlimLocation>;
15
+ /** Fetches one location. Calls `GET v1/slim/location/{locationId}`. */
9
16
  retrieve(locationId: string, options?: RequestOptions): Promise<SlimLocation>;
17
+ /** Creates a location. Calls `POST v1/slim/location`. */
10
18
  create(body: SlimCreateLocation, options?: RequestOptions): Promise<SlimLocation>;
11
19
  /** A 422 "Device not found" means the requested device is unreadable and nothing was saved. */
12
20
  update(locationId: string, body: SlimUpdateLocation, options?: RequestOptions): Promise<SlimLocation>;
21
+ /** Deletes a location. Calls `DELETE v1/slim/location/{locationId}`. */
13
22
  delete(locationId: string, options?: RequestOptions): Promise<void>;
14
23
  }
@@ -6,16 +6,24 @@ const numbered_pages_1 = require("../../paging/numbered-pages");
6
6
  const slim_paths_1 = require("./slim-paths");
7
7
  const LOCATIONS_PATH = `${slim_paths_1.SLIM_PATH}/location`;
8
8
  const locationPath = (locationId) => `${LOCATIONS_PATH}/${(0, url_1.pathSegment)(locationId)}`;
9
+ /**
10
+ * Locations such as rooms and zones.
11
+ *
12
+ * @category slim
13
+ */
9
14
  class SlimLocationsResource {
10
15
  constructor(http) {
11
16
  this.http = http;
12
17
  }
18
+ /** Lists locations page by page. Calls `GET v1/slim/location`. */
13
19
  list(params = {}, options) {
14
20
  return (0, numbered_pages_1.numberedRoutePages)((path) => this.http.get(path, options), LOCATIONS_PATH, params);
15
21
  }
22
+ /** Fetches one location. Calls `GET v1/slim/location/{locationId}`. */
16
23
  retrieve(locationId, options) {
17
24
  return this.http.get(locationPath(locationId), options);
18
25
  }
26
+ /** Creates a location. Calls `POST v1/slim/location`. */
19
27
  create(body, options) {
20
28
  return this.http.post(LOCATIONS_PATH, body, options);
21
29
  }
@@ -23,6 +31,7 @@ class SlimLocationsResource {
23
31
  update(locationId, body, options) {
24
32
  return this.http.put(locationPath(locationId), body, options);
25
33
  }
34
+ /** Deletes a location. Calls `DELETE v1/slim/location/{locationId}`. */
26
35
  delete(locationId, options) {
27
36
  return this.http.delete(locationPath(locationId), options);
28
37
  }
@@ -4,6 +4,11 @@ import { HttpClient } from "../../http/http-client";
4
4
  import { RequestOptions } from "../../http/transmit";
5
5
  import { PagePromise } from "../../paging/page";
6
6
  import { SlimRecentQuery } from "./slim-queries";
7
+ /**
8
+ * Medical notification episodes.
9
+ *
10
+ * @category slim
11
+ */
7
12
  export declare class SlimMedicalNotificationsResource {
8
13
  private readonly http;
9
14
  constructor(http: HttpClient);
@@ -11,6 +16,7 @@ export declare class SlimMedicalNotificationsResource {
11
16
  list(params?: SlimMedicalNotificationsQuery, options?: RequestOptions): PagePromise<SlimMedicalNotificationRow>;
12
17
  /** During a Signals outage this may answer the last good page from up to 10 minutes ago. */
13
18
  recent(params?: SlimRecentQuery, options?: RequestOptions): Promise<SlimRecentNotificationsResponse>;
19
+ /** Reads one medical notification episode. Calls `GET v1/slim/notifications/medical/{episodeId}`. */
14
20
  retrieve(episodeId: string, options?: RequestOptions): Promise<SlimMedicalNotificationDetail>;
15
21
  /** Can take about 12 s; the server makes it safe to repeat, so a 503 is retried. */
16
22
  acknowledge(episodeId: string, options?: RequestOptions): Promise<SlimMedicalNotificationRow>;
@@ -12,6 +12,11 @@ const MEDICAL_CODE = /^(?:\d{1,7}-\d|PI)$/;
12
12
  const MAX_MEDICAL_CODES = 32;
13
13
  const MEDICAL_CODES_MESSAGE = `codes must contain at most ${MAX_MEDICAL_CODES} valid LOINC codes or PI.`;
14
14
  const episodePath = (episodeId) => `${MEDICAL_PATH}/${(0, url_1.pathSegment)(episodeId)}`;
15
+ /**
16
+ * Medical notification episodes.
17
+ *
18
+ * @category slim
19
+ */
15
20
  class SlimMedicalNotificationsResource {
16
21
  constructor(http) {
17
22
  this.http = http;
@@ -24,6 +29,7 @@ class SlimMedicalNotificationsResource {
24
29
  recent(params = {}, options) {
25
30
  return this.http.get(`${RECENT_MEDICAL_PATH}${(0, query_string_1.toQueryString)(params)}`, options);
26
31
  }
32
+ /** Reads one medical notification episode. Calls `GET v1/slim/notifications/medical/{episodeId}`. */
27
33
  retrieve(episodeId, options) {
28
34
  return this.http.get(episodePath(episodeId), options);
29
35
  }
@@ -1,12 +1,22 @@
1
1
  import type { CreateNotificationNote, NotificationNote, NotificationNotes, NotificationTargetKind, UpdateNotificationNote } from "../../../client/notifications/types";
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
+ /**
5
+ * Notes attached to notifications.
6
+ *
7
+ * @category slim
8
+ */
4
9
  export declare class SlimNotificationNotesResource {
5
10
  private readonly http;
6
11
  constructor(http: HttpClient);
12
+ /** Lists the notes of a notification. Calls `GET v1/slim/notifications/{kind}/{targetId}/notes`. */
7
13
  list(kind: NotificationTargetKind, targetId: string, options?: RequestOptions): Promise<NotificationNotes>;
14
+ /** Adds a note. Calls `POST v1/slim/notifications/notes`. */
8
15
  create(body: CreateNotificationNote, options?: RequestOptions): Promise<NotificationNote>;
16
+ /** Replaces a note. Calls `PUT v1/slim/notifications/notes/{noteId}`. */
9
17
  update(noteId: string, body: UpdateNotificationNote, options?: RequestOptions): Promise<NotificationNote>;
18
+ /** Updates part of a note. Calls `PATCH v1/slim/notifications/notes/{noteId}`. */
10
19
  patch(noteId: string, body: UpdateNotificationNote, options?: RequestOptions): Promise<NotificationNote>;
20
+ /** Deletes a note. Calls `DELETE v1/slim/notifications/notes/{noteId}`. */
11
21
  delete(noteId: string, options?: RequestOptions): Promise<void>;
12
22
  }
@@ -11,22 +11,32 @@ const TARGET_SEGMENT = {
11
11
  alert: "raw-alerts",
12
12
  };
13
13
  const notePath = (noteId) => `${NOTES_PATH}/${(0, url_1.pathSegment)(noteId)}`;
14
+ /**
15
+ * Notes attached to notifications.
16
+ *
17
+ * @category slim
18
+ */
14
19
  class SlimNotificationNotesResource {
15
20
  constructor(http) {
16
21
  this.http = http;
17
22
  }
23
+ /** Lists the notes of a notification. Calls `GET v1/slim/notifications/{kind}/{targetId}/notes`. */
18
24
  list(kind, targetId, options) {
19
25
  return this.http.get(`${slim_paths_1.NOTIFICATIONS_PATH}/${TARGET_SEGMENT[kind]}/${(0, url_1.pathSegment)(targetId)}/notes`, options);
20
26
  }
27
+ /** Adds a note. Calls `POST v1/slim/notifications/notes`. */
21
28
  create(body, options) {
22
29
  return this.http.post(NOTES_PATH, body, options);
23
30
  }
31
+ /** Replaces a note. Calls `PUT v1/slim/notifications/notes/{noteId}`. */
24
32
  update(noteId, body, options) {
25
33
  return this.http.put(notePath(noteId), body, options);
26
34
  }
35
+ /** Updates part of a note. Calls `PATCH v1/slim/notifications/notes/{noteId}`. */
27
36
  patch(noteId, body, options) {
28
37
  return this.http.patch(notePath(noteId), body, options);
29
38
  }
39
+ /** Deletes a note. Calls `DELETE v1/slim/notifications/notes/{noteId}`. */
30
40
  delete(noteId, options) {
31
41
  return this.http.delete(notePath(noteId), options);
32
42
  }
@@ -6,14 +6,24 @@ import { SlimMedicalNotificationsResource } from "./slim-medical-notifications-r
6
6
  import { SlimNotificationNotesResource } from "./slim-notification-notes-resource";
7
7
  import { SlimOutOfBedResource } from "./slim-out-of-bed-resource";
8
8
  import { SlimRecentQuery } from "./slim-queries";
9
+ /**
10
+ * Notifications, by kind.
11
+ *
12
+ * @category slim
13
+ */
9
14
  export declare class SlimNotificationsResource {
10
15
  private readonly http;
16
+ /** Alarm notifications. */
11
17
  readonly alarms: SlimAlarmsResource;
18
+ /** Out-of-bed notifications. */
12
19
  readonly outOfBed: SlimOutOfBedResource;
20
+ /** Medical notification episodes. */
13
21
  readonly medical: SlimMedicalNotificationsResource;
22
+ /** Notes on notifications. */
14
23
  readonly notes: SlimNotificationNotesResource;
15
24
  constructor(http: HttpClient);
16
25
  /** @deprecated Use outOfBed.list, alarms.list or medical.list. */
17
26
  list(params?: SlimNotificationsQuery, options?: RequestOptions): Promise<SlimNotificationsResponse>;
27
+ /** Reads the recent notifications. Calls `GET v1/slim/notifications/recent`. */
18
28
  recent(params?: SlimRecentQuery, options?: RequestOptions): Promise<SlimRecentNotificationsResponse>;
19
29
  }
@@ -7,6 +7,11 @@ const slim_medical_notifications_resource_1 = require("./slim-medical-notificati
7
7
  const slim_notification_notes_resource_1 = require("./slim-notification-notes-resource");
8
8
  const slim_out_of_bed_resource_1 = require("./slim-out-of-bed-resource");
9
9
  const slim_paths_1 = require("./slim-paths");
10
+ /**
11
+ * Notifications, by kind.
12
+ *
13
+ * @category slim
14
+ */
10
15
  class SlimNotificationsResource {
11
16
  constructor(http) {
12
17
  this.http = http;
@@ -19,6 +24,7 @@ class SlimNotificationsResource {
19
24
  list(params = {}, options) {
20
25
  return this.http.get(`${slim_paths_1.NOTIFICATIONS_PATH}${(0, query_string_1.toQueryString)(params)}`, options);
21
26
  }
27
+ /** Reads the recent notifications. Calls `GET v1/slim/notifications/recent`. */
22
28
  recent(params = {}, options) {
23
29
  return this.http.get(`${slim_paths_1.RECENT_NOTIFICATIONS_PATH}${(0, query_string_1.toQueryString)(params)}`, options);
24
30
  }
@@ -1,11 +1,20 @@
1
1
  import type { SlimOrganization, SlimOrganizationInput } from "../../../client/slim/types";
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
+ /**
5
+ * Organizations.
6
+ *
7
+ * @category slim
8
+ */
4
9
  export declare class SlimOrganizationsResource {
5
10
  private readonly http;
6
11
  constructor(http: HttpClient);
12
+ /** Fetches one organization. Calls `GET v1/slim/organization/{organizationId}`. */
7
13
  retrieve(organizationId: string, options?: RequestOptions): Promise<SlimOrganization>;
14
+ /** Creates an organization. Calls `POST v1/slim/organization`. */
8
15
  create(body: SlimOrganizationInput, options?: RequestOptions): Promise<SlimOrganization>;
16
+ /** Replaces an organization. Calls `PUT v1/slim/organization/{organizationId}`. */
9
17
  update(organizationId: string, body: SlimOrganizationInput, options?: RequestOptions): Promise<SlimOrganization>;
18
+ /** Deletes an organization. Calls `DELETE v1/slim/organization/{organizationId}`. */
10
19
  delete(organizationId: string, options?: RequestOptions): Promise<void>;
11
20
  }
@@ -5,19 +5,28 @@ const url_1 = require("../../http/url");
5
5
  const slim_paths_1 = require("./slim-paths");
6
6
  const ORGANIZATIONS_PATH = `${slim_paths_1.SLIM_PATH}/organization`;
7
7
  const organizationPath = (organizationId) => `${ORGANIZATIONS_PATH}/${(0, url_1.pathSegment)(organizationId)}`;
8
+ /**
9
+ * Organizations.
10
+ *
11
+ * @category slim
12
+ */
8
13
  class SlimOrganizationsResource {
9
14
  constructor(http) {
10
15
  this.http = http;
11
16
  }
17
+ /** Fetches one organization. Calls `GET v1/slim/organization/{organizationId}`. */
12
18
  retrieve(organizationId, options) {
13
19
  return this.http.get(organizationPath(organizationId), options);
14
20
  }
21
+ /** Creates an organization. Calls `POST v1/slim/organization`. */
15
22
  create(body, options) {
16
23
  return this.http.post(ORGANIZATIONS_PATH, body, options);
17
24
  }
25
+ /** Replaces an organization. Calls `PUT v1/slim/organization/{organizationId}`. */
18
26
  update(organizationId, body, options) {
19
27
  return this.http.put(organizationPath(organizationId), body, options);
20
28
  }
29
+ /** Deletes an organization. Calls `DELETE v1/slim/organization/{organizationId}`. */
21
30
  delete(organizationId, options) {
22
31
  return this.http.delete(organizationPath(organizationId), options);
23
32
  }
@@ -3,11 +3,23 @@ import type { SlimNotificationsQuery, SlimNotificationsResponse } from "../../..
3
3
  import { HttpClient } from "../../http/http-client";
4
4
  import { RequestOptions } from "../../http/transmit";
5
5
  import { SlimRecentQuery } from "./slim-queries";
6
+ /**
7
+ * Query for out-of-bed notifications; the type is fixed by the route.
8
+ *
9
+ * @category slim
10
+ */
6
11
  export type SlimOutOfBedQuery = Omit<SlimNotificationsQuery, "type">;
12
+ /**
13
+ * Out-of-bed notifications.
14
+ *
15
+ * @category slim
16
+ */
7
17
  export declare class SlimOutOfBedResource {
8
18
  private readonly http;
9
19
  constructor(http: HttpClient);
10
20
  /** Omitting status lists new and reviewed rows. */
21
+ /** Lists out-of-bed notifications. Calls `GET v1/slim/notifications/oob`. */
11
22
  list(params?: SlimOutOfBedQuery, options?: RequestOptions): Promise<SlimNotificationsResponse>;
23
+ /** Reads the recent out-of-bed notifications. Calls `GET v1/slim/notifications/recent/oob`. */
12
24
  recent(params?: SlimRecentQuery, options?: RequestOptions): Promise<SlimRecentOutOfBed>;
13
25
  }
@@ -5,14 +5,21 @@ const query_string_1 = require("../../../client/query-string");
5
5
  const slim_paths_1 = require("./slim-paths");
6
6
  const OUT_OF_BED_PATH = `${slim_paths_1.NOTIFICATIONS_PATH}/oob`;
7
7
  const RECENT_OUT_OF_BED_PATH = `${slim_paths_1.RECENT_NOTIFICATIONS_PATH}/oob`;
8
+ /**
9
+ * Out-of-bed notifications.
10
+ *
11
+ * @category slim
12
+ */
8
13
  class SlimOutOfBedResource {
9
14
  constructor(http) {
10
15
  this.http = http;
11
16
  }
12
17
  /** Omitting status lists new and reviewed rows. */
18
+ /** Lists out-of-bed notifications. Calls `GET v1/slim/notifications/oob`. */
13
19
  list(params = {}, options) {
14
20
  return this.http.get(`${OUT_OF_BED_PATH}${(0, query_string_1.toQueryString)(params)}`, options);
15
21
  }
22
+ /** Reads the recent out-of-bed notifications. Calls `GET v1/slim/notifications/recent/oob`. */
16
23
  recent(params = {}, options) {
17
24
  return this.http.get(`${RECENT_OUT_OF_BED_PATH}${(0, query_string_1.toQueryString)(params)}`, options);
18
25
  }
@@ -1,9 +1,15 @@
1
1
  import type { SlimPatientThresholdV2, SlimThresholdV2Update } from "../../../client/slim/types";
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
+ /**
5
+ * Per-patient vital thresholds.
6
+ *
7
+ * @category slim
8
+ */
4
9
  export declare class SlimPatientThresholdsResource {
5
10
  private readonly http;
6
11
  constructor(http: HttpClient);
12
+ /** Reads a patient's thresholds. Calls `GET v2/slim/threshold/patient/{patientId}`. */
7
13
  retrieve(patientId: string, options?: RequestOptions): Promise<SlimPatientThresholdV2>;
8
14
  /** Never retried: a 409 means another save for this resident is running and nothing changed. */
9
15
  update(patientId: string, body: SlimThresholdV2Update, options?: RequestOptions): Promise<SlimPatientThresholdV2>;
@@ -5,10 +5,16 @@ const url_1 = require("../../http/url");
5
5
  const slim_paths_1 = require("./slim-paths");
6
6
  const PATIENT_THRESHOLDS_PATH = `${slim_paths_1.THRESHOLD_V2_PATH}/patient`;
7
7
  const patientThresholdPath = (patientId) => `${PATIENT_THRESHOLDS_PATH}/${(0, url_1.pathSegment)(patientId)}`;
8
+ /**
9
+ * Per-patient vital thresholds.
10
+ *
11
+ * @category slim
12
+ */
8
13
  class SlimPatientThresholdsResource {
9
14
  constructor(http) {
10
15
  this.http = http;
11
16
  }
17
+ /** Reads a patient's thresholds. Calls `GET v2/slim/threshold/patient/{patientId}`. */
12
18
  retrieve(patientId, options) {
13
19
  return this.http.get(patientThresholdPath(patientId), options);
14
20
  }
@@ -4,17 +4,28 @@ import { HttpClient } from "../../http/http-client";
4
4
  import { RequestOptions } from "../../http/transmit";
5
5
  import { PagePromise } from "../../paging/page";
6
6
  import { SlimPatientThresholdsResource } from "./slim-patient-thresholds-resource";
7
+ /**
8
+ * Patients (residents).
9
+ *
10
+ * @category slim
11
+ */
7
12
  export declare class SlimPatientsResource {
8
13
  private readonly http;
14
+ /** Per-patient thresholds. */
9
15
  readonly thresholds: SlimPatientThresholdsResource;
10
16
  constructor(http: HttpClient);
17
+ /** Lists patients page by page. Calls `GET v1/slim/patient`. */
11
18
  list(params?: SlimPatientListQuery, options?: RequestOptions): PagePromise<SlimPatientListItem>;
19
+ /** Fetches one patient. Calls `GET v1/slim/patient/{patientId}`. */
12
20
  retrieve(patientId: string, options?: RequestOptions): Promise<SlimPatient>;
21
+ /** Creates a patient. Calls `POST v1/slim/patient`. */
13
22
  create(body: SlimCreatePatient, options?: RequestOptions): Promise<SlimPatient>;
14
23
  /** Replaces the editable fields: omitting locationId unassigns the resident's devices. */
15
24
  update(patientId: string, body: SlimUpdatePatient, options?: RequestOptions): Promise<SlimPatient>;
16
25
  /** 409 while the resident has a device: unassign it first with an update that omits locationId. */
17
26
  delete(patientId: string, options?: RequestOptions): Promise<void>;
27
+ /** Fetches the patient's records as a bundle. Calls `GET v1/slim/patient/{patientId}/$everything`. */
18
28
  everything(patientId: string, options?: RequestOptions): Promise<Bundle<Resource>>;
29
+ /** Fetches the patient's latest vitals. Calls `GET v1/slim/patient/{patientId}/current-vitals`. */
19
30
  currentVitals(patientId: string, options?: RequestOptions): Promise<Record<string, unknown>>;
20
31
  }
@@ -7,17 +7,25 @@ const slim_paths_1 = require("./slim-paths");
7
7
  const slim_patient_thresholds_resource_1 = require("./slim-patient-thresholds-resource");
8
8
  const PATIENTS_PATH = `${slim_paths_1.SLIM_PATH}/patient`;
9
9
  const patientPath = (patientId) => `${PATIENTS_PATH}/${(0, url_1.pathSegment)(patientId)}`;
10
+ /**
11
+ * Patients (residents).
12
+ *
13
+ * @category slim
14
+ */
10
15
  class SlimPatientsResource {
11
16
  constructor(http) {
12
17
  this.http = http;
13
18
  this.thresholds = new slim_patient_thresholds_resource_1.SlimPatientThresholdsResource(http);
14
19
  }
20
+ /** Lists patients page by page. Calls `GET v1/slim/patient`. */
15
21
  list(params = {}, options) {
16
22
  return (0, numbered_pages_1.numberedRoutePages)((path) => this.http.get(path, options), PATIENTS_PATH, params);
17
23
  }
24
+ /** Fetches one patient. Calls `GET v1/slim/patient/{patientId}`. */
18
25
  retrieve(patientId, options) {
19
26
  return this.http.get(patientPath(patientId), options);
20
27
  }
28
+ /** Creates a patient. Calls `POST v1/slim/patient`. */
21
29
  create(body, options) {
22
30
  return this.http.post(PATIENTS_PATH, body, options);
23
31
  }
@@ -29,9 +37,11 @@ class SlimPatientsResource {
29
37
  delete(patientId, options) {
30
38
  return this.http.delete(patientPath(patientId), options);
31
39
  }
40
+ /** Fetches the patient's records as a bundle. Calls `GET v1/slim/patient/{patientId}/$everything`. */
32
41
  everything(patientId, options) {
33
42
  return this.http.get(`${patientPath(patientId)}/$everything`, options);
34
43
  }
44
+ /** Fetches the patient's latest vitals. Calls `GET v1/slim/patient/{patientId}/current-vitals`. */
35
45
  currentVitals(patientId, options) {
36
46
  return this.http.get(`${patientPath(patientId)}/current-vitals`, options);
37
47
  }
@@ -1,12 +1,22 @@
1
1
  import type { SlimCreatePolicy, SlimPolicyList, SlimPolicyListQuery, SlimPolicyResponse, SlimUpdatePolicy } from "../../../client/slim/types";
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
+ /**
5
+ * Access policies.
6
+ *
7
+ * @category slim
8
+ */
4
9
  export declare class SlimPoliciesResource {
5
10
  private readonly http;
6
11
  constructor(http: HttpClient);
12
+ /** Lists policies. Calls `GET v1/slim/policy`. */
7
13
  list(params?: SlimPolicyListQuery, options?: RequestOptions): Promise<SlimPolicyList>;
14
+ /** Reads one policy. Calls `GET v1/slim/policy/{policyId}`. */
8
15
  retrieve(policyId: string, options?: RequestOptions): Promise<SlimPolicyResponse>;
16
+ /** Creates a policy. Calls `POST v1/slim/policy`. */
9
17
  create(body: SlimCreatePolicy, options?: RequestOptions): Promise<SlimPolicyResponse>;
18
+ /** Replaces a policy. Calls `PUT v1/slim/policy/{policyId}`. */
10
19
  update(policyId: string, body: SlimUpdatePolicy, options?: RequestOptions): Promise<SlimPolicyResponse>;
20
+ /** Deletes a policy. Calls `DELETE v1/slim/policy/{policyId}`. */
11
21
  delete(policyId: string, options?: RequestOptions): Promise<void>;
12
22
  }
@@ -6,22 +6,32 @@ const url_1 = require("../../http/url");
6
6
  const slim_paths_1 = require("./slim-paths");
7
7
  const POLICIES_PATH = `${slim_paths_1.SLIM_PATH}/policy`;
8
8
  const policyPath = (policyId) => `${POLICIES_PATH}/${(0, url_1.pathSegment)(policyId)}`;
9
+ /**
10
+ * Access policies.
11
+ *
12
+ * @category slim
13
+ */
9
14
  class SlimPoliciesResource {
10
15
  constructor(http) {
11
16
  this.http = http;
12
17
  }
18
+ /** Lists policies. Calls `GET v1/slim/policy`. */
13
19
  list(params = {}, options) {
14
20
  return this.http.get(`${POLICIES_PATH}${(0, query_string_1.toQueryString)(params)}`, options);
15
21
  }
22
+ /** Reads one policy. Calls `GET v1/slim/policy/{policyId}`. */
16
23
  retrieve(policyId, options) {
17
24
  return this.http.get(policyPath(policyId), options);
18
25
  }
26
+ /** Creates a policy. Calls `POST v1/slim/policy`. */
19
27
  create(body, options) {
20
28
  return this.http.post(POLICIES_PATH, body, options);
21
29
  }
30
+ /** Replaces a policy. Calls `PUT v1/slim/policy/{policyId}`. */
22
31
  update(policyId, body, options) {
23
32
  return this.http.put(policyPath(policyId), body, options);
24
33
  }
34
+ /** Deletes a policy. Calls `DELETE v1/slim/policy/{policyId}`. */
25
35
  delete(policyId, options) {
26
36
  return this.http.delete(policyPath(policyId), options);
27
37
  }
@@ -1,8 +1,14 @@
1
1
  import type { SlimPractitionerInviteInput, SlimPractitionerInviteResponse } from "../../../client/slim/types";
2
2
  import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
+ /**
5
+ * Practitioners.
6
+ *
7
+ * @category slim
8
+ */
4
9
  export declare class SlimPractitionersResource {
5
10
  private readonly http;
6
11
  constructor(http: HttpClient);
12
+ /** Invites a practitioner by email. Calls `POST v1/slim/invite/practitioner`. */
7
13
  invite(body: SlimPractitionerInviteInput, options?: RequestOptions): Promise<SlimPractitionerInviteResponse>;
8
14
  }
@@ -3,10 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SlimPractitionersResource = void 0;
4
4
  const slim_paths_1 = require("./slim-paths");
5
5
  const INVITE_PRACTITIONER_PATH = `${slim_paths_1.SLIM_PATH}/invite/practitioner`;
6
+ /**
7
+ * Practitioners.
8
+ *
9
+ * @category slim
10
+ */
6
11
  class SlimPractitionersResource {
7
12
  constructor(http) {
8
13
  this.http = http;
9
14
  }
15
+ /** Invites a practitioner by email. Calls `POST v1/slim/invite/practitioner`. */
10
16
  invite(body, options) {
11
17
  return this.http.post(INVITE_PRACTITIONER_PATH, body, options);
12
18
  }
@@ -3,14 +3,26 @@ import { HttpClient } from "../../http/http-client";
3
3
  import { RequestOptions } from "../../http/transmit";
4
4
  import { PagePromise } from "../../paging/page";
5
5
  import { SlimChildProjectsResource } from "./slim-child-projects-resource";
6
+ /**
7
+ * Projects and their users and counts.
8
+ *
9
+ * @category slim
10
+ */
6
11
  export declare class SlimProjectsResource {
7
12
  private readonly http;
13
+ /** Child projects. */
8
14
  readonly children: SlimChildProjectsResource;
9
15
  constructor(http: HttpClient);
16
+ /** Reads a project. Calls `GET v1/slim/project/{projectId}`. */
10
17
  retrieve(projectId: string, options?: RequestOptions): Promise<SlimProject>;
18
+ /** Replaces a project. Calls `PUT v1/slim/project/{projectId}`. */
11
19
  update(projectId: string, body: SlimChildProjectInput, options?: RequestOptions): Promise<SlimProject>;
20
+ /** Lists the users of a project. Calls `GET v1/slim/project/{projectId}/users`. */
12
21
  users(projectId: string, params?: SlimProjectUsersQuery, options?: RequestOptions): PagePromise<SlimProjectUser>;
22
+ /** Lists the users of the current project. Calls `GET v1/slim/project/users`. */
13
23
  currentUsers(params?: SlimProjectUsersQuery, options?: RequestOptions): PagePromise<SlimProjectUser>;
24
+ /** Counts a project's devices. Calls `GET v1/slim/project/{projectId}/device-counts`. */
14
25
  deviceCounts(projectId: string, options?: RequestOptions): Promise<SlimProjectDeviceCounts>;
26
+ /** Counts a project's patients. Calls `GET v1/slim/project/{projectId}/patient-counts`. */
15
27
  patientCounts(projectId: string, options?: RequestOptions): Promise<SlimProjectPatientCounts>;
16
28
  }
@@ -8,26 +8,37 @@ const slim_paths_1 = require("./slim-paths");
8
8
  const USERS = "users";
9
9
  const CURRENT_USERS_PATH = `${slim_paths_1.PROJECT_PATH}/${USERS}`;
10
10
  const projectPath = (projectId) => `${slim_paths_1.PROJECT_PATH}/${(0, url_1.pathSegment)(projectId)}`;
11
+ /**
12
+ * Projects and their users and counts.
13
+ *
14
+ * @category slim
15
+ */
11
16
  class SlimProjectsResource {
12
17
  constructor(http) {
13
18
  this.http = http;
14
19
  this.children = new slim_child_projects_resource_1.SlimChildProjectsResource(http);
15
20
  }
21
+ /** Reads a project. Calls `GET v1/slim/project/{projectId}`. */
16
22
  retrieve(projectId, options) {
17
23
  return this.http.get(projectPath(projectId), options);
18
24
  }
25
+ /** Replaces a project. Calls `PUT v1/slim/project/{projectId}`. */
19
26
  update(projectId, body, options) {
20
27
  return this.http.put(projectPath(projectId), body, options);
21
28
  }
29
+ /** Lists the users of a project. Calls `GET v1/slim/project/{projectId}/users`. */
22
30
  users(projectId, params = {}, options) {
23
31
  return (0, numbered_pages_1.numberedRoutePages)((path) => this.http.get(path, options), `${projectPath(projectId)}/${USERS}`, params);
24
32
  }
33
+ /** Lists the users of the current project. Calls `GET v1/slim/project/users`. */
25
34
  currentUsers(params = {}, options) {
26
35
  return (0, numbered_pages_1.numberedRoutePages)((path) => this.http.get(path, options), CURRENT_USERS_PATH, params);
27
36
  }
37
+ /** Counts a project's devices. Calls `GET v1/slim/project/{projectId}/device-counts`. */
28
38
  deviceCounts(projectId, options) {
29
39
  return this.http.get(`${projectPath(projectId)}/device-counts`, options);
30
40
  }
41
+ /** Counts a project's patients. Calls `GET v1/slim/project/{projectId}/patient-counts`. */
31
42
  patientCounts(projectId, options) {
32
43
  return this.http.get(`${projectPath(projectId)}/patient-counts`, options);
33
44
  }