@ovok/core 0.4.49-dev.504 → 0.4.49-dev.515

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 (391) hide show
  1. package/dist/client/ai-fhir/methods/AIFhirResources.d.ts +3 -1
  2. package/dist/client/ai-fhir/methods/AIFhirResources.js +3 -1
  3. package/dist/client/ai-fhir/types/AIFhirPlan.d.ts +8 -0
  4. package/dist/client/ai-fhir/types/AIFhirPlanRequest.d.ts +8 -0
  5. package/dist/client/ai-fhir/types/AIFhirRequest.d.ts +5 -0
  6. package/dist/client/ai-fhir/types/AIFhirResponse.d.ts +6 -0
  7. package/dist/client/auth/errors.d.ts +15 -2
  8. package/dist/client/auth/errors.js +12 -2
  9. package/dist/client/auth/methods/appleLogin.d.ts +1 -0
  10. package/dist/client/auth/methods/appleLogin.js +1 -0
  11. package/dist/client/auth/methods/changePassword.d.ts +1 -0
  12. package/dist/client/auth/methods/changePassword.js +1 -0
  13. package/dist/client/auth/methods/googleLogin.d.ts +1 -0
  14. package/dist/client/auth/methods/googleLogin.js +1 -0
  15. package/dist/client/auth/methods/login.d.ts +6 -0
  16. package/dist/client/auth/methods/login.js +6 -0
  17. package/dist/client/auth/methods/register.d.ts +5 -0
  18. package/dist/client/auth/methods/register.js +5 -0
  19. package/dist/client/auth/methods/registerPractitioner.d.ts +5 -0
  20. package/dist/client/auth/methods/registerPractitioner.js +5 -0
  21. package/dist/client/auth/methods/reloadSession.d.ts +3 -0
  22. package/dist/client/auth/methods/requestDeleteUser.d.ts +4 -5
  23. package/dist/client/auth/methods/requestDeleteUser.js +4 -5
  24. package/dist/client/auth/methods/setPasswordFromReset.d.ts +1 -0
  25. package/dist/client/auth/methods/setPasswordFromReset.js +1 -0
  26. package/dist/client/auth/session-fetch.d.ts +11 -0
  27. package/dist/client/auth/types/Account.d.ts +8 -1
  28. package/dist/client/auth/types/AppleLoginBody.d.ts +16 -0
  29. package/dist/client/auth/types/AppleLoginBody.js +5 -0
  30. package/dist/client/auth/types/AuthResponse.d.ts +12 -0
  31. package/dist/client/auth/types/ChangePasswordBody.d.ts +7 -0
  32. package/dist/client/auth/types/ChangePasswordResponse.d.ts +5 -0
  33. package/dist/client/auth/types/CompletePasswordResetBody.d.ts +8 -0
  34. package/dist/client/auth/types/GoogleLoginBody.d.ts +5 -0
  35. package/dist/client/auth/types/LoginBody.d.ts +15 -1
  36. package/dist/client/auth/types/LoginError.d.ts +21 -2
  37. package/dist/client/auth/types/LoginError.js +8 -2
  38. package/dist/client/auth/types/LoginResponse.d.ts +8 -1
  39. package/dist/client/auth/types/RegisterBody.d.ts +12 -0
  40. package/dist/client/auth/types/RegisterPractitionerBody.d.ts +5 -0
  41. package/dist/client/auth/types/RegisterResponse.d.ts +7 -0
  42. package/dist/client/auth/types/RequestDeleteUserBody.d.ts +7 -7
  43. package/dist/client/auth/types/RequestDeleteUserResponse.d.ts +14 -0
  44. package/dist/client/auth/types/ResetPasswordBody.d.ts +5 -0
  45. package/dist/client/auth/types/Session.d.ts +14 -2
  46. package/dist/client/change-history/methods.d.ts +6 -0
  47. package/dist/client/change-history/methods.js +6 -0
  48. package/dist/client/change-history/types.d.ts +82 -0
  49. package/dist/client/chat/ai/methods/createAiSession.d.ts +6 -0
  50. package/dist/client/chat/ai/methods/createAiSession.js +6 -0
  51. package/dist/client/chat/ai/types/CreateAiSessionResponse.d.ts +17 -0
  52. package/dist/client/chat/ai/types/SessionMessagesResponse.d.ts +9 -0
  53. package/dist/client/cms/locale.d.ts +12 -2
  54. package/dist/client/cms/locale.js +9 -2
  55. package/dist/client/cms/methods.d.ts +6 -2
  56. package/dist/client/cms/methods.js +7 -3
  57. package/dist/client/cms/types.d.ts +44 -4
  58. package/dist/client/consent/methods.d.ts +16 -0
  59. package/dist/client/consent/methods.js +16 -0
  60. package/dist/client/consent/types.d.ts +53 -1
  61. package/dist/client/consent/types.js +10 -1
  62. package/dist/client/email/methods.d.ts +3 -0
  63. package/dist/client/email/methods.js +3 -0
  64. package/dist/client/email/types.d.ts +33 -0
  65. package/dist/client/errors/field-errors.d.ts +3 -0
  66. package/dist/client/errors/field-errors.js +3 -0
  67. package/dist/client/errors/ovok-error-utils.d.ts +6 -0
  68. package/dist/client/errors/ovok-error-utils.js +6 -0
  69. package/dist/client/errors/ovok-error.d.ts +36 -4
  70. package/dist/client/errors/ovok-error.js +15 -4
  71. package/dist/client/errors/rate-limit-error.d.ts +11 -2
  72. package/dist/client/errors/rate-limit-error.js +10 -2
  73. package/dist/client/errors/sign-in-required-error.d.ts +5 -2
  74. package/dist/client/errors/sign-in-required-error.js +5 -2
  75. package/dist/client/experience/methods.d.ts +38 -0
  76. package/dist/client/experience/methods.js +35 -0
  77. package/dist/client/experience/types.d.ts +316 -0
  78. package/dist/client/experience/types.js +1 -0
  79. package/dist/client/invites/methods.d.ts +27 -9
  80. package/dist/client/invites/methods.js +27 -9
  81. package/dist/client/invites/parse-accept-invite-link.d.ts +3 -1
  82. package/dist/client/invites/parse-accept-invite-link.js +3 -1
  83. package/dist/client/invites/types.d.ts +55 -0
  84. package/dist/client/invites/types.js +12 -0
  85. package/dist/client/notifications/methods.d.ts +15 -0
  86. package/dist/client/notifications/methods.js +15 -0
  87. package/dist/client/notifications/types.d.ts +249 -2
  88. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.d.ts +3 -0
  89. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js +3 -0
  90. package/dist/client/observation/methods/getLatestObservationsByCodes.d.ts +3 -0
  91. package/dist/client/observation/methods/getLatestObservationsByCodes.js +3 -0
  92. package/dist/client/observation/methods/observationsToMeasurements.d.ts +23 -1
  93. package/dist/client/observation/methods/observationsToMeasurements.js +8 -1
  94. package/dist/client/observation/methods/saveMeasurement.d.ts +3 -1
  95. package/dist/client/observation/methods/saveMeasurement.js +3 -1
  96. package/dist/client/observation/observation-bundle-utils.d.ts +6 -0
  97. package/dist/client/observation/observation-bundle-utils.js +6 -0
  98. package/dist/client/observation/series.d.ts +25 -3
  99. package/dist/client/observation/series.js +6 -2
  100. package/dist/client/observation/services/creator.d.ts +5 -0
  101. package/dist/client/observation/services/creator.js +5 -0
  102. package/dist/client/observation/services/uric-acid-service.js +0 -1
  103. package/dist/client/observation/types/GetLatestObservationsByCodeParams.d.ts +10 -0
  104. package/dist/client/observation/types/MeasurementTypeKey.d.ts +26 -0
  105. package/dist/client/observation/types/MeasurementTypeKey.js +26 -0
  106. package/dist/client/observation/types/ObservationCode.d.ts +64 -1
  107. package/dist/client/observation/types/ObservationCode.js +64 -1
  108. package/dist/client/observation/types/UrineAnalytes.d.ts +14 -0
  109. package/dist/client/observation/types/UrineAnalytes.js +1 -0
  110. package/dist/client/observation/types/generate-measurement/Sample.d.ts +33 -0
  111. package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts +9 -0
  112. package/dist/client/observation/types/measurement/BabySleepMeasurement.d.ts +3 -0
  113. package/dist/client/observation/types/measurement/BloodGlucoseMeasurement.d.ts +7 -0
  114. package/dist/client/observation/types/measurement/BloodPressureMeasurement.d.ts +10 -0
  115. package/dist/client/observation/types/measurement/BloodPressureStates.d.ts +10 -0
  116. package/dist/client/observation/types/measurement/BloodPressureStates.js +10 -0
  117. package/dist/client/observation/types/measurement/BodyTemperatureMeasurement.d.ts +7 -0
  118. package/dist/client/observation/types/measurement/BodyWeightMeasurmement.d.ts +8 -0
  119. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.d.ts +18 -0
  120. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.js +18 -0
  121. package/dist/client/observation/types/measurement/EcgMeasurement.d.ts +9 -0
  122. package/dist/client/observation/types/measurement/HeartRateMeasurement.d.ts +7 -0
  123. package/dist/client/observation/types/measurement/HeartRateVariabilityMeasurement.d.ts +7 -0
  124. package/dist/client/observation/types/measurement/LipidPanelMeasurement.d.ts +12 -0
  125. package/dist/client/observation/types/measurement/Measurement.d.ts +9 -0
  126. package/dist/client/observation/types/measurement/MeasurementDevice.d.ts +10 -0
  127. package/dist/client/observation/types/measurement/MeasurementSeries.d.ts +2 -0
  128. package/dist/client/observation/types/measurement/PulseOximeterMeasurement.d.ts +10 -0
  129. package/dist/client/observation/types/measurement/RespiratoryRateMeasurement.d.ts +7 -0
  130. package/dist/client/observation/types/measurement/RespiratoryTherapyMeasurement.d.ts +3 -0
  131. package/dist/client/observation/types/measurement/RestingHeartRateMeasurement.d.ts +7 -0
  132. package/dist/client/observation/types/measurement/SpirometryMeasurement.d.ts +23 -0
  133. package/dist/client/observation/types/measurement/StepCountMeasurement.d.ts +9 -0
  134. package/dist/client/observation/types/measurement/UrineAnalyzeMeasurement.d.ts +29 -0
  135. package/dist/client/observation/types/measurement/Vo2MaxMeasurement.d.ts +7 -0
  136. package/dist/client/observation/types/measurement/WalkingHeartRateAverageMeasurement.d.ts +7 -0
  137. package/dist/client/observation/types/service/MeasurementField.d.ts +5 -1
  138. package/dist/client/observation/utils/getObservationValueDisplay.d.ts +2 -0
  139. package/dist/client/offline/offline-measurement-queue.d.ts +56 -1
  140. package/dist/client/offline/offline-measurement-queue.js +21 -0
  141. package/dist/client/offline/shared-measurement-queue.d.ts +16 -1
  142. package/dist/client/offline/shared-measurement-queue.js +3 -1
  143. package/dist/client/ovok-client.d.ts +27 -6
  144. package/dist/client/ovok-client.js +8 -5
  145. package/dist/client/patient/methods.d.ts +21 -0
  146. package/dist/client/patient/methods.js +21 -0
  147. package/dist/client/patient/types.d.ts +131 -0
  148. package/dist/client/patient-sharing/methods.d.ts +18 -0
  149. package/dist/client/patient-sharing/methods.js +18 -0
  150. package/dist/client/patient-sharing/types.d.ts +89 -1
  151. package/dist/client/platform/methods.d.ts +22 -0
  152. package/dist/client/platform/methods.js +20 -0
  153. package/dist/client/platform/types.d.ts +194 -1
  154. package/dist/client/platform/types.js +24 -0
  155. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.d.ts +3 -0
  156. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.js +3 -0
  157. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.d.ts +3 -0
  158. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.js +3 -0
  159. package/dist/client/questionnaire-response/methods/populateQuestionnaire.d.ts +3 -0
  160. package/dist/client/questionnaire-response/methods/populateQuestionnaire.js +3 -0
  161. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.d.ts +3 -0
  162. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.js +3 -0
  163. package/dist/client/questionnaire-response/types.d.ts +6 -0
  164. package/dist/client/signals/errors.d.ts +13 -2
  165. package/dist/client/signals/errors.js +9 -2
  166. package/dist/client/signals/methods.d.ts +9 -0
  167. package/dist/client/signals/methods.js +9 -0
  168. package/dist/client/signals/types.d.ts +31 -0
  169. package/dist/client/slim/methods.d.ts +268 -21
  170. package/dist/client/slim/methods.js +264 -21
  171. package/dist/client/slim/paging.d.ts +22 -2
  172. package/dist/client/slim/paging.js +6 -2
  173. package/dist/client/slim/types.d.ts +920 -1
  174. package/dist/client/storage.d.ts +15 -1
  175. package/dist/client/storage.js +7 -1
  176. package/dist/client/wearables/methods.d.ts +24 -0
  177. package/dist/client/wearables/methods.js +24 -0
  178. package/dist/client/wearables/types.d.ts +74 -0
  179. package/dist/conformance/api-requirements.d.ts +31 -5
  180. package/dist/conformance/api-requirements.js +47 -10
  181. package/dist/conformance/capability-requirements.d.ts +4 -26
  182. package/dist/conformance/capability-requirements.js +5 -27
  183. package/dist/conformance/capability.d.ts +9 -1
  184. package/dist/conformance/capability.js +3 -1
  185. package/dist/hooks/account-hooks.d.ts +35 -0
  186. package/dist/hooks/account-hooks.js +33 -0
  187. package/dist/hooks/api-hooks.d.ts +74 -4
  188. package/dist/hooks/api-hooks.js +56 -4
  189. package/dist/hooks/cms-hooks.d.ts +9 -3
  190. package/dist/hooks/cms-hooks.js +9 -3
  191. package/dist/hooks/email-hooks.d.ts +3 -0
  192. package/dist/hooks/email-hooks.js +3 -0
  193. package/dist/hooks/experience-hooks.d.ts +26 -0
  194. package/dist/hooks/experience-hooks.js +24 -0
  195. package/dist/hooks/index.d.ts +18 -0
  196. package/dist/hooks/index.js +18 -0
  197. package/dist/hooks/invites-hooks.d.ts +21 -2
  198. package/dist/hooks/invites-hooks.js +21 -2
  199. package/dist/hooks/notification-ack-hooks.d.ts +6 -2
  200. package/dist/hooks/notification-ack-hooks.js +6 -2
  201. package/dist/hooks/notification-hooks.d.ts +27 -3
  202. package/dist/hooks/notification-hooks.js +27 -3
  203. package/dist/hooks/notification-note-hooks.d.ts +41 -0
  204. package/dist/hooks/notification-note-hooks.js +33 -0
  205. package/dist/hooks/observation-hooks.d.ts +29 -0
  206. package/dist/hooks/observation-hooks.js +23 -1
  207. package/dist/hooks/patient-hooks.d.ts +53 -0
  208. package/dist/hooks/patient-hooks.js +48 -0
  209. package/dist/hooks/patient-sharing-hooks.d.ts +18 -0
  210. package/dist/hooks/patient-sharing-hooks.js +18 -0
  211. package/dist/hooks/platform-hooks.d.ts +32 -0
  212. package/dist/hooks/platform-hooks.js +23 -0
  213. package/dist/hooks/poll-hooks.d.ts +17 -1
  214. package/dist/hooks/poll-hooks.js +3 -1
  215. package/dist/hooks/signals-hooks.d.ts +3 -0
  216. package/dist/hooks/signals-hooks.js +3 -0
  217. package/dist/hooks/wearables-hooks.d.ts +23 -0
  218. package/dist/hooks/wearables-hooks.js +21 -0
  219. package/dist/next/auth/saved-accounts-store.d.ts +10 -0
  220. package/dist/next/auth/session.d.ts +17 -0
  221. package/dist/next/auth/user-session.d.ts +5 -0
  222. package/dist/next/config/ovok-config.d.ts +45 -0
  223. package/dist/next/errors/ovok-account-error.d.ts +14 -1
  224. package/dist/next/errors/ovok-account-error.js +8 -1
  225. package/dist/next/errors/ovok-errors.d.ts +88 -0
  226. package/dist/next/errors/ovok-errors.js +67 -0
  227. package/dist/next/http/http-client.d.ts +5 -0
  228. package/dist/next/http/transmit.d.ts +7 -0
  229. package/dist/next/http/url.d.ts +10 -0
  230. package/dist/next/ovok.d.ts +31 -1
  231. package/dist/next/ovok.js +5 -1
  232. package/dist/next/paging/page.d.ts +13 -1
  233. package/dist/next/react/context.d.ts +7 -0
  234. package/dist/next/react/context.js +7 -0
  235. package/dist/next/react/index.d.ts +24 -0
  236. package/dist/next/react/index.js +18 -0
  237. package/dist/next/react/query-hooks.d.ts +69 -0
  238. package/dist/next/react/query-hooks.js +31 -0
  239. package/dist/next/resources/accounts/accounts-resource.d.ts +6 -0
  240. package/dist/next/resources/accounts/accounts-resource.js +6 -0
  241. package/dist/next/resources/ai/ai-chat-resource.d.ts +7 -0
  242. package/dist/next/resources/ai/ai-chat-resource.js +5 -0
  243. package/dist/next/resources/ai/ai-resource.d.ts +13 -0
  244. package/dist/next/resources/ai/ai-resource.js +6 -0
  245. package/dist/next/resources/ai/chat-messages-resource.d.ts +7 -0
  246. package/dist/next/resources/ai/chat-messages-resource.js +7 -0
  247. package/dist/next/resources/ai/chat-sessions-resource.d.ts +14 -0
  248. package/dist/next/resources/ai/chat-sessions-resource.js +8 -0
  249. package/dist/next/resources/auth/auth-sessions-resource.d.ts +6 -1
  250. package/dist/next/resources/auth/auth-sessions-resource.js +6 -1
  251. package/dist/next/resources/auth/registration.d.ts +18 -1
  252. package/dist/next/resources/auth/social-login.d.ts +12 -0
  253. package/dist/next/resources/auth-resource.d.ts +54 -1
  254. package/dist/next/resources/auth-resource.js +23 -0
  255. package/dist/next/resources/bots/bots-resource.d.ts +15 -0
  256. package/dist/next/resources/bots/bots-resource.js +5 -0
  257. package/dist/next/resources/cms/cms-delivery.d.ts +14 -2
  258. package/dist/next/resources/cms/cms-documents-resource.d.ts +7 -1
  259. package/dist/next/resources/cms/cms-documents-resource.js +7 -1
  260. package/dist/next/resources/cms/cms-resource.d.ts +7 -0
  261. package/dist/next/resources/cms/cms-resource.js +5 -0
  262. package/dist/next/resources/cms/release-notes-resource.d.ts +6 -0
  263. package/dist/next/resources/cms/release-notes-resource.js +6 -0
  264. package/dist/next/resources/consent/consent-resource.d.ts +22 -0
  265. package/dist/next/resources/consent/consent-resource.js +20 -0
  266. package/dist/next/resources/content/content-resource.d.ts +18 -0
  267. package/dist/next/resources/content/content-resource.js +12 -0
  268. package/dist/next/resources/documents/documents-resource.d.ts +24 -0
  269. package/dist/next/resources/documents/documents-resource.js +10 -0
  270. package/dist/next/resources/email/email-resource.d.ts +6 -0
  271. package/dist/next/resources/email/email-resource.js +5 -0
  272. package/dist/next/resources/email/email-templates-resource.d.ts +6 -0
  273. package/dist/next/resources/email/email-templates-resource.js +6 -0
  274. package/dist/next/resources/fhir-resource.d.ts +36 -0
  275. package/dist/next/resources/fhir-resource.js +21 -0
  276. package/dist/next/resources/health-resource.d.ts +16 -0
  277. package/dist/next/resources/health-resource.js +5 -0
  278. package/dist/next/resources/invites/invite-flow-resource.d.ts +7 -1
  279. package/dist/next/resources/invites/invite-flow-resource.js +7 -1
  280. package/dist/next/resources/invites/invites-resource.d.ts +15 -0
  281. package/dist/next/resources/invites/invites-resource.js +5 -0
  282. package/dist/next/resources/localization/i18next-resource.d.ts +6 -0
  283. package/dist/next/resources/localization/i18next-resource.js +6 -0
  284. package/dist/next/resources/localization/locales-resource.d.ts +7 -0
  285. package/dist/next/resources/localization/locales-resource.js +7 -0
  286. package/dist/next/resources/localization/localizations-resource.d.ts +17 -0
  287. package/dist/next/resources/localization/localizations-resource.js +9 -0
  288. package/dist/next/resources/measurements/measurements-resource.d.ts +53 -1
  289. package/dist/next/resources/measurements/measurements-resource.js +14 -0
  290. package/dist/next/resources/measurements/observation-builder.d.ts +5 -0
  291. package/dist/next/resources/measurements/offline-measurement-queue-types.d.ts +32 -0
  292. package/dist/next/resources/patient/fhir-records.d.ts +19 -1
  293. package/dist/next/resources/patient/fhir-records.js +19 -1
  294. package/dist/next/resources/patient/patient-resource.d.ts +15 -0
  295. package/dist/next/resources/patient/patient-resource.js +6 -0
  296. package/dist/next/resources/projects/project-features-resource.d.ts +7 -0
  297. package/dist/next/resources/projects/project-features-resource.js +7 -0
  298. package/dist/next/resources/projects/project-members-resource.d.ts +19 -0
  299. package/dist/next/resources/projects/project-members-resource.js +9 -0
  300. package/dist/next/resources/projects/project-settings-resource.d.ts +8 -0
  301. package/dist/next/resources/projects/project-settings-resource.js +8 -0
  302. package/dist/next/resources/projects/projects-resource.d.ts +15 -0
  303. package/dist/next/resources/projects/projects-resource.js +5 -0
  304. package/dist/next/resources/questionnaires/questionnaires-resource.d.ts +13 -0
  305. package/dist/next/resources/questionnaires/questionnaires-resource.js +13 -0
  306. package/dist/next/resources/realtime/realtime-resource.d.ts +11 -0
  307. package/dist/next/resources/realtime/realtime-resource.js +11 -0
  308. package/dist/next/resources/realtime/realtime-types.d.ts +16 -0
  309. package/dist/next/resources/session/saved-accounts-resource.d.ts +16 -0
  310. package/dist/next/resources/session/saved-accounts-resource.js +16 -0
  311. package/dist/next/resources/session/session-resource.d.ts +8 -0
  312. package/dist/next/resources/session/session-resource.js +7 -0
  313. package/dist/next/resources/sharing/sharing-invites-resource.d.ts +7 -0
  314. package/dist/next/resources/sharing/sharing-invites-resource.js +7 -0
  315. package/dist/next/resources/sharing/sharing-resource.d.ts +8 -0
  316. package/dist/next/resources/sharing/sharing-resource.js +5 -0
  317. package/dist/next/resources/sharing/sharing-settings-resource.d.ts +7 -0
  318. package/dist/next/resources/sharing/sharing-settings-resource.js +7 -0
  319. package/dist/next/resources/sharing/sharing-shares-resource.d.ts +7 -0
  320. package/dist/next/resources/sharing/sharing-shares-resource.js +7 -0
  321. package/dist/next/resources/signals/signals-gateway-resource.d.ts +15 -0
  322. package/dist/next/resources/signals/signals-gateway-resource.js +6 -0
  323. package/dist/next/resources/signals/signals-resource.d.ts +7 -0
  324. package/dist/next/resources/signals/signals-resource.js +5 -0
  325. package/dist/next/resources/signals/undeliverable-resource.d.ts +35 -0
  326. package/dist/next/resources/signals/undeliverable-resource.js +6 -0
  327. package/dist/next/resources/slim/slim-alarms-resource.d.ts +7 -0
  328. package/dist/next/resources/slim/slim-alarms-resource.js +7 -0
  329. package/dist/next/resources/slim/slim-change-history-resource.d.ts +6 -0
  330. package/dist/next/resources/slim/slim-change-history-resource.js +6 -0
  331. package/dist/next/resources/slim/slim-child-projects-resource.d.ts +21 -0
  332. package/dist/next/resources/slim/slim-child-projects-resource.js +8 -0
  333. package/dist/next/resources/slim/slim-devices-resource.d.ts +31 -0
  334. package/dist/next/resources/slim/slim-devices-resource.js +16 -0
  335. package/dist/next/resources/slim/slim-exports-resource.d.ts +6 -0
  336. package/dist/next/resources/slim/slim-exports-resource.js +6 -0
  337. package/dist/next/resources/slim/slim-locations-resource.d.ts +9 -0
  338. package/dist/next/resources/slim/slim-locations-resource.js +9 -0
  339. package/dist/next/resources/slim/slim-medical-notifications-resource.d.ts +6 -0
  340. package/dist/next/resources/slim/slim-medical-notifications-resource.js +6 -0
  341. package/dist/next/resources/slim/slim-notification-notes-resource.d.ts +10 -0
  342. package/dist/next/resources/slim/slim-notification-notes-resource.js +10 -0
  343. package/dist/next/resources/slim/slim-notifications-resource.d.ts +10 -0
  344. package/dist/next/resources/slim/slim-notifications-resource.js +6 -0
  345. package/dist/next/resources/slim/slim-organizations-resource.d.ts +9 -0
  346. package/dist/next/resources/slim/slim-organizations-resource.js +9 -0
  347. package/dist/next/resources/slim/slim-out-of-bed-resource.d.ts +12 -0
  348. package/dist/next/resources/slim/slim-out-of-bed-resource.js +7 -0
  349. package/dist/next/resources/slim/slim-patient-thresholds-resource.d.ts +6 -0
  350. package/dist/next/resources/slim/slim-patient-thresholds-resource.js +6 -0
  351. package/dist/next/resources/slim/slim-patients-resource.d.ts +11 -0
  352. package/dist/next/resources/slim/slim-patients-resource.js +10 -0
  353. package/dist/next/resources/slim/slim-policies-resource.d.ts +10 -0
  354. package/dist/next/resources/slim/slim-policies-resource.js +10 -0
  355. package/dist/next/resources/slim/slim-practitioners-resource.d.ts +6 -0
  356. package/dist/next/resources/slim/slim-practitioners-resource.js +6 -0
  357. package/dist/next/resources/slim/slim-projects-resource.d.ts +12 -0
  358. package/dist/next/resources/slim/slim-projects-resource.js +11 -0
  359. package/dist/next/resources/slim/slim-queries.d.ts +51 -0
  360. package/dist/next/resources/slim/slim-resource.d.ts +21 -0
  361. package/dist/next/resources/slim/slim-resource.js +6 -0
  362. package/dist/next/resources/slim/slim-sleep-resource.d.ts +6 -0
  363. package/dist/next/resources/slim/slim-sleep-resource.js +6 -0
  364. package/dist/next/resources/slim/slim-thresholds-resource.d.ts +5 -0
  365. package/dist/next/resources/slim/slim-thresholds-resource.js +5 -0
  366. package/dist/next/resources/slim/slim-trends-resource.d.ts +6 -0
  367. package/dist/next/resources/slim/slim-trends-resource.js +6 -0
  368. package/dist/next/resources/slim/slim-users-resource.d.ts +12 -0
  369. package/dist/next/resources/slim/slim-users-resource.js +6 -0
  370. package/dist/next/resources/slim/slim-zones-resource.d.ts +8 -0
  371. package/dist/next/resources/slim/slim-zones-resource.js +8 -0
  372. package/dist/next/resources/video-calls/video-call-access-resource.d.ts +13 -0
  373. package/dist/next/resources/video-calls/video-call-access-resource.js +8 -0
  374. package/dist/next/resources/video-calls/video-call-appointments-resource.d.ts +8 -0
  375. package/dist/next/resources/video-calls/video-call-appointments-resource.js +8 -0
  376. package/dist/next/resources/video-calls/video-call-emails-resource.d.ts +8 -0
  377. package/dist/next/resources/video-calls/video-call-emails-resource.js +8 -0
  378. package/dist/next/resources/video-calls/video-calls-resource.d.ts +14 -0
  379. package/dist/next/resources/video-calls/video-calls-resource.js +6 -0
  380. package/dist/next/resources/wearables/wearable-connections-resource.d.ts +8 -0
  381. package/dist/next/resources/wearables/wearable-connections-resource.js +8 -0
  382. package/dist/next/resources/wearables/wearable-providers-resource.d.ts +10 -0
  383. package/dist/next/resources/wearables/wearable-providers-resource.js +10 -0
  384. package/dist/next/resources/wearables/wearables-resource.d.ts +7 -0
  385. package/dist/next/resources/wearables/wearables-resource.js +5 -0
  386. package/dist/next/storage/ovok-storage.d.ts +16 -0
  387. package/dist/next/storage/ovok-storage.js +8 -0
  388. package/dist/types/ValidationError.d.ts +9 -0
  389. package/dist/utils/patch/getPatchOperationType.d.ts +3 -0
  390. package/dist/utils/patch/getPatchOperationType.js +3 -0
  391. package/package.json +5 -2
