@tryvital/vital-node 3.1.380 → 3.1.382

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 (136) hide show
  1. package/Client.d.ts +12 -12
  2. package/Client.js +41 -41
  3. package/api/resources/activity/client/Client.js +2 -2
  4. package/api/resources/aggregate/client/Client.d.ts +1 -1
  5. package/api/resources/aggregate/client/Client.js +4 -4
  6. package/api/resources/aggregate/client/requests/QueryBatch.d.ts +1 -1
  7. package/api/resources/body/client/Client.js +2 -2
  8. package/api/resources/devices/client/Client.js +1 -1
  9. package/api/resources/electrocardiogram/client/Client.js +1 -1
  10. package/api/resources/index.d.ts +6 -6
  11. package/api/resources/index.js +7 -7
  12. package/api/resources/insurance/client/Client.js +3 -3
  13. package/api/resources/introspect/client/Client.js +2 -2
  14. package/api/resources/labTests/client/Client.d.ts +106 -107
  15. package/api/resources/labTests/client/Client.js +745 -746
  16. package/api/resources/labTests/client/requests/index.d.ts +6 -6
  17. package/api/resources/labTests/types/index.d.ts +2 -2
  18. package/api/resources/labTests/types/index.js +2 -2
  19. package/api/resources/link/client/Client.js +19 -19
  20. package/api/resources/meal/client/Client.js +1 -1
  21. package/api/resources/menstrualCycle/client/Client.js +1 -1
  22. package/api/resources/order/client/Client.js +1 -1
  23. package/api/resources/payor/client/Client.js +1 -1
  24. package/api/resources/profile/client/Client.js +2 -2
  25. package/api/resources/providers/client/Client.js +1 -1
  26. package/api/resources/sleep/client/Client.js +3 -3
  27. package/api/resources/sleepCycle/client/Client.js +1 -1
  28. package/api/resources/team/client/Client.js +7 -7
  29. package/api/resources/testkit/client/Client.js +2 -2
  30. package/api/resources/user/client/Client.js +18 -18
  31. package/api/resources/vitals/client/Client.js +78 -78
  32. package/api/resources/workouts/client/Client.js +3 -3
  33. package/api/types/AggregateExprArg.d.ts +1 -1
  34. package/api/types/AsleepAtValueMacroExpr.d.ts +7 -0
  35. package/api/types/AsleepAtValueMacroExpr.js +5 -0
  36. package/api/types/AwakeAtValueMacroExpr.d.ts +7 -0
  37. package/api/types/AwakeAtValueMacroExpr.js +5 -0
  38. package/api/types/QueryGroupByItem.d.ts +1 -1
  39. package/api/types/QuerySelectItem.d.ts +1 -1
  40. package/api/types/SleepColumnExprSleep.d.ts +2 -1
  41. package/api/types/SleepColumnExprSleep.js +1 -0
  42. package/api/types/index.d.ts +2 -0
  43. package/api/types/index.js +2 -0
  44. package/dist/Client.d.ts +12 -12
  45. package/dist/Client.js +41 -41
  46. package/dist/api/resources/activity/client/Client.js +2 -2
  47. package/dist/api/resources/aggregate/client/Client.d.ts +1 -1
  48. package/dist/api/resources/aggregate/client/Client.js +4 -4
  49. package/dist/api/resources/aggregate/client/requests/QueryBatch.d.ts +1 -1
  50. package/dist/api/resources/body/client/Client.js +2 -2
  51. package/dist/api/resources/devices/client/Client.js +1 -1
  52. package/dist/api/resources/electrocardiogram/client/Client.js +1 -1
  53. package/dist/api/resources/index.d.ts +6 -6
  54. package/dist/api/resources/index.js +7 -7
  55. package/dist/api/resources/insurance/client/Client.js +3 -3
  56. package/dist/api/resources/introspect/client/Client.js +2 -2
  57. package/dist/api/resources/labTests/client/Client.d.ts +106 -107
  58. package/dist/api/resources/labTests/client/Client.js +745 -746
  59. package/dist/api/resources/labTests/client/requests/index.d.ts +6 -6
  60. package/dist/api/resources/labTests/types/index.d.ts +2 -2
  61. package/dist/api/resources/labTests/types/index.js +2 -2
  62. package/dist/api/resources/link/client/Client.js +19 -19
  63. package/dist/api/resources/meal/client/Client.js +1 -1
  64. package/dist/api/resources/menstrualCycle/client/Client.js +1 -1
  65. package/dist/api/resources/order/client/Client.js +1 -1
  66. package/dist/api/resources/payor/client/Client.js +1 -1
  67. package/dist/api/resources/profile/client/Client.js +2 -2
  68. package/dist/api/resources/providers/client/Client.js +1 -1
  69. package/dist/api/resources/sleep/client/Client.js +3 -3
  70. package/dist/api/resources/sleepCycle/client/Client.js +1 -1
  71. package/dist/api/resources/team/client/Client.js +7 -7
  72. package/dist/api/resources/testkit/client/Client.js +2 -2
  73. package/dist/api/resources/user/client/Client.js +18 -18
  74. package/dist/api/resources/vitals/client/Client.js +78 -78
  75. package/dist/api/resources/workouts/client/Client.js +3 -3
  76. package/dist/api/types/AggregateExprArg.d.ts +1 -1
  77. package/dist/api/types/AsleepAtValueMacroExpr.d.ts +7 -0
  78. package/dist/api/types/AsleepAtValueMacroExpr.js +5 -0
  79. package/dist/api/types/AwakeAtValueMacroExpr.d.ts +7 -0
  80. package/dist/api/types/AwakeAtValueMacroExpr.js +5 -0
  81. package/dist/api/types/QueryGroupByItem.d.ts +1 -1
  82. package/dist/api/types/QuerySelectItem.d.ts +1 -1
  83. package/dist/api/types/SleepColumnExprSleep.d.ts +2 -1
  84. package/dist/api/types/SleepColumnExprSleep.js +1 -0
  85. package/dist/api/types/index.d.ts +2 -0
  86. package/dist/api/types/index.js +2 -0
  87. package/dist/serialization/resources/index.d.ts +2 -2
  88. package/dist/serialization/resources/index.js +2 -2
  89. package/dist/serialization/resources/labTests/client/index.d.ts +2 -2
  90. package/dist/serialization/resources/labTests/client/index.js +3 -3
  91. package/dist/serialization/resources/labTests/client/requests/index.d.ts +2 -2
  92. package/dist/serialization/resources/labTests/client/requests/index.js +5 -5
  93. package/dist/serialization/resources/labTests/types/index.d.ts +2 -2
  94. package/dist/serialization/resources/labTests/types/index.js +2 -2
  95. package/dist/serialization/types/AggregateExprArg.d.ts +3 -1
  96. package/dist/serialization/types/AggregateExprArg.js +4 -0
  97. package/dist/serialization/types/AsleepAtValueMacroExpr.d.ts +13 -0
  98. package/dist/serialization/types/AsleepAtValueMacroExpr.js +34 -0
  99. package/dist/serialization/types/AwakeAtValueMacroExpr.d.ts +13 -0
  100. package/dist/serialization/types/AwakeAtValueMacroExpr.js +34 -0
  101. package/dist/serialization/types/QueryGroupByItem.d.ts +3 -1
  102. package/dist/serialization/types/QueryGroupByItem.js +4 -0
  103. package/dist/serialization/types/QuerySelectItem.d.ts +3 -1
  104. package/dist/serialization/types/QuerySelectItem.js +4 -0
  105. package/dist/serialization/types/SleepColumnExprSleep.d.ts +1 -1
  106. package/dist/serialization/types/SleepColumnExprSleep.js +1 -0
  107. package/dist/serialization/types/index.d.ts +2 -0
  108. package/dist/serialization/types/index.js +2 -0
  109. package/dist/version.d.ts +1 -1
  110. package/dist/version.js +1 -1
  111. package/package.json +1 -1
  112. package/reference.md +1101 -1101
  113. package/serialization/resources/index.d.ts +2 -2
  114. package/serialization/resources/index.js +2 -2
  115. package/serialization/resources/labTests/client/index.d.ts +2 -2
  116. package/serialization/resources/labTests/client/index.js +3 -3
  117. package/serialization/resources/labTests/client/requests/index.d.ts +2 -2
  118. package/serialization/resources/labTests/client/requests/index.js +5 -5
  119. package/serialization/resources/labTests/types/index.d.ts +2 -2
  120. package/serialization/resources/labTests/types/index.js +2 -2
  121. package/serialization/types/AggregateExprArg.d.ts +3 -1
  122. package/serialization/types/AggregateExprArg.js +4 -0
  123. package/serialization/types/AsleepAtValueMacroExpr.d.ts +13 -0
  124. package/serialization/types/AsleepAtValueMacroExpr.js +34 -0
  125. package/serialization/types/AwakeAtValueMacroExpr.d.ts +13 -0
  126. package/serialization/types/AwakeAtValueMacroExpr.js +34 -0
  127. package/serialization/types/QueryGroupByItem.d.ts +3 -1
  128. package/serialization/types/QueryGroupByItem.js +4 -0
  129. package/serialization/types/QuerySelectItem.d.ts +3 -1
  130. package/serialization/types/QuerySelectItem.js +4 -0
  131. package/serialization/types/SleepColumnExprSleep.d.ts +1 -1
  132. package/serialization/types/SleepColumnExprSleep.js +1 -0
  133. package/serialization/types/index.d.ts +2 -0
  134. package/serialization/types/index.js +2 -0
  135. package/version.d.ts +1 -1
  136. package/version.js +1 -1
package/reference.md CHANGED
@@ -1,26 +1,11 @@
1
1
  # Reference
2
2
 
3
- ## User
4
-
5
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getAll</a>({ ...params }) -> Vital.PaginatedUsersResponse</code></summary>
6
- <dl>
7
- <dd>
8
-
9
- #### 📝 Description
10
-
11
- <dl>
12
- <dd>
3
+ ## Link
13
4
 
5
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">listBulkOps</a>({ ...params }) -> Vital.BulkOpsResponse</code></summary>
14
6
  <dl>
15
7
  <dd>
16
8
 
17
- GET All users for team.
18
-
19
- </dd>
20
- </dl>
21
- </dd>
22
- </dl>
23
-
24
9
  #### 🔌 Usage
25
10
 
26
11
  <dl>
@@ -30,7 +15,7 @@ GET All users for team.
30
15
  <dd>
31
16
 
32
17
  ```typescript
33
- await client.user.getAll();
18
+ await client.link.listBulkOps();
34
19
  ```
35
20
 
36
21
  </dd>
@@ -46,7 +31,7 @@ await client.user.getAll();
46
31
  <dl>
47
32
  <dd>
48
33
 
49
- **request:** `Vital.UserGetAllRequest`
34
+ **request:** `Vital.LinkListBulkOpsRequest`
50
35
 
51
36
  </dd>
52
37
  </dl>
@@ -54,7 +39,7 @@ await client.user.getAll();
54
39
  <dl>
55
40
  <dd>
56
41
 
57
- **requestOptions:** `User.RequestOptions`
42
+ **requestOptions:** `Link.RequestOptions`
58
43
 
59
44
  </dd>
60
45
  </dl>
@@ -65,25 +50,10 @@ await client.user.getAll();
65
50
  </dl>
66
51
  </details>
67
52
 
68
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingUserKey</code></summary>
69
- <dl>
70
- <dd>
71
-
72
- #### 📝 Description
73
-
74
- <dl>
75
- <dd>
76
-
53
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkImport</a>({ ...params }) -> Vital.BulkImportConnectionsResponse</code></summary>
77
54
  <dl>
78
55
  <dd>
79
56
 
80
- POST Create a Vital user given a client_user_id and returns the user_id.
81
-
82
- </dd>
83
- </dl>
84
- </dd>
85
- </dl>
86
-
87
57
  #### 🔌 Usage
88
58
 
89
59
  <dl>
@@ -93,8 +63,17 @@ POST Create a Vital user given a client_user_id and returns the user_id.
93
63
  <dd>
94
64
 
95
65
  ```typescript
96
- await client.user.create({
97
- clientUserId: "client_user_id",
66
+ await client.link.bulkImport({
67
+ provider: "oura",
68
+ connections: [
69
+ {
70
+ userId: "user_id",
71
+ accessToken: "access_token",
72
+ refreshToken: "refresh_token",
73
+ providerId: "provider_id",
74
+ expiresAt: 1,
75
+ },
76
+ ],
98
77
  });
99
78
  ```
100
79
 
