@ovok/core 0.4.49-dev.503 → 0.4.49-dev.513

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 (394) 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/methods/generateObservationBodiesByMeasurement.d.ts +3 -0
  90. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js +3 -0
  91. package/dist/client/observation/methods/getLatestObservationsByCodes.d.ts +3 -0
  92. package/dist/client/observation/methods/getLatestObservationsByCodes.js +3 -0
  93. package/dist/client/observation/methods/observationsToMeasurements.d.ts +23 -1
  94. package/dist/client/observation/methods/observationsToMeasurements.js +8 -1
  95. package/dist/client/observation/methods/saveMeasurement.d.ts +3 -1
  96. package/dist/client/observation/methods/saveMeasurement.js +3 -1
  97. package/dist/client/observation/observation-bundle-utils.d.ts +6 -0
  98. package/dist/client/observation/observation-bundle-utils.js +6 -0
  99. package/dist/client/observation/series.d.ts +25 -3
  100. package/dist/client/observation/series.js +6 -2
  101. package/dist/client/observation/services/creator.d.ts +5 -0
  102. package/dist/client/observation/services/creator.js +5 -0
  103. package/dist/client/observation/services/uric-acid-service.js +0 -1
  104. package/dist/client/observation/types/GetLatestObservationsByCodeParams.d.ts +10 -0
  105. package/dist/client/observation/types/MeasurementTypeKey.d.ts +26 -0
  106. package/dist/client/observation/types/MeasurementTypeKey.js +26 -0
  107. package/dist/client/observation/types/ObservationCode.d.ts +64 -1
  108. package/dist/client/observation/types/ObservationCode.js +64 -1
  109. package/dist/client/observation/types/UrineAnalytes.d.ts +14 -0
  110. package/dist/client/observation/types/UrineAnalytes.js +1 -0
  111. package/dist/client/observation/types/generate-measurement/Sample.d.ts +33 -0
  112. package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts +9 -0
  113. package/dist/client/observation/types/measurement/BabySleepMeasurement.d.ts +3 -0
  114. package/dist/client/observation/types/measurement/BloodGlucoseMeasurement.d.ts +7 -0
  115. package/dist/client/observation/types/measurement/BloodPressureMeasurement.d.ts +10 -0
  116. package/dist/client/observation/types/measurement/BloodPressureStates.d.ts +10 -0
  117. package/dist/client/observation/types/measurement/BloodPressureStates.js +10 -0
  118. package/dist/client/observation/types/measurement/BodyTemperatureMeasurement.d.ts +7 -0
  119. package/dist/client/observation/types/measurement/BodyWeightMeasurmement.d.ts +8 -0
  120. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.d.ts +18 -0
  121. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.js +18 -0
  122. package/dist/client/observation/types/measurement/EcgMeasurement.d.ts +9 -0
  123. package/dist/client/observation/types/measurement/HeartRateMeasurement.d.ts +7 -0
  124. package/dist/client/observation/types/measurement/HeartRateVariabilityMeasurement.d.ts +7 -0
  125. package/dist/client/observation/types/measurement/LipidPanelMeasurement.d.ts +12 -0
  126. package/dist/client/observation/types/measurement/Measurement.d.ts +9 -0
  127. package/dist/client/observation/types/measurement/MeasurementDevice.d.ts +10 -0
  128. package/dist/client/observation/types/measurement/MeasurementSeries.d.ts +2 -0
  129. package/dist/client/observation/types/measurement/PulseOximeterMeasurement.d.ts +10 -0
  130. package/dist/client/observation/types/measurement/RespiratoryRateMeasurement.d.ts +7 -0
  131. package/dist/client/observation/types/measurement/RespiratoryTherapyMeasurement.d.ts +3 -0
  132. package/dist/client/observation/types/measurement/RestingHeartRateMeasurement.d.ts +7 -0
  133. package/dist/client/observation/types/measurement/SpirometryMeasurement.d.ts +23 -0
  134. package/dist/client/observation/types/measurement/StepCountMeasurement.d.ts +9 -0
  135. package/dist/client/observation/types/measurement/UrineAnalyzeMeasurement.d.ts +29 -0
  136. package/dist/client/observation/types/measurement/Vo2MaxMeasurement.d.ts +7 -0
  137. package/dist/client/observation/types/measurement/WalkingHeartRateAverageMeasurement.d.ts +7 -0
  138. package/dist/client/observation/types/service/MeasurementField.d.ts +5 -1
  139. package/dist/client/observation/utils/getObservationValueDisplay.d.ts +2 -0
  140. package/dist/client/offline/offline-measurement-queue.d.ts +56 -1
  141. package/dist/client/offline/offline-measurement-queue.js +21 -0
  142. package/dist/client/offline/shared-measurement-queue.d.ts +16 -1
  143. package/dist/client/offline/shared-measurement-queue.js +3 -1
  144. package/dist/client/ovok-client.d.ts +27 -6
  145. package/dist/client/ovok-client.js +8 -5
  146. package/dist/client/patient/methods.d.ts +21 -0
  147. package/dist/client/patient/methods.js +21 -0
  148. package/dist/client/patient/types.d.ts +131 -0
  149. package/dist/client/patient-sharing/methods.d.ts +18 -0
  150. package/dist/client/patient-sharing/methods.js +18 -0
  151. package/dist/client/patient-sharing/types.d.ts +89 -1
  152. package/dist/client/platform/methods.d.ts +22 -0
  153. package/dist/client/platform/methods.js +20 -0
  154. package/dist/client/platform/types.d.ts +194 -1
  155. package/dist/client/platform/types.js +24 -0
  156. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.d.ts +3 -0
  157. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.js +3 -0
  158. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.d.ts +3 -0
  159. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.js +3 -0
  160. package/dist/client/questionnaire-response/methods/populateQuestionnaire.d.ts +3 -0
  161. package/dist/client/questionnaire-response/methods/populateQuestionnaire.js +3 -0
  162. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.d.ts +3 -0
  163. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.js +3 -0
  164. package/dist/client/questionnaire-response/types.d.ts +6 -0
  165. package/dist/client/signals/errors.d.ts +13 -2
  166. package/dist/client/signals/errors.js +9 -2
  167. package/dist/client/signals/methods.d.ts +9 -0
  168. package/dist/client/signals/methods.js +9 -0
  169. package/dist/client/signals/types.d.ts +31 -0
  170. package/dist/client/slim/methods.d.ts +268 -21
  171. package/dist/client/slim/methods.js +264 -21
  172. package/dist/client/slim/paging.d.ts +22 -2
  173. package/dist/client/slim/paging.js +6 -2
  174. package/dist/client/slim/types.d.ts +920 -1
  175. package/dist/client/storage.d.ts +15 -1
  176. package/dist/client/storage.js +7 -1
  177. package/dist/client/wearables/methods.d.ts +24 -0
  178. package/dist/client/wearables/methods.js +24 -0
  179. package/dist/client/wearables/types.d.ts +74 -0
  180. package/dist/conformance/api-requirements.d.ts +31 -5
  181. package/dist/conformance/api-requirements.js +47 -10
  182. package/dist/conformance/capability-requirements.d.ts +4 -26
  183. package/dist/conformance/capability-requirements.js +5 -27
  184. package/dist/conformance/capability.d.ts +9 -1
  185. package/dist/conformance/capability.js +3 -1
  186. package/dist/hooks/account-hooks.d.ts +35 -0
  187. package/dist/hooks/account-hooks.js +33 -0
  188. package/dist/hooks/api-hooks.d.ts +74 -4
  189. package/dist/hooks/api-hooks.js +56 -4
  190. package/dist/hooks/cms-hooks.d.ts +9 -3
  191. package/dist/hooks/cms-hooks.js +9 -3
  192. package/dist/hooks/email-hooks.d.ts +3 -0
  193. package/dist/hooks/email-hooks.js +3 -0
  194. package/dist/hooks/experience-hooks.d.ts +26 -0
  195. package/dist/hooks/experience-hooks.js +24 -0
  196. package/dist/hooks/index.d.ts +18 -0
  197. package/dist/hooks/index.js +18 -0
  198. package/dist/hooks/invites-hooks.d.ts +21 -2
  199. package/dist/hooks/invites-hooks.js +21 -2
  200. package/dist/hooks/notification-ack-hooks.d.ts +6 -2
  201. package/dist/hooks/notification-ack-hooks.js +6 -2
  202. package/dist/hooks/notification-hooks.d.ts +27 -3
  203. package/dist/hooks/notification-hooks.js +27 -3
  204. package/dist/hooks/notification-note-hooks.d.ts +41 -0
  205. package/dist/hooks/notification-note-hooks.js +33 -0
  206. package/dist/hooks/observation-hooks.d.ts +29 -0
  207. package/dist/hooks/observation-hooks.js +23 -1
  208. package/dist/hooks/patient-hooks.d.ts +53 -0
  209. package/dist/hooks/patient-hooks.js +48 -0
  210. package/dist/hooks/patient-sharing-hooks.d.ts +18 -0
  211. package/dist/hooks/patient-sharing-hooks.js +18 -0
  212. package/dist/hooks/platform-hooks.d.ts +32 -0
  213. package/dist/hooks/platform-hooks.js +23 -0
  214. package/dist/hooks/poll-hooks.d.ts +17 -1
  215. package/dist/hooks/poll-hooks.js +3 -1
  216. package/dist/hooks/signals-hooks.d.ts +3 -0
  217. package/dist/hooks/signals-hooks.js +3 -0
  218. package/dist/hooks/wearables-hooks.d.ts +23 -0
  219. package/dist/hooks/wearables-hooks.js +21 -0
  220. package/dist/index.d.ts +1 -965
  221. package/dist/index.js +1 -71
  222. package/dist/next/auth/saved-accounts-store.d.ts +10 -0
  223. package/dist/next/auth/session.d.ts +17 -0
  224. package/dist/next/auth/user-session.d.ts +5 -0
  225. package/dist/next/config/ovok-config.d.ts +45 -0
  226. package/dist/next/errors/ovok-account-error.d.ts +14 -1
  227. package/dist/next/errors/ovok-account-error.js +8 -1
  228. package/dist/next/errors/ovok-errors.d.ts +88 -0
  229. package/dist/next/errors/ovok-errors.js +67 -0
  230. package/dist/next/http/http-client.d.ts +5 -0
  231. package/dist/next/http/transmit.d.ts +7 -0
  232. package/dist/next/http/url.d.ts +10 -0
  233. package/dist/next/ovok.d.ts +31 -1
  234. package/dist/next/ovok.js +5 -1
  235. package/dist/next/paging/page.d.ts +13 -1
  236. package/dist/next/react/context.d.ts +7 -0
  237. package/dist/next/react/context.js +7 -0
  238. package/dist/next/react/index.d.ts +24 -0
  239. package/dist/next/react/index.js +18 -0
  240. package/dist/next/react/query-hooks.d.ts +69 -0
  241. package/dist/next/react/query-hooks.js +31 -0
  242. package/dist/next/resources/accounts/accounts-resource.d.ts +6 -0
  243. package/dist/next/resources/accounts/accounts-resource.js +6 -0
  244. package/dist/next/resources/ai/ai-chat-resource.d.ts +7 -0
  245. package/dist/next/resources/ai/ai-chat-resource.js +5 -0
  246. package/dist/next/resources/ai/ai-resource.d.ts +13 -0
  247. package/dist/next/resources/ai/ai-resource.js +6 -0
  248. package/dist/next/resources/ai/chat-messages-resource.d.ts +7 -0
  249. package/dist/next/resources/ai/chat-messages-resource.js +7 -0
  250. package/dist/next/resources/ai/chat-sessions-resource.d.ts +14 -0
  251. package/dist/next/resources/ai/chat-sessions-resource.js +8 -0
  252. package/dist/next/resources/auth/auth-sessions-resource.d.ts +6 -1
  253. package/dist/next/resources/auth/auth-sessions-resource.js +6 -1
  254. package/dist/next/resources/auth/registration.d.ts +18 -1
  255. package/dist/next/resources/auth/social-login.d.ts +12 -0
  256. package/dist/next/resources/auth-resource.d.ts +54 -1
  257. package/dist/next/resources/auth-resource.js +23 -0
  258. package/dist/next/resources/bots/bots-resource.d.ts +15 -0
  259. package/dist/next/resources/bots/bots-resource.js +5 -0
  260. package/dist/next/resources/cms/cms-delivery.d.ts +14 -2
  261. package/dist/next/resources/cms/cms-documents-resource.d.ts +7 -1
  262. package/dist/next/resources/cms/cms-documents-resource.js +7 -1
  263. package/dist/next/resources/cms/cms-resource.d.ts +7 -0
  264. package/dist/next/resources/cms/cms-resource.js +5 -0
  265. package/dist/next/resources/cms/release-notes-resource.d.ts +6 -0
  266. package/dist/next/resources/cms/release-notes-resource.js +6 -0
  267. package/dist/next/resources/consent/consent-resource.d.ts +22 -0
  268. package/dist/next/resources/consent/consent-resource.js +20 -0
  269. package/dist/next/resources/content/content-resource.d.ts +18 -0
  270. package/dist/next/resources/content/content-resource.js +12 -0
  271. package/dist/next/resources/documents/documents-resource.d.ts +24 -0
  272. package/dist/next/resources/documents/documents-resource.js +10 -0
  273. package/dist/next/resources/email/email-resource.d.ts +6 -0
  274. package/dist/next/resources/email/email-resource.js +5 -0
  275. package/dist/next/resources/email/email-templates-resource.d.ts +6 -0
  276. package/dist/next/resources/email/email-templates-resource.js +6 -0
  277. package/dist/next/resources/fhir-resource.d.ts +36 -0
  278. package/dist/next/resources/fhir-resource.js +21 -0
  279. package/dist/next/resources/health-resource.d.ts +16 -0
  280. package/dist/next/resources/health-resource.js +5 -0
  281. package/dist/next/resources/invites/invite-flow-resource.d.ts +7 -1
  282. package/dist/next/resources/invites/invite-flow-resource.js +7 -1
  283. package/dist/next/resources/invites/invites-resource.d.ts +15 -0
  284. package/dist/next/resources/invites/invites-resource.js +5 -0
  285. package/dist/next/resources/localization/i18next-resource.d.ts +6 -0
  286. package/dist/next/resources/localization/i18next-resource.js +6 -0
  287. package/dist/next/resources/localization/locales-resource.d.ts +7 -0
  288. package/dist/next/resources/localization/locales-resource.js +7 -0
  289. package/dist/next/resources/localization/localizations-resource.d.ts +17 -0
  290. package/dist/next/resources/localization/localizations-resource.js +9 -0
  291. package/dist/next/resources/measurements/measurements-resource.d.ts +53 -1
  292. package/dist/next/resources/measurements/measurements-resource.js +14 -0
  293. package/dist/next/resources/measurements/observation-builder.d.ts +5 -0
  294. package/dist/next/resources/measurements/offline-measurement-queue-types.d.ts +32 -0
  295. package/dist/next/resources/patient/fhir-records.d.ts +19 -1
  296. package/dist/next/resources/patient/fhir-records.js +19 -1
  297. package/dist/next/resources/patient/patient-resource.d.ts +15 -0
  298. package/dist/next/resources/patient/patient-resource.js +6 -0
  299. package/dist/next/resources/projects/project-features-resource.d.ts +7 -0
  300. package/dist/next/resources/projects/project-features-resource.js +7 -0
  301. package/dist/next/resources/projects/project-members-resource.d.ts +19 -0
  302. package/dist/next/resources/projects/project-members-resource.js +9 -0
  303. package/dist/next/resources/projects/project-settings-resource.d.ts +8 -0
  304. package/dist/next/resources/projects/project-settings-resource.js +8 -0
  305. package/dist/next/resources/projects/projects-resource.d.ts +15 -0
  306. package/dist/next/resources/projects/projects-resource.js +5 -0
  307. package/dist/next/resources/questionnaires/questionnaires-resource.d.ts +13 -0
  308. package/dist/next/resources/questionnaires/questionnaires-resource.js +13 -0
  309. package/dist/next/resources/realtime/realtime-resource.d.ts +11 -0
  310. package/dist/next/resources/realtime/realtime-resource.js +11 -0
  311. package/dist/next/resources/realtime/realtime-types.d.ts +16 -0
  312. package/dist/next/resources/session/saved-accounts-resource.d.ts +16 -0
  313. package/dist/next/resources/session/saved-accounts-resource.js +16 -0
  314. package/dist/next/resources/session/session-resource.d.ts +8 -0
  315. package/dist/next/resources/session/session-resource.js +7 -0
  316. package/dist/next/resources/sharing/sharing-invites-resource.d.ts +7 -0
  317. package/dist/next/resources/sharing/sharing-invites-resource.js +7 -0
  318. package/dist/next/resources/sharing/sharing-resource.d.ts +8 -0
  319. package/dist/next/resources/sharing/sharing-resource.js +5 -0
  320. package/dist/next/resources/sharing/sharing-settings-resource.d.ts +7 -0
  321. package/dist/next/resources/sharing/sharing-settings-resource.js +7 -0
  322. package/dist/next/resources/sharing/sharing-shares-resource.d.ts +7 -0
  323. package/dist/next/resources/sharing/sharing-shares-resource.js +7 -0
  324. package/dist/next/resources/signals/signals-gateway-resource.d.ts +15 -0
  325. package/dist/next/resources/signals/signals-gateway-resource.js +6 -0
  326. package/dist/next/resources/signals/signals-resource.d.ts +7 -0
  327. package/dist/next/resources/signals/signals-resource.js +5 -0
  328. package/dist/next/resources/signals/undeliverable-resource.d.ts +35 -0
  329. package/dist/next/resources/signals/undeliverable-resource.js +6 -0
  330. package/dist/next/resources/slim/slim-alarms-resource.d.ts +7 -0
  331. package/dist/next/resources/slim/slim-alarms-resource.js +7 -0
  332. package/dist/next/resources/slim/slim-change-history-resource.d.ts +6 -0
  333. package/dist/next/resources/slim/slim-change-history-resource.js +6 -0
  334. package/dist/next/resources/slim/slim-child-projects-resource.d.ts +21 -0
  335. package/dist/next/resources/slim/slim-child-projects-resource.js +8 -0
  336. package/dist/next/resources/slim/slim-devices-resource.d.ts +31 -0
  337. package/dist/next/resources/slim/slim-devices-resource.js +16 -0
  338. package/dist/next/resources/slim/slim-exports-resource.d.ts +6 -0
  339. package/dist/next/resources/slim/slim-exports-resource.js +6 -0
  340. package/dist/next/resources/slim/slim-locations-resource.d.ts +9 -0
  341. package/dist/next/resources/slim/slim-locations-resource.js +9 -0
  342. package/dist/next/resources/slim/slim-medical-notifications-resource.d.ts +6 -0
  343. package/dist/next/resources/slim/slim-medical-notifications-resource.js +6 -0
  344. package/dist/next/resources/slim/slim-notification-notes-resource.d.ts +10 -0
  345. package/dist/next/resources/slim/slim-notification-notes-resource.js +10 -0
  346. package/dist/next/resources/slim/slim-notifications-resource.d.ts +10 -0
  347. package/dist/next/resources/slim/slim-notifications-resource.js +6 -0
  348. package/dist/next/resources/slim/slim-organizations-resource.d.ts +9 -0
  349. package/dist/next/resources/slim/slim-organizations-resource.js +9 -0
  350. package/dist/next/resources/slim/slim-out-of-bed-resource.d.ts +12 -0
  351. package/dist/next/resources/slim/slim-out-of-bed-resource.js +7 -0
  352. package/dist/next/resources/slim/slim-patient-thresholds-resource.d.ts +6 -0
  353. package/dist/next/resources/slim/slim-patient-thresholds-resource.js +6 -0
  354. package/dist/next/resources/slim/slim-patients-resource.d.ts +11 -0
  355. package/dist/next/resources/slim/slim-patients-resource.js +10 -0
  356. package/dist/next/resources/slim/slim-policies-resource.d.ts +10 -0
  357. package/dist/next/resources/slim/slim-policies-resource.js +10 -0
  358. package/dist/next/resources/slim/slim-practitioners-resource.d.ts +6 -0
  359. package/dist/next/resources/slim/slim-practitioners-resource.js +6 -0
  360. package/dist/next/resources/slim/slim-projects-resource.d.ts +12 -0
  361. package/dist/next/resources/slim/slim-projects-resource.js +11 -0
  362. package/dist/next/resources/slim/slim-queries.d.ts +51 -0
  363. package/dist/next/resources/slim/slim-resource.d.ts +21 -0
  364. package/dist/next/resources/slim/slim-resource.js +6 -0
  365. package/dist/next/resources/slim/slim-sleep-resource.d.ts +6 -0
  366. package/dist/next/resources/slim/slim-sleep-resource.js +6 -0
  367. package/dist/next/resources/slim/slim-thresholds-resource.d.ts +5 -0
  368. package/dist/next/resources/slim/slim-thresholds-resource.js +5 -0
  369. package/dist/next/resources/slim/slim-trends-resource.d.ts +6 -0
  370. package/dist/next/resources/slim/slim-trends-resource.js +6 -0
  371. package/dist/next/resources/slim/slim-users-resource.d.ts +12 -0
  372. package/dist/next/resources/slim/slim-users-resource.js +6 -0
  373. package/dist/next/resources/slim/slim-zones-resource.d.ts +8 -0
  374. package/dist/next/resources/slim/slim-zones-resource.js +8 -0
  375. package/dist/next/resources/video-calls/video-call-access-resource.d.ts +13 -0
  376. package/dist/next/resources/video-calls/video-call-access-resource.js +8 -0
  377. package/dist/next/resources/video-calls/video-call-appointments-resource.d.ts +8 -0
  378. package/dist/next/resources/video-calls/video-call-appointments-resource.js +8 -0
  379. package/dist/next/resources/video-calls/video-call-emails-resource.d.ts +8 -0
  380. package/dist/next/resources/video-calls/video-call-emails-resource.js +8 -0
  381. package/dist/next/resources/video-calls/video-calls-resource.d.ts +14 -0
  382. package/dist/next/resources/video-calls/video-calls-resource.js +6 -0
  383. package/dist/next/resources/wearables/wearable-connections-resource.d.ts +8 -0
  384. package/dist/next/resources/wearables/wearable-connections-resource.js +8 -0
  385. package/dist/next/resources/wearables/wearable-providers-resource.d.ts +10 -0
  386. package/dist/next/resources/wearables/wearable-providers-resource.js +10 -0
  387. package/dist/next/resources/wearables/wearables-resource.d.ts +7 -0
  388. package/dist/next/resources/wearables/wearables-resource.js +5 -0
  389. package/dist/next/storage/ovok-storage.d.ts +16 -0
  390. package/dist/next/storage/ovok-storage.js +8 -0
  391. package/dist/types/ValidationError.d.ts +9 -0
  392. package/dist/utils/patch/getPatchOperationType.d.ts +3 -0
  393. package/dist/utils/patch/getPatchOperationType.js +3 -0
  394. package/package.json +51 -12