@@ -37,12 +37,19 @@ exports.searchAIFhir = searchAIFhir;
37
37
  const query_string_1 = require("../query-string");
38
38
  const request_options_1 = require("../request-options");
39
39
  const documentUrl = (client, path, params) => `${client.getBaseUrl().replace(/\/$/, "")}${path}${(0, query_string_1.toQueryString)(params)}`;
40
+ /**
41
+ * Requests the signed PDF of a consent (`POST /consent/signature/{consentId}`).
42
+ *
43
+ * @param consentId - Id of the Consent resource to sign.
44
+ */
40
45
  async function requestConsentSignature(consentId, requestOptions) {
41
46
  return this.post(`/consent/signature/${encodeURIComponent(consentId)}`, undefined, undefined, requestOptions);
42
47
  }
48
+ /** Registers a document and returns the upload options for its file (`POST /document`). */
43
49
  async function createDocumentUpload(body, requestOptions) {
44
50
  return this.post("/document", body, undefined, requestOptions);
45
51
  }
52
+ /** Searches the user's documents (`GET /document`). */
46
53
  async function listDocuments(params = {}, requestOptions) {
47
54
  return this.get(`/document${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
48
55
  }
@@ -54,87 +61,115 @@ async function getDocumentDownloadUrl(documentId, params = {}) {
54
61
  async function getPublicDocumentDownloadUrl(token, params = {}) {
55
62
  return documentUrl(this, `/document/public/${encodeURIComponent(token)}`, params);
56
63
  }
64
+ /** Deletes a document (`DELETE /document/{documentId}`). */
57
65
  async function deleteDocument(documentId, requestOptions) {
58
66
  return (await this.delete(`/document/${encodeURIComponent(documentId)}`, ...(0, request_options_1.optionalArg)(requestOptions)));
59
67
  }
68
+ /** Changes a document's file name, content type or visibility (`PATCH /document/{documentId}`). */
60
69
  async function updateDocumentMetadata(documentId, body, requestOptions) {
61
70
  return (await this.patch(`/document/${encodeURIComponent(documentId)}`, body, ...(0, request_options_1.optionalArg)(requestOptions)));
62
71
  }
72
+ /** Returns upload options to replace a document's file (`POST /document/{documentId}`). */
63
73
  async function generateDocumentReplacementUpload(documentId, body, requestOptions) {
64
74
  return this.post(`/document/${encodeURIComponent(documentId)}`, body, undefined, requestOptions);
65
75
  }
76
+ /** Searches CMS content of a type with the matching parent-project content (`GET /cms/{type}/map/{language}`). */
66
77
  async function searchMappedContent(type, language, params = {}, requestOptions) {
67
78
  return this.get(`/cms/${encodeURIComponent(type)}/map/${encodeURIComponent(language)}${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
68
79
  }
80
+ /** Copies all CMS content of a type and language from the parent project (`POST /cms/{type}/{language}/copy-from-parent-project`). */
69
81
  async function copyContentsFromParent(type, language, requestOptions) {
70
82
  return this.post(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}/copy-from-parent-project`, undefined, undefined, requestOptions);
71
83
  }
84
+ /** Copies one CMS content item from the parent project (`POST /cms/{type}/{language}/{key}/copy-from-parent-project`). */
72
85
  async function copyContentFromParent(type, language, key, requestOptions) {
73
86
  return this.post(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}/${encodeURIComponent(key)}/copy-from-parent-project`, undefined, undefined, requestOptions);
74
87
  }
88
+ /** Creates a CMS content item (`POST /cms/{type}/{language}`). */
75
89
  async function createContent(type, language, body, requestOptions) {
76
90
  return this.post(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}`, body, undefined, requestOptions);
77
91
  }
92
+ /** Replaces a CMS content item (`PUT /cms/{type}/{language}/{key}`). */
78
93
  async function updateContent(type, language, key, body, requestOptions) {
79
94
  return (await this.put(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}/${encodeURIComponent(key)}`, body, undefined, requestOptions));