@@ -111,7 +90,7 @@ await client.user.create({
111
90
  <dl>
112
91
  <dd>
113
92
 
114
- **request:** `Vital.UserCreateBody`
93
+ **request:** `Vital.BulkImportConnectionsBody`
115
94
 
116
95
  </dd>
117
96
  </dl>
@@ -119,7 +98,7 @@ await client.user.create({
119
98
  <dl>
120
99
  <dd>
121
100
 
122
- **requestOptions:** `User.RequestOptions`
101
+ **requestOptions:** `Link.RequestOptions`
123
102
 
124
103
  </dd>
125
104
  </dl>
@@ -130,11 +109,11 @@ await client.user.create({
130
109
  </dl>
131
110
  </details>
132
111
 
133
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getTeamMetrics</a>() -> Vital.MetricsResult</code></summary>
112
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkTriggerHistoricalPull</a>({ ...params }) -> unknown</code></summary>
134
113
  <dl>
135
114
  <dd>
136
115
 
137
- #### 📝 Description
116
+ #### 🔌 Usage
138
117
 
139
118
  <dl>
140
119
  <dd>
@@ -142,14 +121,19 @@ await client.user.create({
142
121
  <dl>
143
122
  <dd>
144
123
 
145
- GET metrics for team.
124
+ ```typescript
125
+ await client.link.bulkTriggerHistoricalPull({
126
+ userIds: ["user_ids"],
127
+ provider: "oura",
128
+ });
129
+ ```
146
130
 
147
131
  </dd>
148
132
  </dl>
149
133
  </dd>
150
134
  </dl>
151
135
 
152
- #### 🔌 Usage
136
+ #### ⚙️ Parameters
153
137
 
154
138
  <dl>
155
139
  <dd>
@@ -157,24 +141,15 @@ GET metrics for team.
157
141
  <dl>
158
142
  <dd>
159
143
 
160
- ```typescript
161
- await client.user.getTeamMetrics();
162
- ```
144
+ **request:** `Vital.BulkTriggerHistoricalPullBody`
163
145
 
164
146
  </dd>
165
147
  </dl>
166
- </dd>
167
- </dl>
168
-
169
- #### ⚙️ Parameters
170
148
 
171
149
  <dl>
172
150
  <dd>
173
151
 
174
- <dl>
175
- <dd>
176
-
177
- **requestOptions:** `User.RequestOptions`
152
+ **requestOptions:** `Link.RequestOptions`
178
153
 
179
154
  </dd>
180
155
  </dl>
@@ -185,7 +160,7 @@ await client.user.getTeamMetrics();
185
160
  </dl>
186
161
  </details>
187
162
 
188
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getUserSignInToken</a>(userId) -> Vital.UserSignInTokenResponse</code></summary>
163
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkExport</a>({ ...params }) -> Vital.BulkExportConnectionsResponse</code></summary>
189
164
  <dl>
190
165
  <dd>
191
166
 
@@ -198,7 +173,9 @@ await client.user.getTeamMetrics();
198
173
  <dd>
199
174
 
200
175
  ```typescript
201
- await client.user.getUserSignInToken("user_id");
176
+ await client.link.bulkExport({
177
+ provider: "oura",
178
+ });
202
179
  ```
203
180
 
204
181
  </dd>
@@ -214,7 +191,7 @@ await client.user.getUserSignInToken("user_id");
214
191
  <dl>
215
192
  <dd>
216
193
 
217
- **userId:** `string`
194
+ **request:** `Vital.BulkExportConnectionsBody`
218
195
 
219
196
  </dd>
220
197
  </dl>
@@ -222,7 +199,7 @@ await client.user.getUserSignInToken("user_id");
222
199
  <dl>
223
200
  <dd>
224
201
 
225
- **requestOptions:** `User.RequestOptions`
202
+ **requestOptions:** `Link.RequestOptions`
226
203
 
227
204
  </dd>
228
205
  </dl>
@@ -233,25 +210,10 @@ await client.user.getUserSignInToken("user_id");
233
210
  </dl>
234
211
  </details>
235
212
 
236
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getConnectedProviders</a>(userId) -> Record<string, Vital.ClientFacingProviderWithStatus[]></code></summary>
237
- <dl>
238
- <dd>
239
-
240
- #### 📝 Description
241
-
242
- <dl>
243
- <dd>
244
-
213
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkPause</a>({ ...params }) -> unknown</code></summary>
245
214
  <dl>
246
215
  <dd>
247
216
 
248
- GET Users connected providers
249
-
250
- </dd>
251
- </dl>
252
- </dd>
253
- </dl>
254
-
255
217
  #### 🔌 Usage
256
218
 
257
219
  <dl>
@@ -261,7 +223,10 @@ GET Users connected providers
261
223
  <dd>
262
224
 
263
225
  ```typescript
264
- await client.user.getConnectedProviders("user_id");
226
+ await client.link.bulkPause({
227
+ userIds: ["user_ids"],
228
+ provider: "oura",
229
+ });
265
230
  ```
266
231
 
267
232
  </dd>
@@ -277,7 +242,7 @@ await client.user.getConnectedProviders("user_id");
277
242
  <dl>
278
243
  <dd>
279
244
 
280
- **userId:** `string`
245
+ **request:** `Vital.BulkPauseConnectionsBody`
281
246
 
282
247
  </dd>
283
248
  </dl>
@@ -285,7 +250,7 @@ await client.user.getConnectedProviders("user_id");
285
250
  <dl>
286
251
  <dd>
287
252
 
288
- **requestOptions:** `User.RequestOptions`
253
+ **requestOptions:** `Link.RequestOptions`
289
254
 
290
255
  </dd>
291
256
  </dl>
@@ -296,7 +261,7 @@ await client.user.getConnectedProviders("user_id");
296
261
  </dl>
297
262
  </details>
298
263
 
299
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Vital.ClientFacingUser</code></summary>
264
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">token</a>({ ...params }) -> Vital.LinkTokenExchangeResponse</code></summary>
300
265
  <dl>
301
266
  <dd>
302
267
 
@@ -308,7 +273,12 @@ await client.user.getConnectedProviders("user_id");
308
273
  <dl>
309
274
  <dd>
310
275
 
311
- GET User details given the user_id.
276
+ Endpoint to generate a user link token, to be used throughout the vital
277
+ link process. The vital link token is a one time use token, that
278
+ expires after 10 minutes. If you would like vital-link widget to launch
279
+ with a specific provider, pass in a provider in the body. If you would
280
+ like to redirect to a custom url after successful or error connection,
281
+ pass in your own custom redirect_url parameter.
312
282
 
313
283
  </dd>
314
284
  </dl>
@@ -324,7 +294,9 @@ GET User details given the user_id.
324
294
  <dd>
325
295
 
326
296
  ```typescript
327
- await client.user.get("user_id");
297
+ await client.link.token({
298
+ userId: "user_id",
299
+ });
328
300
  ```
329
301
 
330
302
  </dd>
@@ -340,7 +312,7 @@ await client.user.get("user_id");
340
312
  <dl>
341
313
  <dd>
342
314
 
343
- **userId:** `string`
315
+ **request:** `Vital.LinkTokenExchange`
344
316
 
345
317
  </dd>
346
318
  </dl>
@@ -348,7 +320,7 @@ await client.user.get("user_id");
348
320
  <dl>
349
321
  <dd>
350
322
 
351
- **requestOptions:** `User.RequestOptions`
323
+ **requestOptions:** `Link.RequestOptions`
352
324
 
353
325
  </dd>
354
326
  </dl>
@@ -359,7 +331,7 @@ await client.user.get("user_id");
359
331
  </dl>
360
332
  </details>
361
333
 
362
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Vital.UserSuccessResponse</code></summary>
334
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">isTokenValid</a>({ ...params }) -> Record<string, unknown></code></summary>
363
335
  <dl>
364
336
  <dd>
365
337
 
@@ -372,7 +344,9 @@ await client.user.get("user_id");
372
344
  <dd>
373
345
 
374
346
  ```typescript
375
- await client.user.delete("user_id");
347
+ await client.link.isTokenValid({
348
+ token: "token",
349
+ });
376
350
  ```
377
351
 
378
352
  </dd>
@@ -388,7 +362,7 @@ await client.user.delete("user_id");
388
362
  <dl>
389
363
  <dd>
390
364
 
391
- **userId:** `string`
365
+ **request:** `Vital.LinkTokenValidationRequest`
392
366
 
393
367
  </dd>
394
368
  </dl>
@@ -396,7 +370,7 @@ await client.user.delete("user_id");
396
370
  <dl>
397
371
  <dd>
398
372
 
399
- **requestOptions:** `User.RequestOptions`
373
+ **requestOptions:** `Link.RequestOptions`
400
374
 
401
375
  </dd>
402
376
  </dl>
@@ -407,11 +381,11 @@ await client.user.delete("user_id");
407
381
  </dl>
408
382
  </details>
409
383
 
410
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">patch</a>(userId, { ...params }) -> void</code></summary>
384
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">codeCreate</a>({ ...params }) -> Vital.VitalTokenCreatedResponse</code></summary>
411
385
  <dl>
412
386
  <dd>
413
387
 
414
- #### 🔌 Usage
388
+ #### 📝 Description
415
389
 
416
390
  <dl>
417
391
  <dd>
@@ -419,16 +393,14 @@ await client.user.delete("user_id");
419
393
  <dl>
420
394
  <dd>
421
395
 
422
- ```typescript
423
- await client.user.patch("user_id");
424
- ```
396
+ Generate a token to invite a user of Vital mobile app to your team
425
397
 
426
398
  </dd>
427
399
  </dl>
428
400
  </dd>
429
401
  </dl>
430
402
 
431
- #### ⚙️ Parameters
403
+ #### 🔌 Usage
432
404
 
433
405
  <dl>
434
406
  <dd>
@@ -436,15 +408,26 @@ await client.user.patch("user_id");
436
408
  <dl>
437
409
  <dd>
438
410
 
439
- **userId:** `string`
411
+ ```typescript
412
+ await client.link.codeCreate({
413
+ userId: "user_id",
414
+ });
415
+ ```
440
416
 
441
417
  </dd>
442
418
  </dl>
419
+ </dd>
420
+ </dl>
421
+
422
+ #### ⚙️ Parameters
443
423
 
444
424
  <dl>
445
425
  <dd>
446
426
 
447
- **request:** `Vital.UserPatchBody`
427
+ <dl>
428
+ <dd>
429
+
430
+ **request:** `Vital.LinkCodeCreateRequest`
448
431
 
449
432
  </dd>
450
433
  </dl>
@@ -452,7 +435,7 @@ await client.user.patch("user_id");
452
435
  <dl>
453
436
  <dd>
454
437
 
455
- **requestOptions:** `User.RequestOptions`
438
+ **requestOptions:** `Link.RequestOptions`
456
439
 
457
440
  </dd>
458
441
  </dl>
@@ -463,10 +446,26 @@ await client.user.patch("user_id");
463
446
  </dl>
464
447
  </details>
465
448
 
466
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestUserInfo</a>(userId) -> Vital.UserInfo</code></summary>
449
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">startConnect</a>({ ...params }) -> Record<string, unknown></code></summary>
450
+ <dl>
451
+ <dd>
452
+
453
+ #### 📝 Description
454
+
455
+ <dl>
456
+ <dd>
457
+
467
458
  <dl>
468
459
  <dd>
469
460
 
461
+ REQUEST_SOURCE: VITAL-LINK
462
+ Start link token process
463
+
464
+ </dd>
465
+ </dl>
466
+ </dd>
467
+ </dl>
468
+
470
469
  #### 🔌 Usage
471
470
 
472
471
  <dl>
@@ -476,7 +475,10 @@ await client.user.patch("user_id");
476
475
  <dd>
477
476
 
478
477
  ```typescript
479
- await client.user.getLatestUserInfo("user_id");
478
+ await client.link.startConnect({
479
+ linkToken: "link_token",
480
+ provider: "oura",
481
+ });
480
482
  ```
481
483
 
482
484
  </dd>
@@ -492,7 +494,7 @@ await client.user.getLatestUserInfo("user_id");
492
494
  <dl>
493
495
  <dd>
494
496
 
495
- **userId:** `string`
497
+ **request:** `Vital.BeginLinkTokenRequest`
496
498
 
497
499
  </dd>
498
500
  </dl>
@@ -500,7 +502,7 @@ await client.user.getLatestUserInfo("user_id");
500
502
  <dl>
501
503
  <dd>
502
504
 
503
- **requestOptions:** `User.RequestOptions`
505
+ **requestOptions:** `Link.RequestOptions`
504
506
 
505
507
  </dd>
506
508
  </dl>
@@ -511,11 +513,11 @@ await client.user.getLatestUserInfo("user_id");
511
513
  </dl>
512
514
  </details>
513
515
 
514
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createInsurance</a>(userId, { ...params }) -> Vital.ClientFacingInsurance</code></summary>
516
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">tokenState</a>({ ...params }) -> Record<string, unknown></code></summary>
515
517
  <dl>
516
518
  <dd>
517
519
 
518
- #### 🔌 Usage
520
+ #### 📝 Description
519
521
 
520
522
  <dl>
521
523
  <dd>
@@ -523,35 +525,15 @@ await client.user.getLatestUserInfo("user_id");
523
525
  <dl>
524
526
  <dd>
525
527
 
526
- ```typescript
527
- await client.user.createInsurance("user_id", {
528
- payorCode: "payor_code",
529
- memberId: "member_id",
530
- relationship: "Self",
531
- insured: {
532
- firstName: "first_name",
533
- lastName: "last_name",
534
- gender: "female",
535
- address: {
536
- firstLine: "first_line",
537
- country: "country",
538
- zip: "zip",
539
- city: "city",
540
- state: "state",
541
- },
542
- dob: "dob",
543
- email: "email",
544
- phoneNumber: "phone_number",
545
- },
546
- });
547
- ```
528
+ REQUEST_SOURCE: VITAL-LINK
529
+ Check link token state - can be hit continuously used as heartbeat
548
530
 
549
531
  </dd>
550
532
  </dl>
551
533
  </dd>
552
534
  </dl>
553
535
 
554
- #### ⚙️ Parameters
536
+ #### 🔌 Usage
555
537
 
556
538
  <dl>
557
539
  <dd>
@@ -559,15 +541,24 @@ await client.user.createInsurance("user_id", {
559
541
  <dl>
560
542
  <dd>
561
543
 
562
- **userId:** `string`
544
+ ```typescript
545
+ await client.link.tokenState();
546
+ ```
563
547
 
564
548
  </dd>
565
549
  </dl>
550
+ </dd>
551
+ </dl>
552
+
553
+ #### ⚙️ Parameters
566
554
 
567
555
  <dl>
568
556
  <dd>
569
557
 
570
- **request:** `Vital.CreateInsuranceRequest`
558
+ <dl>
559
+ <dd>
560
+
561
+ **request:** `Vital.LinkTokenStateRequest`
571
562
 
572
563
  </dd>
573
564
  </dl>
@@ -575,7 +566,7 @@ await client.user.createInsurance("user_id", {
575
566
  <dl>
576
567
  <dd>
577
568
 
578
- **requestOptions:** `User.RequestOptions`
569
+ **requestOptions:** `Link.RequestOptions`
579
570
 
580
571
  </dd>
581
572
  </dl>
@@ -586,11 +577,11 @@ await client.user.createInsurance("user_id", {
586
577
  </dl>
587
578
  </details>
588
579
 
589
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestInsurance</a>(userId) -> Vital.ClientFacingInsurance</code></summary>
580
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">emailAuth</a>({ ...params }) -> unknown</code></summary>
590
581
  <dl>
591
582
  <dd>
592
583
 
593
- #### 🔌 Usage
584
+ #### 📝 Description
594
585
 
595
586
  <dl>
596
587
  <dd>
@@ -598,16 +589,14 @@ await client.user.createInsurance("user_id", {
598
589
  <dl>
599
590
  <dd>
600
591
 
601
- ```typescript
602
- await client.user.getLatestInsurance("user_id");
603
- ```
592
+ Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
604
593
 
605
594
  </dd>
606
595
  </dl>
607
596
  </dd>
608
597
  </dl>
609
598
 
610
- #### ⚙️ Parameters
599
+ #### 🔌 Usage
611
600
 
612
601
  <dl>
613
602
  <dd>
@@ -615,15 +604,36 @@ await client.user.getLatestInsurance("user_id");
615
604
  <dl>
616
605
  <dd>
617
606
 
618
- **userId:** `string`
607
+ ```typescript
608
+ await client.link.emailAuth({
609
+ email: "email",
610
+ provider: "oura",
611
+ authType: "password",
612
+ });
613
+ ```
619
614
 
620
615
  </dd>
621
616
  </dl>
617
+ </dd>
618
+ </dl>
619
+
620
+ #### ⚙️ Parameters
622
621
 
623
622
  <dl>
624
623
  <dd>
625
624
 
626
- **requestOptions:** `User.RequestOptions`
625
+ <dl>
626
+ <dd>
627
+
628
+ **request:** `Vital.EmailAuthLink`
629
+
630
+ </dd>
631
+ </dl>
632
+
633
+ <dl>
634
+ <dd>
635
+
636
+ **requestOptions:** `Link.RequestOptions`
627
637
 
628
638
  </dd>
629
639
  </dl>
@@ -634,11 +644,11 @@ await client.user.getLatestInsurance("user_id");
634
644
  </dl>
635
645
  </details>
636
646
 
637
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">upsertUserInfo</a>(userId, { ...params }) -> Vital.UserInfo</code></summary>
647
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">passwordAuth</a>({ ...params }) -> unknown</code></summary>
638
648
  <dl>
639
649
  <dd>
640
650
 
641
- #### 🔌 Usage
651
+ #### 📝 Description
642
652
 
643
653
  <dl>
644
654
  <dd>
@@ -646,30 +656,14 @@ await client.user.getLatestInsurance("user_id");
646
656
  <dl>
647
657
  <dd>
648
658
 
649
- ```typescript
650
- await client.user.upsertUserInfo("user_id", {
651
- firstName: "first_name",
652
- lastName: "last_name",
653
- email: "email",
654
- phoneNumber: "phone_number",
655
- gender: "gender",
656
- dob: "dob",
657
- address: {
658
- firstLine: "first_line",
659
- country: "country",
660
- zip: "zip",
661
- city: "city",
662
- state: "state",
663
- },
664
- });
665
- ```
659
+ Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
666
660
 
667
661
  </dd>
668
662
  </dl>
669
663
  </dd>
670
664
  </dl>
671
665
 
672
- #### ⚙️ Parameters
666
+ #### 🔌 Usage
673
667
 
674
668
  <dl>
675
669
  <dd>
@@ -677,15 +671,29 @@ await client.user.upsertUserInfo("user_id", {
677
671
  <dl>
678
672
  <dd>
679
673
 
680
- **userId:** `string`
674
+ ```typescript
675
+ await client.link.passwordAuth({
676
+ username: "username",
677
+ password: "password",
678
+ provider: "oura",
679
+ authType: "password",
680
+ });
681
+ ```
681
682
 
682
683
  </dd>
683
684
  </dl>
685
+ </dd>
686
+ </dl>
687
+
688
+ #### ⚙️ Parameters
684
689
 
685
690
  <dl>
686
691
  <dd>
687
692
 
688
- **request:** `Vital.UserInfoCreateRequest`
693
+ <dl>
694
+ <dd>
695
+
696
+ **request:** `Vital.PasswordAuthLink`
689
697
 
690
698
  </dd>
691
699
  </dl>
@@ -693,7 +701,7 @@ await client.user.upsertUserInfo("user_id", {
693
701
  <dl>
694
702
  <dd>
695
703
 
696
- **requestOptions:** `User.RequestOptions`
704
+ **requestOptions:** `Link.RequestOptions`
697
705
 
698
706
  </dd>
699
707
  </dl>
@@ -704,7 +712,7 @@ await client.user.upsertUserInfo("user_id", {
704
712
  </dl>
705
713
  </details>
706
714
 
707
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getByClientUserId</a>(clientUserId) -> Vital.ClientFacingUser</code></summary>
715
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">generateOauthLink</a>(oauthProvider, { ...params }) -> Vital.Source</code></summary>
708
716
  <dl>
709
717
  <dd>
710
718
 
@@ -716,7 +724,7 @@ await client.user.upsertUserInfo("user_id", {
716
724
  <dl>
717
725
  <dd>
718
726
 
719
- GET user_id from client_user_id.
727
+ This endpoint generates an OAuth link for oauth provider
720
728
 
721
729
  </dd>
722
730
  </dl>
@@ -732,7 +740,7 @@ GET user_id from client_user_id.
732
740
  <dd>
733
741
 
734
742
  ```typescript
735
- await client.user.getByClientUserId("client_user_id");
743
+ await client.link.generateOauthLink("oura");
736
744
  ```
737
745
 
738
746
  </dd>
@@ -748,7 +756,7 @@ await client.user.getByClientUserId("client_user_id");
748
756
  <dl>
749
757
  <dd>
750
758
 
751
- **clientUserId:** `string` — A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
759
+ **oauthProvider:** `Vital.OAuthProviders`
752
760
 
753
761
  </dd>
754
762
  </dl>
@@ -756,7 +764,15 @@ await client.user.getByClientUserId("client_user_id");
756
764
  <dl>
757
765
  <dd>
758
766
 
759
- **requestOptions:** `User.RequestOptions`
767
+ **request:** `Vital.LinkGenerateOauthLinkRequest`
768
+
769
+ </dd>
770
+ </dl>
771
+
772
+ <dl>
773
+ <dd>
774
+
775
+ **requestOptions:** `Link.RequestOptions`
760
776
 
761
777
  </dd>
762
778
  </dl>
@@ -767,10 +783,25 @@ await client.user.getByClientUserId("client_user_id");
767
783
  </dl>
768
784
  </details>
769
785
 
770
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deregisterProvider</a>(userId, provider) -> Vital.UserSuccessResponse</code></summary>
786
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectPasswordProvider</a>(provider, { ...params }) -> Vital.ProviderLinkResponse</code></summary>
787
+ <dl>
788
+ <dd>
789
+
790
+ #### 📝 Description
791
+
792
+ <dl>
793
+ <dd>
794
+
771
795
  <dl>
772
796
  <dd>
773
797
 
798
+ This connects auth providers that are password based.
799
+
800
+ </dd>
801
+ </dl>
802
+ </dd>
803
+ </dl>
804
+
774
805
  #### 🔌 Usage
775
806
 
776
807
  <dl>
@@ -780,7 +811,10 @@ await client.user.getByClientUserId("client_user_id");
780
811
  <dd>
781
812
 
782
813
  ```typescript
783
- await client.user.deregisterProvider("user_id", "oura");
814
+ await client.link.connectPasswordProvider("whoop", {
815
+ username: "username",
816
+ password: "password",
817
+ });
784
818
  ```
785
819
 
786
820
  </dd>
@@ -796,7 +830,7 @@ await client.user.deregisterProvider("user_id", "oura");
796
830
  <dl>
797
831
  <dd>
798
832
 
799
- **userId:** `string`
833
+ **provider:** `Vital.PasswordProviders`
800
834
 
801
835
  </dd>
802
836
  </dl>
@@ -804,7 +838,7 @@ await client.user.deregisterProvider("user_id", "oura");
804
838
  <dl>
805
839
  <dd>
806
840
 
807
- **provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
841
+ **request:** `Vital.IndividualProviderData`
808
842
 
809
843
  </dd>
810
844
  </dl>
@@ -812,7 +846,7 @@ await client.user.deregisterProvider("user_id", "oura");
812
846
  <dl>
813
847
  <dd>
814
848
 
815
- **requestOptions:** `User.RequestOptions`
849
+ **requestOptions:** `Link.RequestOptions`
816
850
 
817
851
  </dd>
818
852
  </dl>
@@ -823,10 +857,25 @@ await client.user.deregisterProvider("user_id", "oura");
823
857
  </dl>
824
858
  </details>
825
859
 
826
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
860
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">completePasswordProviderMfa</a>(provider, { ...params }) -> Vital.ProviderLinkResponse</code></summary>
861
+ <dl>
862
+ <dd>
863
+
864
+ #### 📝 Description
865
+
866
+ <dl>
867
+ <dd>
868
+
827
869
  <dl>
828
870
  <dd>
829
871
 
872
+ This connects auth providers that are password based.
873
+
874
+ </dd>
875
+ </dl>
876
+ </dd>
877
+ </dl>
878
+
830
879
  #### 🔌 Usage
831
880
 
832
881
  <dl>
@@ -836,7 +885,9 @@ await client.user.deregisterProvider("user_id", "oura");
836
885
  <dd>
837
886
 
838
887
  ```typescript
839
- await client.user.undoDelete();
888
+ await client.link.completePasswordProviderMfa("whoop", {
889
+ mfaCode: "mfa_code",
890
+ });
840
891
  ```
841
892
 
842
893
  </dd>
@@ -852,7 +903,7 @@ await client.user.undoDelete();
852
903
  <dl>
853
904
  <dd>
854
905
 
855
- **request:** `Vital.UserUndoDeleteRequest`
906
+ **provider:** `Vital.PasswordProviders`
856
907
 
857
908
  </dd>
858
909
  </dl>
@@ -860,7 +911,15 @@ await client.user.undoDelete();
860
911
  <dl>
861
912
  <dd>
862
913
 
863
- **requestOptions:** `User.RequestOptions`
914
+ **request:** `Vital.CompletePasswordProviderMfaBody`
915
+
916
+ </dd>
917
+ </dl>
918
+
919
+ <dl>
920
+ <dd>
921
+
922
+ **requestOptions:** `Link.RequestOptions`
864
923
 
865
924
  </dd>
866
925
  </dl>
@@ -871,7 +930,7 @@ await client.user.undoDelete();
871
930
  </dl>
872
931
  </details>
873
932
 
874
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
933
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectEmailAuthProvider</a>(provider, { ...params }) -> unknown</code></summary>
875
934
  <dl>
876
935
  <dd>
877
936
 
@@ -883,7 +942,7 @@ await client.user.undoDelete();
883
942
  <dl>
884
943
  <dd>
885
944
 
886
- Trigger a manual refresh for a specific user
945
+ This connects auth providers that are email based.
887
946
 
888
947
  </dd>
889
948
  </dl>
@@ -899,7 +958,9 @@ Trigger a manual refresh for a specific user
899
958
  <dd>
900
959
 
901
960
  ```typescript
902
- await client.user.refresh("user_id");
961
+ await client.link.connectEmailAuthProvider("freestyle_libre", {
962
+ email: "email",
963
+ });
903
964
  ```
904
965
 
905
966
  </dd>
@@ -915,7 +976,7 @@ await client.user.refresh("user_id");
915
976
  <dl>
916
977
  <dd>
917
978
 
918
- **userId:** `string`
979
+ **provider:** `Vital.EmailProviders`
919
980
 
920
981
  </dd>
921
982
  </dl>
@@ -923,7 +984,7 @@ await client.user.refresh("user_id");
923
984
  <dl>
924
985
  <dd>
925
986
 
926
- **request:** `Vital.UserRefreshRequest`
987
+ **request:** `Vital.EmailProviderAuthLink`
927
988
 
928
989
  </dd>
929
990
  </dl>
@@ -931,7 +992,7 @@ await client.user.refresh("user_id");
931
992
  <dl>
932
993
  <dd>
933
994
 
934
- **requestOptions:** `User.RequestOptions`
995
+ **requestOptions:** `Link.RequestOptions`
935
996
 
936
997
  </dd>
937
998
  </dl>
@@ -942,10 +1003,25 @@ await client.user.refresh("user_id");
942
1003
  </dl>
943
1004
  </details>
944
1005
 
945
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevices</a>(userId) -> Vital.ClientFacingDevice[]</code></summary>
1006
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">getAllProviders</a>({ ...params }) -> Vital.SourceLink[]</code></summary>
1007
+ <dl>
1008
+ <dd>
1009
+
1010
+ #### 📝 Description
1011
+
1012
+ <dl>
1013
+ <dd>
1014
+
946
1015
  <dl>
947
1016
  <dd>
948
1017
 
1018
+ GET List of all available providers given the generated link token.
1019
+
1020
+ </dd>
1021
+ </dl>
1022
+ </dd>
1023
+ </dl>
1024
+
949
1025
  #### 🔌 Usage
950
1026
 
951
1027
  <dl>
@@ -955,7 +1031,7 @@ await client.user.refresh("user_id");
955
1031
  <dd>
956
1032
 
957
1033
  ```typescript
958
- await client.user.getDevices("user_id");
1034
+ await client.link.getAllProviders();
959
1035
  ```
960
1036
 
961
1037
  </dd>
@@ -971,7 +1047,7 @@ await client.user.getDevices("user_id");
971
1047
  <dl>
972
1048
  <dd>
973
1049
 
974
- **userId:** `string`
1050
+ **request:** `Vital.LinkGetAllProvidersRequest`
975
1051
 
976
1052
  </dd>
977
1053
  </dl>
@@ -979,7 +1055,7 @@ await client.user.getDevices("user_id");
979
1055
  <dl>
980
1056
  <dd>
981
1057
 
982
- **requestOptions:** `User.RequestOptions`
1058
+ **requestOptions:** `Link.RequestOptions`
983
1059
 
984
1060
  </dd>
985
1061
  </dl>
@@ -990,7 +1066,7 @@ await client.user.getDevices("user_id");
990
1066
  </dl>
991
1067
  </details>
992
1068
 
993
- <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevice</a>(userId, deviceId) -> Vital.ClientFacingDevice</code></summary>
1069
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectManualProvider</a>(provider, { ...params }) -> Record<string, boolean></code></summary>
994
1070
  <dl>
995
1071
  <dd>
996
1072
 
@@ -1003,7 +1079,9 @@ await client.user.getDevices("user_id");
1003
1079
  <dd>
1004
1080
 
1005
1081
  ```typescript
1006
- await client.user.getDevice("user_id", "device_id");
1082
+ await client.link.connectManualProvider("beurer_ble", {
1083
+ userId: "user_id",
1084
+ });
1007
1085
  ```
1008
1086
 
1009
1087
  </dd>
@@ -1019,7 +1097,7 @@ await client.user.getDevice("user_id", "device_id");
1019
1097
  <dl>
1020
1098
  <dd>
1021
1099
 
1022
- **userId:** `string`
1100
+ **provider:** `Vital.ManualProviders`
1023
1101
 
1024
1102
  </dd>
1025
1103
  </dl>
@@ -1027,7 +1105,7 @@ await client.user.getDevice("user_id", "device_id");
1027
1105
  <dl>
1028
1106
  <dd>
1029
1107
 
1030
- **deviceId:** `string`
1108
+ **request:** `Vital.ManualConnectionData`
1031
1109
 
1032
1110
  </dd>
1033
1111
  </dl>
@@ -1035,7 +1113,7 @@ await client.user.getDevice("user_id", "device_id");
1035
1113
  <dl>
1036
1114
  <dd>
1037
1115
 
1038
- **requestOptions:** `User.RequestOptions`
1116
+ **requestOptions:** `Link.RequestOptions`
1039
1117
 
1040
1118
  </dd>
1041
1119
  </dl>
@@ -1046,12 +1124,25 @@ await client.user.getDevice("user_id", "device_id");
1046
1124
  </dl>
1047
1125
  </details>
1048
1126
 
1049
- ## Link
1127
+ <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectDemoProvider</a>({ ...params }) -> Vital.DemoConnectionStatus</code></summary>
1128
+ <dl>
1129
+ <dd>
1130
+
1131
+ #### 📝 Description
1132
+
1133
+ <dl>
1134
+ <dd>
1050
1135
 
1051
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">listBulkOps</a>({ ...params }) -> Vital.BulkOpsResponse</code></summary>
1052
1136
  <dl>
1053
1137
  <dd>
1054
1138
 
1139
+ POST Connect the given Vital user to a demo provider.
1140
+
1141
+ </dd>
1142
+ </dl>
1143
+ </dd>
1144
+ </dl>
1145
+
1055
1146
  #### 🔌 Usage
1056
1147
 
1057
1148
  <dl>
@@ -1061,7 +1152,10 @@ await client.user.getDevice("user_id", "device_id");
1061
1152
  <dd>
1062
1153
 
1063
1154
  ```typescript
1064
- await client.link.listBulkOps();
1155
+ await client.link.connectDemoProvider({
1156
+ userId: "user_id",
1157
+ provider: "apple_health_kit",
1158
+ });
1065
1159
  ```
1066
1160
 
1067
1161
  </dd>
@@ -1077,7 +1171,7 @@ await client.link.listBulkOps();
1077
1171
  <dl>
1078
1172
  <dd>
1079
1173
 
1080
- **request:** `Vital.LinkListBulkOpsRequest`
1174
+ **request:** `Vital.DemoConnectionCreationPayload`
1081
1175
 
1082
1176
  </dd>
1083
1177
  </dl>
@@ -1096,10 +1190,27 @@ await client.link.listBulkOps();
1096
1190
  </dl>
1097
1191
  </details>
1098
1192
 
1099
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkImport</a>({ ...params }) -> Vital.BulkImportConnectionsResponse</code></summary>
1193
+ ## User
1194
+
1195
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getAll</a>({ ...params }) -> Vital.PaginatedUsersResponse</code></summary>
1196
+ <dl>
1197
+ <dd>
1198
+
1199
+ #### 📝 Description
1200
+
1201
+ <dl>
1202
+ <dd>
1203
+
1100
1204
  <dl>
1101
1205
  <dd>
1102
1206
 
1207
+ GET All users for team.
1208
+
1209
+ </dd>
1210
+ </dl>
1211
+ </dd>
1212
+ </dl>
1213
+
1103
1214
  #### 🔌 Usage
1104
1215
 
1105
1216
  <dl>
@@ -1109,18 +1220,7 @@ await client.link.listBulkOps();
1109
1220
  <dd>
1110
1221
 
1111
1222
  ```typescript
1112
- await client.link.bulkImport({
1113
- provider: "oura",
1114
- connections: [
1115
- {
1116
- userId: "user_id",
1117
- accessToken: "access_token",
1118
- refreshToken: "refresh_token",
1119
- providerId: "provider_id",
1120
- expiresAt: 1,
1121
- },
1122
- ],
1123
- });
1223
+ await client.user.getAll();
1124
1224
  ```
1125
1225
 
1126
1226
  </dd>
@@ -1136,7 +1236,7 @@ await client.link.bulkImport({
1136
1236
  <dl>
1137
1237
  <dd>
1138
1238
 
1139
- **request:** `Vital.BulkImportConnectionsBody`
1239
+ **request:** `Vital.UserGetAllRequest`
1140
1240
 
1141
1241
  </dd>
1142
1242
  </dl>
@@ -1144,7 +1244,7 @@ await client.link.bulkImport({
1144
1244
  <dl>
1145
1245
  <dd>
1146
1246
 
1147
- **requestOptions:** `Link.RequestOptions`
1247
+ **requestOptions:** `User.RequestOptions`
1148
1248
 
1149
1249
  </dd>
1150
1250
  </dl>
@@ -1155,10 +1255,25 @@ await client.link.bulkImport({
1155
1255
  </dl>
1156
1256
  </details>
1157
1257
 
1158
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkTriggerHistoricalPull</a>({ ...params }) -> unknown</code></summary>
1258
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingUserKey</code></summary>
1159
1259
  <dl>
1160
1260
  <dd>
1161
1261
 
1262
+ #### 📝 Description
1263
+
1264
+ <dl>
1265
+ <dd>
1266
+
1267
+ <dl>
1268
+ <dd>
1269
+
1270
+ POST Create a Vital user given a client_user_id and returns the user_id.
1271
+
1272
+ </dd>
1273
+ </dl>
1274
+ </dd>
1275
+ </dl>
1276
+
1162
1277
  #### 🔌 Usage
1163
1278
 
1164
1279
  <dl>
@@ -1168,9 +1283,8 @@ await client.link.bulkImport({
1168
1283
  <dd>
1169
1284
 
1170
1285
  ```typescript
1171
- await client.link.bulkTriggerHistoricalPull({
1172
- userIds: ["user_ids"],
1173
- provider: "oura",
1286
+ await client.user.create({
1287
+ clientUserId: "client_user_id",
1174
1288
  });
1175
1289
  ```
1176
1290
 
@@ -1187,7 +1301,7 @@ await client.link.bulkTriggerHistoricalPull({
1187
1301
  <dl>
1188
1302
  <dd>
1189
1303
 
1190
- **request:** `Vital.BulkTriggerHistoricalPullBody`
1304
+ **request:** `Vital.UserCreateBody`
1191
1305
 
1192
1306
  </dd>
1193
1307
  </dl>
@@ -1195,7 +1309,7 @@ await client.link.bulkTriggerHistoricalPull({
1195
1309
  <dl>
1196
1310
  <dd>
1197
1311
 
1198
- **requestOptions:** `Link.RequestOptions`
1312
+ **requestOptions:** `User.RequestOptions`
1199
1313
 
1200
1314
  </dd>
1201
1315
  </dl>
@@ -1206,11 +1320,11 @@ await client.link.bulkTriggerHistoricalPull({
1206
1320
  </dl>
1207
1321
  </details>
1208
1322
 
1209
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkExport</a>({ ...params }) -> Vital.BulkExportConnectionsResponse</code></summary>
1323
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getTeamMetrics</a>() -> Vital.MetricsResult</code></summary>
1210
1324
  <dl>
1211
1325
  <dd>
1212
1326
 
1213
- #### 🔌 Usage
1327
+ #### 📝 Description
1214
1328
 
1215
1329
  <dl>
1216
1330
  <dd>
@@ -1218,18 +1332,14 @@ await client.link.bulkTriggerHistoricalPull({
1218
1332
  <dl>
1219
1333
  <dd>
1220
1334
 
1221
- ```typescript
1222
- await client.link.bulkExport({
1223
- provider: "oura",
1224
- });
1225
- ```
1335
+ GET metrics for team.
1226
1336
 
1227
1337
  </dd>
1228
1338
  </dl>
1229
1339
  </dd>
1230
1340
  </dl>
1231
1341
 
1232
- #### ⚙️ Parameters
1342
+ #### 🔌 Usage
1233
1343
 
1234
1344
  <dl>
1235
1345
  <dd>
@@ -1237,15 +1347,24 @@ await client.link.bulkExport({
1237
1347
  <dl>
1238
1348
  <dd>
1239
1349
 
1240
- **request:** `Vital.BulkExportConnectionsBody`
1350
+ ```typescript
1351
+ await client.user.getTeamMetrics();
1352
+ ```
1241
1353
 
1242
1354
  </dd>
1243
1355
  </dl>
1356
+ </dd>
1357
+ </dl>
1358
+
1359
+ #### ⚙️ Parameters
1244
1360
 
1245
1361
  <dl>
1246
1362
  <dd>
1247
1363
 
1248
- **requestOptions:** `Link.RequestOptions`
1364
+ <dl>
1365
+ <dd>
1366
+
1367
+ **requestOptions:** `User.RequestOptions`
1249
1368
 
1250
1369
  </dd>
1251
1370
  </dl>
@@ -1256,7 +1375,7 @@ await client.link.bulkExport({
1256
1375
  </dl>
1257
1376
  </details>
1258
1377
 
1259
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">bulkPause</a>({ ...params }) -> unknown</code></summary>
1378
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getUserSignInToken</a>(userId) -> Vital.UserSignInTokenResponse</code></summary>
1260
1379
  <dl>
1261
1380
  <dd>
1262
1381
 
@@ -1269,10 +1388,7 @@ await client.link.bulkExport({
1269
1388
  <dd>
1270
1389
 
1271
1390
  ```typescript
1272
- await client.link.bulkPause({
1273
- userIds: ["user_ids"],
1274
- provider: "oura",
1275
- });
1391
+ await client.user.getUserSignInToken("user_id");
1276
1392
  ```
1277
1393
 
1278
1394
  </dd>
@@ -1288,7 +1404,7 @@ await client.link.bulkPause({
1288
1404
  <dl>
1289
1405
  <dd>
1290
1406
 
1291
- **request:** `Vital.BulkPauseConnectionsBody`
1407
+ **userId:** `string`
1292
1408
 
1293
1409
  </dd>
1294
1410
  </dl>
@@ -1296,7 +1412,7 @@ await client.link.bulkPause({
1296
1412
  <dl>
1297
1413
  <dd>
1298
1414
 
1299
- **requestOptions:** `Link.RequestOptions`
1415
+ **requestOptions:** `User.RequestOptions`
1300
1416
 
1301
1417
  </dd>
1302
1418
  </dl>
@@ -1307,7 +1423,7 @@ await client.link.bulkPause({
1307
1423
  </dl>
1308
1424
  </details>
1309
1425
 
1310
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">token</a>({ ...params }) -> Vital.LinkTokenExchangeResponse</code></summary>
1426
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getConnectedProviders</a>(userId) -> Record<string, Vital.ClientFacingProviderWithStatus[]></code></summary>
1311
1427
  <dl>
1312
1428
  <dd>
1313
1429
 
@@ -1319,68 +1435,13 @@ await client.link.bulkPause({
1319
1435
  <dl>
1320
1436
  <dd>
1321
1437
 
1322
- Endpoint to generate a user link token, to be used throughout the vital
1323
- link process. The vital link token is a one time use token, that
1324
- expires after 10 minutes. If you would like vital-link widget to launch
1325
- with a specific provider, pass in a provider in the body. If you would
1326
- like to redirect to a custom url after successful or error connection,
1327
- pass in your own custom redirect_url parameter.
1328
-
1329
- </dd>
1330
- </dl>
1331
- </dd>
1332
- </dl>
1333
-
1334
- #### 🔌 Usage
1335
-
1336
- <dl>
1337
- <dd>
1338
-
1339
- <dl>
1340
- <dd>
1341
-
1342
- ```typescript
1343
- await client.link.token({
1344
- userId: "user_id",
1345
- });
1346
- ```
1347
-
1348
- </dd>
1349
- </dl>
1350
- </dd>
1351
- </dl>
1352
-
1353
- #### ⚙️ Parameters
1354
-
1355
- <dl>
1356
- <dd>
1357
-
1358
- <dl>
1359
- <dd>
1360
-
1361
- **request:** `Vital.LinkTokenExchange`
1362
-
1363
- </dd>
1364
- </dl>
1365
-
1366
- <dl>
1367
- <dd>
1368
-
1369
- **requestOptions:** `Link.RequestOptions`
1438
+ GET Users connected providers
1370
1439
 
1371
1440
  </dd>
1372
1441
  </dl>
1373
1442
  </dd>
1374
1443
  </dl>
1375
1444
 
1376
- </dd>
1377
- </dl>
1378
- </details>
1379
-
1380
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">isTokenValid</a>({ ...params }) -> Record<string, unknown></code></summary>
1381
- <dl>
1382
- <dd>
1383
-
1384
1445
  #### 🔌 Usage
1385
1446
 
1386
1447
  <dl>
@@ -1390,9 +1451,7 @@ await client.link.token({
1390
1451
  <dd>
1391
1452
 
1392
1453
  ```typescript
1393
- await client.link.isTokenValid({
1394
- token: "token",
1395
- });
1454
+ await client.user.getConnectedProviders("user_id");
1396
1455
  ```
1397
1456
 
1398
1457
  </dd>
@@ -1408,7 +1467,7 @@ await client.link.isTokenValid({
1408
1467
  <dl>
1409
1468
  <dd>
1410
1469
 
1411
- **request:** `Vital.LinkTokenValidationRequest`
1470
+ **userId:** `string`
1412
1471
 
1413
1472
  </dd>
1414
1473
  </dl>
@@ -1416,7 +1475,7 @@ await client.link.isTokenValid({
1416
1475
  <dl>
1417
1476
  <dd>
1418
1477
 
1419
- **requestOptions:** `Link.RequestOptions`
1478
+ **requestOptions:** `User.RequestOptions`
1420
1479
 
1421
1480
  </dd>
1422
1481
  </dl>
@@ -1427,7 +1486,7 @@ await client.link.isTokenValid({
1427
1486
  </dl>
1428
1487
  </details>
1429
1488
 
1430
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">codeCreate</a>({ ...params }) -> Vital.VitalTokenCreatedResponse</code></summary>
1489
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Vital.ClientFacingUser</code></summary>
1431
1490
  <dl>
1432
1491
  <dd>
1433
1492
 
@@ -1439,7 +1498,7 @@ await client.link.isTokenValid({
1439
1498
  <dl>
1440
1499
  <dd>
1441
1500
 
1442
- Generate a token to invite a user of Vital mobile app to your team
1501
+ GET User details given the user_id.
1443
1502
 
1444
1503
  </dd>
1445
1504
  </dl>
@@ -1455,9 +1514,7 @@ Generate a token to invite a user of Vital mobile app to your team
1455
1514
  <dd>
1456
1515
 
1457
1516
  ```typescript
1458
- await client.link.codeCreate({
1459
- userId: "user_id",
1460
- });
1517
+ await client.user.get("user_id");
1461
1518
  ```
1462
1519
 
1463
1520
  </dd>
@@ -1473,7 +1530,7 @@ await client.link.codeCreate({
1473
1530
  <dl>
1474
1531
  <dd>
1475
1532
 
1476
- **request:** `Vital.LinkCodeCreateRequest`
1533
+ **userId:** `string`
1477
1534
 
1478
1535
  </dd>
1479
1536
  </dl>
@@ -1481,7 +1538,7 @@ await client.link.codeCreate({
1481
1538
  <dl>
1482
1539
  <dd>
1483
1540
 
1484
- **requestOptions:** `Link.RequestOptions`
1541
+ **requestOptions:** `User.RequestOptions`
1485
1542
 
1486
1543
  </dd>
1487
1544
  </dl>
@@ -1492,26 +1549,10 @@ await client.link.codeCreate({
1492
1549
  </dl>
1493
1550
  </details>
1494
1551
 
1495
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">startConnect</a>({ ...params }) -> Record<string, unknown></code></summary>
1496
- <dl>
1497
- <dd>
1498
-
1499
- #### 📝 Description
1500
-
1501
- <dl>
1502
- <dd>
1503
-
1552
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Vital.UserSuccessResponse</code></summary>
1504
1553
  <dl>
1505
1554
  <dd>
1506
1555
 
1507
- REQUEST_SOURCE: VITAL-LINK
1508
- Start link token process
1509
-
1510
- </dd>
1511
- </dl>
1512
- </dd>
1513
- </dl>
1514
-
1515
1556
  #### 🔌 Usage
1516
1557
 
1517
1558
  <dl>
@@ -1521,10 +1562,7 @@ Start link token process
1521
1562
  <dd>
1522
1563
 
1523
1564
  ```typescript
1524
- await client.link.startConnect({
1525
- linkToken: "link_token",
1526
- provider: "oura",
1527
- });
1565
+ await client.user.delete("user_id");
1528
1566
  ```
1529
1567
 
1530
1568
  </dd>
@@ -1540,7 +1578,7 @@ await client.link.startConnect({
1540
1578
  <dl>
1541
1579
  <dd>
1542
1580
 
1543
- **request:** `Vital.BeginLinkTokenRequest`
1581
+ **userId:** `string`
1544
1582
 
1545
1583
  </dd>
1546
1584
  </dl>
@@ -1548,7 +1586,7 @@ await client.link.startConnect({
1548
1586
  <dl>
1549
1587
  <dd>
1550
1588
 
1551
- **requestOptions:** `Link.RequestOptions`
1589
+ **requestOptions:** `User.RequestOptions`
1552
1590
 
1553
1591
  </dd>
1554
1592
  </dl>
@@ -1559,11 +1597,11 @@ await client.link.startConnect({
1559
1597
  </dl>
1560
1598
  </details>
1561
1599
 
1562
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">tokenState</a>({ ...params }) -> Record<string, unknown></code></summary>
1600
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">patch</a>(userId, { ...params }) -> void</code></summary>
1563
1601
  <dl>
1564
1602
  <dd>
1565
1603
 
1566
- #### 📝 Description
1604
+ #### 🔌 Usage
1567
1605
 
1568
1606
  <dl>
1569
1607
  <dd>
@@ -1571,15 +1609,16 @@ await client.link.startConnect({
1571
1609
  <dl>
1572
1610
  <dd>
1573
1611
 
1574
- REQUEST_SOURCE: VITAL-LINK
1575
- Check link token state - can be hit continuously used as heartbeat
1612
+ ```typescript
1613
+ await client.user.patch("user_id");
1614
+ ```
1576
1615
 
1577
1616
  </dd>
1578
1617
  </dl>
1579
1618
  </dd>
1580
1619
  </dl>
1581
1620
 
1582
- #### 🔌 Usage
1621
+ #### ⚙️ Parameters
1583
1622
 
1584
1623
  <dl>
1585
1624
  <dd>
@@ -1587,24 +1626,15 @@ Check link token state - can be hit continuously used as heartbeat
1587
1626
  <dl>
1588
1627
  <dd>
1589
1628
 
1590
- ```typescript
1591
- await client.link.tokenState();
1592
- ```
1629
+ **userId:** `string`
1593
1630
 
1594
1631
  </dd>
1595
1632
  </dl>
1596
- </dd>
1597
- </dl>
1598
-
1599
- #### ⚙️ Parameters
1600
-
1601
- <dl>
1602
- <dd>
1603
1633
 
1604
1634
  <dl>
1605
1635
  <dd>
1606
1636
 
1607
- **request:** `Vital.LinkTokenStateRequest`
1637
+ **request:** `Vital.UserPatchBody`
1608
1638
 
1609
1639
  </dd>
1610
1640
  </dl>
@@ -1612,7 +1642,7 @@ await client.link.tokenState();
1612
1642
  <dl>
1613
1643
  <dd>
1614
1644
 
1615
- **requestOptions:** `Link.RequestOptions`
1645
+ **requestOptions:** `User.RequestOptions`
1616
1646
 
1617
1647
  </dd>
1618
1648
  </dl>
@@ -1623,25 +1653,10 @@ await client.link.tokenState();
1623
1653
  </dl>
1624
1654
  </details>
1625
1655
 
1626
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">emailAuth</a>({ ...params }) -> unknown</code></summary>
1627
- <dl>
1628
- <dd>
1629
-
1630
- #### 📝 Description
1631
-
1632
- <dl>
1633
- <dd>
1634
-
1656
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestUserInfo</a>(userId) -> Vital.UserInfo</code></summary>
1635
1657
  <dl>
1636
1658
  <dd>
1637
1659
 
1638
- Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
1639
-
1640
- </dd>
1641
- </dl>
1642
- </dd>
1643
- </dl>
1644
-
1645
1660
  #### 🔌 Usage
1646
1661
 
1647
1662
  <dl>
@@ -1651,11 +1666,7 @@ Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
1651
1666
  <dd>
1652
1667
 
1653
1668
  ```typescript
1654
- await client.link.emailAuth({
1655
- email: "email",
1656
- provider: "oura",
1657
- authType: "password",
1658
- });
1669
+ await client.user.getLatestUserInfo("user_id");
1659
1670
  ```
1660
1671
 
1661
1672
  </dd>
@@ -1671,7 +1682,7 @@ await client.link.emailAuth({
1671
1682
  <dl>
1672
1683
  <dd>
1673
1684
 
1674
- **request:** `Vital.EmailAuthLink`
1685
+ **userId:** `string`
1675
1686
 
1676
1687
  </dd>
1677
1688
  </dl>
@@ -1679,7 +1690,7 @@ await client.link.emailAuth({
1679
1690
  <dl>
1680
1691
  <dd>
1681
1692
 
1682
- **requestOptions:** `Link.RequestOptions`
1693
+ **requestOptions:** `User.RequestOptions`
1683
1694
 
1684
1695
  </dd>
1685
1696
  </dl>
@@ -1690,11 +1701,11 @@ await client.link.emailAuth({
1690
1701
  </dl>
1691
1702
  </details>
1692
1703
 
1693
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">passwordAuth</a>({ ...params }) -> unknown</code></summary>
1704
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createInsurance</a>(userId, { ...params }) -> Vital.ClientFacingInsurance</code></summary>
1694
1705
  <dl>
1695
1706
  <dd>
1696
1707
 
1697
- #### 📝 Description
1708
+ #### 🔌 Usage
1698
1709
 
1699
1710
  <dl>
1700
1711
  <dd>
@@ -1702,14 +1713,35 @@ await client.link.emailAuth({
1702
1713
  <dl>
1703
1714
  <dd>
1704
1715
 
1705
- Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
1716
+ ```typescript
1717
+ await client.user.createInsurance("user_id", {
1718
+ payorCode: "payor_code",
1719
+ memberId: "member_id",
1720
+ relationship: "Self",
1721
+ insured: {
1722
+ firstName: "first_name",
1723
+ lastName: "last_name",
1724
+ gender: "female",
1725
+ address: {
1726
+ firstLine: "first_line",
1727
+ country: "country",
1728
+ zip: "zip",
1729
+ city: "city",
1730
+ state: "state",
1731
+ },
1732
+ dob: "dob",
1733
+ email: "email",
1734
+ phoneNumber: "phone_number",
1735
+ },
1736
+ });
1737
+ ```
1706
1738
 
1707
1739
  </dd>
1708
1740
  </dl>
1709
1741
  </dd>
1710
1742
  </dl>
1711
1743
 
1712
- #### 🔌 Usage
1744
+ #### ⚙️ Parameters
1713
1745
 
1714
1746
  <dl>
1715
1747
  <dd>
@@ -1717,29 +1749,15 @@ Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
1717
1749
  <dl>
1718
1750
  <dd>
1719
1751
 
1720
- ```typescript
1721
- await client.link.passwordAuth({
1722
- username: "username",
1723
- password: "password",
1724
- provider: "oura",
1725
- authType: "password",
1726
- });
1727
- ```
1752
+ **userId:** `string`
1728
1753
 
1729
1754
  </dd>
1730
1755
  </dl>
1731
- </dd>
1732
- </dl>
1733
-
1734
- #### ⚙️ Parameters
1735
-
1736
- <dl>
1737
- <dd>
1738
1756
 
1739
1757
  <dl>
1740
1758
  <dd>
1741
1759
 
1742
- **request:** `Vital.PasswordAuthLink`
1760
+ **request:** `Vital.CreateInsuranceRequest`
1743
1761
 
1744
1762
  </dd>
1745
1763
  </dl>
@@ -1747,7 +1765,7 @@ await client.link.passwordAuth({
1747
1765
  <dl>
1748
1766
  <dd>
1749
1767
 
1750
- **requestOptions:** `Link.RequestOptions`
1768
+ **requestOptions:** `User.RequestOptions`
1751
1769
 
1752
1770
  </dd>
1753
1771
  </dl>
@@ -1758,25 +1776,10 @@ await client.link.passwordAuth({
1758
1776
  </dl>
1759
1777
  </details>
1760
1778
 
1761
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">generateOauthLink</a>(oauthProvider, { ...params }) -> Vital.Source</code></summary>
1762
- <dl>
1763
- <dd>
1764
-
1765
- #### 📝 Description
1766
-
1767
- <dl>
1768
- <dd>
1769
-
1779
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestInsurance</a>(userId) -> Vital.ClientFacingInsurance</code></summary>
1770
1780
  <dl>
1771
1781
  <dd>
1772
1782
 
1773
- This endpoint generates an OAuth link for oauth provider
1774
-
1775
- </dd>
1776
- </dl>
1777
- </dd>
1778
- </dl>
1779
-
1780
1783
  #### 🔌 Usage
1781
1784
 
1782
1785
  <dl>
@@ -1786,7 +1789,7 @@ This endpoint generates an OAuth link for oauth provider
1786
1789
  <dd>
1787
1790
 
1788
1791
  ```typescript
1789
- await client.link.generateOauthLink("oura");
1792
+ await client.user.getLatestInsurance("user_id");
1790
1793
  ```
1791
1794
 
1792
1795
  </dd>
@@ -1802,15 +1805,7 @@ await client.link.generateOauthLink("oura");
1802
1805
  <dl>
1803
1806
  <dd>
1804
1807
 
1805
- **oauthProvider:** `Vital.OAuthProviders`
1806
-
1807
- </dd>
1808
- </dl>
1809
-
1810
- <dl>
1811
- <dd>
1812
-
1813
- **request:** `Vital.LinkGenerateOauthLinkRequest`
1808
+ **userId:** `string`
1814
1809
 
1815
1810
  </dd>
1816
1811
  </dl>
@@ -1818,7 +1813,7 @@ await client.link.generateOauthLink("oura");
1818
1813
  <dl>
1819
1814
  <dd>
1820
1815
 
1821
- **requestOptions:** `Link.RequestOptions`
1816
+ **requestOptions:** `User.RequestOptions`
1822
1817
 
1823
1818
  </dd>
1824
1819
  </dl>
@@ -1829,25 +1824,10 @@ await client.link.generateOauthLink("oura");
1829
1824
  </dl>
1830
1825
  </details>
1831
1826
 
1832
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectPasswordProvider</a>(provider, { ...params }) -> Vital.ProviderLinkResponse</code></summary>
1833
- <dl>
1834
- <dd>
1835
-
1836
- #### 📝 Description
1837
-
1838
- <dl>
1839
- <dd>
1840
-
1827
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">upsertUserInfo</a>(userId, { ...params }) -> Vital.UserInfo</code></summary>
1841
1828
  <dl>
1842
1829
  <dd>
1843
1830
 
1844
- This connects auth providers that are password based.
1845
-
1846
- </dd>
1847
- </dl>
1848
- </dd>
1849
- </dl>
1850
-
1851
1831
  #### 🔌 Usage
1852
1832
 
1853
1833
  <dl>
@@ -1857,9 +1837,20 @@ This connects auth providers that are password based.
1857
1837
  <dd>
1858
1838
 
1859
1839
  ```typescript
1860
- await client.link.connectPasswordProvider("whoop", {
1861
- username: "username",
1862
- password: "password",
1840
+ await client.user.upsertUserInfo("user_id", {
1841
+ firstName: "first_name",
1842
+ lastName: "last_name",
1843
+ email: "email",
1844
+ phoneNumber: "phone_number",
1845
+ gender: "gender",
1846
+ dob: "dob",
1847
+ address: {
1848
+ firstLine: "first_line",
1849
+ country: "country",
1850
+ zip: "zip",
1851
+ city: "city",
1852
+ state: "state",
1853
+ },
1863
1854
  });
1864
1855
  ```
1865
1856
 
@@ -1876,7 +1867,7 @@ await client.link.connectPasswordProvider("whoop", {
1876
1867
  <dl>
1877
1868
  <dd>
1878
1869
 
1879
- **provider:** `Vital.PasswordProviders`
1870
+ **userId:** `string`
1880
1871
 
1881
1872
  </dd>
1882
1873
  </dl>
@@ -1884,7 +1875,7 @@ await client.link.connectPasswordProvider("whoop", {
1884
1875
  <dl>
1885
1876
  <dd>
1886
1877
 
1887
- **request:** `Vital.IndividualProviderData`
1878
+ **request:** `Vital.UserInfoCreateRequest`
1888
1879
 
1889
1880
  </dd>
1890
1881
  </dl>
@@ -1892,7 +1883,7 @@ await client.link.connectPasswordProvider("whoop", {
1892
1883
  <dl>
1893
1884
  <dd>
1894
1885
 
1895
- **requestOptions:** `Link.RequestOptions`
1886
+ **requestOptions:** `User.RequestOptions`
1896
1887
 
1897
1888
  </dd>
1898
1889
  </dl>
@@ -1903,7 +1894,7 @@ await client.link.connectPasswordProvider("whoop", {
1903
1894
  </dl>
1904
1895
  </details>
1905
1896
 
1906
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">completePasswordProviderMfa</a>(provider, { ...params }) -> Vital.ProviderLinkResponse</code></summary>
1897
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getByClientUserId</a>(clientUserId) -> Vital.ClientFacingUser</code></summary>
1907
1898
  <dl>
1908
1899
  <dd>
1909
1900
 
@@ -1915,7 +1906,7 @@ await client.link.connectPasswordProvider("whoop", {
1915
1906
  <dl>
1916
1907
  <dd>
1917
1908
 
1918
- This connects auth providers that are password based.
1909
+ GET user_id from client_user_id.
1919
1910
 
1920
1911
  </dd>
1921
1912
  </dl>
@@ -1931,9 +1922,7 @@ This connects auth providers that are password based.
1931
1922
  <dd>
1932
1923
 
1933
1924
  ```typescript
1934
- await client.link.completePasswordProviderMfa("whoop", {
1935
- mfaCode: "mfa_code",
1936
- });
1925
+ await client.user.getByClientUserId("client_user_id");
1937
1926
  ```
1938
1927
 
1939
1928
  </dd>
@@ -1949,15 +1938,7 @@ await client.link.completePasswordProviderMfa("whoop", {
1949
1938
  <dl>
1950
1939
  <dd>
1951
1940
 
1952
- **provider:** `Vital.PasswordProviders`
1953
-
1954
- </dd>
1955
- </dl>
1956
-
1957
- <dl>
1958
- <dd>
1959
-
1960
- **request:** `Vital.CompletePasswordProviderMfaBody`
1941
+ **clientUserId:** `string` — A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
1961
1942
 
1962
1943
  </dd>
1963
1944
  </dl>
@@ -1965,7 +1946,7 @@ await client.link.completePasswordProviderMfa("whoop", {
1965
1946
  <dl>
1966
1947
  <dd>
1967
1948
 
1968
- **requestOptions:** `Link.RequestOptions`
1949
+ **requestOptions:** `User.RequestOptions`
1969
1950
 
1970
1951
  </dd>
1971
1952
  </dl>
@@ -1976,25 +1957,10 @@ await client.link.completePasswordProviderMfa("whoop", {
1976
1957
  </dl>
1977
1958
  </details>
1978
1959
 
1979
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectEmailAuthProvider</a>(provider, { ...params }) -> unknown</code></summary>
1980
- <dl>
1981
- <dd>
1982
-
1983
- #### 📝 Description
1984
-
1985
- <dl>
1986
- <dd>
1987
-
1960
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deregisterProvider</a>(userId, provider) -> Vital.UserSuccessResponse</code></summary>
1988
1961
  <dl>
1989
1962
  <dd>
1990
1963
 
1991
- This connects auth providers that are email based.
1992
-
1993
- </dd>
1994
- </dl>
1995
- </dd>
1996
- </dl>
1997
-
1998
1964
  #### 🔌 Usage
1999
1965
 
2000
1966
  <dl>
@@ -2004,9 +1970,7 @@ This connects auth providers that are email based.
2004
1970
  <dd>
2005
1971
 
2006
1972
  ```typescript
2007
- await client.link.connectEmailAuthProvider("freestyle_libre", {
2008
- email: "email",
2009
- });
1973
+ await client.user.deregisterProvider("user_id", "oura");
2010
1974
  ```
2011
1975
 
2012
1976
  </dd>
@@ -2022,7 +1986,7 @@ await client.link.connectEmailAuthProvider("freestyle_libre", {
2022
1986
  <dl>
2023
1987
  <dd>
2024
1988
 
2025
- **provider:** `Vital.EmailProviders`
1989
+ **userId:** `string`
2026
1990
 
2027
1991
  </dd>
2028
1992
  </dl>
@@ -2030,7 +1994,7 @@ await client.link.connectEmailAuthProvider("freestyle_libre", {
2030
1994
  <dl>
2031
1995
  <dd>
2032
1996
 
2033
- **request:** `Vital.EmailProviderAuthLink`
1997
+ **provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
2034
1998
 
2035
1999
  </dd>
2036
2000
  </dl>
@@ -2038,7 +2002,7 @@ await client.link.connectEmailAuthProvider("freestyle_libre", {
2038
2002
  <dl>
2039
2003
  <dd>
2040
2004
 
2041
- **requestOptions:** `Link.RequestOptions`
2005
+ **requestOptions:** `User.RequestOptions`
2042
2006
 
2043
2007
  </dd>
2044
2008
  </dl>
@@ -2049,25 +2013,10 @@ await client.link.connectEmailAuthProvider("freestyle_libre", {
2049
2013
  </dl>
2050
2014
  </details>
2051
2015
 
2052
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">getAllProviders</a>({ ...params }) -> Vital.SourceLink[]</code></summary>
2053
- <dl>
2054
- <dd>
2055
-
2056
- #### 📝 Description
2057
-
2058
- <dl>
2059
- <dd>
2060
-
2016
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
2061
2017
  <dl>
2062
2018
  <dd>
2063
2019
 
2064
- GET List of all available providers given the generated link token.
2065
-
2066
- </dd>
2067
- </dl>
2068
- </dd>
2069
- </dl>
2070
-
2071
2020
  #### 🔌 Usage
2072
2021
 
2073
2022
  <dl>
@@ -2077,7 +2026,7 @@ GET List of all available providers given the generated link token.
2077
2026
  <dd>
2078
2027
 
2079
2028
  ```typescript
2080
- await client.link.getAllProviders();
2029
+ await client.user.undoDelete();
2081
2030
  ```
2082
2031
 
2083
2032
  </dd>
@@ -2093,7 +2042,7 @@ await client.link.getAllProviders();
2093
2042
  <dl>
2094
2043
  <dd>
2095
2044
 
2096
- **request:** `Vital.LinkGetAllProvidersRequest`
2045
+ **request:** `Vital.UserUndoDeleteRequest`
2097
2046
 
2098
2047
  </dd>
2099
2048
  </dl>
@@ -2101,7 +2050,7 @@ await client.link.getAllProviders();
2101
2050
  <dl>
2102
2051
  <dd>
2103
2052
 
2104
- **requestOptions:** `Link.RequestOptions`
2053
+ **requestOptions:** `User.RequestOptions`
2105
2054
 
2106
2055
  </dd>
2107
2056
  </dl>
@@ -2112,10 +2061,25 @@ await client.link.getAllProviders();
2112
2061
  </dl>
2113
2062
  </details>
2114
2063
 
2115
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectManualProvider</a>(provider, { ...params }) -> Record<string, boolean></code></summary>
2064
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
2065
+ <dl>
2066
+ <dd>
2067
+
2068
+ #### 📝 Description
2069
+
2116
2070
  <dl>
2117
2071
  <dd>
2118
2072
 
2073
+ <dl>
2074
+ <dd>
2075
+
2076
+ Trigger a manual refresh for a specific user
2077
+
2078
+ </dd>
2079
+ </dl>
2080
+ </dd>
2081
+ </dl>
2082
+
2119
2083
  #### 🔌 Usage
2120
2084
 
2121
2085
  <dl>
@@ -2125,9 +2089,7 @@ await client.link.getAllProviders();
2125
2089
  <dd>
2126
2090
 
2127
2091
  ```typescript
2128
- await client.link.connectManualProvider("beurer_ble", {
2129
- userId: "user_id",
2130
- });
2092
+ await client.user.refresh("user_id");
2131
2093
  ```
2132
2094
 
2133
2095
  </dd>
@@ -2143,7 +2105,7 @@ await client.link.connectManualProvider("beurer_ble", {
2143
2105
  <dl>
2144
2106
  <dd>
2145
2107
 
2146
- **provider:** `Vital.ManualProviders`
2108
+ **userId:** `string`
2147
2109
 
2148
2110
  </dd>
2149
2111
  </dl>
@@ -2151,7 +2113,7 @@ await client.link.connectManualProvider("beurer_ble", {
2151
2113
  <dl>
2152
2114
  <dd>
2153
2115
 
2154
- **request:** `Vital.ManualConnectionData`
2116
+ **request:** `Vital.UserRefreshRequest`
2155
2117
 
2156
2118
  </dd>
2157
2119
  </dl>
@@ -2159,7 +2121,7 @@ await client.link.connectManualProvider("beurer_ble", {
2159
2121
  <dl>
2160
2122
  <dd>
2161
2123
 
2162
- **requestOptions:** `Link.RequestOptions`
2124
+ **requestOptions:** `User.RequestOptions`
2163
2125
 
2164
2126
  </dd>
2165
2127
  </dl>
@@ -2170,25 +2132,10 @@ await client.link.connectManualProvider("beurer_ble", {
2170
2132
  </dl>
2171
2133
  </details>
2172
2134
 
2173
- <details><summary><code>client.link.<a href="/src/api/resources/link/client/Client.ts">connectDemoProvider</a>({ ...params }) -> Vital.DemoConnectionStatus</code></summary>
2174
- <dl>
2175
- <dd>
2176
-
2177
- #### 📝 Description
2178
-
2179
- <dl>
2180
- <dd>
2181
-
2135
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevices</a>(userId) -> Vital.ClientFacingDevice[]</code></summary>
2182
2136
  <dl>
2183
2137
  <dd>
2184
2138
 
2185
- POST Connect the given Vital user to a demo provider.
2186
-
2187
- </dd>
2188
- </dl>
2189
- </dd>
2190
- </dl>
2191
-
2192
2139
  #### 🔌 Usage
2193
2140
 
2194
2141
  <dl>
@@ -2198,10 +2145,7 @@ POST Connect the given Vital user to a demo provider.
2198
2145
  <dd>
2199
2146
 
2200
2147
  ```typescript
2201
- await client.link.connectDemoProvider({
2202
- userId: "user_id",
2203
- provider: "apple_health_kit",
2204
- });
2148
+ await client.user.getDevices("user_id");
2205
2149
  ```
2206
2150
 
2207
2151
  </dd>
@@ -2217,7 +2161,7 @@ await client.link.connectDemoProvider({
2217
2161
  <dl>
2218
2162
  <dd>
2219
2163
 
2220
- **request:** `Vital.DemoConnectionCreationPayload`
2164
+ **userId:** `string`
2221
2165
 
2222
2166
  </dd>
2223
2167
  </dl>
@@ -2225,7 +2169,7 @@ await client.link.connectDemoProvider({
2225
2169
  <dl>
2226
2170
  <dd>
2227
2171
 
2228
- **requestOptions:** `Link.RequestOptions`
2172
+ **requestOptions:** `User.RequestOptions`
2229
2173
 
2230
2174
  </dd>
2231
2175
  </dl>
@@ -2236,13 +2180,11 @@ await client.link.connectDemoProvider({
2236
2180
  </dl>
2237
2181
  </details>
2238
2182
 
2239
- ## Providers
2240
-
2241
- <details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">getAll</a>({ ...params }) -> Vital.ClientFacingProviderDetailed[]</code></summary>
2183
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevice</a>(userId, deviceId) -> Vital.ClientFacingDevice</code></summary>
2242
2184
  <dl>
2243
2185
  <dd>
2244
2186
 
2245
- #### 📝 Description
2187
+ #### 🔌 Usage
2246
2188
 
2247
2189
  <dl>
2248
2190
  <dd>
@@ -2250,14 +2192,16 @@ await client.link.connectDemoProvider({
2250
2192
  <dl>
2251
2193
  <dd>
2252
2194
 
2253
- Get Provider list
2195
+ ```typescript
2196
+ await client.user.getDevice("user_id", "device_id");
2197
+ ```
2254
2198
 
2255
2199
  </dd>
2256
2200
  </dl>
2257
2201
  </dd>
2258
2202
  </dl>
2259
2203
 
2260
- #### 🔌 Usage
2204
+ #### ⚙️ Parameters
2261
2205
 
2262
2206
  <dl>
2263
2207
  <dd>
@@ -2265,24 +2209,15 @@ Get Provider list
2265
2209
  <dl>
2266
2210
  <dd>
2267
2211
 
2268
- ```typescript
2269
- await client.providers.getAll();
2270
- ```
2212
+ **userId:** `string`
2271
2213
 
2272
2214
  </dd>
2273
2215
  </dl>
2274
- </dd>
2275
- </dl>
2276
-
2277
- #### ⚙️ Parameters
2278
-
2279
- <dl>
2280
- <dd>
2281
2216
 
2282
2217
  <dl>
2283
2218
  <dd>
2284
2219
 
2285
- **request:** `Vital.ProvidersGetAllRequest`
2220
+ **deviceId:** `string`
2286
2221
 
2287
2222
  </dd>
2288
2223
  </dl>
@@ -2290,7 +2225,7 @@ await client.providers.getAll();
2290
2225
  <dl>
2291
2226
  <dd>
2292
2227
 
2293
- **requestOptions:** `Providers.RequestOptions`
2228
+ **requestOptions:** `User.RequestOptions`
2294
2229
 
2295
2230
  </dd>
2296
2231
  </dl>
@@ -3506,9 +3441,9 @@ await client.menstrualCycle.get("user_id", {
3506
3441
  </dl>
3507
3442
  </details>
3508
3443
 
3509
- ## LabTests
3444
+ ## Providers
3510
3445
 
3511
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">get</a>({ ...params }) -> Vital.ClientFacingLabTest[]</code></summary>
3446
+ <details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">getAll</a>({ ...params }) -> Vital.ClientFacingProviderDetailed[]</code></summary>
3512
3447
  <dl>
3513
3448
  <dd>
3514
3449
 
@@ -3520,7 +3455,7 @@ await client.menstrualCycle.get("user_id", {
3520
3455
  <dl>
3521
3456
  <dd>
3522
3457
 
3523
- GET all the lab tests the team has access to.
3458
+ Get Provider list
3524
3459
 
3525
3460
  </dd>
3526
3461
  </dl>
@@ -3536,7 +3471,7 @@ GET all the lab tests the team has access to.
3536
3471
  <dd>
3537
3472
 
3538
3473
  ```typescript
3539
- await client.labTests.get();
3474
+ await client.providers.getAll();
3540
3475
  ```
3541
3476
 
3542
3477
  </dd>
@@ -3552,7 +3487,7 @@ await client.labTests.get();
3552
3487
  <dl>
3553
3488
  <dd>
3554
3489
 
3555
- **request:** `Vital.LabTestsGetRequest`
3490
+ **request:** `Vital.ProvidersGetAllRequest`
3556
3491
 
3557
3492
  </dd>
3558
3493
  </dl>
@@ -3560,7 +3495,7 @@ await client.labTests.get();
3560
3495
  <dl>
3561
3496
  <dd>
3562
3497
 
3563
- **requestOptions:** `LabTests.RequestOptions`
3498
+ **requestOptions:** `Providers.RequestOptions`
3564
3499
 
3565
3500
  </dd>
3566
3501
  </dl>
@@ -3571,10 +3506,170 @@ await client.labTests.get();
3571
3506
  </dl>
3572
3507
  </details>
3573
3508
 
3574
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingLabTest</code></summary>
3509
+ ## Testkit
3510
+
3511
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">register</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
3512
+ <dl>
3513
+ <dd>
3514
+
3515
+ #### 🔌 Usage
3516
+
3517
+ <dl>
3518
+ <dd>
3519
+
3520
+ <dl>
3521
+ <dd>
3522
+
3523
+ ```typescript
3524
+ await client.testkit.register({
3525
+ sampleId: "sample_id",
3526
+ patientDetails: {
3527
+ firstName: "first_name",
3528
+ lastName: "last_name",
3529
+ dob: "dob",
3530
+ gender: "female",
3531
+ phoneNumber: "phone_number",
3532
+ email: "email",
3533
+ },
3534
+ patientAddress: {
3535
+ firstLine: "first_line",
3536
+ city: "city",
3537
+ state: "state",
3538
+ zip: "zip",
3539
+ country: "country",
3540
+ },
3541
+ });
3542
+ ```
3543
+
3544
+ </dd>
3545
+ </dl>
3546
+ </dd>
3547
+ </dl>
3548
+
3549
+ #### ⚙️ Parameters
3550
+
3551
+ <dl>
3552
+ <dd>
3553
+
3554
+ <dl>
3555
+ <dd>
3556
+
3557
+ **request:** `Vital.RegisterTestkitRequest`
3558
+
3559
+ </dd>
3560
+ </dl>
3561
+
3562
+ <dl>
3563
+ <dd>
3564
+
3565
+ **requestOptions:** `Testkit.RequestOptions`
3566
+
3567
+ </dd>
3568
+ </dl>
3569
+ </dd>
3570
+ </dl>
3571
+
3572
+ </dd>
3573
+ </dl>
3574
+ </details>
3575
+
3576
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
3577
+ <dl>
3578
+ <dd>
3579
+
3580
+ #### 📝 Description
3581
+
3582
+ <dl>
3583
+ <dd>
3584
+
3585
+ <dl>
3586
+ <dd>
3587
+
3588
+ Creates an order for an unregistered testkit
3589
+
3590
+ </dd>
3591
+ </dl>
3592
+ </dd>
3593
+ </dl>
3594
+
3595
+ #### 🔌 Usage
3596
+
3597
+ <dl>
3598
+ <dd>
3599
+
3600
+ <dl>
3601
+ <dd>
3602
+
3603
+ ```typescript
3604
+ await client.testkit.createOrder({
3605
+ userId: "user_id",
3606
+ labTestId: "lab_test_id",
3607
+ shippingDetails: {
3608
+ receiverName: "receiver_name",
3609
+ firstLine: "first_line",
3610
+ city: "city",
3611
+ state: "state",
3612
+ zip: "zip",
3613
+ country: "country",
3614
+ phoneNumber: "phone_number",
3615
+ },
3616
+ });
3617
+ ```
3618
+
3619
+ </dd>
3620
+ </dl>
3621
+ </dd>
3622
+ </dl>
3623
+
3624
+ #### ⚙️ Parameters
3625
+
3626
+ <dl>
3627
+ <dd>
3628
+
3629
+ <dl>
3630
+ <dd>
3631
+
3632
+ **request:** `Vital.CreateRegistrableTestkitOrderRequest`
3633
+
3634
+ </dd>
3635
+ </dl>
3636
+
3637
+ <dl>
3638
+ <dd>
3639
+
3640
+ **requestOptions:** `Testkit.RequestOptions`
3641
+
3642
+ </dd>
3643
+ </dl>
3644
+ </dd>
3645
+ </dl>
3646
+
3647
+ </dd>
3648
+ </dl>
3649
+ </details>
3650
+
3651
+ ## LabTests
3652
+
3653
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
3654
+ <dl>
3655
+ <dd>
3656
+
3657
+ #### 📝 Description
3658
+
3575
3659
  <dl>
3576
3660
  <dd>
3577
3661
 
3662
+ <dl>
3663
+ <dd>
3664
+
3665
+ Return the available time slots to book an appointment with a phlebotomist
3666
+ for the given address and order.
3667
+
3668
+ </dd>
3669
+ </dl>
3670
+ </dd>
3671
+ </dl>
3672
+
3578
3673
  #### 🔌 Usage
3579
3674
 
3580
3675
  <dl>
@@ -3584,10 +3679,13 @@ await client.labTests.get();
3584
3679
  <dd>
3585
3680
 
3586
3681
  ```typescript
3587
- await client.labTests.create({
3588
- name: "name",
3589
- method: "testkit",
3590
- description: "description",
3682
+ await client.labTests.getPhlebotomyAppointmentAvailability({
3683
+ body: {
3684
+ firstLine: "first_line",
3685
+ city: "city",
3686
+ state: "state",
3687
+ zipCode: "zip_code",
3688
+ },
3591
3689
  });
3592
3690
  ```
3593
3691
 
@@ -3604,7 +3702,7 @@ await client.labTests.create({
3604
3702
  <dl>
3605
3703
  <dd>
3606
3704
 
3607
- **request:** `Vital.CreateLabTestRequest`
3705
+ **request:** `Vital.LabTestsGetPhlebotomyAppointmentAvailabilityRequest`
3608
3706
 
3609
3707
  </dd>
3610
3708
  </dl>
@@ -3623,7 +3721,7 @@ await client.labTests.create({
3623
3721
  </dl>
3624
3722
  </details>
3625
3723
 
3626
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getById</a>(labTestId) -> Vital.ClientFacingLabTest</code></summary>
3724
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
3627
3725
  <dl>
3628
3726
  <dd>
3629
3727
 
@@ -3635,7 +3733,7 @@ await client.labTests.create({
3635
3733
  <dl>
3636
3734
  <dd>
3637
3735
 
3638
- GET all the lab tests the team has access to.
3736
+ Book an at-home phlebotomy appointment.
3639
3737
 
3640
3738
  </dd>
3641
3739
  </dl>
@@ -3651,7 +3749,9 @@ GET all the lab tests the team has access to.
3651
3749
  <dd>
3652
3750
 
3653
3751
  ```typescript
3654
- await client.labTests.getById("lab_test_id");
3752
+ await client.labTests.bookPhlebotomyAppointment("order_id", {
3753
+ bookingKey: "booking_key",
3754
+ });
3655
3755
  ```
3656
3756
 
3657
3757
  </dd>
@@ -3667,7 +3767,15 @@ await client.labTests.getById("lab_test_id");
3667
3767
  <dl>
3668
3768
  <dd>
3669
3769
 
3670
- **labTestId:** `string`
3770
+ **orderId:** `string` — Your Order ID.
3771
+
3772
+ </dd>
3773
+ </dl>
3774
+
3775
+ <dl>
3776
+ <dd>
3777
+
3778
+ **request:** `Vital.AppointmentBookingRequest`
3671
3779
 
3672
3780
  </dd>
3673
3781
  </dl>
@@ -3686,10 +3794,25 @@ await client.labTests.getById("lab_test_id");
3686
3794
  </dl>
3687
3795
  </details>
3688
3796
 
3689
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateLabTest</a>(labTestId, { ...params }) -> Vital.ClientFacingLabTest</code></summary>
3797
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">requestPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
3798
+ <dl>
3799
+ <dd>
3800
+
3801
+ #### 📝 Description
3802
+
3803
+ <dl>
3804
+ <dd>
3805
+
3690
3806
  <dl>
3691
3807
  <dd>
3692
3808
 
3809
+ Request an at-home phlebotomy appointment.
3810
+
3811
+ </dd>
3812
+ </dl>
3813
+ </dd>
3814
+ </dl>
3815
+
3693
3816
  #### 🔌 Usage
3694
3817
 
3695
3818
  <dl>
@@ -3699,7 +3822,15 @@ await client.labTests.getById("lab_test_id");
3699
3822
  <dd>
3700
3823
 
3701
3824
  ```typescript
3702
- await client.labTests.updateLabTest("lab_test_id");
3825
+ await client.labTests.requestPhlebotomyAppointment("order_id", {
3826
+ address: {
3827
+ firstLine: "first_line",
3828
+ city: "city",
3829
+ state: "state",
3830
+ zipCode: "zip_code",
3831
+ },
3832
+ provider: "getlabs",
3833
+ });
3703
3834
  ```
3704
3835
 
3705
3836
  </dd>
@@ -3715,7 +3846,7 @@ await client.labTests.updateLabTest("lab_test_id");
3715
3846
  <dl>
3716
3847
  <dd>
3717
3848
 
3718
- **labTestId:** `string`
3849
+ **orderId:** `string` — Your Order ID.
3719
3850
 
3720
3851
  </dd>
3721
3852
  </dl>
@@ -3723,7 +3854,7 @@ await client.labTests.updateLabTest("lab_test_id");
3723
3854
  <dl>
3724
3855
  <dd>
3725
3856
 
3726
- **request:** `Vital.UpdateLabTestRequest`
3857
+ **request:** `Vital.RequestAppointmentRequest`
3727
3858
 
3728
3859
  </dd>
3729
3860
  </dl>
@@ -3742,7 +3873,7 @@ await client.labTests.updateLabTest("lab_test_id");
3742
3873
  </dl>
3743
3874
  </details>
3744
3875
 
3745
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkers</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
3876
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
3746
3877
  <dl>
3747
3878
  <dd>
3748
3879
 
@@ -3754,7 +3885,7 @@ await client.labTests.updateLabTest("lab_test_id");
3754
3885
  <dl>
3755
3886
  <dd>
3756
3887
 
3757
- GET all the markers for the given lab.
3888
+ Reschedule a previously booked at-home phlebotomy appointment.
3758
3889
 
3759
3890
  </dd>
3760
3891
  </dl>
@@ -3770,7 +3901,9 @@ GET all the markers for the given lab.
3770
3901
  <dd>
3771
3902
 
3772
3903
  ```typescript
3773
- await client.labTests.getMarkers();
3904
+ await client.labTests.reschedulePhlebotomyAppointment("order_id", {
3905
+ bookingKey: "booking_key",
3906
+ });
3774
3907
  ```
3775
3908
 
3776
3909
  </dd>
@@ -3786,7 +3919,15 @@ await client.labTests.getMarkers();
3786
3919
  <dl>
3787
3920
  <dd>
3788
3921
 
3789
- **request:** `Vital.LabTestsGetMarkersRequest`
3922
+ **orderId:** `string` — Your Order ID.
3923
+
3924
+ </dd>
3925
+ </dl>
3926
+
3927
+ <dl>
3928
+ <dd>
3929
+
3930
+ **request:** `Vital.AppointmentRescheduleRequest`
3790
3931
 
3791
3932
  </dd>
3792
3933
  </dl>
@@ -3805,10 +3946,25 @@ await client.labTests.getMarkers();
3805
3946
  </dl>
3806
3947
  </details>
3807
3948
 
3808
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForOrderSet</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
3949
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
3950
+ <dl>
3951
+ <dd>
3952
+
3953
+ #### 📝 Description
3954
+
3955
+ <dl>
3956
+ <dd>
3957
+
3809
3958
  <dl>
3810
3959
  <dd>
3811
3960
 
3961
+ Cancel a previously booked at-home phlebotomy appointment.
3962
+
3963
+ </dd>
3964
+ </dl>
3965
+ </dd>
3966
+ </dl>
3967
+
3812
3968
  #### 🔌 Usage
3813
3969
 
3814
3970
  <dl>
@@ -3818,8 +3974,8 @@ await client.labTests.getMarkers();
3818
3974
  <dd>
3819
3975
 
3820
3976
  ```typescript
3821
- await client.labTests.getMarkersForOrderSet({
3822
- body: {},
3977
+ await client.labTests.cancelPhlebotomyAppointment("order_id", {
3978
+ cancellationReasonId: "cancellation_reason_id",
3823
3979
  });
3824
3980
  ```
3825
3981
 
@@ -3836,7 +3992,15 @@ await client.labTests.getMarkersForOrderSet({
3836
3992
  <dl>
3837
3993
  <dd>
3838
3994
 
3839
- **request:** `Vital.LabTestsGetMarkersForOrderSetRequest`
3995
+ **orderId:** `string` — Your Order ID.
3996
+
3997
+ </dd>
3998
+ </dl>
3999
+
4000
+ <dl>
4001
+ <dd>
4002
+
4003
+ **request:** `Vital.ApiApiV1EndpointsVitalApiLabTestingOrdersHelpersAppointmentCancelRequest`
3840
4004
 
3841
4005
  </dd>
3842
4006
  </dl>
@@ -3855,11 +4019,11 @@ await client.labTests.getMarkersForOrderSet({
3855
4019
  </dl>
3856
4020
  </details>
3857
4021
 
3858
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForLabTest</a>(labTestId, { ...params }) -> Vital.GetMarkersResponse</code></summary>
4022
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
3859
4023
  <dl>
3860
4024
  <dd>
3861
4025
 
3862
- #### 🔌 Usage
4026
+ #### 📝 Description
3863
4027
 
3864
4028
  <dl>
3865
4029
  <dd>
@@ -3867,16 +4031,14 @@ await client.labTests.getMarkersForOrderSet({
3867
4031
  <dl>
3868
4032
  <dd>
3869
4033
 
3870
- ```typescript
3871
- await client.labTests.getMarkersForLabTest("lab_test_id");
3872
- ```
4034
+ Get the list of reasons for cancelling an at-home phlebotomy appointment.
3873
4035
 
3874
4036
  </dd>
3875
4037
  </dl>
3876
4038
  </dd>
3877
4039
  </dl>
3878
4040
 
3879
- #### ⚙️ Parameters
4041
+ #### 🔌 Usage
3880
4042
 
3881
4043
  <dl>
3882
4044
  <dd>
@@ -3884,19 +4046,20 @@ await client.labTests.getMarkersForLabTest("lab_test_id");
3884
4046
  <dl>
3885
4047
  <dd>
3886
4048
 
3887
- **labTestId:** `string`
4049
+ ```typescript
4050
+ await client.labTests.getPhlebotomyAppointmentCancellationReason();
4051
+ ```
3888
4052
 
3889
4053
  </dd>
3890
4054
  </dl>
4055
+ </dd>
4056
+ </dl>
4057
+
4058
+ #### ⚙️ Parameters
3891
4059
 
3892
4060
  <dl>
3893
4061
  <dd>
3894
4062
 
3895
- **request:** `Vital.LabTestsGetMarkersForLabTestRequest`
3896
-
3897
- </dd>
3898
- </dl>
3899
-
3900
4063
  <dl>
3901
4064
  <dd>
3902
4065
 
@@ -3911,7 +4074,7 @@ await client.labTests.getMarkersForLabTest("lab_test_id");
3911
4074
  </dl>
3912
4075
  </details>
3913
4076
 
3914
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersByLabAndProviderId</a>(providerId, labId) -> Vital.ClientFacingMarker</code></summary>
4077
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
3915
4078
  <dl>
3916
4079
  <dd>
3917
4080
 
@@ -3923,7 +4086,7 @@ await client.labTests.getMarkersForLabTest("lab_test_id");
3923
4086
  <dl>
3924
4087
  <dd>
3925
4088
 
3926
- GET a specific marker for the given lab and provider_id
4089
+ Get the appointment associated with an order.
3927
4090
 
3928
4091
  </dd>
3929
4092
  </dl>
@@ -3939,7 +4102,7 @@ GET a specific marker for the given lab and provider_id
3939
4102
  <dd>
3940
4103
 
3941
4104
  ```typescript
3942
- await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
4105
+ await client.labTests.getPhlebotomyAppointment("order_id");
3943
4106
  ```
3944
4107
 
3945
4108
  </dd>
@@ -3955,15 +4118,7 @@ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
3955
4118
  <dl>
3956
4119
  <dd>
3957
4120
 
3958
- **providerId:** `string`
3959
-
3960
- </dd>
3961
- </dl>
3962
-
3963
- <dl>
3964
- <dd>
3965
-
3966
- **labId:** `number`
4121
+ **orderId:** `string` — Your Order ID.
3967
4122
 
3968
4123
  </dd>
3969
4124
  </dl>
@@ -3982,7 +4137,7 @@ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
3982
4137
  </dl>
3983
4138
  </details>
3984
4139
 
3985
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getLabs</a>() -> Vital.ClientFacingLab[]</code></summary>
4140
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getAreaInfo</a>({ ...params }) -> Vital.AreaInfo</code></summary>
3986
4141
  <dl>
3987
4142
  <dd>
3988
4143
 
@@ -3994,8 +4149,12 @@ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
3994
4149
  <dl>
3995
4150
  <dd>
3996
4151
 
3997
- GET all the labs.
4152
+ GET information about an area with respect to lab-testing.
4153
+
4154
+ Information returned:
3998
4155
 
4156
+ - Whether a given zip code is served by our Phlebotomy network.
4157
+ - List of Lab locations in the area.
3999
4158
  </dd>
4000
4159
  </dl>
4001
4160
  </dd>
@@ -4010,7 +4169,9 @@ GET all the labs.
4010
4169
  <dd>
4011
4170
 
4012
4171
  ```typescript
4013
- await client.labTests.getLabs();
4172
+ await client.labTests.getAreaInfo({
4173
+ zipCode: "zip_code",
4174
+ });
4014
4175
  ```
4015
4176
 
4016
4177
  </dd>
@@ -4026,6 +4187,14 @@ await client.labTests.getLabs();
4026
4187
  <dl>
4027
4188
  <dd>
4028
4189
 
4190
+ **request:** `Vital.LabTestsGetAreaInfoRequest`
4191
+
4192
+ </dd>
4193
+ </dl>
4194
+
4195
+ <dl>
4196
+ <dd>
4197
+
4029
4198
  **requestOptions:** `LabTests.RequestOptions`
4030
4199
 
4031
4200
  </dd>
@@ -4037,26 +4206,10 @@ await client.labTests.getLabs();
4037
4206
  </dl>
4038
4207
  </details>
4039
4208
 
4040
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
4041
- <dl>
4042
- <dd>
4043
-
4044
- #### 📝 Description
4045
-
4046
- <dl>
4047
- <dd>
4048
-
4209
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscInfo</a>({ ...params }) -> Vital.PscInfo</code></summary>
4049
4210
  <dl>
4050
4211
  <dd>
4051
4212
 
4052
- Return the available time slots to book an appointment with a phlebotomist
4053
- for the given address and order.
4054
-
4055
- </dd>
4056
- </dl>
4057
- </dd>
4058
- </dl>
4059
-
4060
4213
  #### 🔌 Usage
4061
4214
 
4062
4215
  <dl>
@@ -4066,13 +4219,9 @@ for the given address and order.
4066
4219
  <dd>
4067
4220
 
4068
4221
  ```typescript
4069
- await client.labTests.getPhlebotomyAppointmentAvailability({
4070
- body: {
4071
- firstLine: "first_line",
4072
- city: "city",
4073
- state: "state",
4074
- zipCode: "zip_code",
4075
- },
4222
+ await client.labTests.getPscInfo({
4223
+ zipCode: "zip_code",
4224
+ labId: 1,
4076
4225
  });
4077
4226
  ```
4078
4227
 
@@ -4089,7 +4238,7 @@ await client.labTests.getPhlebotomyAppointmentAvailability({
4089
4238
  <dl>
4090
4239
  <dd>
4091
4240
 
4092
- **request:** `Vital.LabTestsGetPhlebotomyAppointmentAvailabilityRequest`
4241
+ **request:** `Vital.LabTestsGetPscInfoRequest`
4093
4242
 
4094
4243
  </dd>
4095
4244
  </dl>
@@ -4108,25 +4257,10 @@ await client.labTests.getPhlebotomyAppointmentAvailability({
4108
4257
  </dl>
4109
4258
  </details>
4110
4259
 
4111
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4112
- <dl>
4113
- <dd>
4114
-
4115
- #### 📝 Description
4116
-
4117
- <dl>
4118
- <dd>
4119
-
4260
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderPscInfo</a>(orderId, { ...params }) -> Vital.PscInfo</code></summary>
4120
4261
  <dl>
4121
4262
  <dd>
4122
4263
 
4123
- Book an at-home phlebotomy appointment.
4124
-
4125
- </dd>
4126
- </dl>
4127
- </dd>
4128
- </dl>
4129
-
4130
4264
  #### 🔌 Usage
4131
4265
 
4132
4266
  <dl>
@@ -4136,9 +4270,7 @@ Book an at-home phlebotomy appointment.
4136
4270
  <dd>
4137
4271
 
4138
4272
  ```typescript
4139
- await client.labTests.bookPhlebotomyAppointment("order_id", {
4140
- bookingKey: "booking_key",
4141
- });
4273
+ await client.labTests.getOrderPscInfo("order_id");
4142
4274
  ```
4143
4275
 
4144
4276
  </dd>
@@ -4162,7 +4294,7 @@ await client.labTests.bookPhlebotomyAppointment("order_id", {
4162
4294
  <dl>
4163
4295
  <dd>
4164
4296
 
4165
- **request:** `Vital.AppointmentBookingRequest`
4297
+ **request:** `Vital.LabTestsGetOrderPscInfoRequest`
4166
4298
 
4167
4299
  </dd>
4168
4300
  </dl>
@@ -4181,7 +4313,7 @@ await client.labTests.bookPhlebotomyAppointment("order_id", {
4181
4313
  </dl>
4182
4314
  </details>
4183
4315
 
4184
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">requestPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4316
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultMetadata</a>(orderId) -> Vital.LabResultsMetadata</code></summary>
4185
4317
  <dl>
4186
4318
  <dd>
4187
4319
 
@@ -4193,39 +4325,15 @@ await client.labTests.bookPhlebotomyAppointment("order_id", {
4193
4325
  <dl>
4194
4326
  <dd>
4195
4327
 
4196
- Request an at-home phlebotomy appointment.
4197
-
4198
- </dd>
4199
- </dl>
4200
- </dd>
4201
- </dl>
4202
-
4203
- #### 🔌 Usage
4204
-
4205
- <dl>
4206
- <dd>
4207
-
4208
- <dl>
4209
- <dd>
4210
-
4211
- ```typescript
4212
- await client.labTests.requestPhlebotomyAppointment("order_id", {
4213
- address: {
4214
- firstLine: "first_line",
4215
- city: "city",
4216
- state: "state",
4217
- zipCode: "zip_code",
4218
- },
4219
- provider: "getlabs",
4220
- });
4221
- ```
4328
+ Return metadata related to order results, such as lab metadata,
4329
+ provider and sample dates.
4222
4330
 
4223
4331
  </dd>
4224
4332
  </dl>
4225
4333
  </dd>
4226
4334
  </dl>
4227
4335
 
4228
- #### ⚙️ Parameters
4336
+ #### 🔌 Usage
4229
4337
 
4230
4338
  <dl>
4231
4339
  <dd>
@@ -4233,15 +4341,24 @@ await client.labTests.requestPhlebotomyAppointment("order_id", {
4233
4341
  <dl>
4234
4342
  <dd>
4235
4343
 
4236
- **orderId:** `string` — Your Order ID.
4344
+ ```typescript
4345
+ await client.labTests.getResultMetadata("order_id");
4346
+ ```
4237
4347
 
4348
+ </dd>
4349
+ </dl>
4238
4350
  </dd>
4239
4351
  </dl>
4240
4352
 
4353
+ #### ⚙️ Parameters
4354
+
4241
4355
  <dl>
4242
4356
  <dd>
4243
4357
 
4244
- **request:** `Vital.RequestAppointmentRequest`
4358
+ <dl>
4359
+ <dd>
4360
+
4361
+ **orderId:** `string`
4245
4362
 
4246
4363
  </dd>
4247
4364
  </dl>
@@ -4260,7 +4377,7 @@ await client.labTests.requestPhlebotomyAppointment("order_id", {
4260
4377
  </dl>
4261
4378
  </details>
4262
4379
 
4263
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4380
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultRaw</a>(orderId) -> Vital.LabResultsRaw</code></summary>
4264
4381
  <dl>
4265
4382
  <dd>
4266
4383
 
@@ -4272,7 +4389,7 @@ await client.labTests.requestPhlebotomyAppointment("order_id", {
4272
4389
  <dl>
4273
4390
  <dd>
4274
4391
 
4275
- Reschedule a previously booked at-home phlebotomy appointment.
4392
+ Return both metadata and raw json test data
4276
4393
 
4277
4394
  </dd>
4278
4395
  </dl>
@@ -4288,9 +4405,7 @@ Reschedule a previously booked at-home phlebotomy appointment.
4288
4405
  <dd>
4289
4406
 
4290
4407
  ```typescript
4291
- await client.labTests.reschedulePhlebotomyAppointment("order_id", {
4292
- bookingKey: "booking_key",
4293
- });
4408
+ await client.labTests.getResultRaw("order_id");
4294
4409
  ```
4295
4410
 
4296
4411
  </dd>
@@ -4306,15 +4421,7 @@ await client.labTests.reschedulePhlebotomyAppointment("order_id", {
4306
4421
  <dl>
4307
4422
  <dd>
4308
4423
 
4309
- **orderId:** `string` — Your Order ID.
4310
-
4311
- </dd>
4312
- </dl>
4313
-
4314
- <dl>
4315
- <dd>
4316
-
4317
- **request:** `Vital.AppointmentRescheduleRequest`
4424
+ **orderId:** `string`
4318
4425
 
4319
4426
  </dd>
4320
4427
  </dl>
@@ -4333,25 +4440,10 @@ await client.labTests.reschedulePhlebotomyAppointment("order_id", {
4333
4440
  </dl>
4334
4441
  </details>
4335
4442
 
4336
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4337
- <dl>
4338
- <dd>
4339
-
4340
- #### 📝 Description
4341
-
4342
- <dl>
4343
- <dd>
4344
-
4443
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
4345
4444
  <dl>
4346
4445
  <dd>
4347
4446
 
4348
- Cancel a previously booked at-home phlebotomy appointment.
4349
-
4350
- </dd>
4351
- </dl>
4352
- </dd>
4353
- </dl>
4354
-
4355
4447
  #### 🔌 Usage
4356
4448
 
4357
4449
  <dl>
@@ -4361,8 +4453,8 @@ Cancel a previously booked at-home phlebotomy appointment.
4361
4453
  <dd>
4362
4454
 
4363
4455
  ```typescript
4364
- await client.labTests.cancelPhlebotomyAppointment("order_id", {
4365
- cancellationReasonId: "cancellation_reason_id",
4456
+ await client.labTests.getPscAppointmentAvailability({
4457
+ lab: "quest",
4366
4458
  });
4367
4459
  ```
4368
4460
 
@@ -4379,15 +4471,7 @@ await client.labTests.cancelPhlebotomyAppointment("order_id", {
4379
4471
  <dl>
4380
4472
  <dd>
4381
4473
 
4382
- **orderId:** `string` — Your Order ID.
4383
-
4384
- </dd>
4385
- </dl>
4386
-
4387
- <dl>
4388
- <dd>
4389
-
4390
- **request:** `Vital.ApiApiV1EndpointsVitalApiLabTestingOrdersHelpersAppointmentCancelRequest`
4474
+ **request:** `Vital.LabTestsGetPscAppointmentAvailabilityRequest`
4391
4475
 
4392
4476
  </dd>
4393
4477
  </dl>
@@ -4406,11 +4490,11 @@ await client.labTests.cancelPhlebotomyAppointment("order_id", {
4406
4490
  </dl>
4407
4491
  </details>
4408
4492
 
4409
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
4493
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4410
4494
  <dl>
4411
4495
  <dd>
4412
4496
 
4413
- #### 📝 Description
4497
+ #### 🔌 Usage
4414
4498
 
4415
4499
  <dl>
4416
4500
  <dd>
@@ -4418,14 +4502,18 @@ await client.labTests.cancelPhlebotomyAppointment("order_id", {
4418
4502
  <dl>
4419
4503
  <dd>
4420
4504
 
4421
- Get the list of reasons for cancelling an at-home phlebotomy appointment.
4505
+ ```typescript
4506
+ await client.labTests.bookPscAppointment("order_id", {
4507
+ bookingKey: "booking_key",
4508
+ });
4509
+ ```
4422
4510
 
4423
4511
  </dd>
4424
4512
  </dl>
4425
4513
  </dd>
4426
4514
  </dl>
4427
4515
 
4428
- #### 🔌 Usage
4516
+ #### ⚙️ Parameters
4429
4517
 
4430
4518
  <dl>
4431
4519
  <dd>
@@ -4433,20 +4521,19 @@ Get the list of reasons for cancelling an at-home phlebotomy appointment.
4433
4521
  <dl>
4434
4522
  <dd>
4435
4523
 
4436
- ```typescript
4437
- await client.labTests.getPhlebotomyAppointmentCancellationReason();
4438
- ```
4524
+ **orderId:** `string` — Your Order ID.
4439
4525
 
4440
4526
  </dd>
4441
4527
  </dl>
4442
- </dd>
4443
- </dl>
4444
-
4445
- #### ⚙️ Parameters
4446
4528
 
4447
4529
  <dl>
4448
4530
  <dd>
4449
4531
 
4532
+ **request:** `Vital.AppointmentBookingRequest`
4533
+
4534
+ </dd>
4535
+ </dl>
4536
+
4450
4537
  <dl>
4451
4538
  <dd>
4452
4539
 
@@ -4461,11 +4548,11 @@ await client.labTests.getPhlebotomyAppointmentCancellationReason();
4461
4548
  </dl>
4462
4549
  </details>
4463
4550
 
4464
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
4551
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4465
4552
  <dl>
4466
4553
  <dd>
4467
4554
 
4468
- #### 📝 Description
4555
+ #### 🔌 Usage
4469
4556
 
4470
4557
  <dl>
4471
4558
  <dd>
@@ -4473,14 +4560,18 @@ await client.labTests.getPhlebotomyAppointmentCancellationReason();
4473
4560
  <dl>
4474
4561
  <dd>
4475
4562
 
4476
- Get the appointment associated with an order.
4563
+ ```typescript
4564
+ await client.labTests.reschedulePscAppointment("order_id", {
4565
+ bookingKey: "booking_key",
4566
+ });
4567
+ ```
4477
4568
 
4478
4569
  </dd>
4479
4570
  </dl>
4480
4571
  </dd>
4481
4572
  </dl>
4482
4573
 
4483
- #### 🔌 Usage
4574
+ #### ⚙️ Parameters
4484
4575
 
4485
4576
  <dl>
4486
4577
  <dd>
@@ -4488,24 +4579,15 @@ Get the appointment associated with an order.
4488
4579
  <dl>
4489
4580
  <dd>
4490
4581
 
4491
- ```typescript
4492
- await client.labTests.getPhlebotomyAppointment("order_id");
4493
- ```
4582
+ **orderId:** `string` — Your Order ID.
4494
4583
 
4495
4584
  </dd>
4496
4585
  </dl>
4497
- </dd>
4498
- </dl>
4499
-
4500
- #### ⚙️ Parameters
4501
-
4502
- <dl>
4503
- <dd>
4504
4586
 
4505
4587
  <dl>
4506
4588
  <dd>
4507
4589
 
4508
- **orderId:** `string` — Your Order ID.
4590
+ **request:** `Vital.AppointmentRescheduleRequest`
4509
4591
 
4510
4592
  </dd>
4511
4593
  </dl>
@@ -4524,11 +4606,11 @@ await client.labTests.getPhlebotomyAppointment("order_id");
4524
4606
  </dl>
4525
4607
  </details>
4526
4608
 
4527
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getAreaInfo</a>({ ...params }) -> Vital.AreaInfo</code></summary>
4609
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4528
4610
  <dl>
4529
4611
  <dd>
4530
4612
 
4531
- #### 📝 Description
4613
+ #### 🔌 Usage
4532
4614
 
4533
4615
  <dl>
4534
4616
  <dd>
@@ -4536,18 +4618,18 @@ await client.labTests.getPhlebotomyAppointment("order_id");
4536
4618
  <dl>
4537
4619
  <dd>
4538
4620
 
4539
- GET information about an area with respect to lab-testing.
4540
-
4541
- Information returned:
4621
+ ```typescript
4622
+ await client.labTests.cancelPscAppointment("order_id", {
4623
+ cancellationReasonId: "cancellationReasonId",
4624
+ });
4625
+ ```
4542
4626
 
4543
- - Whether a given zip code is served by our Phlebotomy network.
4544
- - List of Lab locations in the area.
4545
4627
  </dd>
4546
4628
  </dl>
4547
4629
  </dd>
4548
4630
  </dl>
4549
4631
 
4550
- #### 🔌 Usage
4632
+ #### ⚙️ Parameters
4551
4633
 
4552
4634
  <dl>
4553
4635
  <dd>
@@ -4555,26 +4637,15 @@ Information returned:
4555
4637
  <dl>
4556
4638
  <dd>
4557
4639
 
4558
- ```typescript
4559
- await client.labTests.getAreaInfo({
4560
- zipCode: "zip_code",
4561
- });
4562
- ```
4640
+ **orderId:** `string` — Your Order ID.
4563
4641
 
4564
4642
  </dd>
4565
4643
  </dl>
4566
- </dd>
4567
- </dl>
4568
-
4569
- #### ⚙️ Parameters
4570
4644
 
4571
4645
  <dl>
4572
4646
  <dd>
4573
4647
 
4574
- <dl>
4575
- <dd>
4576
-
4577
- **request:** `Vital.LabTestsGetAreaInfoRequest`
4648
+ **request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
4578
4649
 
4579
4650
  </dd>
4580
4651
  </dl>
@@ -4593,7 +4664,7 @@ await client.labTests.getAreaInfo({
4593
4664
  </dl>
4594
4665
  </details>
4595
4666
 
4596
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscInfo</a>({ ...params }) -> Vital.PscInfo</code></summary>
4667
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
4597
4668
  <dl>
4598
4669
  <dd>
4599
4670
 
@@ -4606,10 +4677,7 @@ await client.labTests.getAreaInfo({
4606
4677
  <dd>
4607
4678
 
4608
4679
  ```typescript
4609
- await client.labTests.getPscInfo({
4610
- zipCode: "zip_code",
4611
- labId: 1,
4612
- });
4680
+ await client.labTests.getPscAppointmentCancellationReason();
4613
4681
  ```
4614
4682
 
4615
4683
  </dd>
@@ -4625,14 +4693,6 @@ await client.labTests.getPscInfo({
4625
4693
  <dl>
4626
4694
  <dd>
4627
4695
 
4628
- **request:** `Vital.LabTestsGetPscInfoRequest`
4629
-
4630
- </dd>
4631
- </dl>
4632
-
4633
- <dl>
4634
- <dd>
4635
-
4636
4696
  **requestOptions:** `LabTests.RequestOptions`
4637
4697
 
4638
4698
  </dd>
@@ -4644,11 +4704,11 @@ await client.labTests.getPscInfo({
4644
4704
  </dl>
4645
4705
  </details>
4646
4706
 
4647
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderPscInfo</a>(orderId, { ...params }) -> Vital.PscInfo</code></summary>
4707
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
4648
4708
  <dl>
4649
4709
  <dd>
4650
4710
 
4651
- #### 🔌 Usage
4711
+ #### 📝 Description
4652
4712
 
4653
4713
  <dl>
4654
4714
  <dd>
@@ -4656,16 +4716,14 @@ await client.labTests.getPscInfo({
4656
4716
  <dl>
4657
4717
  <dd>
4658
4718
 
4659
- ```typescript
4660
- await client.labTests.getOrderPscInfo("order_id");
4661
- ```
4719
+ Get the appointment associated with an order.
4662
4720
 
4663
4721
  </dd>
4664
4722
  </dl>
4665
4723
  </dd>
4666
4724
  </dl>
4667
4725
 
4668
- #### ⚙️ Parameters
4726
+ #### 🔌 Usage
4669
4727
 
4670
4728
  <dl>
4671
4729
  <dd>
@@ -4673,15 +4731,24 @@ await client.labTests.getOrderPscInfo("order_id");
4673
4731
  <dl>
4674
4732
  <dd>
4675
4733
 
4676
- **orderId:** `string` — Your Order ID.
4734
+ ```typescript
4735
+ await client.labTests.getPscAppointment("order_id");
4736
+ ```
4677
4737
 
4738
+ </dd>
4739
+ </dl>
4678
4740
  </dd>
4679
4741
  </dl>
4680
4742
 
4743
+ #### ⚙️ Parameters
4744
+
4681
4745
  <dl>
4682
4746
  <dd>
4683
4747
 
4684
- **request:** `Vital.LabTestsGetOrderPscInfoRequest`
4748
+ <dl>
4749
+ <dd>
4750
+
4751
+ **orderId:** `string` — Your Order ID.
4685
4752
 
4686
4753
  </dd>
4687
4754
  </dl>
@@ -4700,7 +4767,7 @@ await client.labTests.getOrderPscInfo("order_id");
4700
4767
  </dl>
4701
4768
  </details>
4702
4769
 
4703
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultMetadata</a>(orderId) -> Vital.LabResultsMetadata</code></summary>
4770
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrder</a>(orderId) -> Vital.ClientFacingOrder</code></summary>
4704
4771
  <dl>
4705
4772
  <dd>
4706
4773
 
@@ -4712,8 +4779,7 @@ await client.labTests.getOrderPscInfo("order_id");
4712
4779
  <dl>
4713
4780
  <dd>
4714
4781
 
4715
- Return metadata related to order results, such as lab metadata,
4716
- provider and sample dates.
4782
+ GET individual order by ID.
4717
4783
 
4718
4784
  </dd>
4719
4785
  </dl>
@@ -4729,7 +4795,7 @@ provider and sample dates.
4729
4795
  <dd>
4730
4796
 
4731
4797
  ```typescript
4732
- await client.labTests.getResultMetadata("order_id");
4798
+ await client.labTests.getOrder("order_id");
4733
4799
  ```
4734
4800
 
4735
4801
  </dd>
@@ -4745,7 +4811,7 @@ await client.labTests.getResultMetadata("order_id");
4745
4811
  <dl>
4746
4812
  <dd>
4747
4813
 
4748
- **orderId:** `string`
4814
+ **orderId:** `string` — Your Order ID.
4749
4815
 
4750
4816
  </dd>
4751
4817
  </dl>
@@ -4764,25 +4830,10 @@ await client.labTests.getResultMetadata("order_id");
4764
4830
  </dl>
4765
4831
  </details>
4766
4832
 
4767
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultRaw</a>(orderId) -> Vital.LabResultsRaw</code></summary>
4768
- <dl>
4769
- <dd>
4770
-
4771
- #### 📝 Description
4772
-
4773
- <dl>
4774
- <dd>
4775
-
4833
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
4776
4834
  <dl>
4777
4835
  <dd>
4778
4836
 
4779
- Return both metadata and raw json test data
4780
-
4781
- </dd>
4782
- </dl>
4783
- </dd>
4784
- </dl>
4785
-
4786
4837
  #### 🔌 Usage
4787
4838
 
4788
4839
  <dl>
@@ -4792,7 +4843,24 @@ Return both metadata and raw json test data
4792
4843
  <dd>
4793
4844
 
4794
4845
  ```typescript
4795
- await client.labTests.getResultRaw("order_id");
4846
+ await client.labTests.createOrder({
4847
+ userId: "user_id",
4848
+ patientDetails: {
4849
+ firstName: "first_name",
4850
+ lastName: "last_name",
4851
+ dob: "dob",
4852
+ gender: "female",
4853
+ phoneNumber: "phone_number",
4854
+ email: "email",
4855
+ },
4856
+ patientAddress: {
4857
+ firstLine: "first_line",
4858
+ city: "city",
4859
+ state: "state",
4860
+ zip: "zip",
4861
+ country: "country",
4862
+ },
4863
+ });
4796
4864
  ```
4797
4865
 
4798
4866
  </dd>
@@ -4808,7 +4876,7 @@ await client.labTests.getResultRaw("order_id");
4808
4876
  <dl>
4809
4877
  <dd>
4810
4878
 
4811
- **orderId:** `string`
4879
+ **request:** `Vital.CreateOrderRequestCompatible`
4812
4880
 
4813
4881
  </dd>
4814
4882
  </dl>
@@ -4827,7 +4895,7 @@ await client.labTests.getResultRaw("order_id");
4827
4895
  </dl>
4828
4896
  </details>
4829
4897
 
4830
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
4898
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">importOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
4831
4899
  <dl>
4832
4900
  <dd>
4833
4901
 
@@ -4840,8 +4908,28 @@ await client.labTests.getResultRaw("order_id");
4840
4908
  <dd>
4841
4909
 
4842
4910
  ```typescript
4843
- await client.labTests.getPscAppointmentAvailability({
4844
- lab: "quest",
4911
+ await client.labTests.importOrder({
4912
+ userId: "user_id",
4913
+ billingType: "client_bill",
4914
+ orderSet: {},
4915
+ collectionMethod: "testkit",
4916
+ patientDetails: {
4917
+ firstName: "first_name",
4918
+ lastName: "last_name",
4919
+ dob: "dob",
4920
+ gender: "female",
4921
+ phoneNumber: "phone_number",
4922
+ email: "email",
4923
+ },
4924
+ patientAddress: {
4925
+ receiverName: "receiver_name",
4926
+ firstLine: "first_line",
4927
+ city: "city",
4928
+ state: "state",
4929
+ zip: "zip",
4930
+ country: "country",
4931
+ },
4932
+ sampleId: "sample_id",
4845
4933
  });
4846
4934
  ```
4847
4935
 
@@ -4858,7 +4946,7 @@ await client.labTests.getPscAppointmentAvailability({
4858
4946
  <dl>
4859
4947
  <dd>
4860
4948
 
4861
- **request:** `Vital.LabTestsGetPscAppointmentAvailabilityRequest`
4949
+ **request:** `Vital.ImportOrderBody`
4862
4950
 
4863
4951
  </dd>
4864
4952
  </dl>
@@ -4877,11 +4965,11 @@ await client.labTests.getPscAppointmentAvailability({
4877
4965
  </dl>
4878
4966
  </details>
4879
4967
 
4880
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
4968
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelOrder</a>(orderId) -> Vital.PostOrderResponse</code></summary>
4881
4969
  <dl>
4882
4970
  <dd>
4883
4971
 
4884
- #### 🔌 Usage
4972
+ #### 📝 Description
4885
4973
 
4886
4974
  <dl>
4887
4975
  <dd>
@@ -4889,18 +4977,14 @@ await client.labTests.getPscAppointmentAvailability({
4889
4977
  <dl>
4890
4978
  <dd>
4891
4979
 
4892
- ```typescript
4893
- await client.labTests.bookPscAppointment("order_id", {
4894
- bookingKey: "booking_key",
4895
- });
4896
- ```
4980
+ POST cancel order
4897
4981
 
4898
4982
  </dd>
4899
4983
  </dl>
4900
4984
  </dd>
4901
4985
  </dl>
4902
4986
 
4903
- #### ⚙️ Parameters
4987
+ #### 🔌 Usage
4904
4988
 
4905
4989
  <dl>
4906
4990
  <dd>
@@ -4908,15 +4992,24 @@ await client.labTests.bookPscAppointment("order_id", {
4908
4992
  <dl>
4909
4993
  <dd>
4910
4994
 
4911
- **orderId:** `string` — Your Order ID.
4995
+ ```typescript
4996
+ await client.labTests.cancelOrder("order_id");
4997
+ ```
4912
4998
 
4999
+ </dd>
5000
+ </dl>
4913
5001
  </dd>
4914
5002
  </dl>
4915
5003
 
5004
+ #### ⚙️ Parameters
5005
+
4916
5006
  <dl>
4917
5007
  <dd>
4918
5008
 
4919
- **request:** `Vital.AppointmentBookingRequest`
5009
+ <dl>
5010
+ <dd>
5011
+
5012
+ **orderId:** `string` — Your Order ID.
4920
5013
 
4921
5014
  </dd>
4922
5015
  </dl>
@@ -4935,10 +5028,25 @@ await client.labTests.bookPscAppointment("order_id", {
4935
5028
  </dl>
4936
5029
  </details>
4937
5030
 
4938
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
5031
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">simulateOrderProcess</a>(orderId, { ...params }) -> unknown</code></summary>
5032
+ <dl>
5033
+ <dd>
5034
+
5035
+ #### 📝 Description
5036
+
5037
+ <dl>
5038
+ <dd>
5039
+
4939
5040
  <dl>
4940
5041
  <dd>
4941
5042
 
5043
+ Get available test kits.
5044
+
5045
+ </dd>
5046
+ </dl>
5047
+ </dd>
5048
+ </dl>
5049
+
4942
5050
  #### 🔌 Usage
4943
5051
 
4944
5052
  <dl>
@@ -4948,8 +5056,8 @@ await client.labTests.bookPscAppointment("order_id", {
4948
5056
  <dd>
4949
5057
 
4950
5058
  ```typescript
4951
- await client.labTests.reschedulePscAppointment("order_id", {
4952
- bookingKey: "booking_key",
5059
+ await client.labTests.simulateOrderProcess("order_id", {
5060
+ body: undefined,
4953
5061
  });
4954
5062
  ```
4955
5063
 
@@ -4966,7 +5074,7 @@ await client.labTests.reschedulePscAppointment("order_id", {
4966
5074
  <dl>
4967
5075
  <dd>
4968
5076
 
4969
- **orderId:** `string` — Your Order ID.
5077
+ **orderId:** `string`
4970
5078
 
4971
5079
  </dd>
4972
5080
  </dl>
@@ -4974,7 +5082,7 @@ await client.labTests.reschedulePscAppointment("order_id", {
4974
5082
  <dl>
4975
5083
  <dd>
4976
5084
 
4977
- **request:** `Vital.AppointmentRescheduleRequest`
5085
+ **request:** `Vital.LabTestsSimulateOrderProcessRequest`
4978
5086
 
4979
5087
  </dd>
4980
5088
  </dl>
@@ -4993,11 +5101,11 @@ await client.labTests.reschedulePscAppointment("order_id", {
4993
5101
  </dl>
4994
5102
  </details>
4995
5103
 
4996
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
5104
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateOnSiteCollectionOrderDrawCompleted</a>(orderId) -> Vital.PostOrderResponse</code></summary>
4997
5105
  <dl>
4998
5106
  <dd>
4999
5107
 
5000
- #### 🔌 Usage
5108
+ #### 📝 Description
5001
5109
 
5002
5110
  <dl>
5003
5111
  <dd>
@@ -5005,57 +5113,31 @@ await client.labTests.reschedulePscAppointment("order_id", {
5005
5113
  <dl>
5006
5114
  <dd>
5007
5115
 
5008
- ```typescript
5009
- await client.labTests.cancelPscAppointment("order_id", {
5010
- cancellationReasonId: "cancellationReasonId",
5011
- });
5012
- ```
5116
+ PATCH update on site collection order when draw is completed
5013
5117
 
5014
5118
  </dd>
5015
5119
  </dl>
5016
5120
  </dd>
5017
5121
  </dl>
5018
5122
 
5019
- #### ⚙️ Parameters
5020
-
5021
- <dl>
5022
- <dd>
5023
-
5024
- <dl>
5025
- <dd>
5026
-
5027
- **orderId:** `string` — Your Order ID.
5028
-
5029
- </dd>
5030
- </dl>
5123
+ #### 🔌 Usage
5031
5124
 
5032
5125
  <dl>
5033
5126
  <dd>
5034
5127
 
5035
- **request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
5036
-
5037
- </dd>
5038
- </dl>
5039
-
5040
5128
  <dl>
5041
5129
  <dd>
5042
5130
 
5043
- **requestOptions:** `LabTests.RequestOptions`
5131
+ ```typescript
5132
+ await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
5133
+ ```
5044
5134
 
5045
5135
  </dd>
5046
5136
  </dl>
5047
5137
  </dd>
5048
5138
  </dl>
5049
5139
 
5050
- </dd>
5051
- </dl>
5052
- </details>
5053
-
5054
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
5055
- <dl>
5056
- <dd>
5057
-
5058
- #### 🔌 Usage
5140
+ #### ⚙️ Parameters
5059
5141
 
5060
5142
  <dl>
5061
5143
  <dd>
@@ -5063,19 +5145,10 @@ await client.labTests.cancelPscAppointment("order_id", {
5063
5145
  <dl>
5064
5146
  <dd>
5065
5147
 
5066
- ```typescript
5067
- await client.labTests.getPscAppointmentCancellationReason();
5068
- ```
5148
+ **orderId:** `string` — Your Order ID.
5069
5149
 
5070
5150
  </dd>
5071
5151
  </dl>
5072
- </dd>
5073
- </dl>
5074
-
5075
- #### ⚙️ Parameters
5076
-
5077
- <dl>
5078
- <dd>
5079
5152
 
5080
5153
  <dl>
5081
5154
  <dd>
@@ -5091,7 +5164,7 @@ await client.labTests.getPscAppointmentCancellationReason();
5091
5164
  </dl>
5092
5165
  </details>
5093
5166
 
5094
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
5167
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrders</a>({ ...params }) -> Vital.GetOrdersResponse</code></summary>
5095
5168
  <dl>
5096
5169
  <dd>
5097
5170
 
@@ -5103,7 +5176,7 @@ await client.labTests.getPscAppointmentCancellationReason();
5103
5176
  <dl>
5104
5177
  <dd>
5105
5178
 
5106
- Get the appointment associated with an order.
5179
+ GET many orders with filters.
5107
5180
 
5108
5181
  </dd>
5109
5182
  </dl>
@@ -5119,7 +5192,7 @@ Get the appointment associated with an order.
5119
5192
  <dd>
5120
5193
 
5121
5194
  ```typescript
5122
- await client.labTests.getPscAppointment("order_id");
5195
+ await client.labTests.getOrders();
5123
5196
  ```
5124
5197
 
5125
5198
  </dd>
@@ -5135,7 +5208,7 @@ await client.labTests.getPscAppointment("order_id");
5135
5208
  <dl>
5136
5209
  <dd>
5137
5210
 
5138
- **orderId:** `string` — Your Order ID.
5211
+ **request:** `Vital.LabTestsGetOrdersRequest`
5139
5212
 
5140
5213
  </dd>
5141
5214
  </dl>
@@ -5154,7 +5227,7 @@ await client.labTests.getPscAppointment("order_id");
5154
5227
  </dl>
5155
5228
  </details>
5156
5229
 
5157
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrder</a>(orderId) -> Vital.ClientFacingOrder</code></summary>
5230
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">get</a>({ ...params }) -> Vital.ClientFacingLabTest[]</code></summary>
5158
5231
  <dl>
5159
5232
  <dd>
5160
5233
 
@@ -5166,7 +5239,7 @@ await client.labTests.getPscAppointment("order_id");
5166
5239
  <dl>
5167
5240
  <dd>
5168
5241
 
5169
- GET individual order by ID.
5242
+ GET all the lab tests the team has access to.
5170
5243
 
5171
5244
  </dd>
5172
5245
  </dl>
@@ -5182,7 +5255,7 @@ GET individual order by ID.
5182
5255
  <dd>
5183
5256
 
5184
5257
  ```typescript
5185
- await client.labTests.getOrder("order_id");
5258
+ await client.labTests.get();
5186
5259
  ```
5187
5260
 
5188
5261
  </dd>
@@ -5198,7 +5271,7 @@ await client.labTests.getOrder("order_id");
5198
5271
  <dl>
5199
5272
  <dd>
5200
5273
 
5201
- **orderId:** `string` — Your Order ID.
5274
+ **request:** `Vital.LabTestsGetRequest`
5202
5275
 
5203
5276
  </dd>
5204
5277
  </dl>
@@ -5217,7 +5290,7 @@ await client.labTests.getOrder("order_id");
5217
5290
  </dl>
5218
5291
  </details>
5219
5292
 
5220
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
5293
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingLabTest</code></summary>
5221
5294
  <dl>
5222
5295
  <dd>
5223
5296
 
@@ -5230,23 +5303,10 @@ await client.labTests.getOrder("order_id");
5230
5303
  <dd>
5231
5304
 
5232
5305
  ```typescript
5233
- await client.labTests.createOrder({
5234
- userId: "user_id",
5235
- patientDetails: {
5236
- firstName: "first_name",
5237
- lastName: "last_name",
5238
- dob: "dob",
5239
- gender: "female",
5240
- phoneNumber: "phone_number",
5241
- email: "email",
5242
- },
5243
- patientAddress: {
5244
- firstLine: "first_line",
5245
- city: "city",
5246
- state: "state",
5247
- zip: "zip",
5248
- country: "country",
5249
- },
5306
+ await client.labTests.create({
5307
+ name: "name",
5308
+ method: "testkit",
5309
+ description: "description",
5250
5310
  });
5251
5311
  ```
5252
5312
 
@@ -5263,7 +5323,7 @@ await client.labTests.createOrder({
5263
5323
  <dl>
5264
5324
  <dd>
5265
5325
 
5266
- **request:** `Vital.CreateOrderRequestCompatible`
5326
+ **request:** `Vital.CreateLabTestRequest`
5267
5327
 
5268
5328
  </dd>
5269
5329
  </dl>
@@ -5282,10 +5342,25 @@ await client.labTests.createOrder({
5282
5342
  </dl>
5283
5343
  </details>
5284
5344
 
5285
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">importOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
5345
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getById</a>(labTestId) -> Vital.ClientFacingLabTest</code></summary>
5346
+ <dl>
5347
+ <dd>
5348
+
5349
+ #### 📝 Description
5350
+
5351
+ <dl>
5352
+ <dd>
5353
+
5286
5354
  <dl>
5287
5355
  <dd>
5288
5356
 
5357
+ GET all the lab tests the team has access to.
5358
+
5359
+ </dd>
5360
+ </dl>
5361
+ </dd>
5362
+ </dl>
5363
+
5289
5364
  #### 🔌 Usage
5290
5365
 
5291
5366
  <dl>
@@ -5295,29 +5370,7 @@ await client.labTests.createOrder({
5295
5370
  <dd>
5296
5371
 
5297
5372
  ```typescript
5298
- await client.labTests.importOrder({
5299
- userId: "user_id",
5300
- billingType: "client_bill",
5301
- orderSet: {},
5302
- collectionMethod: "testkit",
5303
- patientDetails: {
5304
- firstName: "first_name",
5305
- lastName: "last_name",
5306
- dob: "dob",
5307
- gender: "female",
5308
- phoneNumber: "phone_number",
5309
- email: "email",
5310
- },
5311
- patientAddress: {
5312
- receiverName: "receiver_name",
5313
- firstLine: "first_line",
5314
- city: "city",
5315
- state: "state",
5316
- zip: "zip",
5317
- country: "country",
5318
- },
5319
- sampleId: "sample_id",
5320
- });
5373
+ await client.labTests.getById("lab_test_id");
5321
5374
  ```
5322
5375
 
5323
5376
  </dd>
@@ -5333,7 +5386,7 @@ await client.labTests.importOrder({
5333
5386
  <dl>
5334
5387
  <dd>
5335
5388
 
5336
- **request:** `Vital.ImportOrderBody`
5389
+ **labTestId:** `string`
5337
5390
 
5338
5391
  </dd>
5339
5392
  </dl>
@@ -5352,11 +5405,11 @@ await client.labTests.importOrder({
5352
5405
  </dl>
5353
5406
  </details>
5354
5407
 
5355
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelOrder</a>(orderId) -> Vital.PostOrderResponse</code></summary>
5408
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateLabTest</a>(labTestId, { ...params }) -> Vital.ClientFacingLabTest</code></summary>
5356
5409
  <dl>
5357
5410
  <dd>
5358
5411
 
5359
- #### 📝 Description
5412
+ #### 🔌 Usage
5360
5413
 
5361
5414
  <dl>
5362
5415
  <dd>
@@ -5364,14 +5417,16 @@ await client.labTests.importOrder({
5364
5417
  <dl>
5365
5418
  <dd>
5366
5419
 
5367
- POST cancel order
5420
+ ```typescript
5421
+ await client.labTests.updateLabTest("lab_test_id");
5422
+ ```
5368
5423
 
5369
5424
  </dd>
5370
5425
  </dl>
5371
5426
  </dd>
5372
5427
  </dl>
5373
5428
 
5374
- #### 🔌 Usage
5429
+ #### ⚙️ Parameters
5375
5430
 
5376
5431
  <dl>
5377
5432
  <dd>
@@ -5379,24 +5434,15 @@ POST cancel order
5379
5434
  <dl>
5380
5435
  <dd>
5381
5436
 
5382
- ```typescript
5383
- await client.labTests.cancelOrder("order_id");
5384
- ```
5437
+ **labTestId:** `string`
5385
5438
 
5386
5439
  </dd>
5387
5440
  </dl>
5388
- </dd>
5389
- </dl>
5390
-
5391
- #### ⚙️ Parameters
5392
-
5393
- <dl>
5394
- <dd>
5395
5441
 
5396
5442
  <dl>
5397
5443
  <dd>
5398
5444
 
5399
- **orderId:** `string` — Your Order ID.
5445
+ **request:** `Vital.UpdateLabTestRequest`
5400
5446
 
5401
5447
  </dd>
5402
5448
  </dl>
@@ -5415,7 +5461,7 @@ await client.labTests.cancelOrder("order_id");
5415
5461
  </dl>
5416
5462
  </details>
5417
5463
 
5418
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">simulateOrderProcess</a>(orderId, { ...params }) -> unknown</code></summary>
5464
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkers</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
5419
5465
  <dl>
5420
5466
  <dd>
5421
5467
 
@@ -5427,7 +5473,7 @@ await client.labTests.cancelOrder("order_id");
5427
5473
  <dl>
5428
5474
  <dd>
5429
5475
 
5430
- Get available test kits.
5476
+ GET all the markers for the given lab.
5431
5477
 
5432
5478
  </dd>
5433
5479
  </dl>
@@ -5443,9 +5489,7 @@ Get available test kits.
5443
5489
  <dd>
5444
5490
 
5445
5491
  ```typescript
5446
- await client.labTests.simulateOrderProcess("order_id", {
5447
- body: undefined,
5448
- });
5492
+ await client.labTests.getMarkers();
5449
5493
  ```
5450
5494
 
5451
5495
  </dd>
@@ -5461,52 +5505,29 @@ await client.labTests.simulateOrderProcess("order_id", {
5461
5505
  <dl>
5462
5506
  <dd>
5463
5507
 
5464
- **orderId:** `string`
5465
-
5466
- </dd>
5467
- </dl>
5468
-
5469
- <dl>
5470
- <dd>
5471
-
5472
- **request:** `Vital.LabTestsSimulateOrderProcessRequest`
5473
-
5474
- </dd>
5475
- </dl>
5476
-
5477
- <dl>
5478
- <dd>
5479
-
5480
- **requestOptions:** `LabTests.RequestOptions`
5481
-
5482
- </dd>
5483
- </dl>
5484
- </dd>
5485
- </dl>
5486
-
5487
- </dd>
5488
- </dl>
5489
- </details>
5490
-
5491
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateOnSiteCollectionOrderDrawCompleted</a>(orderId) -> Vital.PostOrderResponse</code></summary>
5492
- <dl>
5493
- <dd>
5494
-
5495
- #### 📝 Description
5496
-
5497
- <dl>
5498
- <dd>
5499
-
5508
+ **request:** `Vital.LabTestsGetMarkersRequest`
5509
+
5510
+ </dd>
5511
+ </dl>
5512
+
5500
5513
  <dl>
5501
5514
  <dd>
5502
5515
 
5503
- PATCH update on site collection order when draw is completed
5516
+ **requestOptions:** `LabTests.RequestOptions`
5504
5517
 
5505
5518
  </dd>
5506
5519
  </dl>
5507
5520
  </dd>
5508
5521
  </dl>
5509
5522
 
5523
+ </dd>
5524
+ </dl>
5525
+ </details>
5526
+
5527
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForOrderSet</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
5528
+ <dl>
5529
+ <dd>
5530
+
5510
5531
  #### 🔌 Usage
5511
5532
 
5512
5533
  <dl>
@@ -5516,7 +5537,9 @@ PATCH update on site collection order when draw is completed
5516
5537
  <dd>
5517
5538
 
5518
5539
  ```typescript
5519
- await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
5540
+ await client.labTests.getMarkersForOrderSet({
5541
+ body: {},
5542
+ });
5520
5543
  ```
5521
5544
 
5522
5545
  </dd>
@@ -5532,7 +5555,7 @@ await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
5532
5555
  <dl>
5533
5556
  <dd>
5534
5557
 
5535
- **orderId:** `string` — Your Order ID.
5558
+ **request:** `Vital.LabTestsGetMarkersForOrderSetRequest`
5536
5559
 
5537
5560
  </dd>
5538
5561
  </dl>
@@ -5551,11 +5574,11 @@ await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
5551
5574
  </dl>
5552
5575
  </details>
5553
5576
 
5554
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrders</a>({ ...params }) -> Vital.GetOrdersResponse</code></summary>
5577
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForLabTest</a>(labTestId, { ...params }) -> Vital.GetMarkersResponse</code></summary>
5555
5578
  <dl>
5556
5579
  <dd>
5557
5580
 
5558
- #### 📝 Description
5581
+ #### 🔌 Usage
5559
5582
 
5560
5583
  <dl>
5561
5584
  <dd>
@@ -5563,14 +5586,16 @@ await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
5563
5586
  <dl>
5564
5587
  <dd>
5565
5588
 
5566
- GET many orders with filters.
5589
+ ```typescript
5590
+ await client.labTests.getMarkersForLabTest("lab_test_id");
5591
+ ```
5567
5592
 
5568
5593
  </dd>
5569
5594
  </dl>
5570
5595
  </dd>
5571
5596
  </dl>
5572
5597
 
5573
- #### 🔌 Usage
5598
+ #### ⚙️ Parameters
5574
5599
 
5575
5600
  <dl>
5576
5601
  <dd>
@@ -5578,24 +5603,15 @@ GET many orders with filters.
5578
5603
  <dl>
5579
5604
  <dd>
5580
5605
 
5581
- ```typescript
5582
- await client.labTests.getOrders();
5583
- ```
5606
+ **labTestId:** `string`
5584
5607
 
5585
5608
  </dd>
5586
5609
  </dl>
5587
- </dd>
5588
- </dl>
5589
-
5590
- #### ⚙️ Parameters
5591
-
5592
- <dl>
5593
- <dd>
5594
5610
 
5595
5611
  <dl>
5596
5612
  <dd>
5597
5613
 
5598
- **request:** `Vital.LabTestsGetOrdersRequest`
5614
+ **request:** `Vital.LabTestsGetMarkersForLabTestRequest`
5599
5615
 
5600
5616
  </dd>
5601
5617
  </dl>
@@ -5614,7 +5630,7 @@ await client.labTests.getOrders();
5614
5630
  </dl>
5615
5631
  </details>
5616
5632
 
5617
- <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPaginated</a>({ ...params }) -> Vital.LabTestResourcesResponse</code></summary>
5633
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersByLabAndProviderId</a>(providerId, labId) -> Vital.ClientFacingMarker</code></summary>
5618
5634
  <dl>
5619
5635
  <dd>
5620
5636
 
@@ -5626,7 +5642,7 @@ await client.labTests.getOrders();
5626
5642
  <dl>
5627
5643
  <dd>
5628
5644
 
5629
- GET lab tests the team has access to as a paginated list.
5645
+ GET a specific marker for the given lab and provider_id
5630
5646
 
5631
5647
  </dd>
5632
5648
  </dl>
@@ -5642,7 +5658,7 @@ GET lab tests the team has access to as a paginated list.
5642
5658
  <dd>
5643
5659
 
5644
5660
  ```typescript
5645
- await client.labTests.getPaginated();
5661
+ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
5646
5662
  ```
5647
5663
 
5648
5664
  </dd>
@@ -5658,7 +5674,15 @@ await client.labTests.getPaginated();
5658
5674
  <dl>
5659
5675
  <dd>
5660
5676
 
5661
- **request:** `Vital.LabTestsGetPaginatedRequest`
5677
+ **providerId:** `string`
5678
+
5679
+ </dd>
5680
+ </dl>
5681
+
5682
+ <dl>
5683
+ <dd>
5684
+
5685
+ **labId:** `number`
5662
5686
 
5663
5687
  </dd>
5664
5688
  </dl>
@@ -5677,9 +5701,7 @@ await client.labTests.getPaginated();
5677
5701
  </dl>
5678
5702
  </details>
5679
5703
 
5680
- ## Team
5681
-
5682
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getLinkConfig</a>({ ...params }) -> Record<string, unknown></code></summary>
5704
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getLabs</a>() -> Vital.ClientFacingLab[]</code></summary>
5683
5705
  <dl>
5684
5706
  <dd>
5685
5707
 
@@ -5691,7 +5713,7 @@ await client.labTests.getPaginated();
5691
5713
  <dl>
5692
5714
  <dd>
5693
5715
 
5694
- Post teams.
5716
+ GET all the labs.
5695
5717
 
5696
5718
  </dd>
5697
5719
  </dl>
@@ -5707,7 +5729,7 @@ Post teams.
5707
5729
  <dd>
5708
5730
 
5709
5731
  ```typescript
5710
- await client.team.getLinkConfig();
5732
+ await client.labTests.getLabs();
5711
5733
  ```
5712
5734
 
5713
5735
  </dd>
@@ -5723,15 +5745,7 @@ await client.team.getLinkConfig();
5723
5745
  <dl>
5724
5746
  <dd>
5725
5747
 
5726
- **request:** `Vital.TeamGetLinkConfigRequest`
5727
-
5728
- </dd>
5729
- </dl>
5730
-
5731
- <dl>
5732
- <dd>
5733
-
5734
- **requestOptions:** `Team.RequestOptions`
5748
+ **requestOptions:** `LabTests.RequestOptions`
5735
5749
 
5736
5750
  </dd>
5737
5751
  </dl>
@@ -5742,7 +5756,7 @@ await client.team.getLinkConfig();
5742
5756
  </dl>
5743
5757
  </details>
5744
5758
 
5745
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">get</a>(teamId) -> Vital.ClientFacingTeam</code></summary>
5759
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPaginated</a>({ ...params }) -> Vital.LabTestResourcesResponse</code></summary>
5746
5760
  <dl>
5747
5761
  <dd>
5748
5762
 
@@ -5754,7 +5768,7 @@ await client.team.getLinkConfig();
5754
5768
  <dl>
5755
5769
  <dd>
5756
5770
 
5757
- Get team.
5771
+ GET lab tests the team has access to as a paginated list.
5758
5772
 
5759
5773
  </dd>
5760
5774
  </dl>
@@ -5770,7 +5784,7 @@ Get team.
5770
5784
  <dd>
5771
5785
 
5772
5786
  ```typescript
5773
- await client.team.get("team_id");
5787
+ await client.labTests.getPaginated();
5774
5788
  ```
5775
5789
 
5776
5790
  </dd>
@@ -5786,7 +5800,7 @@ await client.team.get("team_id");
5786
5800
  <dl>
5787
5801
  <dd>
5788
5802
 
5789
- **teamId:** `string`
5803
+ **request:** `Vital.LabTestsGetPaginatedRequest`
5790
5804
 
5791
5805
  </dd>
5792
5806
  </dl>
@@ -5794,7 +5808,7 @@ await client.team.get("team_id");
5794
5808
  <dl>
5795
5809
  <dd>
5796
5810
 
5797
- **requestOptions:** `Team.RequestOptions`
5811
+ **requestOptions:** `LabTests.RequestOptions`
5798
5812
 
5799
5813
  </dd>
5800
5814
  </dl>
@@ -5805,7 +5819,9 @@ await client.team.get("team_id");
5805
5819
  </dl>
5806
5820
  </details>
5807
5821
 
5808
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getUserById</a>({ ...params }) -> Vital.ClientFacingUser[]</code></summary>
5822
+ ## Order
5823
+
5824
+ <details><summary><code>client.order.<a href="/src/api/resources/order/client/Client.ts">resendEvents</a>({ ...params }) -> Vital.ResendWebhookResponse</code></summary>
5809
5825
  <dl>
5810
5826
  <dd>
5811
5827
 
@@ -5817,7 +5833,7 @@ await client.team.get("team_id");
5817
5833
  <dl>
5818
5834
  <dd>
5819
5835
 
5820
- Search team users by user_id
5836
+ Replay a webhook for a given set of orders
5821
5837
 
5822
5838
  </dd>
5823
5839
  </dl>
@@ -5833,7 +5849,7 @@ Search team users by user_id
5833
5849
  <dd>
5834
5850
 
5835
5851
  ```typescript
5836
- await client.team.getUserById();
5852
+ await client.order.resendEvents();
5837
5853
  ```
5838
5854
 
5839
5855
  </dd>
@@ -5849,7 +5865,7 @@ await client.team.getUserById();
5849
5865
  <dl>
5850
5866
  <dd>
5851
5867
 
5852
- **request:** `Vital.TeamGetUserByIdRequest`
5868
+ **request:** `Vital.ResendWebhookBody`
5853
5869
 
5854
5870
  </dd>
5855
5871
  </dl>
@@ -5857,7 +5873,7 @@ await client.team.getUserById();
5857
5873
  <dl>
5858
5874
  <dd>
5859
5875
 
5860
- **requestOptions:** `Team.RequestOptions`
5876
+ **requestOptions:** `Order.RequestOptions`
5861
5877
 
5862
5878
  </dd>
5863
5879
  </dl>
@@ -5868,10 +5884,27 @@ await client.team.getUserById();
5868
5884
  </dl>
5869
5885
  </details>
5870
5886
 
5871
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSvixUrl</a>() -> Record<string, unknown></code></summary>
5887
+ ## Team
5888
+
5889
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getLinkConfig</a>({ ...params }) -> Record<string, unknown></code></summary>
5890
+ <dl>
5891
+ <dd>
5892
+
5893
+ #### 📝 Description
5894
+
5895
+ <dl>
5896
+ <dd>
5897
+
5872
5898
  <dl>
5873
5899
  <dd>
5874
5900
 
5901
+ Post teams.
5902
+
5903
+ </dd>
5904
+ </dl>
5905
+ </dd>
5906
+ </dl>
5907
+
5875
5908
  #### 🔌 Usage
5876
5909
 
5877
5910
  <dl>
@@ -5881,7 +5914,7 @@ await client.team.getUserById();
5881
5914
  <dd>
5882
5915
 
5883
5916
  ```typescript
5884
- await client.team.getSvixUrl();
5917
+ await client.team.getLinkConfig();
5885
5918
  ```
5886
5919
 
5887
5920
  </dd>
@@ -5897,6 +5930,14 @@ await client.team.getSvixUrl();
5897
5930
  <dl>
5898
5931
  <dd>
5899
5932
 
5933
+ **request:** `Vital.TeamGetLinkConfigRequest`
5934
+
5935
+ </dd>
5936
+ </dl>
5937
+
5938
+ <dl>
5939
+ <dd>
5940
+
5900
5941
  **requestOptions:** `Team.RequestOptions`
5901
5942
 
5902
5943
  </dd>
@@ -5908,7 +5949,7 @@ await client.team.getSvixUrl();
5908
5949
  </dl>
5909
5950
  </details>
5910
5951
 
5911
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSourcePriorities</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
5952
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">get</a>(teamId) -> Vital.ClientFacingTeam</code></summary>
5912
5953
  <dl>
5913
5954
  <dd>
5914
5955
 
@@ -5920,7 +5961,7 @@ await client.team.getSvixUrl();
5920
5961
  <dl>
5921
5962
  <dd>
5922
5963
 
5923
- GET source priorities.
5964
+ Get team.
5924
5965
 
5925
5966
  </dd>
5926
5967
  </dl>
@@ -5936,7 +5977,7 @@ GET source priorities.
5936
5977
  <dd>
5937
5978
 
5938
5979
  ```typescript
5939
- await client.team.getSourcePriorities();
5980
+ await client.team.get("team_id");
5940
5981
  ```
5941
5982
 
5942
5983
  </dd>
@@ -5952,7 +5993,7 @@ await client.team.getSourcePriorities();
5952
5993
  <dl>
5953
5994
  <dd>
5954
5995
 
5955
- **request:** `Vital.TeamGetSourcePrioritiesRequest`
5996
+ **teamId:** `string`
5956
5997
 
5957
5998
  </dd>
5958
5999
  </dl>
@@ -5971,7 +6012,7 @@ await client.team.getSourcePriorities();
5971
6012
  </dl>
5972
6013
  </details>
5973
6014
 
5974
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">updateSourcePriorities</a>() -> Record<string, unknown>[]</code></summary>
6015
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getUserById</a>({ ...params }) -> Vital.ClientFacingUser[]</code></summary>
5975
6016
  <dl>
5976
6017
  <dd>
5977
6018
 
@@ -5983,7 +6024,7 @@ await client.team.getSourcePriorities();
5983
6024
  <dl>
5984
6025
  <dd>
5985
6026
 
5986
- Patch source priorities.
6027
+ Search team users by user_id
5987
6028
 
5988
6029
  </dd>
5989
6030
  </dl>
@@ -5999,7 +6040,7 @@ Patch source priorities.
5999
6040
  <dd>
6000
6041
 
6001
6042
  ```typescript
6002
- await client.team.updateSourcePriorities();
6043
+ await client.team.getUserById();
6003
6044
  ```
6004
6045
 
6005
6046
  </dd>
@@ -6015,6 +6056,14 @@ await client.team.updateSourcePriorities();
6015
6056
  <dl>
6016
6057
  <dd>
6017
6058
 
6059
+ **request:** `Vital.TeamGetUserByIdRequest`
6060
+
6061
+ </dd>
6062
+ </dl>
6063
+
6064
+ <dl>
6065
+ <dd>
6066
+
6018
6067
  **requestOptions:** `Team.RequestOptions`
6019
6068
 
6020
6069
  </dd>
@@ -6026,7 +6075,7 @@ await client.team.updateSourcePriorities();
6026
6075
  </dl>
6027
6076
  </details>
6028
6077
 
6029
- <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getPhysicians</a>(teamId) -> Vital.ClientFacingPhysician[]</code></summary>
6078
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSvixUrl</a>() -> Record<string, unknown></code></summary>
6030
6079
  <dl>
6031
6080
  <dd>
6032
6081
 
@@ -6039,7 +6088,7 @@ await client.team.updateSourcePriorities();
6039
6088
  <dd>
6040
6089
 
6041
6090
  ```typescript
6042
- await client.team.getPhysicians("team_id");
6091
+ await client.team.getSvixUrl();
6043
6092
  ```
6044
6093
 
6045
6094
  </dd>
@@ -6055,14 +6104,6 @@ await client.team.getPhysicians("team_id");
6055
6104
  <dl>
6056
6105
  <dd>
6057
6106
 
6058
- **teamId:** `string`
6059
-
6060
- </dd>
6061
- </dl>
6062
-
6063
- <dl>
6064
- <dd>
6065
-
6066
6107
  **requestOptions:** `Team.RequestOptions`
6067
6108
 
6068
6109
  </dd>
@@ -6074,12 +6115,25 @@ await client.team.getPhysicians("team_id");
6074
6115
  </dl>
6075
6116
  </details>
6076
6117
 
6077
- ## Testkit
6118
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSourcePriorities</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
6119
+ <dl>
6120
+ <dd>
6121
+
6122
+ #### 📝 Description
6123
+
6124
+ <dl>
6125
+ <dd>
6078
6126
 
6079
- <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">register</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
6080
6127
  <dl>
6081
6128
  <dd>
6082
6129
 
6130
+ GET source priorities.
6131
+
6132
+ </dd>
6133
+ </dl>
6134
+ </dd>
6135
+ </dl>
6136
+
6083
6137
  #### 🔌 Usage
6084
6138
 
6085
6139
  <dl>
@@ -6089,24 +6143,7 @@ await client.team.getPhysicians("team_id");
6089
6143
  <dd>
6090
6144
 
6091
6145
  ```typescript
6092
- await client.testkit.register({
6093
- sampleId: "sample_id",
6094
- patientDetails: {
6095
- firstName: "first_name",
6096
- lastName: "last_name",
6097
- dob: "dob",
6098
- gender: "female",
6099
- phoneNumber: "phone_number",
6100
- email: "email",
6101
- },
6102
- patientAddress: {
6103
- firstLine: "first_line",
6104
- city: "city",
6105
- state: "state",
6106
- zip: "zip",
6107
- country: "country",
6108
- },
6109
- });
6146
+ await client.team.getSourcePriorities();
6110
6147
  ```
6111
6148
 
6112
6149
  </dd>
@@ -6122,7 +6159,7 @@ await client.testkit.register({
6122
6159
  <dl>
6123
6160
  <dd>
6124
6161
 
6125
- **request:** `Vital.RegisterTestkitRequest`
6162
+ **request:** `Vital.TeamGetSourcePrioritiesRequest`
6126
6163
 
6127
6164
  </dd>
6128
6165
  </dl>
@@ -6130,7 +6167,7 @@ await client.testkit.register({
6130
6167
  <dl>
6131
6168
  <dd>
6132
6169
 
6133
- **requestOptions:** `Testkit.RequestOptions`
6170
+ **requestOptions:** `Team.RequestOptions`
6134
6171
 
6135
6172
  </dd>
6136
6173
  </dl>
@@ -6141,7 +6178,7 @@ await client.testkit.register({
6141
6178
  </dl>
6142
6179
  </details>
6143
6180
 
6144
- <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
6181
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">updateSourcePriorities</a>() -> Record<string, unknown>[]</code></summary>
6145
6182
  <dl>
6146
6183
  <dd>
6147
6184
 
@@ -6153,7 +6190,7 @@ await client.testkit.register({
6153
6190
  <dl>
6154
6191
  <dd>
6155
6192
 
6156
- Creates an order for an unregistered testkit
6193
+ Patch source priorities.
6157
6194
 
6158
6195
  </dd>
6159
6196
  </dl>
@@ -6169,19 +6206,7 @@ Creates an order for an unregistered testkit
6169
6206
  <dd>
6170
6207
 
6171
6208
  ```typescript
6172
- await client.testkit.createOrder({
6173
- userId: "user_id",
6174
- labTestId: "lab_test_id",
6175
- shippingDetails: {
6176
- receiverName: "receiver_name",
6177
- firstLine: "first_line",
6178
- city: "city",
6179
- state: "state",
6180
- zip: "zip",
6181
- country: "country",
6182
- phoneNumber: "phone_number",
6183
- },
6184
- });
6209
+ await client.team.updateSourcePriorities();
6185
6210
  ```
6186
6211
 
6187
6212
  </dd>
@@ -6197,15 +6222,7 @@ await client.testkit.createOrder({
6197
6222
  <dl>
6198
6223
  <dd>
6199
6224
 
6200
- **request:** `Vital.CreateRegistrableTestkitOrderRequest`
6201
-
6202
- </dd>
6203
- </dl>
6204
-
6205
- <dl>
6206
- <dd>
6207
-
6208
- **requestOptions:** `Testkit.RequestOptions`
6225
+ **requestOptions:** `Team.RequestOptions`
6209
6226
 
6210
6227
  </dd>
6211
6228
  </dl>
@@ -6216,27 +6233,10 @@ await client.testkit.createOrder({
6216
6233
  </dl>
6217
6234
  </details>
6218
6235
 
6219
- ## Order
6220
-
6221
- <details><summary><code>client.order.<a href="/src/api/resources/order/client/Client.ts">resendEvents</a>({ ...params }) -> Vital.ResendWebhookResponse</code></summary>
6222
- <dl>
6223
- <dd>
6224
-
6225
- #### 📝 Description
6226
-
6227
- <dl>
6228
- <dd>
6229
-
6236
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getPhysicians</a>(teamId) -> Vital.ClientFacingPhysician[]</code></summary>
6230
6237
  <dl>
6231
6238
  <dd>
6232
6239
 
6233
- Replay a webhook for a given set of orders
6234
-
6235
- </dd>
6236
- </dl>
6237
- </dd>
6238
- </dl>
6239
-
6240
6240
  #### 🔌 Usage
6241
6241
 
6242
6242
  <dl>
@@ -6246,7 +6246,7 @@ Replay a webhook for a given set of orders
6246
6246
  <dd>
6247
6247
 
6248
6248
  ```typescript
6249
- await client.order.resendEvents();
6249
+ await client.team.getPhysicians("team_id");
6250
6250
  ```
6251
6251
 
6252
6252
  </dd>
@@ -6262,7 +6262,7 @@ await client.order.resendEvents();
6262
6262
  <dl>
6263
6263
  <dd>
6264
6264
 
6265
- **request:** `Vital.ResendWebhookBody`
6265
+ **teamId:** `string`
6266
6266
 
6267
6267
  </dd>
6268
6268
  </dl>
@@ -6270,7 +6270,7 @@ await client.order.resendEvents();
6270
6270
  <dl>
6271
6271
  <dd>
6272
6272
 
6273
- **requestOptions:** `Order.RequestOptions`
6273
+ **requestOptions:** `Team.RequestOptions`
6274
6274
 
6275
6275
  </dd>
6276
6276
  </dl>
@@ -11140,7 +11140,7 @@ await client.aggregate.queryOne("user_id", {
11140
11140
  select: [
11141
11141
  {
11142
11142
  arg: {
11143
- sleep: "session_start",
11143
+ sleep: "id",
11144
11144
  },
11145
11145
  func: "mean",
11146
11146
  },