@@ -84,105 +84,201 @@ const validateLiveCount = (params) => {
84
84
  throw new RangeError("count must be an integer from 1 to 100.");
85
85
  }
86
86
  };
87
+ /**
88
+ * Lists residents (patients) in the project, paged (`GET /v1/slim/patient`).
89
+ */
87
90
  async function listSlimPatients(params = {}, requestOptions) {
88
91
  return this.get(`/v1/slim/patient${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
89
92
  }
93
+ /**
94
+ * Reads one resident by id (`GET /v1/slim/patient/{id}`).
95
+ */
90
96
  async function getSlimPatient(patientId, requestOptions) {
91
97
  return this.get(`/v1/slim/patient/${encodeURIComponent(patientId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
92
98
  }
99
+ /**
100
+ * Reads a resident and all related resources as a FHIR bundle (`GET /v1/slim/patient/{id}/$everything`).
101
+ */
93
102
  async function getSlimPatientEverything(patientId, requestOptions) {
94
103
  return this.get(`/v1/slim/patient/${encodeURIComponent(patientId)}/$everything`, ...(0, request_options_1.optionalArg)(requestOptions));
95
104
  }
105
+ /**
106
+ * Reads a resident's current vital readings, keyed by vital (`GET /v1/slim/patient/{id}/current-vitals`).
107
+ */
96
108
  async function getSlimPatientCurrentVitals(patientId, requestOptions) {
97
109
  return this.get(`/v1/slim/patient/${encodeURIComponent(patientId)}/current-vitals`, ...(0, request_options_1.optionalArg)(requestOptions));
98
110
  }
99
- /** 422 when organizationId has no locationId or deviceId, or the assigned devices span zones. */
111
+ /**
112
+ * Creates a resident, optionally assigned to a location or device (`POST /v1/slim/patient`).
113
+ *
114
+ * 422 when organizationId has no locationId or deviceId, or the assigned devices span zones.
115
+ */
100
116
  async function createSlimPatient(body, requestOptions) {
101
117
  return this.post("/v1/slim/patient", body, undefined, requestOptions);
102
118
  }
103
- /** Replaces editable fields; omitting locationId unassigns devices; 422 for null, empty, or [] deviceId with a location or devices across zones. Names are trimmed. */
119
+ /**
120
+ * Updates a resident (`PUT /v1/slim/patient/{id}`).
121
+ *
122
+ * Replaces editable fields; omitting locationId unassigns devices; 422 for null, empty, or [] deviceId with a location or devices across zones. Names are trimmed.
123
+ */
104
124
  async function updateSlimPatient(patientId, body, requestOptions) {
105
125
  return (await this.put(`/v1/slim/patient/${encodeURIComponent(patientId)}`, body, undefined, requestOptions));
106
126
  }
107
- /** 409 while the resident has a device; unassign it first with updateSlimPatient and no locationId. */
127
+ /**
128
+ * Deletes a resident (`DELETE /v1/slim/patient/{id}`).
129
+ *
130
+ * 409 while the resident has a device; unassign it first with updateSlimPatient and no locationId.
131
+ */
108
132
  async function deleteSlimPatient(patientId, requestOptions) {
109
133
  await this.delete(`/v1/slim/patient/${encodeURIComponent(patientId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
110
134
  }
135
+ /**
136
+ * Lists devices in the project, paged (`GET /v1/slim/device`).
137
+ */
111
138
  async function listSlimDevices(params = {}, requestOptions) {
112
139
  return this.get(`/v1/slim/device${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
113
140
  }
141
+ /**
142
+ * Reads one device by id (`GET /v1/slim/device/{id}`).
143
+ */
114
144
  async function getSlimDevice(deviceId, requestOptions) {
115
145
  return this.get(`/v1/slim/device/${encodeURIComponent(deviceId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
116
146
  }
117
- /** 409 when another customer holds the serial; 422 when this project already uses it or its organization differs from the room's zone. */
147
+ /**
148
+ * Creates a device (`POST /v1/slim/device`).
149
+ *
150
+ * 409 when another customer holds the serial; 422 when this project already uses it or its organization differs from the room's zone.
151
+ */
118
152
  async function createSlimDevice(body, requestOptions) {
119
153
  return this.post("/v1/slim/device", body, undefined, requestOptions);
120
154
  }
121
- /** 409 when another customer holds the serial; 422 when this project already uses it or its organization differs from the room's zone. Renaming moves the serial, so old-serial readings stop and live values return after a reading under the new serial. */
155
+ /**
156
+ * Updates a device (`PUT /v1/slim/device/{id}`).
157
+ *
158
+ * 409 when another customer holds the serial; 422 when this project already uses it or its organization differs from the room's zone. Renaming moves the serial, so old-serial readings stop and live values return after a reading under the new serial.
159
+ */
122
160
  async function updateSlimDevice(deviceId, body, requestOptions) {
123
161
  return (await this.put(`/v1/slim/device/${encodeURIComponent(deviceId)}`, body, undefined, requestOptions));
124
162
  }
163
+ /**
164
+ * Deletes a device (`DELETE /v1/slim/device/{id}`).
165
+ */
125
166
  async function deleteSlimDevice(deviceId, requestOptions) {
126
167
  await this.delete(`/v1/slim/device/${encodeURIComponent(deviceId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
127
168
  }
169
+ /**
170
+ * Assigns a device to a project, optionally to one of its locations (`PUT /v1/slim/device/assign/project`).
171
+ */
128
172
  async function assignSlimDeviceToProject(body, requestOptions) {
129
173
  return (await this.put("/v1/slim/device/assign/project", body, undefined, requestOptions));
130
174
  }
175
+ /**
176
+ * Lists devices with their live row data, paged (`GET /v1/slim/device/live`).
177
+ */
131
178
  async function listSlimLiveDevices(params = {}, requestOptions) {
132
179
  validateLiveCount(params);
133
180
  return (0, live_read_1.liveGet)(this, `/v1/slim/device/live${(0, query_string_1.toQueryString)(params)}`, requestOptions);
134
181
  }
182
+ /**
183
+ * Reads latest telemetry and alert summaries for the matching devices, keyed by device id (`GET /v1/slim/device/live/telemetry`).
184
+ */
135
185
  async function listSlimLiveTelemetry(params = {}, requestOptions) {
136
186
  validateLiveCount(params);
137
187
  return (0, live_read_1.liveGet)(this, `/v1/slim/device/live/telemetry${(0, query_string_1.toQueryString)(params)}`, requestOptions);
138
188
  }
189
+ /**
190
+ * Reads latest telemetry and alerts for one device (`GET /v1/slim/telemetry/{deviceId}`).
191
+ */
139
192
  async function getSlimDeviceTelemetry(deviceId, requestOptions) {
140
193
  return (0, live_read_1.liveGet)(this, `/v1/slim/telemetry/${encodeURIComponent(deviceId)}`, requestOptions);
141
194
  }
195
+ /**
196
+ * Lists the effective observation ids per device, keyed by device id (`GET /v1/slim/telemetry/effectiveIds`).
197
+ */
142
198
  async function listSlimEffectiveObservationIds(requestOptions) {
143
199
  return this.get("/v1/slim/telemetry/effectiveIds", ...(0, request_options_1.optionalArg)(requestOptions));
144
200
  }
201
+ /**
202
+ * Lists the last observation ids per device, keyed by device id (`GET /v1/slim/telemetry/lastIds`).
203
+ */
145
204
  async function listSlimLastObservationIds(requestOptions) {
146
205
  return this.get("/v1/slim/telemetry/lastIds", ...(0, request_options_1.optionalArg)(requestOptions));
147
206
  }
207
+ /**
208
+ * Reads the effective observation ids of one device (`GET /v1/slim/telemetry/{deviceId}/effectiveIds`).
209
+ */
148
210
  async function getSlimDeviceEffectiveObservationIds(deviceId, requestOptions) {
149
211
  return this.get(`/v1/slim/telemetry/${encodeURIComponent(deviceId)}/effectiveIds`, ...(0, request_options_1.optionalArg)(requestOptions));
150
212
  }
213
+ /**
214
+ * Reads the last observation ids of one device (`GET /v1/slim/telemetry/{deviceId}/lastIds`).
215
+ */
151
216
  async function getSlimDeviceLastObservationIds(deviceId, requestOptions) {
152
217
  return this.get(`/v1/slim/telemetry/${encodeURIComponent(deviceId)}/lastIds`, ...(0, request_options_1.optionalArg)(requestOptions));
153
218
  }
154
- /** @deprecated Use listSlimOutOfBedNotifications, listSlimAlarms, or listSlimMedicalNotifications. */
219
+ /**
220
+ * Lists notifications of any type (`GET /v1/slim/notifications`).
221
+ *
222
+ * @deprecated Use listSlimOutOfBedNotifications, listSlimAlarms, or listSlimMedicalNotifications.
223
+ */
155
224
  async function listSlimNotifications(params = {}, requestOptions) {
156
225
  return this.get(`/v1/slim/notifications${(0, query_string_1.toQueryString)(params)}`, { cache: "reload", ...requestOptions });
157
226
  }
227
+ /**
228
+ * Reads the most recent notifications (`GET /v1/slim/notifications/recent`).
229
+ */
158
230
  async function getRecentSlimNotifications(count, requestOptions) {
159
231
  return this.get(`/v1/slim/notifications/recent${(0, query_string_1.toQueryString)({ count })}`, { cache: "reload", ...requestOptions });
160
232
  }
233
+ /**
234
+ * Lists alarm notifications, paged (`GET /v1/slim/notifications/alarms`).
235
+ */
161
236
  async function listSlimAlarms(params = {}, requestOptions) {
162
237
  return this.get(`/v1/slim/notifications/alarms${(0, query_string_1.toQueryString)(params)}`, { cache: "reload", ...requestOptions });
163
238
  }
164
- /** Can take about 12 s; a 503 signals_unavailable means it was not confirmed, so repeat after retryAfterMs (safe to repeat). */
239
+ /**
240
+ * Acknowledges an alarm notification (`PATCH /v1/slim/notifications/{id}/ack`).
241
+ *
242
+ * Can take about 12 s; a 503 signals_unavailable means it was not confirmed, so repeat after retryAfterMs (safe to repeat).
243
+ */
165
244
  async function acknowledgeSlimAlarm(notificationId, requestOptions) {
166
245
  return (await this.patch(`/v1/slim/notifications/${encodeURIComponent(notificationId)}/ack`, [], ...(0, request_options_1.optionalArg)(requestOptions)));
167
246
  }
247
+ /**
248
+ * Reads the most recent alarm notifications (`GET /v1/slim/notifications/recent/alarms`).
249
+ */
168
250
  async function getRecentSlimAlarms(count, requestOptions) {
169
251
  return this.get(`/v1/slim/notifications/recent/alarms${(0, query_string_1.toQueryString)({ count })}`, { cache: "reload", ...requestOptions });
170
252
  }
171
- /** Same as `getRecentSlimAlarms`. */
253
+ /**
254
+ * Alias of `getRecentSlimAlarms`.
255
+ */
172
256
  function getRecentAlarms(count, requestOptions) {
173
257
  return getRecentSlimAlarms.call(this, count, ...(0, request_options_1.optionalArg)(requestOptions));
174
258
  }
259
+ /**
260
+ * Reads the most recent out-of-bed notifications (`GET /v1/slim/notifications/recent/oob`).
261
+ */
175
262
  async function getRecentSlimOutOfBed(count, requestOptions) {
176
263
  return this.get(`/v1/slim/notifications/recent/oob${(0, query_string_1.toQueryString)({ count })}`, { cache: "reload", ...requestOptions });
177
264
  }
178
- /** Same as `getRecentSlimOutOfBed`. */
265
+ /**
266
+ * Alias of `getRecentSlimOutOfBed`.
267
+ */
179
268
  function getRecentOutOfBed(count, requestOptions) {
180
269
  return getRecentSlimOutOfBed.call(this, count, ...(0, request_options_1.optionalArg)(requestOptions));
181
270
  }
182
- /** Omitting status lists new and reviewed rows; active is new, completed reviewed, and revoked hand-closed. */
271
+ /**
272
+ * Lists out-of-bed notifications (`GET /v1/slim/notifications/oob`).
273
+ *
274
+ * Omitting status lists new and reviewed rows; active is new, completed reviewed, and revoked hand-closed.
275
+ */
183
276
  async function listSlimOutOfBedNotifications(params = {}, requestOptions) {
184
277
  return this.get(`/v1/slim/notifications/oob${(0, query_string_1.toQueryString)(params)}`, { cache: "reload", ...requestOptions });
185
278
  }
279
+ /**
280
+ * Lists medical (vital-sign) notifications, cursor-paged (`GET /v1/slim/notifications/medical`).
281
+ */
186
282
  async function listSlimMedicalNotifications(params = {}, requestOptions) {
187
283
  validateMedicalCodes(params.codes);
188
284
  return this.get(`/v1/slim/notifications/medical${(0, query_string_1.toQueryString)(params)}`, { cache: "reload", ...requestOptions });
@@ -194,156 +290,303 @@ function validateMedicalCodes(codes) {
194
290
  throw new TypeError("codes must contain at most 32 valid LOINC codes or PI.");
195
291
  }
196
292
  }
197
- /** During a Signals outage, this may return the last good page from up to 10 minutes ago, without a marker. */
293
+ /**
294
+ * Reads the most recent medical notifications (`GET /v1/slim/notifications/recent/medical`).
295
+ *
296
+ * During a Signals outage, this may return the last good page from up to 10 minutes ago, without a marker.
297
+ */
198
298
  async function getRecentSlimMedicalNotifications(count, requestOptions) {
199
299
  return this.get(`/v1/slim/notifications/recent/medical${(0, query_string_1.toQueryString)({ count })}`, { cache: "reload", ...requestOptions });
200
300
  }
301
+ /**
302
+ * Reads one medical notification episode (`GET /v1/slim/notifications/medical/{episodeId}`).
303
+ */
201
304
  async function getSlimMedicalNotification(episodeId, requestOptions) {
202
305
  return this.get(`/v1/slim/notifications/medical/${encodeURIComponent(episodeId)}`, { cache: "reload", ...requestOptions });
203
306
  }
204
- /** Can take about 12 s; a 503 signals_unavailable means it was not confirmed, so repeat after retryAfterMs (safe to repeat). */
307
+ /**
308
+ * Acknowledges a medical notification episode (`POST /v1/slim/notifications/medical/{episodeId}/ack`).
309
+ *
310
+ * Can take about 12 s; a 503 signals_unavailable means it was not confirmed, so repeat after retryAfterMs (safe to repeat).
311
+ */
205
312
  async function acknowledgeSlimMedicalNotification(episodeId, requestOptions) {
206
313
  return this.post(`/v1/slim/notifications/medical/${encodeURIComponent(episodeId)}/ack`, undefined, undefined, requestOptions);
207
314
  }
208
- /** Same as `acknowledgeSlimAlarm`. */
315
+ /**
316
+ * Alias of `acknowledgeSlimAlarm`.
317
+ */
209
318
  function acknowledgeSlimNotification(notificationId, requestOptions) {
210
319
  return acknowledgeSlimAlarm.call(this, notificationId, ...(0, request_options_1.optionalArg)(requestOptions));
211
320
  }
212
- /** A home with no stored limits reads as the default template, not as unset. */
321
+ /**
322
+ * Reads the project's v1 vital-sign limits (`GET /v1/slim/threshold`).
323
+ *
324
+ * A home with no stored limits reads as the default template, not as unset.
325
+ */
213
326
  async function getSlimThreshold(requestOptions) {
214
327
  return this.get("/v1/slim/threshold", ...(0, request_options_1.optionalArg)(requestOptions));
215
328
  }
216
- /** A 502 means Signals did not take every resident's limits and nothing was written. */
329
+ /**
330
+ * Updates the project's v1 vital-sign limits; never retried (`PUT /v1/slim/threshold`).
331
+ *
332
+ * A 502 means Signals did not take every resident's limits and nothing was written.
333
+ */
217
334
  async function updateSlimThreshold(body, requestOptions) {
218
335
  return (await this.put("/v1/slim/threshold", body, undefined, {
219
336
  ...requestOptions, maxRetries: 0, maxRetryTime: 0,
220
337
  }));
221
338
  }
339
+ /**
340
+ * Reads one resident's v1 limits (`GET /v1/slim/threshold/patient/{id}`).
341
+ */
222
342
  async function getSlimPatientThreshold(patientId, requestOptions) {
223
343
  return this.get(`/v1/slim/threshold/patient/${encodeURIComponent(patientId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
224
344
  }
225
- /** 409 means another save for this resident is running and nothing changed; wait briefly, then send again. */
345
+ /**
346
+ * Updates one resident's v1 limits; never retried (`PUT /v1/slim/threshold/patient/{id}`).
347
+ *
348
+ * 409 means another save for this resident is running and nothing changed; wait briefly, then send again.
349
+ */
226
350
  async function updateSlimPatientThreshold(patientId, body, requestOptions) {
227
351
  return (await this.put(`/v1/slim/threshold/patient/${encodeURIComponent(patientId)}`, body, undefined, { ...requestOptions, maxRetries: 0, maxRetryTime: 0 }));
228
352
  }
229
- /** A home with no stored limits reads as the default template, not as unset. */
353
+ /**
354
+ * Reads the project's v2 vital-sign limits (`GET /v2/slim/threshold`).
355
+ *
356
+ * A home with no stored limits reads as the default template, not as unset.
357
+ */
230
358
  async function getSlimThresholdV2(requestOptions) {
231
359
  return this.get("/v2/slim/threshold", ...(0, request_options_1.optionalArg)(requestOptions));
232
360
  }
233
- /** A 502 means Signals did not take every resident's limits and nothing was written. */
361
+ /**
362
+ * Updates the project's v2 vital-sign limits; never retried (`PUT /v2/slim/threshold`).
363
+ *
364
+ * A 502 means Signals did not take every resident's limits and nothing was written.
365
+ */
234
366
  async function updateSlimThresholdV2(body, requestOptions) {
235
367
  return (await this.put("/v2/slim/threshold", body, undefined, {
236
368
  ...requestOptions, maxRetries: 0, maxRetryTime: 0,
237
369
  }));
238
370
  }
371
+ /**
372
+ * Reads one resident's v2 limits (`GET /v2/slim/threshold/patient/{id}`).
373
+ */
239
374
  async function getSlimPatientThresholdV2(patientId, requestOptions) {
240
375
  return this.get(`/v2/slim/threshold/patient/${encodeURIComponent(patientId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
241
376
  }
242
- /** 409 means another save for this resident is running and nothing changed; wait briefly, then send again. */
377
+ /**
378
+ * Updates one resident's v2 limits; never retried (`PUT /v2/slim/threshold/patient/{id}`).
379
+ *
380
+ * 409 means another save for this resident is running and nothing changed; wait briefly, then send again.
381
+ */
243
382
  async function updateSlimPatientThresholdV2(patientId, body, requestOptions) {
244
383
  return (await this.put(`/v2/slim/threshold/patient/${encodeURIComponent(patientId)}`, body, undefined, { ...requestOptions, maxRetries: 0, maxRetryTime: 0 }));
245
384
  }
385
+ /**
386
+ * Reads historical heart-rate or respiratory-rate graphs for a resident (`GET /v1/slim/trends/graphs`).
387
+ */
246
388
  async function getSlimTrends(params, requestOptions) {
247
389
  return this.get(`/v1/slim/trends/graphs${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
248
390
  }
249
- /** At most 20 calls per minute per caller; load once per view and wait retryAfterMs after 503. */
391
+ /**
392
+ * Reads raw-reading graphs for a resident over a time range (`GET /v1/slim/trends/realtime`).
393
+ *
394
+ * At most 20 calls per minute per caller; load once per view and wait retryAfterMs after 503.
395
+ */
250
396
  async function getSlimRealtimeTrends(params, requestOptions) {
251
397
  return this.get(`/v1/slim/trends/realtime${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
252
398
  }
399
+ /**
400
+ * Reads a resident's sleep statistics for the days up to `endDate` (`GET /v1/slim/sleep/statistics`).
401
+ */
253
402
  async function getSlimSleepStatistics(params, requestOptions) {
254
403
  return this.get(`/v1/slim/sleep/statistics${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
255
404
  }
405
+ /**
406
+ * Lists locations (floor, room, bed), paged (`GET /v1/slim/location`).
407
+ */
256
408
  async function listSlimLocations(params = {}, requestOptions) {
257
409
  return this.get(`/v1/slim/location${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
258
410
  }
411
+ /**
412
+ * Reads one location by id (`GET /v1/slim/location/{id}`).
413
+ */
259
414
  async function getSlimLocation(locationId, requestOptions) {
260
415
  return this.get(`/v1/slim/location/${encodeURIComponent(locationId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
261
416
  }
417
+ /**
418
+ * Creates a location (`POST /v1/slim/location`).
419
+ */
262
420
  async function createSlimLocation(body, requestOptions) {
263
421
  return this.post("/v1/slim/location", body, undefined, requestOptions);
264
422
  }
265
- /** 422 Device not found means the requested device is unreadable; nothing was saved. */
423
+ /**
424
+ * Updates a location, including its device and resident (`PUT /v1/slim/location/{id}`).
425
+ *
426
+ * 422 Device not found means the requested device is unreadable; nothing was saved.
427
+ */
266
428
  async function updateSlimLocation(locationId, body, requestOptions) {
267
429
  return (await this.put(`/v1/slim/location/${encodeURIComponent(locationId)}`, body, undefined, requestOptions));
268
430
  }
431
+ /**
432
+ * Deletes a location (`DELETE /v1/slim/location/{id}`).
433
+ */
269
434
  async function deleteSlimLocation(locationId, requestOptions) {
270
435
  await this.delete(`/v1/slim/location/${encodeURIComponent(locationId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
271
436
  }
437
+ /**
438
+ * Lists zones with device counts, paged (`GET /v1/slim/zones`).
439
+ */
272
440
  async function listSlimZones(params = {}, requestOptions) {
273
441
  return this.get(`/v1/slim/zones${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
274
442
  }
443
+ /**
444
+ * Reads one zone with its locations, devices and residents (`GET /v1/slim/zones/{id}`).
445
+ */
275
446
  async function getSlimZone(zoneId, requestOptions) {
276
447
  return this.get(`/v1/slim/zones/${encodeURIComponent(zoneId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
277
448
  }
449
+ /**
450
+ * Reads device counts per zone (`GET /v1/slim/zones/device-counts`).
451
+ */
278
452
  async function getSlimZoneDeviceCounts(params = {}, requestOptions) {
279
453
  return this.get(`/v1/slim/zones/device-counts${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
280
454
  }
455
+ /**
456
+ * Creates a PDF report for a resident and returns its download link (`POST /v1/slim/export/pdf`).
457
+ */
281
458
  async function exportSlimPatientPdf(body, requestOptions) {
282
459
  return this.post("/v1/slim/export/pdf", body, undefined, requestOptions);
283
460
  }
461
+ /**
462
+ * Lists the current project's users, paged (`GET /v1/slim/project/users`).
463
+ */
284
464
  function listSlimProjectUsers(params = {}, requestOptions) {
285
465
  return this.get(`/v1/slim/project/users${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
286
466
  }
467
+ /**
468
+ * Creates a child project (`POST /v1/slim/project/child`).
469
+ */
287
470
  function createSlimChildProject(body, requestOptions) {
288
471
  return this.post("/v1/slim/project/child", body, undefined, requestOptions);
289
472
  }
473
+ /**
474
+ * Reads the current, parent and child projects (`GET /v1/slim/project/child`).
475
+ */
290
476
  function getSlimProjectRelationships(requestOptions) {
291
477
  return this.get("/v1/slim/project/child", ...(0, request_options_1.optionalArg)(requestOptions));
292
478
  }
479
+ /**
480
+ * Reads the current, parent and child projects with device counts (`GET /v2/slim/project/child`).
481
+ */
293
482
  function getSlimProjectRelationshipsV2(requestOptions) {
294
483
  return this.get("/v2/slim/project/child", ...(0, request_options_1.optionalArg)(requestOptions));
295
484
  }
485
+ /**
486
+ * Deletes a child project (`DELETE /v1/slim/project/child/{id}`).
487
+ */
296
488
  function deleteSlimChildProject(subProjectId, requestOptions) {
297
489
  return this.delete(`/v1/slim/project/child/${encodeURIComponent(subProjectId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
298
490
  }
491
+ /**
492
+ * Lists the users of a given project, paged (`GET /v1/slim/project/{id}/users`).
493
+ */
299
494
  function listSlimProjectUsersById(projectId, params = {}, requestOptions) {
300
495
  return this.get(`/v1/slim/project/${encodeURIComponent(projectId)}/users${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
301
496
  }
497
+ /**
498
+ * Reads device counts of a project (`GET /v1/slim/project/{id}/device-counts`).
499
+ */
302
500
  function getSlimProjectDeviceCounts(projectId, requestOptions) {
303
501
  return this.get(`/v1/slim/project/${encodeURIComponent(projectId)}/device-counts`, ...(0, request_options_1.optionalArg)(requestOptions));
304
502
  }
503
+ /**
504
+ * Reads resident counts of a project (`GET /v1/slim/project/{id}/patient-counts`).
505
+ */
305
506
  function getSlimProjectPatientCounts(projectId, requestOptions) {
306
507
  return this.get(`/v1/slim/project/${encodeURIComponent(projectId)}/patient-counts`, ...(0, request_options_1.optionalArg)(requestOptions));
307
508
  }
509
+ /**
510
+ * Updates a project (`PUT /v1/slim/project/{id}`).
511
+ */
308
512
  function updateSlimProject(projectId, body, requestOptions) {
309
513
  return this.put(`/v1/slim/project/${encodeURIComponent(projectId)}`, body, undefined, requestOptions);
310
514
  }
515
+ /**
516
+ * Reads a project by id (`GET /v1/slim/project/{id}`).
517
+ */
311
518
  function getSlimProject(projectId, requestOptions) {
312
519
  return this.get(`/v1/slim/project/${encodeURIComponent(projectId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
313
520
  }
521
+ /**
522
+ * Lists access policies, paged (`GET /v1/slim/policy`).
523
+ */
314
524
  function listSlimPolicies(params = {}, requestOptions) {
315
525
  return this.get(`/v1/slim/policy${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
316
526
  }
527
+ /**
528
+ * Reads an access policy and its members (`GET /v1/slim/policy/{id}`).
529
+ */
317
530
  function getSlimPolicy(policyId, requestOptions) {
318
531
  return this.get(`/v1/slim/policy/${encodeURIComponent(policyId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
319
532
  }
533
+ /**
534
+ * Creates an access policy with its members (`POST /v1/slim/policy`).
535
+ */
320
536
  function createSlimPolicy(body, requestOptions) {
321
537
  return this.post("/v1/slim/policy", body, undefined, requestOptions);
322
538
  }
539
+ /**
540
+ * Updates an access policy and its members (`PUT /v1/slim/policy/{id}`).
541
+ */
323
542
  function updateSlimPolicy(policyId, body, requestOptions) {
324
543
  return this.put(`/v1/slim/policy/${encodeURIComponent(policyId)}`, body, undefined, requestOptions);
325
544
  }
545
+ /**
546
+ * Deletes an access policy (`DELETE /v1/slim/policy/{id}`).
547
+ */
326
548
  async function deleteSlimPolicy(policyId, requestOptions) {
327
549
  await this.delete(`/v1/slim/policy/${encodeURIComponent(policyId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
328
550
  }
551
+ /**
552
+ * Reads an organization by id (`GET /v1/slim/organization/{id}`).
553
+ */
329
554
  function getSlimOrganization(organizationId, requestOptions) {
330
555
  return this.get(`/v1/slim/organization/${encodeURIComponent(organizationId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
331
556
  }
557
+ /**
558
+ * Creates an organization (`POST /v1/slim/organization`).
559
+ */
332
560
  function createSlimOrganization(body, requestOptions) {
333
561
  return this.post("/v1/slim/organization", body, undefined, requestOptions);
334
562
  }
563
+ /**
564
+ * Updates an organization (`PUT /v1/slim/organization/{id}`).
565
+ */
335
566
  function updateSlimOrganization(organizationId, body, requestOptions) {
336
567
  return this.put(`/v1/slim/organization/${encodeURIComponent(organizationId)}`, body, undefined, requestOptions);
337
568
  }
569
+ /**
570
+ * Deletes an organization (`DELETE /v1/slim/organization/{id}`).
571
+ */
338
572
  async function deleteSlimOrganization(organizationId, requestOptions) {
339
573
  await this.delete(`/v1/slim/organization/${encodeURIComponent(organizationId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
340
574
  }
575
+ /**
576
+ * Invites a practitioner to the project (`POST /v1/slim/invite/practitioner`).
577
+ */
341
578
  function inviteSlimPractitioner(body, requestOptions) {
342
579
  return this.post("/v1/slim/invite/practitioner", body, undefined, requestOptions);
343
580
  }
581
+ /**
582
+ * Deletes a patient or practitioner user by profile id (`DELETE /v1/slim/user/{type}/{id}`).
583
+ */
344
584
  function deleteSlimUser(profileType, profileId, requestOptions) {
345
585
  return this.delete(`/v1/slim/user/${encodeURIComponent(profileType)}/${encodeURIComponent(profileId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
346
586
  }
587
+ /**
588
+ * Reads service health and dependency status (`GET /v1/slim/health`).
589
+ */
347
590
  function getSlimHealth(requestOptions) {
348
591
  return this.get("/v1/slim/health", ...(0, request_options_1.optionalArg)(requestOptions));
349
592
  }
@@ -1,18 +1,38 @@
1
1
  import { SlimPage } from "./types";
2
+ /**
3
+ * Options that bound how many pages a collecting helper fetches.
4
+ */
2
5
  export type SlimPagingOptions = {
6
+ /** Maximum pages to fetch; must be a positive integer. Unlimited when omitted. */
3
7
  maxPages?: number;
4
8
  };
9
+ /**
10
+ * Rows collected across pages.
11
+ */
5
12
  export type SlimPageCollection<T> = {
13
+ /** All rows fetched, in page order. */
6
14
  rows: T[];
15
+ /** Total row count reported by the server (row count fetched for cursor paging without a total). */
7
16
  total: number;
17
+ /** True when more pages remained after the `maxPages` limit was reached. */
8
18
  truncated: boolean;
9
19
  };
10
- /** Collects numbered Slim pages without exceeding the optional page limit. */
20
+ /**
21
+ * Collects numbered Slim pages without exceeding the optional page limit.
22
+ */
11
23
  export declare function iterateSlimPages<T>(loadPage: (page: number) => Promise<SlimPage<T>>, options?: SlimPagingOptions): Promise<SlimPageCollection<T>>;
24
+ /**
25
+ * One page of a cursor-paged Slim list.
26
+ */
12
27
  export type SlimCursorPage<T> = {
28
+ /** Rows on this page. */
13
29
  items: T[];
30
+ /** Cursor for the next page, or null on the last page. */
14
31
  nextCursor: string | null;
32
+ /** Total row count, when the server reports it. */
15
33
  total?: number;
16
34
  };
17
- /** Collects cursor pages, stopping at maxPages and rejecting a repeated cursor. */
35
+ /**
36
+ * Collects cursor pages, stopping at maxPages and rejecting a repeated cursor.
37
+ */
18
38
  export declare function iterateCursor<T>(loadPage: (cursor?: string) => Promise<SlimCursorPage<T>>, options?: SlimPagingOptions): Promise<SlimPageCollection<T>>;
@@ -11,7 +11,9 @@ const pageLimit = ({ maxPages }) => {
11
11
  }
12
12
  return maxPages;
13
13
  };
14
- /** Collects numbered Slim pages without exceeding the optional page limit. */
14
+ /**
15
+ * Collects numbered Slim pages without exceeding the optional page limit.
16
+ */
15
17
  async function iterateSlimPages(loadPage, options = {}) {
16
18
  const rows = [];
17
19
  const maxPages = pageLimit(options);
@@ -30,7 +32,9 @@ async function iterateSlimPages(loadPage, options = {}) {
30
32
  }
31
33
  return { rows, total, truncated: hasMore };
32
34
  }
33
- /** Collects cursor pages, stopping at maxPages and rejecting a repeated cursor. */
35
+ /**
36
+ * Collects cursor pages, stopping at maxPages and rejecting a repeated cursor.
37
+ */
34
38
  async function iterateCursor(loadPage, options = {}) {
35
39
  var _a, _b;
36
40
  const rows = [];