80
95
  }
96
+ /** Reads a CMS content item (`GET /cms/{type}/{language}/{key}`). */
81
97
  async function getContent(type, language, key, requestOptions) {
82
98
  return this.get(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}/${encodeURIComponent(key)}`, ...(0, request_options_1.optionalArg)(requestOptions));
83
99
  }
100
+ /** Deletes a CMS content item (`DELETE /cms/{type}/{language}/{key}`). */
84
101
  async function deleteContent(type, language, key, requestOptions) {
85
102
  await this.delete(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}/${encodeURIComponent(key)}`, ...(0, request_options_1.optionalArg)(requestOptions));
86
103
  }
104
+ /** Searches CMS content of a type and language (`GET /cms/{type}/{language}`). */
87
105
  async function searchContent(type, language, params = {}, requestOptions) {
88
106
  return this.get(`/cms/${encodeURIComponent(type)}/${encodeURIComponent(language)}${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
89
107
  }
108
+ /** Creates a video-call appointment (`POST /video-call/livekit/appointment`). */
90
109
  async function createVideoCallAppointment(body, requestOptions) {
91
110
  return this.post("/video-call/livekit/appointment", body, undefined, requestOptions);
92
111
  }
112
+ /** Updates a video-call appointment (`PUT /video-call/livekit/appointment/{appointmentId}`). */
93
113
  async function updateVideoCallAppointment(appointmentId, body, requestOptions) {
94
114
  return (await this.put(`/video-call/livekit/appointment/${encodeURIComponent(appointmentId)}`, body, undefined, requestOptions));
95
115
  }
116
+ /** Lists video-call appointments, optionally within a date range (`GET /video-call/livekit/appointment`). */
96
117
  async function listVideoCallAppointments(params = {}, requestOptions) {
97
118
  return this.get(`/video-call/livekit/appointment${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
98
119
  }
120
+ /** Checks the user's permission to join a video call (`GET /video-call/livekit/access-permission/{appointmentId}`). */
99
121
  async function getVideoCallAccessPermission(appointmentId, requestOptions) {
100
122
  return this.get(`/video-call/livekit/access-permission/${encodeURIComponent(appointmentId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
101
123
  }
124
+ /** Creates access to a video call for a guest by email (`POST /video-call/livekit/guest-access/{appointmentId}`). */
102
125
  async function createVideoCallGuestAccess(appointmentId, body, requestOptions) {
103
126
  return this.post(`/video-call/livekit/guest-access/${encodeURIComponent(appointmentId)}`, body, undefined, requestOptions);
104
127
  }
128
+ /** Creates access to a video call for the signed-in user (`POST /video-call/livekit/user-access/{appointmentId}`). */
105
129
  async function createVideoCallUserAccess(appointmentId, requestOptions) {
106
130
  return this.post(`/video-call/livekit/user-access/${encodeURIComponent(appointmentId)}`, undefined, undefined, requestOptions);
107
131
  }
132
+ /** Emails invitations to a video-call appointment (`POST /video-call/livekit/mail/invite`). */
108
133
  async function sendVideoCallInvite(body, requestOptions) {
109
134
  return this.post("/video-call/livekit/mail/invite", body, undefined, requestOptions);
110
135
  }
136
+ /** Emails an update of a video-call appointment (`POST /video-call/livekit/mail/update`). */
111
137
  async function sendVideoCallUpdate(body, requestOptions) {
112
138
  return this.post("/video-call/livekit/mail/update", body, undefined, requestOptions);
113
139
  }
140
+ /** Emails a cancellation of a video-call appointment (`POST /video-call/livekit/mail/cancel`). */
114
141
  async function sendVideoCallCancellation(body, requestOptions) {
115
142
  return this.post("/video-call/livekit/mail/cancel", body, undefined, requestOptions);
116
143
  }
144
+ /** Notifies the participants that a video call is active (`POST /video-call/livekit/notification/active-call/{appointmentId}`). */
117
145
  async function sendVideoCallActiveNotification(appointmentId, requestOptions) {
118
146
  return this.post(`/video-call/livekit/notification/active-call/${encodeURIComponent(appointmentId)}`, undefined, undefined, requestOptions);
119
147
  }
148
+ /** Translates texts between two languages (`POST /ai/translation`). */
120
149
  async function translate(body, requestOptions) {
121
150
  return this.post("/ai/translation", body, undefined, requestOptions);
122
151
  }
152
+ /** Creates an AI chat session (`POST /ai/session`). */
123
153
  async function createChatSession(body, requestOptions) {
124
154
  return this.post("/ai/session", body, undefined, requestOptions);
125
155
  }
156
+ /** Sends a message in an AI chat session (`POST /ai/session/{sessionId}/message`). */
126
157
  async function sendChatMessage(sessionId, body, requestOptions) {
127
158
  return this.post(`/ai/session/${encodeURIComponent(sessionId)}/message`, body, undefined, requestOptions);
128
159
  }
160
+ /** Lists AI chat sessions (`GET /ai/session`). */
129
161
  async function listChatSessions(params = {}, requestOptions) {
130
162
  return this.get(`/ai/session${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
131
163
  }
164
+ /** Reads an AI chat session (`GET /ai/session/{sessionId}`). */
132
165
  async function getChatSession(sessionId, params = {}, requestOptions) {
133
166
  return this.get(`/ai/session/${encodeURIComponent(sessionId)}${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
134
167
  }
168
+ /** Lists the messages of an AI chat session (`GET /ai/session/{sessionId}/message`). */
135
169
  async function listChatMessages(sessionId, params = {}, requestOptions) {
136
170
  return this.get(`/ai/session/${encodeURIComponent(sessionId)}/message${(0, query_string_1.toQueryString)(params)}`, ...(0, request_options_1.optionalArg)(requestOptions));
137
171
  }
172
+ /** Runs an AI FHIR search with an untyped body (`POST /ai/fhir/search`). */
138
173
  async function searchAIFhir(request, requestOptions) {
139
174
  return this.post("/ai/fhir/search", request, undefined, requestOptions);
140
175
  }
@@ -1,207 +1,523 @@
1
+ /**
2
+ * Metadata of the signed consent PDF.
3
+ *
4
+ * @category consent
5
+ */
1
6
  export type OvokConsentSignatureResponse = {
7
+ /** Number of pages in the PDF. */
2
8
  numberOfPages: number;
9
+ /** PDF title. */
3
10
  title: string;
11
+ /** PDF author. */
4
12
  author: string;
13
+ /** PDF subject. */
5
14
  subject: string;
15
+ /** Id of the stored document. */
6
16
  documentId: string;
17
+ /** Email address the PDF was sent to. */
7
18
  email: string;
8
19
  };
20
+ /**
21
+ * Request body that registers a new document.
22
+ *
23
+ * @category documents
24
+ */
9
25
  export type OvokDocumentUploadRequest = {
26
+ /** Name of the file. */
10
27
  fileName: string;
28
+ /** MIME type of the file. */
11
29
  contentType: string;
30
+ /** Whether the document is reachable through a public token. */
12
31
  isPublic?: boolean;
13
32
  };
33
+ /**
34
+ * Pre-signed upload target for a document's file.
35
+ *
36
+ * @category documents
37
+ */
14
38
  export type OvokDocumentUploadOptions = {
39
+ /** URL to post the file to. */
15
40
  url: string;
41
+ /** Form fields to send with the file. */
16
42
  fields: Record<string, string>;
17
43
  };
44
+ /**
45
+ * A stored document.
46
+ *
47
+ * @category documents
48
+ */
18
49
  export type OvokDocumentFile = {
50
+ /** Document id. */
19
51
  id: string;
52
+ /** Resource metadata. */
20
53
  meta?: {
54
+ /** ISO 8601 time of the last change. */
21
55
  lastUpdated: string;
22
56
  };
57
+ /** Who uploaded the document. */
23
58
  author?: {
59
+ /** Reference to the author, e.g. `Practitioner/123`. */
24
60
  reference?: string;
61
+ /** Display name of the author. */
25
62
  display?: string;
26
63
  };
64
+ /** Name of the file. */
27
65
  fileName?: string;
66
+ /** MIME type of the file. */
28
67
  contentType?: string;
68
+ /** Upload target, present when the file still has to be uploaded. */
29
69
  uploadOptions?: OvokDocumentUploadOptions;
70
+ /** Token for the public download URL, when the document is public. */
30
71
  publicToken?: string;
31
72
  };
73
+ /**
74
+ * Paging and sorting of a document search.
75
+ *
76
+ * @category documents
77
+ */
32
78
  export type OvokDocumentSearchQuery = {
79
+ /** Page size. */
33
80
  _count?: number;
81
+ /** Number of results to skip. */
34
82
  _offset?: number;
83
+ /** Field to sort by; prefix `-` for descending. */
35
84
  _sort?: string;
36
85
  };
86
+ /**
87
+ * A page of documents.
88
+ *
89
+ * @category documents
90
+ */
37
91
  export type OvokDocumentSearchResponse = {
92
+ /** Number of matching documents. */
38
93
  total: number;
94
+ /** Documents on this page. */
39
95
  resources: OvokDocumentFile[];
40
96
  };
97
+ /**
98
+ * Fields of a document that can be changed.
99
+ *
100
+ * @category documents
101
+ */
41
102
  export type OvokDocumentMetadataUpdate = {
103
+ /** New file name. */
42
104
  fileName?: string;
105
+ /** New visibility. */
43
106
  isPublic?: boolean;
107
+ /** New MIME type. */
44
108
  contentType?: string;
45
109
  };
110
+ /**
111
+ * Request body that replaces a document's file.
112
+ *
113
+ * @category documents
114
+ */
46
115
  export type OvokDocumentReplacement = {
116
+ /** Name of the new file. */
47
117
  fileName: string;
118
+ /** MIME type of the new file. */
48
119
  contentType: string;
120
+ /** Whether the document is reachable through a public token. */
49
121
  isPublic?: boolean;
50
122
  };
123
+ /**
124
+ * Kind of CMS content.
125
+ *
126
+ * @category content
127
+ */
51
128
  export type OvokContentType = "blog" | "video" | "audio" | "template" | "export-template";
129
+ /**
130
+ * One section of a content item.
131
+ *
132
+ * @category content
133
+ */
52
134
  export type OvokContentSection = {
135
+ /** Section heading. */
53
136
  title?: string;
137
+ /** Section text. */
54
138
  text?: string;
139
+ /** Extra key/value fields of the section. */
55
140
  extension?: Record<string, string>;
141
+ /** Codes the section is tagged with. */
56
142
  code?: string[];
57
143
  };
144
+ /**
145
+ * A CMS content item.
146
+ *
147
+ * @category content
148
+ */
58
149
  export type OvokContent = {
150
+ /** Content id. */
59
151
  id?: string;
152
+ /** Content title. */
60
153
  title: string;
154
+ /** Who wrote the content. */
61
155
  author: {
156
+ /** Reference to the author, e.g. `Practitioner/123`. */
62
157
  reference: string;
158
+ /** Display name of the author. */
63
159
  display?: string;
64
160
  };
161
+ /** Key that identifies the item within its type and language. */
65
162
  key: string;
163
+ /** Language code of the content. */
66
164
  language: string;
165
+ /** ISO 8601 date of the content. */
67
166
  date: string;
167
+ /** Id of the project that owns the content. */
68
168
  projectId?: string;
169
+ /** Kind of content. */
69
170
  type: OvokContentType;
171
+ /** Code the content is tagged with. */
70
172
  code?: string;
173
+ /** Categories of the content. */
71
174
  category?: string[];
175
+ /** Sections that make up the body. */
72
176
  section?: OvokContentSection[];
73
177
  };
178
+ /**
179
+ * Fields accepted when creating or updating a content item.
180
+ *
181
+ * @category content
182
+ */
74
183
  export type OvokContentBody = Pick<OvokContent, "title" | "category" | "section" | "code">;
184
+ /**
185
+ * Filters and paging of a content search.
186
+ *
187
+ * @category content
188
+ */
75
189
  export type OvokContentQuery = {
190
+ /** Free-text search. */
76
191
  search?: string;
192
+ /** Only content with this code. */
77
193
  code?: string;
194
+ /** Page size. */
78
195
  _count?: number;
196
+ /** Number of results to skip. */
79
197
  _offset?: number;
80
198
  };
199
+ /**
200
+ * A page of content items.
201
+ *
202
+ * @category content
203
+ */
81
204
  export type OvokContentSearchResponse = {
205
+ /** Number of matching items. */
82
206
  total: number;
207
+ /** Items on this page. */
83
208
  resources: OvokContent[];
84
209
  };
210
+ /**
211
+ * A content item paired with its counterpart in the parent project.
212
+ *
213
+ * @category content
214
+ */
85
215
  export type OvokMappedContent = {
216
+ /** Content of the parent project. */
86
217
  source?: OvokContent;
218
+ /** Content of this project. */
87
219
  target?: OvokContent;
88
220
  };
221
+ /**
222
+ * A page of mapped content pairs.
223
+ *
224
+ * @category content
225
+ */
89
226
  export type OvokMappedContentSearchResponse = {
227
+ /** Number of matching pairs. */
90
228
  total: number;
229
+ /** Pairs on this page. */
91
230
  resources: OvokMappedContent[];
92
231
  };
232
+ /**
233
+ * Request body that creates or updates a video-call appointment.
234
+ *
235
+ * @category videoCalls
236
+ */
93
237
  export type OvokVideoCallAppointmentInput = {
238
+ /** Appointment id, when updating. */
94
239
  id?: string;
240
+ /** ISO 8601 start time. */
95
241
  start: string;
242
+ /** ISO 8601 end time. */
96
243
  end: string;
244
+ /** Comment shown on the appointment. */
97
245
  comment: string;
246
+ /** Longer description. */
98
247
  description?: string;
248
+ /** Invited participants. */
99
249
  videoCallParticipants: {
250
+ /** Participant's email address. */
100
251
  email: string;
101
252
  }[];
102
253
  };
254
+ /**
255
+ * FHIR Appointment status of a video call.
256
+ *
257
+ * @category videoCalls
258
+ */
103
259
  export type OvokVideoCallAppointmentStatus = "proposed" | "pending" | "booked" | "arrived" | "fulfilled" | "cancelled" | "noshow" | "entered-in-error" | "checked-in" | "waitlist";
260
+ /**
261
+ * A video-call appointment.
262
+ *
263
+ * @category videoCalls
264
+ */
104
265
  export type OvokVideoCallAppointment = {
266
+ /** Appointment id. */
105
267
  id: string;
268
+ /** Always `Appointment`. */
106
269
  resourceType: "Appointment";
270
+ /** Appointment status. */
107
271
  status: OvokVideoCallAppointmentStatus;
272
+ /** ISO 8601 start time. */
108
273
  start: string;
274
+ /** ISO 8601 end time. */
109
275
  end: string;
276
+ /** Comment shown on the appointment. */
110
277
  comment: string;
278
+ /** Longer description. */
111
279
  description?: string;
280
+ /** Participants and their responses. */
112
281
  videoCallParticipants: {
282
+ /** Participant's email address. */
113
283
  email: string;
284
+ /** Participant's response to the invitation. */
114
285
  status: "accepted" | "declined" | "tentative" | "needs-action";
286
+ /** Reference to the participant's profile. */
115
287
  profileRef: string;
116
288
  }[];
289
+ /** Passphrase of the call. */
117
290
  passphrase: string;
118
291
  };
292
+ /**
293
+ * Date range filter for listing appointments.
294
+ *
295
+ * @category videoCalls
296
+ */
119
297
  export type OvokVideoCallAppointmentQuery = {
298
+ /** Only appointments from this date. */
120
299
  startDate?: string;
300
+ /** Only appointments up to this date. */
121
301
  endDate?: string;
122
302
  };
303
+ /**
304
+ * Request body that creates guest access to a video call.
305
+ *
306
+ * @category videoCalls
307
+ */
123
308
  export type OvokVideoCallGuestAccess = {
309
+ /** Email address of the guest. */
124
310
  guestEmail: string;
125
311
  };
312
+ /**
313
+ * Details needed to join a video call.
314
+ *
315
+ * @category videoCalls
316
+ */
126
317
  export type OvokVideoCallAccess = {
318
+ /** URL of the call. */
127
319
  videoCallUrl: string;
320
+ /** Access token for the call room. */
128
321
  livekitJwt: string;
322
+ /** Passphrase of the call. */
129
323
  passphrase: string;
130
324
  };
325
+ /**
326
+ * Request body for emailing video-call participants.
327
+ *
328
+ * @category videoCalls
329
+ */
131
330
  export type OvokVideoCallMailRequest = {
331
+ /** Id of the appointment. */
132
332
  appointmentId: string;
333
+ /** People to email. */
133
334
  emailRecipients: {
335
+ /** Recipient's email address. */
134
336
  email: string;
337
+ /** Reference to the recipient's profile. */
135
338
  profileRef: string;
136
339
  }[];
137
340
  };
341
+ /**
342
+ * Per-recipient outcome of a video-call email.
343
+ *
344
+ * @category videoCalls
345
+ */
138
346
  export type OvokVideoCallMailResponse = {
347
+ /** Id of the appointment. */
139
348
  appointmentId: string;
349
+ /** Outcome per recipient. */
140
350
  emailRecipientsResult: {
351
+ /** Recipient's email address. */
141
352
  email: string;
353
+ /** Reference to the recipient's profile. */
142
354
  profileRef: string;
355
+ /** Whether the email was sent. */
143
356
  isEmailSent: boolean;
144
357
  }[];
145
358
  };
359
+ /**
360
+ * Texts to translate.
361
+ *
362
+ * @category content
363
+ */
146
364
  export type OvokTranslationRequest = {
365
+ /** Language code of the texts. */
147
366
  sourceLanguage: string;
367
+ /** Language code to translate into. */
148
368
  targetLanguage: string;
369
+ /** Texts to translate. */
149
370
  text: string[];
150
371
  };
372
+ /**
373
+ * Translated texts, in the shape of the request.
374
+ *
375
+ * @category content
376
+ */
151
377
  export type OvokTranslationResponse = OvokTranslationRequest;
378
+ /**
379
+ * A message of an AI chat session.
380
+ *
381
+ * @category ai
382
+ */
152
383
  export type OvokChatMessage = {
384
+ /** Reference to the message. */
153
385
  reference: string;
386
+ /** Reference to the sender. */
154
387
  sender: string;
388
+ /** Message text. */
155
389
  content: string;
390
+ /** ISO 8601 time the message was sent. */
156
391
  sentAt: string;
392
+ /** Role of the sender. */
157
393
  mode: "assistant" | "user" | "system";
158
394
  };
395
+ /**
396
+ * Settings of the AI assistant in a chat session.
397
+ *
398
+ * @category ai
399
+ */
159
400
  export type OvokChatAssistant = {
401
+ /** System prompt. */
160
402
  system: string;
403
+ /** Extra context passed to the assistant. */
161
404
  context?: string[];
405
+ /** Number of earlier messages the assistant sees. */
162
406
  history?: number;
407
+ /** Reference to the assistant participant. */
163
408
  participant: string;
164
409
  };
410
+ /**
411
+ * Request body that creates an AI chat session.
412
+ *
413
+ * @category ai
414
+ */
165
415
  export type OvokCreateChatSession = {
416
+ /** Assistant settings. */
166
417
  assistant: OvokChatAssistant;
418
+ /** Reference to the user. */
167
419
  participant: string;
420
+ /** Session title. */
168
421
  title?: string;
422
+ /** Opening messages. */
169
423
  messages: {
424
+ /** Reference to the sender. */
170
425
  sender: string;
426
+ /** Message text. */
171
427
  content: string;
428
+ /** Role of the sender. */
172
429
  mode?: "assistant" | "user" | "system";
173
430
  }[];
174
431
  };
432
+ /**
433
+ * An AI chat session.
434
+ *
435
+ * @category ai
436
+ */
175
437
  export type OvokChatSession = {
438
+ /** Reference to the session. */
176
439
  reference?: string;
440
+ /** Reference to the user. */
177
441
  participant: string;
442
+ /** Session title. */
178
443
  title?: string;
444
+ /** Assistant settings. */
179
445
  assistant: OvokChatAssistant;
446
+ /** Messages of the session, when requested. */
180
447
  messages?: OvokChatMessage[];
181
448
  };
449
+ /**
450
+ * A page of chat sessions.
451
+ *
452
+ * @category ai
453
+ */
182
454
  export type OvokChatSessionsResponse = {
455
+ /** Sessions on this page. */
183
456
  sessions: OvokChatSession[];
184
457
  };
458
+ /**
459
+ * A page of chat messages.
460
+ *
461
+ * @category ai
462
+ */
185
463
  export type OvokChatMessagesResponse = {
464
+ /** Messages on this page. */
186
465
  messages: OvokChatMessage[];
187
466
  };
467
+ /**
468
+ * Filters, sorting and paging of a chat session search.
469
+ *
470
+ * @category ai
471
+ */
188
472
  export type OvokChatSessionQuery = {
473
+ /** Only the session with this id. */
189
474
  _id?: string;
475
+ /** Sort by sent time, `-sent` for newest first. */
190
476
  _sort?: "-sent" | "sent";
477
+ /** Page size. */
191
478
  _count?: number;
479
+ /** Number of results to skip. */
192
480
  _offset?: number;
481
+ /** Number of latest messages to include per session. */
193
482
  messageCount?: number;
194
483
  };
484
+ /**
485
+ * Request body that sends a chat message.
486
+ *
487
+ * @category ai
488
+ */
195
489
  export type OvokChatMessageInput = {
490
+ /** Message text. */
196
491
  content: string;
492
+ /** Reference to the sender. */
197
493
  sender: string;
494
+ /** Role of the sender. */
198
495
  mode?: "assistant" | "user" | "system";
496
+ /** Reference to the message this one answers. */
199
497
  replyTo?: string;
200
498
  };
499
+ /**
500
+ * Sorting and paging of a chat message search.
501
+ *
502
+ * @category ai
503
+ */
201
504
  export type OvokChatMessageQuery = {
505
+ /** Sort by sent time, `-sent` for newest first. */
202
506
  _sort?: "-sent" | "sent";
507
+ /** Page size. */
203
508
  _count?: number;
509
+ /** Number of results to skip. */
204
510
  _offset?: number;
205
511
  };
512
+ /**
513
+ * Untyped body of an AI FHIR search.
514
+ *
515
+ * @category ai
516
+ */
206
517
  export type OvokAIFhirRequest = Record<string, unknown>;
518
+ /**
519
+ * Untyped result of an AI FHIR search.
520
+ *
521
+ * @category ai
522
+ */
207
523
  export type OvokAIFhirResponse = Record<string, unknown>;
@@ -1,2 +1,3 @@
1
1
  "use strict";
2
+ /* eslint-disable max-lines -- one documented type per experience API payload. */
2
3
  Object.defineProperty(exports, "__esModule", { value: true });