@tryvital/vital-node 3.1.297 → 3.1.298

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 (48) hide show
  1. package/api/resources/activity/client/Client.js +2 -2
  2. package/api/resources/aggregate/client/Client.js +3 -3
  3. package/api/resources/body/client/Client.js +2 -2
  4. package/api/resources/devices/client/Client.js +1 -1
  5. package/api/resources/electrocardiogram/client/Client.js +1 -1
  6. package/api/resources/insurance/client/Client.js +3 -3
  7. package/api/resources/introspect/client/Client.js +2 -2
  8. package/api/resources/labTests/client/Client.js +41 -41
  9. package/api/resources/link/client/Client.js +19 -19
  10. package/api/resources/meal/client/Client.js +1 -1
  11. package/api/resources/menstrualCycle/client/Client.js +1 -1
  12. package/api/resources/order/client/Client.js +1 -1
  13. package/api/resources/profile/client/Client.js +2 -2
  14. package/api/resources/providers/client/Client.js +1 -1
  15. package/api/resources/sleep/client/Client.js +4 -4
  16. package/api/resources/sleepCycle/client/Client.js +1 -1
  17. package/api/resources/team/client/Client.js +7 -7
  18. package/api/resources/testkit/client/Client.js +2 -2
  19. package/api/resources/user/client/Client.js +16 -16
  20. package/api/resources/vitals/client/Client.js +78 -78
  21. package/api/resources/workouts/client/Client.js +3 -3
  22. package/dist/api/resources/activity/client/Client.js +2 -2
  23. package/dist/api/resources/aggregate/client/Client.js +3 -3
  24. package/dist/api/resources/body/client/Client.js +2 -2
  25. package/dist/api/resources/devices/client/Client.js +1 -1
  26. package/dist/api/resources/electrocardiogram/client/Client.js +1 -1
  27. package/dist/api/resources/insurance/client/Client.js +3 -3
  28. package/dist/api/resources/introspect/client/Client.js +2 -2
  29. package/dist/api/resources/labTests/client/Client.js +41 -41
  30. package/dist/api/resources/link/client/Client.js +19 -19
  31. package/dist/api/resources/meal/client/Client.js +1 -1
  32. package/dist/api/resources/menstrualCycle/client/Client.js +1 -1
  33. package/dist/api/resources/order/client/Client.js +1 -1
  34. package/dist/api/resources/profile/client/Client.js +2 -2
  35. package/dist/api/resources/providers/client/Client.js +1 -1
  36. package/dist/api/resources/sleep/client/Client.js +4 -4
  37. package/dist/api/resources/sleepCycle/client/Client.js +1 -1
  38. package/dist/api/resources/team/client/Client.js +7 -7
  39. package/dist/api/resources/testkit/client/Client.js +2 -2
  40. package/dist/api/resources/user/client/Client.js +16 -16
  41. package/dist/api/resources/vitals/client/Client.js +78 -78
  42. package/dist/api/resources/workouts/client/Client.js +3 -3
  43. package/dist/version.d.ts +1 -1
  44. package/dist/version.js +1 -1
  45. package/package.json +1 -1
  46. package/reference.md +5096 -0
  47. package/version.d.ts +1 -1
  48. package/version.js +1 -1
package/reference.md CHANGED
@@ -6123,3 +6123,5099 @@ await client.vitals.ige("user_id", {
6123
6123
  </dd>
6124
6124
  </dl>
6125
6125
  </details>
6126
+
6127
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">igg</a>(userId, { ...params }) -> Vital.ClientFacingIggTimeseries[]</code></summary>
6128
+ <dl>
6129
+ <dd>
6130
+
6131
+ #### 🔌 Usage
6132
+
6133
+ <dl>
6134
+ <dd>
6135
+
6136
+ <dl>
6137
+ <dd>
6138
+
6139
+ ```typescript
6140
+ await client.vitals.igg("user_id", {
6141
+ startDate: "start_date",
6142
+ });
6143
+ ```
6144
+
6145
+ </dd>
6146
+ </dl>
6147
+ </dd>
6148
+ </dl>
6149
+
6150
+ #### ⚙️ Parameters
6151
+
6152
+ <dl>
6153
+ <dd>
6154
+
6155
+ <dl>
6156
+ <dd>
6157
+
6158
+ **userId:** `string`
6159
+
6160
+ </dd>
6161
+ </dl>
6162
+
6163
+ <dl>
6164
+ <dd>
6165
+
6166
+ **request:** `Vital.VitalsIggRequest`
6167
+
6168
+ </dd>
6169
+ </dl>
6170
+
6171
+ <dl>
6172
+ <dd>
6173
+
6174
+ **requestOptions:** `Vitals.RequestOptions`
6175
+
6176
+ </dd>
6177
+ </dl>
6178
+ </dd>
6179
+ </dl>
6180
+
6181
+ </dd>
6182
+ </dl>
6183
+ </details>
6184
+
6185
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">hypnogram</a>(userId, { ...params }) -> Vital.ClientFacingHypnogramTimeseries[]</code></summary>
6186
+ <dl>
6187
+ <dd>
6188
+
6189
+ #### 🔌 Usage
6190
+
6191
+ <dl>
6192
+ <dd>
6193
+
6194
+ <dl>
6195
+ <dd>
6196
+
6197
+ ```typescript
6198
+ await client.vitals.hypnogram("user_id", {
6199
+ startDate: "start_date",
6200
+ });
6201
+ ```
6202
+
6203
+ </dd>
6204
+ </dl>
6205
+ </dd>
6206
+ </dl>
6207
+
6208
+ #### ⚙️ Parameters
6209
+
6210
+ <dl>
6211
+ <dd>
6212
+
6213
+ <dl>
6214
+ <dd>
6215
+
6216
+ **userId:** `string`
6217
+
6218
+ </dd>
6219
+ </dl>
6220
+
6221
+ <dl>
6222
+ <dd>
6223
+
6224
+ **request:** `Vital.VitalsHypnogramRequest`
6225
+
6226
+ </dd>
6227
+ </dl>
6228
+
6229
+ <dl>
6230
+ <dd>
6231
+
6232
+ **requestOptions:** `Vitals.RequestOptions`
6233
+
6234
+ </dd>
6235
+ </dl>
6236
+ </dd>
6237
+ </dl>
6238
+
6239
+ </dd>
6240
+ </dl>
6241
+ </details>
6242
+
6243
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">hrv</a>(userId, { ...params }) -> Vital.ClientFacingHrvTimeseries[]</code></summary>
6244
+ <dl>
6245
+ <dd>
6246
+
6247
+ #### 🔌 Usage
6248
+
6249
+ <dl>
6250
+ <dd>
6251
+
6252
+ <dl>
6253
+ <dd>
6254
+
6255
+ ```typescript
6256
+ await client.vitals.hrv("user_id", {
6257
+ startDate: "start_date",
6258
+ });
6259
+ ```
6260
+
6261
+ </dd>
6262
+ </dl>
6263
+ </dd>
6264
+ </dl>
6265
+
6266
+ #### ⚙️ Parameters
6267
+
6268
+ <dl>
6269
+ <dd>
6270
+
6271
+ <dl>
6272
+ <dd>
6273
+
6274
+ **userId:** `string`
6275
+
6276
+ </dd>
6277
+ </dl>
6278
+
6279
+ <dl>
6280
+ <dd>
6281
+
6282
+ **request:** `Vital.VitalsHrvRequest`
6283
+
6284
+ </dd>
6285
+ </dl>
6286
+
6287
+ <dl>
6288
+ <dd>
6289
+
6290
+ **requestOptions:** `Vitals.RequestOptions`
6291
+
6292
+ </dd>
6293
+ </dl>
6294
+ </dd>
6295
+ </dl>
6296
+
6297
+ </dd>
6298
+ </dl>
6299
+ </details>
6300
+
6301
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">heartrate</a>(userId, { ...params }) -> Vital.ClientFacingHeartRateTimeseries[]</code></summary>
6302
+ <dl>
6303
+ <dd>
6304
+
6305
+ #### 🔌 Usage
6306
+
6307
+ <dl>
6308
+ <dd>
6309
+
6310
+ <dl>
6311
+ <dd>
6312
+
6313
+ ```typescript
6314
+ await client.vitals.heartrate("user_id", {
6315
+ startDate: "start_date",
6316
+ });
6317
+ ```
6318
+
6319
+ </dd>
6320
+ </dl>
6321
+ </dd>
6322
+ </dl>
6323
+
6324
+ #### ⚙️ Parameters
6325
+
6326
+ <dl>
6327
+ <dd>
6328
+
6329
+ <dl>
6330
+ <dd>
6331
+
6332
+ **userId:** `string`
6333
+
6334
+ </dd>
6335
+ </dl>
6336
+
6337
+ <dl>
6338
+ <dd>
6339
+
6340
+ **request:** `Vital.VitalsHeartrateRequest`
6341
+
6342
+ </dd>
6343
+ </dl>
6344
+
6345
+ <dl>
6346
+ <dd>
6347
+
6348
+ **requestOptions:** `Vitals.RequestOptions`
6349
+
6350
+ </dd>
6351
+ </dl>
6352
+ </dd>
6353
+ </dl>
6354
+
6355
+ </dd>
6356
+ </dl>
6357
+ </details>
6358
+
6359
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">glucose</a>(userId, { ...params }) -> Vital.ClientFacingGlucoseTimeseries[]</code></summary>
6360
+ <dl>
6361
+ <dd>
6362
+
6363
+ #### 🔌 Usage
6364
+
6365
+ <dl>
6366
+ <dd>
6367
+
6368
+ <dl>
6369
+ <dd>
6370
+
6371
+ ```typescript
6372
+ await client.vitals.glucose("user_id", {
6373
+ startDate: "start_date",
6374
+ });
6375
+ ```
6376
+
6377
+ </dd>
6378
+ </dl>
6379
+ </dd>
6380
+ </dl>
6381
+
6382
+ #### ⚙️ Parameters
6383
+
6384
+ <dl>
6385
+ <dd>
6386
+
6387
+ <dl>
6388
+ <dd>
6389
+
6390
+ **userId:** `string`
6391
+
6392
+ </dd>
6393
+ </dl>
6394
+
6395
+ <dl>
6396
+ <dd>
6397
+
6398
+ **request:** `Vital.VitalsGlucoseRequest`
6399
+
6400
+ </dd>
6401
+ </dl>
6402
+
6403
+ <dl>
6404
+ <dd>
6405
+
6406
+ **requestOptions:** `Vitals.RequestOptions`
6407
+
6408
+ </dd>
6409
+ </dl>
6410
+ </dd>
6411
+ </dl>
6412
+
6413
+ </dd>
6414
+ </dl>
6415
+ </details>
6416
+
6417
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">cholesterolTriglycerides</a>(userId, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]</code></summary>
6418
+ <dl>
6419
+ <dd>
6420
+
6421
+ #### 🔌 Usage
6422
+
6423
+ <dl>
6424
+ <dd>
6425
+
6426
+ <dl>
6427
+ <dd>
6428
+
6429
+ ```typescript
6430
+ await client.vitals.cholesterolTriglycerides("user_id", {
6431
+ startDate: "start_date",
6432
+ });
6433
+ ```
6434
+
6435
+ </dd>
6436
+ </dl>
6437
+ </dd>
6438
+ </dl>
6439
+
6440
+ #### ⚙️ Parameters
6441
+
6442
+ <dl>
6443
+ <dd>
6444
+
6445
+ <dl>
6446
+ <dd>
6447
+
6448
+ **userId:** `string`
6449
+
6450
+ </dd>
6451
+ </dl>
6452
+
6453
+ <dl>
6454
+ <dd>
6455
+
6456
+ **request:** `Vital.VitalsCholesterolTriglyceridesRequest`
6457
+
6458
+ </dd>
6459
+ </dl>
6460
+
6461
+ <dl>
6462
+ <dd>
6463
+
6464
+ **requestOptions:** `Vitals.RequestOptions`
6465
+
6466
+ </dd>
6467
+ </dl>
6468
+ </dd>
6469
+ </dl>
6470
+
6471
+ </dd>
6472
+ </dl>
6473
+ </details>
6474
+
6475
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">cholesterolTotal</a>(userId, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]</code></summary>
6476
+ <dl>
6477
+ <dd>
6478
+
6479
+ #### 🔌 Usage
6480
+
6481
+ <dl>
6482
+ <dd>
6483
+
6484
+ <dl>
6485
+ <dd>
6486
+
6487
+ ```typescript
6488
+ await client.vitals.cholesterolTotal("user_id", {
6489
+ startDate: "start_date",
6490
+ });
6491
+ ```
6492
+
6493
+ </dd>
6494
+ </dl>
6495
+ </dd>
6496
+ </dl>
6497
+
6498
+ #### ⚙️ Parameters
6499
+
6500
+ <dl>
6501
+ <dd>
6502
+
6503
+ <dl>
6504
+ <dd>
6505
+
6506
+ **userId:** `string`
6507
+
6508
+ </dd>
6509
+ </dl>
6510
+
6511
+ <dl>
6512
+ <dd>
6513
+
6514
+ **request:** `Vital.VitalsCholesterolTotalRequest`
6515
+
6516
+ </dd>
6517
+ </dl>
6518
+
6519
+ <dl>
6520
+ <dd>
6521
+
6522
+ **requestOptions:** `Vitals.RequestOptions`
6523
+
6524
+ </dd>
6525
+ </dl>
6526
+ </dd>
6527
+ </dl>
6528
+
6529
+ </dd>
6530
+ </dl>
6531
+ </details>
6532
+
6533
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">cholesterolLdl</a>(userId, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]</code></summary>
6534
+ <dl>
6535
+ <dd>
6536
+
6537
+ #### 🔌 Usage
6538
+
6539
+ <dl>
6540
+ <dd>
6541
+
6542
+ <dl>
6543
+ <dd>
6544
+
6545
+ ```typescript
6546
+ await client.vitals.cholesterolLdl("user_id", {
6547
+ startDate: "start_date",
6548
+ });
6549
+ ```
6550
+
6551
+ </dd>
6552
+ </dl>
6553
+ </dd>
6554
+ </dl>
6555
+
6556
+ #### ⚙️ Parameters
6557
+
6558
+ <dl>
6559
+ <dd>
6560
+
6561
+ <dl>
6562
+ <dd>
6563
+
6564
+ **userId:** `string`
6565
+
6566
+ </dd>
6567
+ </dl>
6568
+
6569
+ <dl>
6570
+ <dd>
6571
+
6572
+ **request:** `Vital.VitalsCholesterolLdlRequest`
6573
+
6574
+ </dd>
6575
+ </dl>
6576
+
6577
+ <dl>
6578
+ <dd>
6579
+
6580
+ **requestOptions:** `Vitals.RequestOptions`
6581
+
6582
+ </dd>
6583
+ </dl>
6584
+ </dd>
6585
+ </dl>
6586
+
6587
+ </dd>
6588
+ </dl>
6589
+ </details>
6590
+
6591
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">cholesterolHdl</a>(userId, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]</code></summary>
6592
+ <dl>
6593
+ <dd>
6594
+
6595
+ #### 🔌 Usage
6596
+
6597
+ <dl>
6598
+ <dd>
6599
+
6600
+ <dl>
6601
+ <dd>
6602
+
6603
+ ```typescript
6604
+ await client.vitals.cholesterolHdl("user_id", {
6605
+ startDate: "start_date",
6606
+ });
6607
+ ```
6608
+
6609
+ </dd>
6610
+ </dl>
6611
+ </dd>
6612
+ </dl>
6613
+
6614
+ #### ⚙️ Parameters
6615
+
6616
+ <dl>
6617
+ <dd>
6618
+
6619
+ <dl>
6620
+ <dd>
6621
+
6622
+ **userId:** `string`
6623
+
6624
+ </dd>
6625
+ </dl>
6626
+
6627
+ <dl>
6628
+ <dd>
6629
+
6630
+ **request:** `Vital.VitalsCholesterolHdlRequest`
6631
+
6632
+ </dd>
6633
+ </dl>
6634
+
6635
+ <dl>
6636
+ <dd>
6637
+
6638
+ **requestOptions:** `Vitals.RequestOptions`
6639
+
6640
+ </dd>
6641
+ </dl>
6642
+ </dd>
6643
+ </dl>
6644
+
6645
+ </dd>
6646
+ </dl>
6647
+ </details>
6648
+
6649
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">cholesterol</a>(userId, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]</code></summary>
6650
+ <dl>
6651
+ <dd>
6652
+
6653
+ #### 🔌 Usage
6654
+
6655
+ <dl>
6656
+ <dd>
6657
+
6658
+ <dl>
6659
+ <dd>
6660
+
6661
+ ```typescript
6662
+ await client.vitals.cholesterol("user_id", {
6663
+ startDate: "start_date",
6664
+ });
6665
+ ```
6666
+
6667
+ </dd>
6668
+ </dl>
6669
+ </dd>
6670
+ </dl>
6671
+
6672
+ #### ⚙️ Parameters
6673
+
6674
+ <dl>
6675
+ <dd>
6676
+
6677
+ <dl>
6678
+ <dd>
6679
+
6680
+ **userId:** `string`
6681
+
6682
+ </dd>
6683
+ </dl>
6684
+
6685
+ <dl>
6686
+ <dd>
6687
+
6688
+ **request:** `Vital.VitalsCholesterolRequest`
6689
+
6690
+ </dd>
6691
+ </dl>
6692
+
6693
+ <dl>
6694
+ <dd>
6695
+
6696
+ **requestOptions:** `Vitals.RequestOptions`
6697
+
6698
+ </dd>
6699
+ </dl>
6700
+ </dd>
6701
+ </dl>
6702
+
6703
+ </dd>
6704
+ </dl>
6705
+ </details>
6706
+
6707
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">bodyWeight</a>(userId, { ...params }) -> Vital.ClientFacingBodyWeightTimeseries[]</code></summary>
6708
+ <dl>
6709
+ <dd>
6710
+
6711
+ #### 🔌 Usage
6712
+
6713
+ <dl>
6714
+ <dd>
6715
+
6716
+ <dl>
6717
+ <dd>
6718
+
6719
+ ```typescript
6720
+ await client.vitals.bodyWeight("user_id", {
6721
+ startDate: "start_date",
6722
+ });
6723
+ ```
6724
+
6725
+ </dd>
6726
+ </dl>
6727
+ </dd>
6728
+ </dl>
6729
+
6730
+ #### ⚙️ Parameters
6731
+
6732
+ <dl>
6733
+ <dd>
6734
+
6735
+ <dl>
6736
+ <dd>
6737
+
6738
+ **userId:** `string`
6739
+
6740
+ </dd>
6741
+ </dl>
6742
+
6743
+ <dl>
6744
+ <dd>
6745
+
6746
+ **request:** `Vital.VitalsBodyWeightRequest`
6747
+
6748
+ </dd>
6749
+ </dl>
6750
+
6751
+ <dl>
6752
+ <dd>
6753
+
6754
+ **requestOptions:** `Vitals.RequestOptions`
6755
+
6756
+ </dd>
6757
+ </dl>
6758
+ </dd>
6759
+ </dl>
6760
+
6761
+ </dd>
6762
+ </dl>
6763
+ </details>
6764
+
6765
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">bodyFat</a>(userId, { ...params }) -> Vital.ClientFacingBodyFatTimeseries[]</code></summary>
6766
+ <dl>
6767
+ <dd>
6768
+
6769
+ #### 🔌 Usage
6770
+
6771
+ <dl>
6772
+ <dd>
6773
+
6774
+ <dl>
6775
+ <dd>
6776
+
6777
+ ```typescript
6778
+ await client.vitals.bodyFat("user_id", {
6779
+ startDate: "start_date",
6780
+ });
6781
+ ```
6782
+
6783
+ </dd>
6784
+ </dl>
6785
+ </dd>
6786
+ </dl>
6787
+
6788
+ #### ⚙️ Parameters
6789
+
6790
+ <dl>
6791
+ <dd>
6792
+
6793
+ <dl>
6794
+ <dd>
6795
+
6796
+ **userId:** `string`
6797
+
6798
+ </dd>
6799
+ </dl>
6800
+
6801
+ <dl>
6802
+ <dd>
6803
+
6804
+ **request:** `Vital.VitalsBodyFatRequest`
6805
+
6806
+ </dd>
6807
+ </dl>
6808
+
6809
+ <dl>
6810
+ <dd>
6811
+
6812
+ **requestOptions:** `Vitals.RequestOptions`
6813
+
6814
+ </dd>
6815
+ </dl>
6816
+ </dd>
6817
+ </dl>
6818
+
6819
+ </dd>
6820
+ </dl>
6821
+ </details>
6822
+
6823
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">bloodOxygen</a>(userId, { ...params }) -> Vital.ClientFacingBloodOxygenTimeseries[]</code></summary>
6824
+ <dl>
6825
+ <dd>
6826
+
6827
+ #### 🔌 Usage
6828
+
6829
+ <dl>
6830
+ <dd>
6831
+
6832
+ <dl>
6833
+ <dd>
6834
+
6835
+ ```typescript
6836
+ await client.vitals.bloodOxygen("user_id", {
6837
+ startDate: "start_date",
6838
+ });
6839
+ ```
6840
+
6841
+ </dd>
6842
+ </dl>
6843
+ </dd>
6844
+ </dl>
6845
+
6846
+ #### ⚙️ Parameters
6847
+
6848
+ <dl>
6849
+ <dd>
6850
+
6851
+ <dl>
6852
+ <dd>
6853
+
6854
+ **userId:** `string`
6855
+
6856
+ </dd>
6857
+ </dl>
6858
+
6859
+ <dl>
6860
+ <dd>
6861
+
6862
+ **request:** `Vital.VitalsBloodOxygenRequest`
6863
+
6864
+ </dd>
6865
+ </dl>
6866
+
6867
+ <dl>
6868
+ <dd>
6869
+
6870
+ **requestOptions:** `Vitals.RequestOptions`
6871
+
6872
+ </dd>
6873
+ </dl>
6874
+ </dd>
6875
+ </dl>
6876
+
6877
+ </dd>
6878
+ </dl>
6879
+ </details>
6880
+
6881
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">electrocardiogramVoltage</a>(userId, { ...params }) -> Vital.ClientFacingElectrocardiogramVoltageTimeseries[]</code></summary>
6882
+ <dl>
6883
+ <dd>
6884
+
6885
+ #### 🔌 Usage
6886
+
6887
+ <dl>
6888
+ <dd>
6889
+
6890
+ <dl>
6891
+ <dd>
6892
+
6893
+ ```typescript
6894
+ await client.vitals.electrocardiogramVoltage("user_id", {
6895
+ startDate: "start_date",
6896
+ });
6897
+ ```
6898
+
6899
+ </dd>
6900
+ </dl>
6901
+ </dd>
6902
+ </dl>
6903
+
6904
+ #### ⚙️ Parameters
6905
+
6906
+ <dl>
6907
+ <dd>
6908
+
6909
+ <dl>
6910
+ <dd>
6911
+
6912
+ **userId:** `string`
6913
+
6914
+ </dd>
6915
+ </dl>
6916
+
6917
+ <dl>
6918
+ <dd>
6919
+
6920
+ **request:** `Vital.VitalsElectrocardiogramVoltageRequest`
6921
+
6922
+ </dd>
6923
+ </dl>
6924
+
6925
+ <dl>
6926
+ <dd>
6927
+
6928
+ **requestOptions:** `Vitals.RequestOptions`
6929
+
6930
+ </dd>
6931
+ </dl>
6932
+ </dd>
6933
+ </dl>
6934
+
6935
+ </dd>
6936
+ </dl>
6937
+ </details>
6938
+
6939
+ <details><summary><code>client.vitals.<a href="/src/api/resources/vitals/client/Client.ts">bloodPressure</a>(userId, { ...params }) -> Vital.ClientFacingBloodPressureTimeseries[]</code></summary>
6940
+ <dl>
6941
+ <dd>
6942
+
6943
+ #### 🔌 Usage
6944
+
6945
+ <dl>
6946
+ <dd>
6947
+
6948
+ <dl>
6949
+ <dd>
6950
+
6951
+ ```typescript
6952
+ await client.vitals.bloodPressure("user_id", {
6953
+ startDate: "start_date",
6954
+ });
6955
+ ```
6956
+
6957
+ </dd>
6958
+ </dl>
6959
+ </dd>
6960
+ </dl>
6961
+
6962
+ #### ⚙️ Parameters
6963
+
6964
+ <dl>
6965
+ <dd>
6966
+
6967
+ <dl>
6968
+ <dd>
6969
+
6970
+ **userId:** `string`
6971
+
6972
+ </dd>
6973
+ </dl>
6974
+
6975
+ <dl>
6976
+ <dd>
6977
+
6978
+ **request:** `Vital.VitalsBloodPressureRequest`
6979
+
6980
+ </dd>
6981
+ </dl>
6982
+
6983
+ <dl>
6984
+ <dd>
6985
+
6986
+ **requestOptions:** `Vitals.RequestOptions`
6987
+
6988
+ </dd>
6989
+ </dl>
6990
+ </dd>
6991
+ </dl>
6992
+
6993
+ </dd>
6994
+ </dl>
6995
+ </details>
6996
+
6997
+ ## User
6998
+
6999
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getAll</a>({ ...params }) -> Vital.PaginatedUsersResponse</code></summary>
7000
+ <dl>
7001
+ <dd>
7002
+
7003
+ #### 📝 Description
7004
+
7005
+ <dl>
7006
+ <dd>
7007
+
7008
+ <dl>
7009
+ <dd>
7010
+
7011
+ GET All users for team.
7012
+
7013
+ </dd>
7014
+ </dl>
7015
+ </dd>
7016
+ </dl>
7017
+
7018
+ #### 🔌 Usage
7019
+
7020
+ <dl>
7021
+ <dd>
7022
+
7023
+ <dl>
7024
+ <dd>
7025
+
7026
+ ```typescript
7027
+ await client.user.getAll();
7028
+ ```
7029
+
7030
+ </dd>
7031
+ </dl>
7032
+ </dd>
7033
+ </dl>
7034
+
7035
+ #### ⚙️ Parameters
7036
+
7037
+ <dl>
7038
+ <dd>
7039
+
7040
+ <dl>
7041
+ <dd>
7042
+
7043
+ **request:** `Vital.UserGetAllRequest`
7044
+
7045
+ </dd>
7046
+ </dl>
7047
+
7048
+ <dl>
7049
+ <dd>
7050
+
7051
+ **requestOptions:** `User.RequestOptions`
7052
+
7053
+ </dd>
7054
+ </dl>
7055
+ </dd>
7056
+ </dl>
7057
+
7058
+ </dd>
7059
+ </dl>
7060
+ </details>
7061
+
7062
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingUserKey</code></summary>
7063
+ <dl>
7064
+ <dd>
7065
+
7066
+ #### 📝 Description
7067
+
7068
+ <dl>
7069
+ <dd>
7070
+
7071
+ <dl>
7072
+ <dd>
7073
+
7074
+ POST Create a Vital user given a client_user_id and returns the user_id.
7075
+
7076
+ </dd>
7077
+ </dl>
7078
+ </dd>
7079
+ </dl>
7080
+
7081
+ #### 🔌 Usage
7082
+
7083
+ <dl>
7084
+ <dd>
7085
+
7086
+ <dl>
7087
+ <dd>
7088
+
7089
+ ```typescript
7090
+ await client.user.create({
7091
+ clientUserId: "client_user_id",
7092
+ });
7093
+ ```
7094
+
7095
+ </dd>
7096
+ </dl>
7097
+ </dd>
7098
+ </dl>
7099
+
7100
+ #### ⚙️ Parameters
7101
+
7102
+ <dl>
7103
+ <dd>
7104
+
7105
+ <dl>
7106
+ <dd>
7107
+
7108
+ **request:** `Vital.UserCreateBody`
7109
+
7110
+ </dd>
7111
+ </dl>
7112
+
7113
+ <dl>
7114
+ <dd>
7115
+
7116
+ **requestOptions:** `User.RequestOptions`
7117
+
7118
+ </dd>
7119
+ </dl>
7120
+ </dd>
7121
+ </dl>
7122
+
7123
+ </dd>
7124
+ </dl>
7125
+ </details>
7126
+
7127
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getTeamMetrics</a>() -> Vital.MetricsResult</code></summary>
7128
+ <dl>
7129
+ <dd>
7130
+
7131
+ #### 📝 Description
7132
+
7133
+ <dl>
7134
+ <dd>
7135
+
7136
+ <dl>
7137
+ <dd>
7138
+
7139
+ GET metrics for team.
7140
+
7141
+ </dd>
7142
+ </dl>
7143
+ </dd>
7144
+ </dl>
7145
+
7146
+ #### 🔌 Usage
7147
+
7148
+ <dl>
7149
+ <dd>
7150
+
7151
+ <dl>
7152
+ <dd>
7153
+
7154
+ ```typescript
7155
+ await client.user.getTeamMetrics();
7156
+ ```
7157
+
7158
+ </dd>
7159
+ </dl>
7160
+ </dd>
7161
+ </dl>
7162
+
7163
+ #### ⚙️ Parameters
7164
+
7165
+ <dl>
7166
+ <dd>
7167
+
7168
+ <dl>
7169
+ <dd>
7170
+
7171
+ **requestOptions:** `User.RequestOptions`
7172
+
7173
+ </dd>
7174
+ </dl>
7175
+ </dd>
7176
+ </dl>
7177
+
7178
+ </dd>
7179
+ </dl>
7180
+ </details>
7181
+
7182
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getUserSignInToken</a>(userId) -> Vital.UserSignInTokenResponse</code></summary>
7183
+ <dl>
7184
+ <dd>
7185
+
7186
+ #### 🔌 Usage
7187
+
7188
+ <dl>
7189
+ <dd>
7190
+
7191
+ <dl>
7192
+ <dd>
7193
+
7194
+ ```typescript
7195
+ await client.user.getUserSignInToken("user_id");
7196
+ ```
7197
+
7198
+ </dd>
7199
+ </dl>
7200
+ </dd>
7201
+ </dl>
7202
+
7203
+ #### ⚙️ Parameters
7204
+
7205
+ <dl>
7206
+ <dd>
7207
+
7208
+ <dl>
7209
+ <dd>
7210
+
7211
+ **userId:** `string`
7212
+
7213
+ </dd>
7214
+ </dl>
7215
+
7216
+ <dl>
7217
+ <dd>
7218
+
7219
+ **requestOptions:** `User.RequestOptions`
7220
+
7221
+ </dd>
7222
+ </dl>
7223
+ </dd>
7224
+ </dl>
7225
+
7226
+ </dd>
7227
+ </dl>
7228
+ </details>
7229
+
7230
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getConnectedProviders</a>(userId) -> Record<string, Vital.ClientFacingProviderWithStatus[]></code></summary>
7231
+ <dl>
7232
+ <dd>
7233
+
7234
+ #### 📝 Description
7235
+
7236
+ <dl>
7237
+ <dd>
7238
+
7239
+ <dl>
7240
+ <dd>
7241
+
7242
+ GET Users connected providers
7243
+
7244
+ </dd>
7245
+ </dl>
7246
+ </dd>
7247
+ </dl>
7248
+
7249
+ #### 🔌 Usage
7250
+
7251
+ <dl>
7252
+ <dd>
7253
+
7254
+ <dl>
7255
+ <dd>
7256
+
7257
+ ```typescript
7258
+ await client.user.getConnectedProviders("user_id");
7259
+ ```
7260
+
7261
+ </dd>
7262
+ </dl>
7263
+ </dd>
7264
+ </dl>
7265
+
7266
+ #### ⚙️ Parameters
7267
+
7268
+ <dl>
7269
+ <dd>
7270
+
7271
+ <dl>
7272
+ <dd>
7273
+
7274
+ **userId:** `string`
7275
+
7276
+ </dd>
7277
+ </dl>
7278
+
7279
+ <dl>
7280
+ <dd>
7281
+
7282
+ **requestOptions:** `User.RequestOptions`
7283
+
7284
+ </dd>
7285
+ </dl>
7286
+ </dd>
7287
+ </dl>
7288
+
7289
+ </dd>
7290
+ </dl>
7291
+ </details>
7292
+
7293
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Vital.ClientFacingUser</code></summary>
7294
+ <dl>
7295
+ <dd>
7296
+
7297
+ #### 📝 Description
7298
+
7299
+ <dl>
7300
+ <dd>
7301
+
7302
+ <dl>
7303
+ <dd>
7304
+
7305
+ GET User details given the user_id.
7306
+
7307
+ </dd>
7308
+ </dl>
7309
+ </dd>
7310
+ </dl>
7311
+
7312
+ #### 🔌 Usage
7313
+
7314
+ <dl>
7315
+ <dd>
7316
+
7317
+ <dl>
7318
+ <dd>
7319
+
7320
+ ```typescript
7321
+ await client.user.get("user_id");
7322
+ ```
7323
+
7324
+ </dd>
7325
+ </dl>
7326
+ </dd>
7327
+ </dl>
7328
+
7329
+ #### ⚙️ Parameters
7330
+
7331
+ <dl>
7332
+ <dd>
7333
+
7334
+ <dl>
7335
+ <dd>
7336
+
7337
+ **userId:** `string`
7338
+
7339
+ </dd>
7340
+ </dl>
7341
+
7342
+ <dl>
7343
+ <dd>
7344
+
7345
+ **requestOptions:** `User.RequestOptions`
7346
+
7347
+ </dd>
7348
+ </dl>
7349
+ </dd>
7350
+ </dl>
7351
+
7352
+ </dd>
7353
+ </dl>
7354
+ </details>
7355
+
7356
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Vital.UserSuccessResponse</code></summary>
7357
+ <dl>
7358
+ <dd>
7359
+
7360
+ #### 🔌 Usage
7361
+
7362
+ <dl>
7363
+ <dd>
7364
+
7365
+ <dl>
7366
+ <dd>
7367
+
7368
+ ```typescript
7369
+ await client.user.delete("user_id");
7370
+ ```
7371
+
7372
+ </dd>
7373
+ </dl>
7374
+ </dd>
7375
+ </dl>
7376
+
7377
+ #### ⚙️ Parameters
7378
+
7379
+ <dl>
7380
+ <dd>
7381
+
7382
+ <dl>
7383
+ <dd>
7384
+
7385
+ **userId:** `string`
7386
+
7387
+ </dd>
7388
+ </dl>
7389
+
7390
+ <dl>
7391
+ <dd>
7392
+
7393
+ **requestOptions:** `User.RequestOptions`
7394
+
7395
+ </dd>
7396
+ </dl>
7397
+ </dd>
7398
+ </dl>
7399
+
7400
+ </dd>
7401
+ </dl>
7402
+ </details>
7403
+
7404
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">patch</a>(userId, { ...params }) -> void</code></summary>
7405
+ <dl>
7406
+ <dd>
7407
+
7408
+ #### 🔌 Usage
7409
+
7410
+ <dl>
7411
+ <dd>
7412
+
7413
+ <dl>
7414
+ <dd>
7415
+
7416
+ ```typescript
7417
+ await client.user.patch("user_id");
7418
+ ```
7419
+
7420
+ </dd>
7421
+ </dl>
7422
+ </dd>
7423
+ </dl>
7424
+
7425
+ #### ⚙️ Parameters
7426
+
7427
+ <dl>
7428
+ <dd>
7429
+
7430
+ <dl>
7431
+ <dd>
7432
+
7433
+ **userId:** `string`
7434
+
7435
+ </dd>
7436
+ </dl>
7437
+
7438
+ <dl>
7439
+ <dd>
7440
+
7441
+ **request:** `Vital.UserPatchBody`
7442
+
7443
+ </dd>
7444
+ </dl>
7445
+
7446
+ <dl>
7447
+ <dd>
7448
+
7449
+ **requestOptions:** `User.RequestOptions`
7450
+
7451
+ </dd>
7452
+ </dl>
7453
+ </dd>
7454
+ </dl>
7455
+
7456
+ </dd>
7457
+ </dl>
7458
+ </details>
7459
+
7460
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestUserInfo</a>(userId) -> Vital.UserInfo</code></summary>
7461
+ <dl>
7462
+ <dd>
7463
+
7464
+ #### 🔌 Usage
7465
+
7466
+ <dl>
7467
+ <dd>
7468
+
7469
+ <dl>
7470
+ <dd>
7471
+
7472
+ ```typescript
7473
+ await client.user.getLatestUserInfo("user_id");
7474
+ ```
7475
+
7476
+ </dd>
7477
+ </dl>
7478
+ </dd>
7479
+ </dl>
7480
+
7481
+ #### ⚙️ Parameters
7482
+
7483
+ <dl>
7484
+ <dd>
7485
+
7486
+ <dl>
7487
+ <dd>
7488
+
7489
+ **userId:** `string`
7490
+
7491
+ </dd>
7492
+ </dl>
7493
+
7494
+ <dl>
7495
+ <dd>
7496
+
7497
+ **requestOptions:** `User.RequestOptions`
7498
+
7499
+ </dd>
7500
+ </dl>
7501
+ </dd>
7502
+ </dl>
7503
+
7504
+ </dd>
7505
+ </dl>
7506
+ </details>
7507
+
7508
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createInsurance</a>(userId, { ...params }) -> Vital.ClientFacingInsurance</code></summary>
7509
+ <dl>
7510
+ <dd>
7511
+
7512
+ #### 🔌 Usage
7513
+
7514
+ <dl>
7515
+ <dd>
7516
+
7517
+ <dl>
7518
+ <dd>
7519
+
7520
+ ```typescript
7521
+ await client.user.createInsurance("user_id", {
7522
+ payorCode: "payor_code",
7523
+ memberId: "member_id",
7524
+ relationship: "Self",
7525
+ insured: {
7526
+ firstName: "first_name",
7527
+ lastName: "last_name",
7528
+ gender: "female",
7529
+ address: {
7530
+ firstLine: "first_line",
7531
+ country: "country",
7532
+ zip: "zip",
7533
+ city: "city",
7534
+ state: "state",
7535
+ },
7536
+ dob: "dob",
7537
+ email: "email",
7538
+ phoneNumber: "phone_number",
7539
+ },
7540
+ });
7541
+ ```
7542
+
7543
+ </dd>
7544
+ </dl>
7545
+ </dd>
7546
+ </dl>
7547
+
7548
+ #### ⚙️ Parameters
7549
+
7550
+ <dl>
7551
+ <dd>
7552
+
7553
+ <dl>
7554
+ <dd>
7555
+
7556
+ **userId:** `string`
7557
+
7558
+ </dd>
7559
+ </dl>
7560
+
7561
+ <dl>
7562
+ <dd>
7563
+
7564
+ **request:** `Vital.CreateInsuranceRequest`
7565
+
7566
+ </dd>
7567
+ </dl>
7568
+
7569
+ <dl>
7570
+ <dd>
7571
+
7572
+ **requestOptions:** `User.RequestOptions`
7573
+
7574
+ </dd>
7575
+ </dl>
7576
+ </dd>
7577
+ </dl>
7578
+
7579
+ </dd>
7580
+ </dl>
7581
+ </details>
7582
+
7583
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestInsurance</a>(userId) -> Vital.ClientFacingInsurance</code></summary>
7584
+ <dl>
7585
+ <dd>
7586
+
7587
+ #### 🔌 Usage
7588
+
7589
+ <dl>
7590
+ <dd>
7591
+
7592
+ <dl>
7593
+ <dd>
7594
+
7595
+ ```typescript
7596
+ await client.user.getLatestInsurance("user_id");
7597
+ ```
7598
+
7599
+ </dd>
7600
+ </dl>
7601
+ </dd>
7602
+ </dl>
7603
+
7604
+ #### ⚙️ Parameters
7605
+
7606
+ <dl>
7607
+ <dd>
7608
+
7609
+ <dl>
7610
+ <dd>
7611
+
7612
+ **userId:** `string`
7613
+
7614
+ </dd>
7615
+ </dl>
7616
+
7617
+ <dl>
7618
+ <dd>
7619
+
7620
+ **requestOptions:** `User.RequestOptions`
7621
+
7622
+ </dd>
7623
+ </dl>
7624
+ </dd>
7625
+ </dl>
7626
+
7627
+ </dd>
7628
+ </dl>
7629
+ </details>
7630
+
7631
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">upsertUserInfo</a>(userId, { ...params }) -> Vital.UserInfo</code></summary>
7632
+ <dl>
7633
+ <dd>
7634
+
7635
+ #### 🔌 Usage
7636
+
7637
+ <dl>
7638
+ <dd>
7639
+
7640
+ <dl>
7641
+ <dd>
7642
+
7643
+ ```typescript
7644
+ await client.user.upsertUserInfo("user_id", {
7645
+ firstName: "first_name",
7646
+ lastName: "last_name",
7647
+ email: "email",
7648
+ phoneNumber: "phone_number",
7649
+ gender: "gender",
7650
+ dob: "dob",
7651
+ address: {
7652
+ firstLine: "first_line",
7653
+ country: "country",
7654
+ zip: "zip",
7655
+ city: "city",
7656
+ state: "state",
7657
+ },
7658
+ });
7659
+ ```
7660
+
7661
+ </dd>
7662
+ </dl>
7663
+ </dd>
7664
+ </dl>
7665
+
7666
+ #### ⚙️ Parameters
7667
+
7668
+ <dl>
7669
+ <dd>
7670
+
7671
+ <dl>
7672
+ <dd>
7673
+
7674
+ **userId:** `string`
7675
+
7676
+ </dd>
7677
+ </dl>
7678
+
7679
+ <dl>
7680
+ <dd>
7681
+
7682
+ **request:** `Vital.UserInfoCreateRequest`
7683
+
7684
+ </dd>
7685
+ </dl>
7686
+
7687
+ <dl>
7688
+ <dd>
7689
+
7690
+ **requestOptions:** `User.RequestOptions`
7691
+
7692
+ </dd>
7693
+ </dl>
7694
+ </dd>
7695
+ </dl>
7696
+
7697
+ </dd>
7698
+ </dl>
7699
+ </details>
7700
+
7701
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getByClientUserId</a>(clientUserId) -> Vital.ClientFacingUser</code></summary>
7702
+ <dl>
7703
+ <dd>
7704
+
7705
+ #### 📝 Description
7706
+
7707
+ <dl>
7708
+ <dd>
7709
+
7710
+ <dl>
7711
+ <dd>
7712
+
7713
+ GET user_id from client_user_id.
7714
+
7715
+ </dd>
7716
+ </dl>
7717
+ </dd>
7718
+ </dl>
7719
+
7720
+ #### 🔌 Usage
7721
+
7722
+ <dl>
7723
+ <dd>
7724
+
7725
+ <dl>
7726
+ <dd>
7727
+
7728
+ ```typescript
7729
+ await client.user.getByClientUserId("client_user_id");
7730
+ ```
7731
+
7732
+ </dd>
7733
+ </dl>
7734
+ </dd>
7735
+ </dl>
7736
+
7737
+ #### ⚙️ Parameters
7738
+
7739
+ <dl>
7740
+ <dd>
7741
+
7742
+ <dl>
7743
+ <dd>
7744
+
7745
+ **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.
7746
+
7747
+ </dd>
7748
+ </dl>
7749
+
7750
+ <dl>
7751
+ <dd>
7752
+
7753
+ **requestOptions:** `User.RequestOptions`
7754
+
7755
+ </dd>
7756
+ </dl>
7757
+ </dd>
7758
+ </dl>
7759
+
7760
+ </dd>
7761
+ </dl>
7762
+ </details>
7763
+
7764
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deregisterProvider</a>(userId, provider) -> Vital.UserSuccessResponse</code></summary>
7765
+ <dl>
7766
+ <dd>
7767
+
7768
+ #### 🔌 Usage
7769
+
7770
+ <dl>
7771
+ <dd>
7772
+
7773
+ <dl>
7774
+ <dd>
7775
+
7776
+ ```typescript
7777
+ await client.user.deregisterProvider("user_id", "oura");
7778
+ ```
7779
+
7780
+ </dd>
7781
+ </dl>
7782
+ </dd>
7783
+ </dl>
7784
+
7785
+ #### ⚙️ Parameters
7786
+
7787
+ <dl>
7788
+ <dd>
7789
+
7790
+ <dl>
7791
+ <dd>
7792
+
7793
+ **userId:** `string`
7794
+
7795
+ </dd>
7796
+ </dl>
7797
+
7798
+ <dl>
7799
+ <dd>
7800
+
7801
+ **provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
7802
+
7803
+ </dd>
7804
+ </dl>
7805
+
7806
+ <dl>
7807
+ <dd>
7808
+
7809
+ **requestOptions:** `User.RequestOptions`
7810
+
7811
+ </dd>
7812
+ </dl>
7813
+ </dd>
7814
+ </dl>
7815
+
7816
+ </dd>
7817
+ </dl>
7818
+ </details>
7819
+
7820
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
7821
+ <dl>
7822
+ <dd>
7823
+
7824
+ #### 🔌 Usage
7825
+
7826
+ <dl>
7827
+ <dd>
7828
+
7829
+ <dl>
7830
+ <dd>
7831
+
7832
+ ```typescript
7833
+ await client.user.undoDelete();
7834
+ ```
7835
+
7836
+ </dd>
7837
+ </dl>
7838
+ </dd>
7839
+ </dl>
7840
+
7841
+ #### ⚙️ Parameters
7842
+
7843
+ <dl>
7844
+ <dd>
7845
+
7846
+ <dl>
7847
+ <dd>
7848
+
7849
+ **request:** `Vital.UserUndoDeleteRequest`
7850
+
7851
+ </dd>
7852
+ </dl>
7853
+
7854
+ <dl>
7855
+ <dd>
7856
+
7857
+ **requestOptions:** `User.RequestOptions`
7858
+
7859
+ </dd>
7860
+ </dl>
7861
+ </dd>
7862
+ </dl>
7863
+
7864
+ </dd>
7865
+ </dl>
7866
+ </details>
7867
+
7868
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
7869
+ <dl>
7870
+ <dd>
7871
+
7872
+ #### 📝 Description
7873
+
7874
+ <dl>
7875
+ <dd>
7876
+
7877
+ <dl>
7878
+ <dd>
7879
+
7880
+ Trigger a manual refresh for a specific user
7881
+
7882
+ </dd>
7883
+ </dl>
7884
+ </dd>
7885
+ </dl>
7886
+
7887
+ #### 🔌 Usage
7888
+
7889
+ <dl>
7890
+ <dd>
7891
+
7892
+ <dl>
7893
+ <dd>
7894
+
7895
+ ```typescript
7896
+ await client.user.refresh("user_id");
7897
+ ```
7898
+
7899
+ </dd>
7900
+ </dl>
7901
+ </dd>
7902
+ </dl>
7903
+
7904
+ #### ⚙️ Parameters
7905
+
7906
+ <dl>
7907
+ <dd>
7908
+
7909
+ <dl>
7910
+ <dd>
7911
+
7912
+ **userId:** `string`
7913
+
7914
+ </dd>
7915
+ </dl>
7916
+
7917
+ <dl>
7918
+ <dd>
7919
+
7920
+ **request:** `Vital.UserRefreshRequest`
7921
+
7922
+ </dd>
7923
+ </dl>
7924
+
7925
+ <dl>
7926
+ <dd>
7927
+
7928
+ **requestOptions:** `User.RequestOptions`
7929
+
7930
+ </dd>
7931
+ </dl>
7932
+ </dd>
7933
+ </dl>
7934
+
7935
+ </dd>
7936
+ </dl>
7937
+ </details>
7938
+
7939
+ ## Team
7940
+
7941
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getLinkConfig</a>({ ...params }) -> Record<string, unknown></code></summary>
7942
+ <dl>
7943
+ <dd>
7944
+
7945
+ #### 📝 Description
7946
+
7947
+ <dl>
7948
+ <dd>
7949
+
7950
+ <dl>
7951
+ <dd>
7952
+
7953
+ Post teams.
7954
+
7955
+ </dd>
7956
+ </dl>
7957
+ </dd>
7958
+ </dl>
7959
+
7960
+ #### 🔌 Usage
7961
+
7962
+ <dl>
7963
+ <dd>
7964
+
7965
+ <dl>
7966
+ <dd>
7967
+
7968
+ ```typescript
7969
+ await client.team.getLinkConfig();
7970
+ ```
7971
+
7972
+ </dd>
7973
+ </dl>
7974
+ </dd>
7975
+ </dl>
7976
+
7977
+ #### ⚙️ Parameters
7978
+
7979
+ <dl>
7980
+ <dd>
7981
+
7982
+ <dl>
7983
+ <dd>
7984
+
7985
+ **request:** `Vital.TeamGetLinkConfigRequest`
7986
+
7987
+ </dd>
7988
+ </dl>
7989
+
7990
+ <dl>
7991
+ <dd>
7992
+
7993
+ **requestOptions:** `Team.RequestOptions`
7994
+
7995
+ </dd>
7996
+ </dl>
7997
+ </dd>
7998
+ </dl>
7999
+
8000
+ </dd>
8001
+ </dl>
8002
+ </details>
8003
+
8004
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">get</a>(teamId) -> Vital.ClientFacingTeam</code></summary>
8005
+ <dl>
8006
+ <dd>
8007
+
8008
+ #### 📝 Description
8009
+
8010
+ <dl>
8011
+ <dd>
8012
+
8013
+ <dl>
8014
+ <dd>
8015
+
8016
+ Get team.
8017
+
8018
+ </dd>
8019
+ </dl>
8020
+ </dd>
8021
+ </dl>
8022
+
8023
+ #### 🔌 Usage
8024
+
8025
+ <dl>
8026
+ <dd>
8027
+
8028
+ <dl>
8029
+ <dd>
8030
+
8031
+ ```typescript
8032
+ await client.team.get("team_id");
8033
+ ```
8034
+
8035
+ </dd>
8036
+ </dl>
8037
+ </dd>
8038
+ </dl>
8039
+
8040
+ #### ⚙️ Parameters
8041
+
8042
+ <dl>
8043
+ <dd>
8044
+
8045
+ <dl>
8046
+ <dd>
8047
+
8048
+ **teamId:** `string`
8049
+
8050
+ </dd>
8051
+ </dl>
8052
+
8053
+ <dl>
8054
+ <dd>
8055
+
8056
+ **requestOptions:** `Team.RequestOptions`
8057
+
8058
+ </dd>
8059
+ </dl>
8060
+ </dd>
8061
+ </dl>
8062
+
8063
+ </dd>
8064
+ </dl>
8065
+ </details>
8066
+
8067
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getUserById</a>({ ...params }) -> Vital.ClientFacingUser[]</code></summary>
8068
+ <dl>
8069
+ <dd>
8070
+
8071
+ #### 📝 Description
8072
+
8073
+ <dl>
8074
+ <dd>
8075
+
8076
+ <dl>
8077
+ <dd>
8078
+
8079
+ Search team users by user_id
8080
+
8081
+ </dd>
8082
+ </dl>
8083
+ </dd>
8084
+ </dl>
8085
+
8086
+ #### 🔌 Usage
8087
+
8088
+ <dl>
8089
+ <dd>
8090
+
8091
+ <dl>
8092
+ <dd>
8093
+
8094
+ ```typescript
8095
+ await client.team.getUserById();
8096
+ ```
8097
+
8098
+ </dd>
8099
+ </dl>
8100
+ </dd>
8101
+ </dl>
8102
+
8103
+ #### ⚙️ Parameters
8104
+
8105
+ <dl>
8106
+ <dd>
8107
+
8108
+ <dl>
8109
+ <dd>
8110
+
8111
+ **request:** `Vital.TeamGetUserByIdRequest`
8112
+
8113
+ </dd>
8114
+ </dl>
8115
+
8116
+ <dl>
8117
+ <dd>
8118
+
8119
+ **requestOptions:** `Team.RequestOptions`
8120
+
8121
+ </dd>
8122
+ </dl>
8123
+ </dd>
8124
+ </dl>
8125
+
8126
+ </dd>
8127
+ </dl>
8128
+ </details>
8129
+
8130
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSvixUrl</a>() -> Record<string, unknown></code></summary>
8131
+ <dl>
8132
+ <dd>
8133
+
8134
+ #### 🔌 Usage
8135
+
8136
+ <dl>
8137
+ <dd>
8138
+
8139
+ <dl>
8140
+ <dd>
8141
+
8142
+ ```typescript
8143
+ await client.team.getSvixUrl();
8144
+ ```
8145
+
8146
+ </dd>
8147
+ </dl>
8148
+ </dd>
8149
+ </dl>
8150
+
8151
+ #### ⚙️ Parameters
8152
+
8153
+ <dl>
8154
+ <dd>
8155
+
8156
+ <dl>
8157
+ <dd>
8158
+
8159
+ **requestOptions:** `Team.RequestOptions`
8160
+
8161
+ </dd>
8162
+ </dl>
8163
+ </dd>
8164
+ </dl>
8165
+
8166
+ </dd>
8167
+ </dl>
8168
+ </details>
8169
+
8170
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSourcePriorities</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
8171
+ <dl>
8172
+ <dd>
8173
+
8174
+ #### 📝 Description
8175
+
8176
+ <dl>
8177
+ <dd>
8178
+
8179
+ <dl>
8180
+ <dd>
8181
+
8182
+ GET source priorities.
8183
+
8184
+ </dd>
8185
+ </dl>
8186
+ </dd>
8187
+ </dl>
8188
+
8189
+ #### 🔌 Usage
8190
+
8191
+ <dl>
8192
+ <dd>
8193
+
8194
+ <dl>
8195
+ <dd>
8196
+
8197
+ ```typescript
8198
+ await client.team.getSourcePriorities();
8199
+ ```
8200
+
8201
+ </dd>
8202
+ </dl>
8203
+ </dd>
8204
+ </dl>
8205
+
8206
+ #### ⚙️ Parameters
8207
+
8208
+ <dl>
8209
+ <dd>
8210
+
8211
+ <dl>
8212
+ <dd>
8213
+
8214
+ **request:** `Vital.TeamGetSourcePrioritiesRequest`
8215
+
8216
+ </dd>
8217
+ </dl>
8218
+
8219
+ <dl>
8220
+ <dd>
8221
+
8222
+ **requestOptions:** `Team.RequestOptions`
8223
+
8224
+ </dd>
8225
+ </dl>
8226
+ </dd>
8227
+ </dl>
8228
+
8229
+ </dd>
8230
+ </dl>
8231
+ </details>
8232
+
8233
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">updateSourcePriorities</a>() -> Record<string, unknown>[]</code></summary>
8234
+ <dl>
8235
+ <dd>
8236
+
8237
+ #### 📝 Description
8238
+
8239
+ <dl>
8240
+ <dd>
8241
+
8242
+ <dl>
8243
+ <dd>
8244
+
8245
+ Patch source priorities.
8246
+
8247
+ </dd>
8248
+ </dl>
8249
+ </dd>
8250
+ </dl>
8251
+
8252
+ #### 🔌 Usage
8253
+
8254
+ <dl>
8255
+ <dd>
8256
+
8257
+ <dl>
8258
+ <dd>
8259
+
8260
+ ```typescript
8261
+ await client.team.updateSourcePriorities();
8262
+ ```
8263
+
8264
+ </dd>
8265
+ </dl>
8266
+ </dd>
8267
+ </dl>
8268
+
8269
+ #### ⚙️ Parameters
8270
+
8271
+ <dl>
8272
+ <dd>
8273
+
8274
+ <dl>
8275
+ <dd>
8276
+
8277
+ **requestOptions:** `Team.RequestOptions`
8278
+
8279
+ </dd>
8280
+ </dl>
8281
+ </dd>
8282
+ </dl>
8283
+
8284
+ </dd>
8285
+ </dl>
8286
+ </details>
8287
+
8288
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getPhysicians</a>(teamId) -> Vital.ClientFacingPhysician[]</code></summary>
8289
+ <dl>
8290
+ <dd>
8291
+
8292
+ #### 🔌 Usage
8293
+
8294
+ <dl>
8295
+ <dd>
8296
+
8297
+ <dl>
8298
+ <dd>
8299
+
8300
+ ```typescript
8301
+ await client.team.getPhysicians("team_id");
8302
+ ```
8303
+
8304
+ </dd>
8305
+ </dl>
8306
+ </dd>
8307
+ </dl>
8308
+
8309
+ #### ⚙️ Parameters
8310
+
8311
+ <dl>
8312
+ <dd>
8313
+
8314
+ <dl>
8315
+ <dd>
8316
+
8317
+ **teamId:** `string`
8318
+
8319
+ </dd>
8320
+ </dl>
8321
+
8322
+ <dl>
8323
+ <dd>
8324
+
8325
+ **requestOptions:** `Team.RequestOptions`
8326
+
8327
+ </dd>
8328
+ </dl>
8329
+ </dd>
8330
+ </dl>
8331
+
8332
+ </dd>
8333
+ </dl>
8334
+ </details>
8335
+
8336
+ ## Providers
8337
+
8338
+ <details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">getAll</a>({ ...params }) -> Vital.ClientFacingProviderDetailed[]</code></summary>
8339
+ <dl>
8340
+ <dd>
8341
+
8342
+ #### 📝 Description
8343
+
8344
+ <dl>
8345
+ <dd>
8346
+
8347
+ <dl>
8348
+ <dd>
8349
+
8350
+ Get Provider list
8351
+
8352
+ </dd>
8353
+ </dl>
8354
+ </dd>
8355
+ </dl>
8356
+
8357
+ #### 🔌 Usage
8358
+
8359
+ <dl>
8360
+ <dd>
8361
+
8362
+ <dl>
8363
+ <dd>
8364
+
8365
+ ```typescript
8366
+ await client.providers.getAll();
8367
+ ```
8368
+
8369
+ </dd>
8370
+ </dl>
8371
+ </dd>
8372
+ </dl>
8373
+
8374
+ #### ⚙️ Parameters
8375
+
8376
+ <dl>
8377
+ <dd>
8378
+
8379
+ <dl>
8380
+ <dd>
8381
+
8382
+ **request:** `Vital.ProvidersGetAllRequest`
8383
+
8384
+ </dd>
8385
+ </dl>
8386
+
8387
+ <dl>
8388
+ <dd>
8389
+
8390
+ **requestOptions:** `Providers.RequestOptions`
8391
+
8392
+ </dd>
8393
+ </dl>
8394
+ </dd>
8395
+ </dl>
8396
+
8397
+ </dd>
8398
+ </dl>
8399
+ </details>
8400
+
8401
+ ## Introspect
8402
+
8403
+ <details><summary><code>client.introspect.<a href="/src/api/resources/introspect/client/Client.ts">getUserResources</a>({ ...params }) -> Vital.UserResourcesResponse</code></summary>
8404
+ <dl>
8405
+ <dd>
8406
+
8407
+ #### 🔌 Usage
8408
+
8409
+ <dl>
8410
+ <dd>
8411
+
8412
+ <dl>
8413
+ <dd>
8414
+
8415
+ ```typescript
8416
+ await client.introspect.getUserResources();
8417
+ ```
8418
+
8419
+ </dd>
8420
+ </dl>
8421
+ </dd>
8422
+ </dl>
8423
+
8424
+ #### ⚙️ Parameters
8425
+
8426
+ <dl>
8427
+ <dd>
8428
+
8429
+ <dl>
8430
+ <dd>
8431
+
8432
+ **request:** `Vital.IntrospectGetUserResourcesRequest`
8433
+
8434
+ </dd>
8435
+ </dl>
8436
+
8437
+ <dl>
8438
+ <dd>
8439
+
8440
+ **requestOptions:** `Introspect.RequestOptions`
8441
+
8442
+ </dd>
8443
+ </dl>
8444
+ </dd>
8445
+ </dl>
8446
+
8447
+ </dd>
8448
+ </dl>
8449
+ </details>
8450
+
8451
+ <details><summary><code>client.introspect.<a href="/src/api/resources/introspect/client/Client.ts">getUserHistoricalPulls</a>({ ...params }) -> Vital.UserHistoricalPullsResponse</code></summary>
8452
+ <dl>
8453
+ <dd>
8454
+
8455
+ #### 🔌 Usage
8456
+
8457
+ <dl>
8458
+ <dd>
8459
+
8460
+ <dl>
8461
+ <dd>
8462
+
8463
+ ```typescript
8464
+ await client.introspect.getUserHistoricalPulls();
8465
+ ```
8466
+
8467
+ </dd>
8468
+ </dl>
8469
+ </dd>
8470
+ </dl>
8471
+
8472
+ #### ⚙️ Parameters
8473
+
8474
+ <dl>
8475
+ <dd>
8476
+
8477
+ <dl>
8478
+ <dd>
8479
+
8480
+ **request:** `Vital.IntrospectGetUserHistoricalPullsRequest`
8481
+
8482
+ </dd>
8483
+ </dl>
8484
+
8485
+ <dl>
8486
+ <dd>
8487
+
8488
+ **requestOptions:** `Introspect.RequestOptions`
8489
+
8490
+ </dd>
8491
+ </dl>
8492
+ </dd>
8493
+ </dl>
8494
+
8495
+ </dd>
8496
+ </dl>
8497
+ </details>
8498
+
8499
+ ## LabTests
8500
+
8501
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">get</a>({ ...params }) -> Vital.ClientFacingLabTest[]</code></summary>
8502
+ <dl>
8503
+ <dd>
8504
+
8505
+ #### 📝 Description
8506
+
8507
+ <dl>
8508
+ <dd>
8509
+
8510
+ <dl>
8511
+ <dd>
8512
+
8513
+ GET all the lab tests the team has access to.
8514
+
8515
+ </dd>
8516
+ </dl>
8517
+ </dd>
8518
+ </dl>
8519
+
8520
+ #### 🔌 Usage
8521
+
8522
+ <dl>
8523
+ <dd>
8524
+
8525
+ <dl>
8526
+ <dd>
8527
+
8528
+ ```typescript
8529
+ await client.labTests.get();
8530
+ ```
8531
+
8532
+ </dd>
8533
+ </dl>
8534
+ </dd>
8535
+ </dl>
8536
+
8537
+ #### ⚙️ Parameters
8538
+
8539
+ <dl>
8540
+ <dd>
8541
+
8542
+ <dl>
8543
+ <dd>
8544
+
8545
+ **request:** `Vital.LabTestsGetRequest`
8546
+
8547
+ </dd>
8548
+ </dl>
8549
+
8550
+ <dl>
8551
+ <dd>
8552
+
8553
+ **requestOptions:** `LabTests.RequestOptions`
8554
+
8555
+ </dd>
8556
+ </dl>
8557
+ </dd>
8558
+ </dl>
8559
+
8560
+ </dd>
8561
+ </dl>
8562
+ </details>
8563
+
8564
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingLabTest</code></summary>
8565
+ <dl>
8566
+ <dd>
8567
+
8568
+ #### 🔌 Usage
8569
+
8570
+ <dl>
8571
+ <dd>
8572
+
8573
+ <dl>
8574
+ <dd>
8575
+
8576
+ ```typescript
8577
+ await client.labTests.create({
8578
+ name: "name",
8579
+ method: "testkit",
8580
+ description: "description",
8581
+ });
8582
+ ```
8583
+
8584
+ </dd>
8585
+ </dl>
8586
+ </dd>
8587
+ </dl>
8588
+
8589
+ #### ⚙️ Parameters
8590
+
8591
+ <dl>
8592
+ <dd>
8593
+
8594
+ <dl>
8595
+ <dd>
8596
+
8597
+ **request:** `Vital.CreateLabTestRequest`
8598
+
8599
+ </dd>
8600
+ </dl>
8601
+
8602
+ <dl>
8603
+ <dd>
8604
+
8605
+ **requestOptions:** `LabTests.RequestOptions`
8606
+
8607
+ </dd>
8608
+ </dl>
8609
+ </dd>
8610
+ </dl>
8611
+
8612
+ </dd>
8613
+ </dl>
8614
+ </details>
8615
+
8616
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getById</a>(labTestId) -> Vital.ClientFacingLabTest</code></summary>
8617
+ <dl>
8618
+ <dd>
8619
+
8620
+ #### 📝 Description
8621
+
8622
+ <dl>
8623
+ <dd>
8624
+
8625
+ <dl>
8626
+ <dd>
8627
+
8628
+ GET all the lab tests the team has access to.
8629
+
8630
+ </dd>
8631
+ </dl>
8632
+ </dd>
8633
+ </dl>
8634
+
8635
+ #### 🔌 Usage
8636
+
8637
+ <dl>
8638
+ <dd>
8639
+
8640
+ <dl>
8641
+ <dd>
8642
+
8643
+ ```typescript
8644
+ await client.labTests.getById("lab_test_id");
8645
+ ```
8646
+
8647
+ </dd>
8648
+ </dl>
8649
+ </dd>
8650
+ </dl>
8651
+
8652
+ #### ⚙️ Parameters
8653
+
8654
+ <dl>
8655
+ <dd>
8656
+
8657
+ <dl>
8658
+ <dd>
8659
+
8660
+ **labTestId:** `string`
8661
+
8662
+ </dd>
8663
+ </dl>
8664
+
8665
+ <dl>
8666
+ <dd>
8667
+
8668
+ **requestOptions:** `LabTests.RequestOptions`
8669
+
8670
+ </dd>
8671
+ </dl>
8672
+ </dd>
8673
+ </dl>
8674
+
8675
+ </dd>
8676
+ </dl>
8677
+ </details>
8678
+
8679
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateLabTest</a>(labTestId, { ...params }) -> Vital.ClientFacingLabTest</code></summary>
8680
+ <dl>
8681
+ <dd>
8682
+
8683
+ #### 🔌 Usage
8684
+
8685
+ <dl>
8686
+ <dd>
8687
+
8688
+ <dl>
8689
+ <dd>
8690
+
8691
+ ```typescript
8692
+ await client.labTests.updateLabTest("lab_test_id");
8693
+ ```
8694
+
8695
+ </dd>
8696
+ </dl>
8697
+ </dd>
8698
+ </dl>
8699
+
8700
+ #### ⚙️ Parameters
8701
+
8702
+ <dl>
8703
+ <dd>
8704
+
8705
+ <dl>
8706
+ <dd>
8707
+
8708
+ **labTestId:** `string`
8709
+
8710
+ </dd>
8711
+ </dl>
8712
+
8713
+ <dl>
8714
+ <dd>
8715
+
8716
+ **request:** `Vital.UpdateLabTestRequest`
8717
+
8718
+ </dd>
8719
+ </dl>
8720
+
8721
+ <dl>
8722
+ <dd>
8723
+
8724
+ **requestOptions:** `LabTests.RequestOptions`
8725
+
8726
+ </dd>
8727
+ </dl>
8728
+ </dd>
8729
+ </dl>
8730
+
8731
+ </dd>
8732
+ </dl>
8733
+ </details>
8734
+
8735
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkers</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
8736
+ <dl>
8737
+ <dd>
8738
+
8739
+ #### 📝 Description
8740
+
8741
+ <dl>
8742
+ <dd>
8743
+
8744
+ <dl>
8745
+ <dd>
8746
+
8747
+ GET all the markers for the given lab.
8748
+
8749
+ </dd>
8750
+ </dl>
8751
+ </dd>
8752
+ </dl>
8753
+
8754
+ #### 🔌 Usage
8755
+
8756
+ <dl>
8757
+ <dd>
8758
+
8759
+ <dl>
8760
+ <dd>
8761
+
8762
+ ```typescript
8763
+ await client.labTests.getMarkers();
8764
+ ```
8765
+
8766
+ </dd>
8767
+ </dl>
8768
+ </dd>
8769
+ </dl>
8770
+
8771
+ #### ⚙️ Parameters
8772
+
8773
+ <dl>
8774
+ <dd>
8775
+
8776
+ <dl>
8777
+ <dd>
8778
+
8779
+ **request:** `Vital.LabTestsGetMarkersRequest`
8780
+
8781
+ </dd>
8782
+ </dl>
8783
+
8784
+ <dl>
8785
+ <dd>
8786
+
8787
+ **requestOptions:** `LabTests.RequestOptions`
8788
+
8789
+ </dd>
8790
+ </dl>
8791
+ </dd>
8792
+ </dl>
8793
+
8794
+ </dd>
8795
+ </dl>
8796
+ </details>
8797
+
8798
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForOrderSet</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
8799
+ <dl>
8800
+ <dd>
8801
+
8802
+ #### 🔌 Usage
8803
+
8804
+ <dl>
8805
+ <dd>
8806
+
8807
+ <dl>
8808
+ <dd>
8809
+
8810
+ ```typescript
8811
+ await client.labTests.getMarkersForOrderSet({
8812
+ body: {},
8813
+ });
8814
+ ```
8815
+
8816
+ </dd>
8817
+ </dl>
8818
+ </dd>
8819
+ </dl>
8820
+
8821
+ #### ⚙️ Parameters
8822
+
8823
+ <dl>
8824
+ <dd>
8825
+
8826
+ <dl>
8827
+ <dd>
8828
+
8829
+ **request:** `Vital.LabTestsGetMarkersForOrderSetRequest`
8830
+
8831
+ </dd>
8832
+ </dl>
8833
+
8834
+ <dl>
8835
+ <dd>
8836
+
8837
+ **requestOptions:** `LabTests.RequestOptions`
8838
+
8839
+ </dd>
8840
+ </dl>
8841
+ </dd>
8842
+ </dl>
8843
+
8844
+ </dd>
8845
+ </dl>
8846
+ </details>
8847
+
8848
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForLabTest</a>(labTestId, { ...params }) -> Vital.GetMarkersResponse</code></summary>
8849
+ <dl>
8850
+ <dd>
8851
+
8852
+ #### 🔌 Usage
8853
+
8854
+ <dl>
8855
+ <dd>
8856
+
8857
+ <dl>
8858
+ <dd>
8859
+
8860
+ ```typescript
8861
+ await client.labTests.getMarkersForLabTest("lab_test_id");
8862
+ ```
8863
+
8864
+ </dd>
8865
+ </dl>
8866
+ </dd>
8867
+ </dl>
8868
+
8869
+ #### ⚙️ Parameters
8870
+
8871
+ <dl>
8872
+ <dd>
8873
+
8874
+ <dl>
8875
+ <dd>
8876
+
8877
+ **labTestId:** `string`
8878
+
8879
+ </dd>
8880
+ </dl>
8881
+
8882
+ <dl>
8883
+ <dd>
8884
+
8885
+ **request:** `Vital.LabTestsGetMarkersForLabTestRequest`
8886
+
8887
+ </dd>
8888
+ </dl>
8889
+
8890
+ <dl>
8891
+ <dd>
8892
+
8893
+ **requestOptions:** `LabTests.RequestOptions`
8894
+
8895
+ </dd>
8896
+ </dl>
8897
+ </dd>
8898
+ </dl>
8899
+
8900
+ </dd>
8901
+ </dl>
8902
+ </details>
8903
+
8904
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersByLabAndProviderId</a>(providerId, labId) -> Vital.ClientFacingMarker</code></summary>
8905
+ <dl>
8906
+ <dd>
8907
+
8908
+ #### 📝 Description
8909
+
8910
+ <dl>
8911
+ <dd>
8912
+
8913
+ <dl>
8914
+ <dd>
8915
+
8916
+ GET a specific marker for the given lab and provider_id
8917
+
8918
+ </dd>
8919
+ </dl>
8920
+ </dd>
8921
+ </dl>
8922
+
8923
+ #### 🔌 Usage
8924
+
8925
+ <dl>
8926
+ <dd>
8927
+
8928
+ <dl>
8929
+ <dd>
8930
+
8931
+ ```typescript
8932
+ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
8933
+ ```
8934
+
8935
+ </dd>
8936
+ </dl>
8937
+ </dd>
8938
+ </dl>
8939
+
8940
+ #### ⚙️ Parameters
8941
+
8942
+ <dl>
8943
+ <dd>
8944
+
8945
+ <dl>
8946
+ <dd>
8947
+
8948
+ **providerId:** `string`
8949
+
8950
+ </dd>
8951
+ </dl>
8952
+
8953
+ <dl>
8954
+ <dd>
8955
+
8956
+ **labId:** `number`
8957
+
8958
+ </dd>
8959
+ </dl>
8960
+
8961
+ <dl>
8962
+ <dd>
8963
+
8964
+ **requestOptions:** `LabTests.RequestOptions`
8965
+
8966
+ </dd>
8967
+ </dl>
8968
+ </dd>
8969
+ </dl>
8970
+
8971
+ </dd>
8972
+ </dl>
8973
+ </details>
8974
+
8975
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getLabs</a>() -> Vital.ClientFacingLab[]</code></summary>
8976
+ <dl>
8977
+ <dd>
8978
+
8979
+ #### 📝 Description
8980
+
8981
+ <dl>
8982
+ <dd>
8983
+
8984
+ <dl>
8985
+ <dd>
8986
+
8987
+ GET all the labs.
8988
+
8989
+ </dd>
8990
+ </dl>
8991
+ </dd>
8992
+ </dl>
8993
+
8994
+ #### 🔌 Usage
8995
+
8996
+ <dl>
8997
+ <dd>
8998
+
8999
+ <dl>
9000
+ <dd>
9001
+
9002
+ ```typescript
9003
+ await client.labTests.getLabs();
9004
+ ```
9005
+
9006
+ </dd>
9007
+ </dl>
9008
+ </dd>
9009
+ </dl>
9010
+
9011
+ #### ⚙️ Parameters
9012
+
9013
+ <dl>
9014
+ <dd>
9015
+
9016
+ <dl>
9017
+ <dd>
9018
+
9019
+ **requestOptions:** `LabTests.RequestOptions`
9020
+
9021
+ </dd>
9022
+ </dl>
9023
+ </dd>
9024
+ </dl>
9025
+
9026
+ </dd>
9027
+ </dl>
9028
+ </details>
9029
+
9030
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPaginated</a>({ ...params }) -> Vital.LabTestResourcesResponse</code></summary>
9031
+ <dl>
9032
+ <dd>
9033
+
9034
+ #### 📝 Description
9035
+
9036
+ <dl>
9037
+ <dd>
9038
+
9039
+ <dl>
9040
+ <dd>
9041
+
9042
+ GET lab tests the team has access to as a paginated list.
9043
+
9044
+ </dd>
9045
+ </dl>
9046
+ </dd>
9047
+ </dl>
9048
+
9049
+ #### 🔌 Usage
9050
+
9051
+ <dl>
9052
+ <dd>
9053
+
9054
+ <dl>
9055
+ <dd>
9056
+
9057
+ ```typescript
9058
+ await client.labTests.getPaginated();
9059
+ ```
9060
+
9061
+ </dd>
9062
+ </dl>
9063
+ </dd>
9064
+ </dl>
9065
+
9066
+ #### ⚙️ Parameters
9067
+
9068
+ <dl>
9069
+ <dd>
9070
+
9071
+ <dl>
9072
+ <dd>
9073
+
9074
+ **request:** `Vital.LabTestsGetPaginatedRequest`
9075
+
9076
+ </dd>
9077
+ </dl>
9078
+
9079
+ <dl>
9080
+ <dd>
9081
+
9082
+ **requestOptions:** `LabTests.RequestOptions`
9083
+
9084
+ </dd>
9085
+ </dl>
9086
+ </dd>
9087
+ </dl>
9088
+
9089
+ </dd>
9090
+ </dl>
9091
+ </details>
9092
+
9093
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
9094
+ <dl>
9095
+ <dd>
9096
+
9097
+ #### 📝 Description
9098
+
9099
+ <dl>
9100
+ <dd>
9101
+
9102
+ <dl>
9103
+ <dd>
9104
+
9105
+ Return the available time slots to book an appointment with a phlebotomist
9106
+ for the given address and order.
9107
+
9108
+ </dd>
9109
+ </dl>
9110
+ </dd>
9111
+ </dl>
9112
+
9113
+ #### 🔌 Usage
9114
+
9115
+ <dl>
9116
+ <dd>
9117
+
9118
+ <dl>
9119
+ <dd>
9120
+
9121
+ ```typescript
9122
+ await client.labTests.getPhlebotomyAppointmentAvailability({
9123
+ body: {
9124
+ firstLine: "first_line",
9125
+ city: "city",
9126
+ state: "state",
9127
+ zipCode: "zip_code",
9128
+ },
9129
+ });
9130
+ ```
9131
+
9132
+ </dd>
9133
+ </dl>
9134
+ </dd>
9135
+ </dl>
9136
+
9137
+ #### ⚙️ Parameters
9138
+
9139
+ <dl>
9140
+ <dd>
9141
+
9142
+ <dl>
9143
+ <dd>
9144
+
9145
+ **request:** `Vital.LabTestsGetPhlebotomyAppointmentAvailabilityRequest`
9146
+
9147
+ </dd>
9148
+ </dl>
9149
+
9150
+ <dl>
9151
+ <dd>
9152
+
9153
+ **requestOptions:** `LabTests.RequestOptions`
9154
+
9155
+ </dd>
9156
+ </dl>
9157
+ </dd>
9158
+ </dl>
9159
+
9160
+ </dd>
9161
+ </dl>
9162
+ </details>
9163
+
9164
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9165
+ <dl>
9166
+ <dd>
9167
+
9168
+ #### 📝 Description
9169
+
9170
+ <dl>
9171
+ <dd>
9172
+
9173
+ <dl>
9174
+ <dd>
9175
+
9176
+ Book an at-home phlebotomy appointment.
9177
+
9178
+ </dd>
9179
+ </dl>
9180
+ </dd>
9181
+ </dl>
9182
+
9183
+ #### 🔌 Usage
9184
+
9185
+ <dl>
9186
+ <dd>
9187
+
9188
+ <dl>
9189
+ <dd>
9190
+
9191
+ ```typescript
9192
+ await client.labTests.bookPhlebotomyAppointment("order_id", {
9193
+ bookingKey: "booking_key",
9194
+ });
9195
+ ```
9196
+
9197
+ </dd>
9198
+ </dl>
9199
+ </dd>
9200
+ </dl>
9201
+
9202
+ #### ⚙️ Parameters
9203
+
9204
+ <dl>
9205
+ <dd>
9206
+
9207
+ <dl>
9208
+ <dd>
9209
+
9210
+ **orderId:** `string` — Your Order ID.
9211
+
9212
+ </dd>
9213
+ </dl>
9214
+
9215
+ <dl>
9216
+ <dd>
9217
+
9218
+ **request:** `Vital.AppointmentBookingRequest`
9219
+
9220
+ </dd>
9221
+ </dl>
9222
+
9223
+ <dl>
9224
+ <dd>
9225
+
9226
+ **requestOptions:** `LabTests.RequestOptions`
9227
+
9228
+ </dd>
9229
+ </dl>
9230
+ </dd>
9231
+ </dl>
9232
+
9233
+ </dd>
9234
+ </dl>
9235
+ </details>
9236
+
9237
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">requestPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9238
+ <dl>
9239
+ <dd>
9240
+
9241
+ #### 📝 Description
9242
+
9243
+ <dl>
9244
+ <dd>
9245
+
9246
+ <dl>
9247
+ <dd>
9248
+
9249
+ Request an at-home phlebotomy appointment.
9250
+
9251
+ </dd>
9252
+ </dl>
9253
+ </dd>
9254
+ </dl>
9255
+
9256
+ #### 🔌 Usage
9257
+
9258
+ <dl>
9259
+ <dd>
9260
+
9261
+ <dl>
9262
+ <dd>
9263
+
9264
+ ```typescript
9265
+ await client.labTests.requestPhlebotomyAppointment("order_id", {
9266
+ address: {
9267
+ firstLine: "first_line",
9268
+ city: "city",
9269
+ state: "state",
9270
+ zipCode: "zip_code",
9271
+ },
9272
+ provider: "getlabs",
9273
+ });
9274
+ ```
9275
+
9276
+ </dd>
9277
+ </dl>
9278
+ </dd>
9279
+ </dl>
9280
+
9281
+ #### ⚙️ Parameters
9282
+
9283
+ <dl>
9284
+ <dd>
9285
+
9286
+ <dl>
9287
+ <dd>
9288
+
9289
+ **orderId:** `string` — Your Order ID.
9290
+
9291
+ </dd>
9292
+ </dl>
9293
+
9294
+ <dl>
9295
+ <dd>
9296
+
9297
+ **request:** `Vital.RequestAppointmentRequest`
9298
+
9299
+ </dd>
9300
+ </dl>
9301
+
9302
+ <dl>
9303
+ <dd>
9304
+
9305
+ **requestOptions:** `LabTests.RequestOptions`
9306
+
9307
+ </dd>
9308
+ </dl>
9309
+ </dd>
9310
+ </dl>
9311
+
9312
+ </dd>
9313
+ </dl>
9314
+ </details>
9315
+
9316
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9317
+ <dl>
9318
+ <dd>
9319
+
9320
+ #### 📝 Description
9321
+
9322
+ <dl>
9323
+ <dd>
9324
+
9325
+ <dl>
9326
+ <dd>
9327
+
9328
+ Reschedule a previously booked at-home phlebotomy appointment.
9329
+
9330
+ </dd>
9331
+ </dl>
9332
+ </dd>
9333
+ </dl>
9334
+
9335
+ #### 🔌 Usage
9336
+
9337
+ <dl>
9338
+ <dd>
9339
+
9340
+ <dl>
9341
+ <dd>
9342
+
9343
+ ```typescript
9344
+ await client.labTests.reschedulePhlebotomyAppointment("order_id", {
9345
+ bookingKey: "booking_key",
9346
+ });
9347
+ ```
9348
+
9349
+ </dd>
9350
+ </dl>
9351
+ </dd>
9352
+ </dl>
9353
+
9354
+ #### ⚙️ Parameters
9355
+
9356
+ <dl>
9357
+ <dd>
9358
+
9359
+ <dl>
9360
+ <dd>
9361
+
9362
+ **orderId:** `string` — Your Order ID.
9363
+
9364
+ </dd>
9365
+ </dl>
9366
+
9367
+ <dl>
9368
+ <dd>
9369
+
9370
+ **request:** `Vital.AppointmentRescheduleRequest`
9371
+
9372
+ </dd>
9373
+ </dl>
9374
+
9375
+ <dl>
9376
+ <dd>
9377
+
9378
+ **requestOptions:** `LabTests.RequestOptions`
9379
+
9380
+ </dd>
9381
+ </dl>
9382
+ </dd>
9383
+ </dl>
9384
+
9385
+ </dd>
9386
+ </dl>
9387
+ </details>
9388
+
9389
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9390
+ <dl>
9391
+ <dd>
9392
+
9393
+ #### 📝 Description
9394
+
9395
+ <dl>
9396
+ <dd>
9397
+
9398
+ <dl>
9399
+ <dd>
9400
+
9401
+ Cancel a previously booked at-home phlebotomy appointment.
9402
+
9403
+ </dd>
9404
+ </dl>
9405
+ </dd>
9406
+ </dl>
9407
+
9408
+ #### 🔌 Usage
9409
+
9410
+ <dl>
9411
+ <dd>
9412
+
9413
+ <dl>
9414
+ <dd>
9415
+
9416
+ ```typescript
9417
+ await client.labTests.cancelPhlebotomyAppointment("order_id", {
9418
+ cancellationReasonId: "cancellation_reason_id",
9419
+ });
9420
+ ```
9421
+
9422
+ </dd>
9423
+ </dl>
9424
+ </dd>
9425
+ </dl>
9426
+
9427
+ #### ⚙️ Parameters
9428
+
9429
+ <dl>
9430
+ <dd>
9431
+
9432
+ <dl>
9433
+ <dd>
9434
+
9435
+ **orderId:** `string` — Your Order ID.
9436
+
9437
+ </dd>
9438
+ </dl>
9439
+
9440
+ <dl>
9441
+ <dd>
9442
+
9443
+ **request:** `Vital.ApiApiV1EndpointsVitalApiLabTestingOrdersHelpersAppointmentCancelRequest`
9444
+
9445
+ </dd>
9446
+ </dl>
9447
+
9448
+ <dl>
9449
+ <dd>
9450
+
9451
+ **requestOptions:** `LabTests.RequestOptions`
9452
+
9453
+ </dd>
9454
+ </dl>
9455
+ </dd>
9456
+ </dl>
9457
+
9458
+ </dd>
9459
+ </dl>
9460
+ </details>
9461
+
9462
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
9463
+ <dl>
9464
+ <dd>
9465
+
9466
+ #### 📝 Description
9467
+
9468
+ <dl>
9469
+ <dd>
9470
+
9471
+ <dl>
9472
+ <dd>
9473
+
9474
+ Get the list of reasons for cancelling an at-home phlebotomy appointment.
9475
+
9476
+ </dd>
9477
+ </dl>
9478
+ </dd>
9479
+ </dl>
9480
+
9481
+ #### 🔌 Usage
9482
+
9483
+ <dl>
9484
+ <dd>
9485
+
9486
+ <dl>
9487
+ <dd>
9488
+
9489
+ ```typescript
9490
+ await client.labTests.getPhlebotomyAppointmentCancellationReason();
9491
+ ```
9492
+
9493
+ </dd>
9494
+ </dl>
9495
+ </dd>
9496
+ </dl>
9497
+
9498
+ #### ⚙️ Parameters
9499
+
9500
+ <dl>
9501
+ <dd>
9502
+
9503
+ <dl>
9504
+ <dd>
9505
+
9506
+ **requestOptions:** `LabTests.RequestOptions`
9507
+
9508
+ </dd>
9509
+ </dl>
9510
+ </dd>
9511
+ </dl>
9512
+
9513
+ </dd>
9514
+ </dl>
9515
+ </details>
9516
+
9517
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
9518
+ <dl>
9519
+ <dd>
9520
+
9521
+ #### 📝 Description
9522
+
9523
+ <dl>
9524
+ <dd>
9525
+
9526
+ <dl>
9527
+ <dd>
9528
+
9529
+ Get the appointment associated with an order.
9530
+
9531
+ </dd>
9532
+ </dl>
9533
+ </dd>
9534
+ </dl>
9535
+
9536
+ #### 🔌 Usage
9537
+
9538
+ <dl>
9539
+ <dd>
9540
+
9541
+ <dl>
9542
+ <dd>
9543
+
9544
+ ```typescript
9545
+ await client.labTests.getPhlebotomyAppointment("order_id");
9546
+ ```
9547
+
9548
+ </dd>
9549
+ </dl>
9550
+ </dd>
9551
+ </dl>
9552
+
9553
+ #### ⚙️ Parameters
9554
+
9555
+ <dl>
9556
+ <dd>
9557
+
9558
+ <dl>
9559
+ <dd>
9560
+
9561
+ **orderId:** `string` — Your Order ID.
9562
+
9563
+ </dd>
9564
+ </dl>
9565
+
9566
+ <dl>
9567
+ <dd>
9568
+
9569
+ **requestOptions:** `LabTests.RequestOptions`
9570
+
9571
+ </dd>
9572
+ </dl>
9573
+ </dd>
9574
+ </dl>
9575
+
9576
+ </dd>
9577
+ </dl>
9578
+ </details>
9579
+
9580
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getAreaInfo</a>({ ...params }) -> Vital.AreaInfo</code></summary>
9581
+ <dl>
9582
+ <dd>
9583
+
9584
+ #### 📝 Description
9585
+
9586
+ <dl>
9587
+ <dd>
9588
+
9589
+ <dl>
9590
+ <dd>
9591
+
9592
+ GET information about an area with respect to lab-testing.
9593
+
9594
+ Information returned:
9595
+
9596
+ - Whether a given zip code is served by our Phlebotomy network.
9597
+ - List of Lab locations in the area.
9598
+ </dd>
9599
+ </dl>
9600
+ </dd>
9601
+ </dl>
9602
+
9603
+ #### 🔌 Usage
9604
+
9605
+ <dl>
9606
+ <dd>
9607
+
9608
+ <dl>
9609
+ <dd>
9610
+
9611
+ ```typescript
9612
+ await client.labTests.getAreaInfo({
9613
+ zipCode: "zip_code",
9614
+ });
9615
+ ```
9616
+
9617
+ </dd>
9618
+ </dl>
9619
+ </dd>
9620
+ </dl>
9621
+
9622
+ #### ⚙️ Parameters
9623
+
9624
+ <dl>
9625
+ <dd>
9626
+
9627
+ <dl>
9628
+ <dd>
9629
+
9630
+ **request:** `Vital.LabTestsGetAreaInfoRequest`
9631
+
9632
+ </dd>
9633
+ </dl>
9634
+
9635
+ <dl>
9636
+ <dd>
9637
+
9638
+ **requestOptions:** `LabTests.RequestOptions`
9639
+
9640
+ </dd>
9641
+ </dl>
9642
+ </dd>
9643
+ </dl>
9644
+
9645
+ </dd>
9646
+ </dl>
9647
+ </details>
9648
+
9649
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscInfo</a>({ ...params }) -> Vital.PscInfo</code></summary>
9650
+ <dl>
9651
+ <dd>
9652
+
9653
+ #### 🔌 Usage
9654
+
9655
+ <dl>
9656
+ <dd>
9657
+
9658
+ <dl>
9659
+ <dd>
9660
+
9661
+ ```typescript
9662
+ await client.labTests.getPscInfo({
9663
+ zipCode: "zip_code",
9664
+ labId: 1,
9665
+ });
9666
+ ```
9667
+
9668
+ </dd>
9669
+ </dl>
9670
+ </dd>
9671
+ </dl>
9672
+
9673
+ #### ⚙️ Parameters
9674
+
9675
+ <dl>
9676
+ <dd>
9677
+
9678
+ <dl>
9679
+ <dd>
9680
+
9681
+ **request:** `Vital.LabTestsGetPscInfoRequest`
9682
+
9683
+ </dd>
9684
+ </dl>
9685
+
9686
+ <dl>
9687
+ <dd>
9688
+
9689
+ **requestOptions:** `LabTests.RequestOptions`
9690
+
9691
+ </dd>
9692
+ </dl>
9693
+ </dd>
9694
+ </dl>
9695
+
9696
+ </dd>
9697
+ </dl>
9698
+ </details>
9699
+
9700
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderPscInfo</a>(orderId, { ...params }) -> Vital.PscInfo</code></summary>
9701
+ <dl>
9702
+ <dd>
9703
+
9704
+ #### 🔌 Usage
9705
+
9706
+ <dl>
9707
+ <dd>
9708
+
9709
+ <dl>
9710
+ <dd>
9711
+
9712
+ ```typescript
9713
+ await client.labTests.getOrderPscInfo("order_id");
9714
+ ```
9715
+
9716
+ </dd>
9717
+ </dl>
9718
+ </dd>
9719
+ </dl>
9720
+
9721
+ #### ⚙️ Parameters
9722
+
9723
+ <dl>
9724
+ <dd>
9725
+
9726
+ <dl>
9727
+ <dd>
9728
+
9729
+ **orderId:** `string` — Your Order ID.
9730
+
9731
+ </dd>
9732
+ </dl>
9733
+
9734
+ <dl>
9735
+ <dd>
9736
+
9737
+ **request:** `Vital.LabTestsGetOrderPscInfoRequest`
9738
+
9739
+ </dd>
9740
+ </dl>
9741
+
9742
+ <dl>
9743
+ <dd>
9744
+
9745
+ **requestOptions:** `LabTests.RequestOptions`
9746
+
9747
+ </dd>
9748
+ </dl>
9749
+ </dd>
9750
+ </dl>
9751
+
9752
+ </dd>
9753
+ </dl>
9754
+ </details>
9755
+
9756
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultMetadata</a>(orderId) -> Vital.LabResultsMetadata</code></summary>
9757
+ <dl>
9758
+ <dd>
9759
+
9760
+ #### 📝 Description
9761
+
9762
+ <dl>
9763
+ <dd>
9764
+
9765
+ <dl>
9766
+ <dd>
9767
+
9768
+ Return metadata related to order results, such as lab metadata,
9769
+ provider and sample dates.
9770
+
9771
+ </dd>
9772
+ </dl>
9773
+ </dd>
9774
+ </dl>
9775
+
9776
+ #### 🔌 Usage
9777
+
9778
+ <dl>
9779
+ <dd>
9780
+
9781
+ <dl>
9782
+ <dd>
9783
+
9784
+ ```typescript
9785
+ await client.labTests.getResultMetadata("order_id");
9786
+ ```
9787
+
9788
+ </dd>
9789
+ </dl>
9790
+ </dd>
9791
+ </dl>
9792
+
9793
+ #### ⚙️ Parameters
9794
+
9795
+ <dl>
9796
+ <dd>
9797
+
9798
+ <dl>
9799
+ <dd>
9800
+
9801
+ **orderId:** `string`
9802
+
9803
+ </dd>
9804
+ </dl>
9805
+
9806
+ <dl>
9807
+ <dd>
9808
+
9809
+ **requestOptions:** `LabTests.RequestOptions`
9810
+
9811
+ </dd>
9812
+ </dl>
9813
+ </dd>
9814
+ </dl>
9815
+
9816
+ </dd>
9817
+ </dl>
9818
+ </details>
9819
+
9820
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultRaw</a>(orderId) -> Vital.LabResultsRaw</code></summary>
9821
+ <dl>
9822
+ <dd>
9823
+
9824
+ #### 📝 Description
9825
+
9826
+ <dl>
9827
+ <dd>
9828
+
9829
+ <dl>
9830
+ <dd>
9831
+
9832
+ Return both metadata and raw json test data
9833
+
9834
+ </dd>
9835
+ </dl>
9836
+ </dd>
9837
+ </dl>
9838
+
9839
+ #### 🔌 Usage
9840
+
9841
+ <dl>
9842
+ <dd>
9843
+
9844
+ <dl>
9845
+ <dd>
9846
+
9847
+ ```typescript
9848
+ await client.labTests.getResultRaw("order_id");
9849
+ ```
9850
+
9851
+ </dd>
9852
+ </dl>
9853
+ </dd>
9854
+ </dl>
9855
+
9856
+ #### ⚙️ Parameters
9857
+
9858
+ <dl>
9859
+ <dd>
9860
+
9861
+ <dl>
9862
+ <dd>
9863
+
9864
+ **orderId:** `string`
9865
+
9866
+ </dd>
9867
+ </dl>
9868
+
9869
+ <dl>
9870
+ <dd>
9871
+
9872
+ **requestOptions:** `LabTests.RequestOptions`
9873
+
9874
+ </dd>
9875
+ </dl>
9876
+ </dd>
9877
+ </dl>
9878
+
9879
+ </dd>
9880
+ </dl>
9881
+ </details>
9882
+
9883
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
9884
+ <dl>
9885
+ <dd>
9886
+
9887
+ #### 🔌 Usage
9888
+
9889
+ <dl>
9890
+ <dd>
9891
+
9892
+ <dl>
9893
+ <dd>
9894
+
9895
+ ```typescript
9896
+ await client.labTests.getPscAppointmentAvailability({
9897
+ lab: "quest",
9898
+ });
9899
+ ```
9900
+
9901
+ </dd>
9902
+ </dl>
9903
+ </dd>
9904
+ </dl>
9905
+
9906
+ #### ⚙️ Parameters
9907
+
9908
+ <dl>
9909
+ <dd>
9910
+
9911
+ <dl>
9912
+ <dd>
9913
+
9914
+ **request:** `Vital.LabTestsGetPscAppointmentAvailabilityRequest`
9915
+
9916
+ </dd>
9917
+ </dl>
9918
+
9919
+ <dl>
9920
+ <dd>
9921
+
9922
+ **requestOptions:** `LabTests.RequestOptions`
9923
+
9924
+ </dd>
9925
+ </dl>
9926
+ </dd>
9927
+ </dl>
9928
+
9929
+ </dd>
9930
+ </dl>
9931
+ </details>
9932
+
9933
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9934
+ <dl>
9935
+ <dd>
9936
+
9937
+ #### 🔌 Usage
9938
+
9939
+ <dl>
9940
+ <dd>
9941
+
9942
+ <dl>
9943
+ <dd>
9944
+
9945
+ ```typescript
9946
+ await client.labTests.bookPscAppointment("order_id", {
9947
+ bookingKey: "booking_key",
9948
+ });
9949
+ ```
9950
+
9951
+ </dd>
9952
+ </dl>
9953
+ </dd>
9954
+ </dl>
9955
+
9956
+ #### ⚙️ Parameters
9957
+
9958
+ <dl>
9959
+ <dd>
9960
+
9961
+ <dl>
9962
+ <dd>
9963
+
9964
+ **orderId:** `string` — Your Order ID.
9965
+
9966
+ </dd>
9967
+ </dl>
9968
+
9969
+ <dl>
9970
+ <dd>
9971
+
9972
+ **request:** `Vital.AppointmentBookingRequest`
9973
+
9974
+ </dd>
9975
+ </dl>
9976
+
9977
+ <dl>
9978
+ <dd>
9979
+
9980
+ **requestOptions:** `LabTests.RequestOptions`
9981
+
9982
+ </dd>
9983
+ </dl>
9984
+ </dd>
9985
+ </dl>
9986
+
9987
+ </dd>
9988
+ </dl>
9989
+ </details>
9990
+
9991
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9992
+ <dl>
9993
+ <dd>
9994
+
9995
+ #### 🔌 Usage
9996
+
9997
+ <dl>
9998
+ <dd>
9999
+
10000
+ <dl>
10001
+ <dd>
10002
+
10003
+ ```typescript
10004
+ await client.labTests.reschedulePscAppointment("order_id", {
10005
+ bookingKey: "booking_key",
10006
+ });
10007
+ ```
10008
+
10009
+ </dd>
10010
+ </dl>
10011
+ </dd>
10012
+ </dl>
10013
+
10014
+ #### ⚙️ Parameters
10015
+
10016
+ <dl>
10017
+ <dd>
10018
+
10019
+ <dl>
10020
+ <dd>
10021
+
10022
+ **orderId:** `string` — Your Order ID.
10023
+
10024
+ </dd>
10025
+ </dl>
10026
+
10027
+ <dl>
10028
+ <dd>
10029
+
10030
+ **request:** `Vital.AppointmentRescheduleRequest`
10031
+
10032
+ </dd>
10033
+ </dl>
10034
+
10035
+ <dl>
10036
+ <dd>
10037
+
10038
+ **requestOptions:** `LabTests.RequestOptions`
10039
+
10040
+ </dd>
10041
+ </dl>
10042
+ </dd>
10043
+ </dl>
10044
+
10045
+ </dd>
10046
+ </dl>
10047
+ </details>
10048
+
10049
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
10050
+ <dl>
10051
+ <dd>
10052
+
10053
+ #### 🔌 Usage
10054
+
10055
+ <dl>
10056
+ <dd>
10057
+
10058
+ <dl>
10059
+ <dd>
10060
+
10061
+ ```typescript
10062
+ await client.labTests.cancelPscAppointment("order_id", {
10063
+ cancellationReasonId: "cancellationReasonId",
10064
+ });
10065
+ ```
10066
+
10067
+ </dd>
10068
+ </dl>
10069
+ </dd>
10070
+ </dl>
10071
+
10072
+ #### ⚙️ Parameters
10073
+
10074
+ <dl>
10075
+ <dd>
10076
+
10077
+ <dl>
10078
+ <dd>
10079
+
10080
+ **orderId:** `string` — Your Order ID.
10081
+
10082
+ </dd>
10083
+ </dl>
10084
+
10085
+ <dl>
10086
+ <dd>
10087
+
10088
+ **request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
10089
+
10090
+ </dd>
10091
+ </dl>
10092
+
10093
+ <dl>
10094
+ <dd>
10095
+
10096
+ **requestOptions:** `LabTests.RequestOptions`
10097
+
10098
+ </dd>
10099
+ </dl>
10100
+ </dd>
10101
+ </dl>
10102
+
10103
+ </dd>
10104
+ </dl>
10105
+ </details>
10106
+
10107
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
10108
+ <dl>
10109
+ <dd>
10110
+
10111
+ #### 🔌 Usage
10112
+
10113
+ <dl>
10114
+ <dd>
10115
+
10116
+ <dl>
10117
+ <dd>
10118
+
10119
+ ```typescript
10120
+ await client.labTests.getPscAppointmentCancellationReason();
10121
+ ```
10122
+
10123
+ </dd>
10124
+ </dl>
10125
+ </dd>
10126
+ </dl>
10127
+
10128
+ #### ⚙️ Parameters
10129
+
10130
+ <dl>
10131
+ <dd>
10132
+
10133
+ <dl>
10134
+ <dd>
10135
+
10136
+ **requestOptions:** `LabTests.RequestOptions`
10137
+
10138
+ </dd>
10139
+ </dl>
10140
+ </dd>
10141
+ </dl>
10142
+
10143
+ </dd>
10144
+ </dl>
10145
+ </details>
10146
+
10147
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
10148
+ <dl>
10149
+ <dd>
10150
+
10151
+ #### 📝 Description
10152
+
10153
+ <dl>
10154
+ <dd>
10155
+
10156
+ <dl>
10157
+ <dd>
10158
+
10159
+ Get the appointment associated with an order.
10160
+
10161
+ </dd>
10162
+ </dl>
10163
+ </dd>
10164
+ </dl>
10165
+
10166
+ #### 🔌 Usage
10167
+
10168
+ <dl>
10169
+ <dd>
10170
+
10171
+ <dl>
10172
+ <dd>
10173
+
10174
+ ```typescript
10175
+ await client.labTests.getPscAppointment("order_id");
10176
+ ```
10177
+
10178
+ </dd>
10179
+ </dl>
10180
+ </dd>
10181
+ </dl>
10182
+
10183
+ #### ⚙️ Parameters
10184
+
10185
+ <dl>
10186
+ <dd>
10187
+
10188
+ <dl>
10189
+ <dd>
10190
+
10191
+ **orderId:** `string` — Your Order ID.
10192
+
10193
+ </dd>
10194
+ </dl>
10195
+
10196
+ <dl>
10197
+ <dd>
10198
+
10199
+ **requestOptions:** `LabTests.RequestOptions`
10200
+
10201
+ </dd>
10202
+ </dl>
10203
+ </dd>
10204
+ </dl>
10205
+
10206
+ </dd>
10207
+ </dl>
10208
+ </details>
10209
+
10210
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrder</a>(orderId) -> Vital.ClientFacingOrder</code></summary>
10211
+ <dl>
10212
+ <dd>
10213
+
10214
+ #### 📝 Description
10215
+
10216
+ <dl>
10217
+ <dd>
10218
+
10219
+ <dl>
10220
+ <dd>
10221
+
10222
+ GET individual order by ID.
10223
+
10224
+ </dd>
10225
+ </dl>
10226
+ </dd>
10227
+ </dl>
10228
+
10229
+ #### 🔌 Usage
10230
+
10231
+ <dl>
10232
+ <dd>
10233
+
10234
+ <dl>
10235
+ <dd>
10236
+
10237
+ ```typescript
10238
+ await client.labTests.getOrder("order_id");
10239
+ ```
10240
+
10241
+ </dd>
10242
+ </dl>
10243
+ </dd>
10244
+ </dl>
10245
+
10246
+ #### ⚙️ Parameters
10247
+
10248
+ <dl>
10249
+ <dd>
10250
+
10251
+ <dl>
10252
+ <dd>
10253
+
10254
+ **orderId:** `string` — Your Order ID.
10255
+
10256
+ </dd>
10257
+ </dl>
10258
+
10259
+ <dl>
10260
+ <dd>
10261
+
10262
+ **requestOptions:** `LabTests.RequestOptions`
10263
+
10264
+ </dd>
10265
+ </dl>
10266
+ </dd>
10267
+ </dl>
10268
+
10269
+ </dd>
10270
+ </dl>
10271
+ </details>
10272
+
10273
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10274
+ <dl>
10275
+ <dd>
10276
+
10277
+ #### 🔌 Usage
10278
+
10279
+ <dl>
10280
+ <dd>
10281
+
10282
+ <dl>
10283
+ <dd>
10284
+
10285
+ ```typescript
10286
+ await client.labTests.createOrder({
10287
+ userId: "user_id",
10288
+ patientDetails: {
10289
+ firstName: "first_name",
10290
+ lastName: "last_name",
10291
+ dob: "dob",
10292
+ gender: "female",
10293
+ phoneNumber: "phone_number",
10294
+ email: "email",
10295
+ },
10296
+ patientAddress: {
10297
+ firstLine: "first_line",
10298
+ city: "city",
10299
+ state: "state",
10300
+ zip: "zip",
10301
+ country: "country",
10302
+ },
10303
+ });
10304
+ ```
10305
+
10306
+ </dd>
10307
+ </dl>
10308
+ </dd>
10309
+ </dl>
10310
+
10311
+ #### ⚙️ Parameters
10312
+
10313
+ <dl>
10314
+ <dd>
10315
+
10316
+ <dl>
10317
+ <dd>
10318
+
10319
+ **request:** `Vital.CreateOrderRequestCompatible`
10320
+
10321
+ </dd>
10322
+ </dl>
10323
+
10324
+ <dl>
10325
+ <dd>
10326
+
10327
+ **requestOptions:** `LabTests.RequestOptions`
10328
+
10329
+ </dd>
10330
+ </dl>
10331
+ </dd>
10332
+ </dl>
10333
+
10334
+ </dd>
10335
+ </dl>
10336
+ </details>
10337
+
10338
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">importOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10339
+ <dl>
10340
+ <dd>
10341
+
10342
+ #### 🔌 Usage
10343
+
10344
+ <dl>
10345
+ <dd>
10346
+
10347
+ <dl>
10348
+ <dd>
10349
+
10350
+ ```typescript
10351
+ await client.labTests.importOrder({
10352
+ userId: "user_id",
10353
+ billingType: "client_bill",
10354
+ orderSet: {},
10355
+ collectionMethod: "testkit",
10356
+ patientDetails: {
10357
+ firstName: "first_name",
10358
+ lastName: "last_name",
10359
+ dob: "dob",
10360
+ gender: "female",
10361
+ phoneNumber: "phone_number",
10362
+ email: "email",
10363
+ },
10364
+ patientAddress: {
10365
+ receiverName: "receiver_name",
10366
+ firstLine: "first_line",
10367
+ city: "city",
10368
+ state: "state",
10369
+ zip: "zip",
10370
+ country: "country",
10371
+ },
10372
+ sampleId: "sample_id",
10373
+ });
10374
+ ```
10375
+
10376
+ </dd>
10377
+ </dl>
10378
+ </dd>
10379
+ </dl>
10380
+
10381
+ #### ⚙️ Parameters
10382
+
10383
+ <dl>
10384
+ <dd>
10385
+
10386
+ <dl>
10387
+ <dd>
10388
+
10389
+ **request:** `Vital.ImportOrderBody`
10390
+
10391
+ </dd>
10392
+ </dl>
10393
+
10394
+ <dl>
10395
+ <dd>
10396
+
10397
+ **requestOptions:** `LabTests.RequestOptions`
10398
+
10399
+ </dd>
10400
+ </dl>
10401
+ </dd>
10402
+ </dl>
10403
+
10404
+ </dd>
10405
+ </dl>
10406
+ </details>
10407
+
10408
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelOrder</a>(orderId) -> Vital.PostOrderResponse</code></summary>
10409
+ <dl>
10410
+ <dd>
10411
+
10412
+ #### 📝 Description
10413
+
10414
+ <dl>
10415
+ <dd>
10416
+
10417
+ <dl>
10418
+ <dd>
10419
+
10420
+ POST cancel order
10421
+
10422
+ </dd>
10423
+ </dl>
10424
+ </dd>
10425
+ </dl>
10426
+
10427
+ #### 🔌 Usage
10428
+
10429
+ <dl>
10430
+ <dd>
10431
+
10432
+ <dl>
10433
+ <dd>
10434
+
10435
+ ```typescript
10436
+ await client.labTests.cancelOrder("order_id");
10437
+ ```
10438
+
10439
+ </dd>
10440
+ </dl>
10441
+ </dd>
10442
+ </dl>
10443
+
10444
+ #### ⚙️ Parameters
10445
+
10446
+ <dl>
10447
+ <dd>
10448
+
10449
+ <dl>
10450
+ <dd>
10451
+
10452
+ **orderId:** `string` — Your Order ID.
10453
+
10454
+ </dd>
10455
+ </dl>
10456
+
10457
+ <dl>
10458
+ <dd>
10459
+
10460
+ **requestOptions:** `LabTests.RequestOptions`
10461
+
10462
+ </dd>
10463
+ </dl>
10464
+ </dd>
10465
+ </dl>
10466
+
10467
+ </dd>
10468
+ </dl>
10469
+ </details>
10470
+
10471
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">simulateOrderProcess</a>(orderId, { ...params }) -> unknown</code></summary>
10472
+ <dl>
10473
+ <dd>
10474
+
10475
+ #### 📝 Description
10476
+
10477
+ <dl>
10478
+ <dd>
10479
+
10480
+ <dl>
10481
+ <dd>
10482
+
10483
+ Get available test kits.
10484
+
10485
+ </dd>
10486
+ </dl>
10487
+ </dd>
10488
+ </dl>
10489
+
10490
+ #### 🔌 Usage
10491
+
10492
+ <dl>
10493
+ <dd>
10494
+
10495
+ <dl>
10496
+ <dd>
10497
+
10498
+ ```typescript
10499
+ await client.labTests.simulateOrderProcess("order_id", {
10500
+ body: undefined,
10501
+ });
10502
+ ```
10503
+
10504
+ </dd>
10505
+ </dl>
10506
+ </dd>
10507
+ </dl>
10508
+
10509
+ #### ⚙️ Parameters
10510
+
10511
+ <dl>
10512
+ <dd>
10513
+
10514
+ <dl>
10515
+ <dd>
10516
+
10517
+ **orderId:** `string`
10518
+
10519
+ </dd>
10520
+ </dl>
10521
+
10522
+ <dl>
10523
+ <dd>
10524
+
10525
+ **request:** `Vital.LabTestsSimulateOrderProcessRequest`
10526
+
10527
+ </dd>
10528
+ </dl>
10529
+
10530
+ <dl>
10531
+ <dd>
10532
+
10533
+ **requestOptions:** `LabTests.RequestOptions`
10534
+
10535
+ </dd>
10536
+ </dl>
10537
+ </dd>
10538
+ </dl>
10539
+
10540
+ </dd>
10541
+ </dl>
10542
+ </details>
10543
+
10544
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateOnSiteCollectionOrderDrawCompleted</a>(orderId) -> Vital.PostOrderResponse</code></summary>
10545
+ <dl>
10546
+ <dd>
10547
+
10548
+ #### 📝 Description
10549
+
10550
+ <dl>
10551
+ <dd>
10552
+
10553
+ <dl>
10554
+ <dd>
10555
+
10556
+ PATCH update on site collection order when draw is completed
10557
+
10558
+ </dd>
10559
+ </dl>
10560
+ </dd>
10561
+ </dl>
10562
+
10563
+ #### 🔌 Usage
10564
+
10565
+ <dl>
10566
+ <dd>
10567
+
10568
+ <dl>
10569
+ <dd>
10570
+
10571
+ ```typescript
10572
+ await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
10573
+ ```
10574
+
10575
+ </dd>
10576
+ </dl>
10577
+ </dd>
10578
+ </dl>
10579
+
10580
+ #### ⚙️ Parameters
10581
+
10582
+ <dl>
10583
+ <dd>
10584
+
10585
+ <dl>
10586
+ <dd>
10587
+
10588
+ **orderId:** `string` — Your Order ID.
10589
+
10590
+ </dd>
10591
+ </dl>
10592
+
10593
+ <dl>
10594
+ <dd>
10595
+
10596
+ **requestOptions:** `LabTests.RequestOptions`
10597
+
10598
+ </dd>
10599
+ </dl>
10600
+ </dd>
10601
+ </dl>
10602
+
10603
+ </dd>
10604
+ </dl>
10605
+ </details>
10606
+
10607
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrders</a>({ ...params }) -> Vital.GetOrdersResponse</code></summary>
10608
+ <dl>
10609
+ <dd>
10610
+
10611
+ #### 📝 Description
10612
+
10613
+ <dl>
10614
+ <dd>
10615
+
10616
+ <dl>
10617
+ <dd>
10618
+
10619
+ GET many orders with filters.
10620
+
10621
+ </dd>
10622
+ </dl>
10623
+ </dd>
10624
+ </dl>
10625
+
10626
+ #### 🔌 Usage
10627
+
10628
+ <dl>
10629
+ <dd>
10630
+
10631
+ <dl>
10632
+ <dd>
10633
+
10634
+ ```typescript
10635
+ await client.labTests.getOrders();
10636
+ ```
10637
+
10638
+ </dd>
10639
+ </dl>
10640
+ </dd>
10641
+ </dl>
10642
+
10643
+ #### ⚙️ Parameters
10644
+
10645
+ <dl>
10646
+ <dd>
10647
+
10648
+ <dl>
10649
+ <dd>
10650
+
10651
+ **request:** `Vital.LabTestsGetOrdersRequest`
10652
+
10653
+ </dd>
10654
+ </dl>
10655
+
10656
+ <dl>
10657
+ <dd>
10658
+
10659
+ **requestOptions:** `LabTests.RequestOptions`
10660
+
10661
+ </dd>
10662
+ </dl>
10663
+ </dd>
10664
+ </dl>
10665
+
10666
+ </dd>
10667
+ </dl>
10668
+ </details>
10669
+
10670
+ ## Testkit
10671
+
10672
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">register</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10673
+ <dl>
10674
+ <dd>
10675
+
10676
+ #### 🔌 Usage
10677
+
10678
+ <dl>
10679
+ <dd>
10680
+
10681
+ <dl>
10682
+ <dd>
10683
+
10684
+ ```typescript
10685
+ await client.testkit.register({
10686
+ sampleId: "sample_id",
10687
+ patientDetails: {
10688
+ firstName: "first_name",
10689
+ lastName: "last_name",
10690
+ dob: "dob",
10691
+ gender: "female",
10692
+ phoneNumber: "phone_number",
10693
+ email: "email",
10694
+ },
10695
+ patientAddress: {
10696
+ firstLine: "first_line",
10697
+ city: "city",
10698
+ state: "state",
10699
+ zip: "zip",
10700
+ country: "country",
10701
+ },
10702
+ });
10703
+ ```
10704
+
10705
+ </dd>
10706
+ </dl>
10707
+ </dd>
10708
+ </dl>
10709
+
10710
+ #### ⚙️ Parameters
10711
+
10712
+ <dl>
10713
+ <dd>
10714
+
10715
+ <dl>
10716
+ <dd>
10717
+
10718
+ **request:** `Vital.RegisterTestkitRequest`
10719
+
10720
+ </dd>
10721
+ </dl>
10722
+
10723
+ <dl>
10724
+ <dd>
10725
+
10726
+ **requestOptions:** `Testkit.RequestOptions`
10727
+
10728
+ </dd>
10729
+ </dl>
10730
+ </dd>
10731
+ </dl>
10732
+
10733
+ </dd>
10734
+ </dl>
10735
+ </details>
10736
+
10737
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10738
+ <dl>
10739
+ <dd>
10740
+
10741
+ #### 📝 Description
10742
+
10743
+ <dl>
10744
+ <dd>
10745
+
10746
+ <dl>
10747
+ <dd>
10748
+
10749
+ Creates an order for an unregistered testkit
10750
+
10751
+ </dd>
10752
+ </dl>
10753
+ </dd>
10754
+ </dl>
10755
+
10756
+ #### 🔌 Usage
10757
+
10758
+ <dl>
10759
+ <dd>
10760
+
10761
+ <dl>
10762
+ <dd>
10763
+
10764
+ ```typescript
10765
+ await client.testkit.createOrder({
10766
+ userId: "user_id",
10767
+ labTestId: "lab_test_id",
10768
+ shippingDetails: {
10769
+ receiverName: "receiver_name",
10770
+ firstLine: "first_line",
10771
+ city: "city",
10772
+ state: "state",
10773
+ zip: "zip",
10774
+ country: "country",
10775
+ phoneNumber: "phone_number",
10776
+ },
10777
+ });
10778
+ ```
10779
+
10780
+ </dd>
10781
+ </dl>
10782
+ </dd>
10783
+ </dl>
10784
+
10785
+ #### ⚙️ Parameters
10786
+
10787
+ <dl>
10788
+ <dd>
10789
+
10790
+ <dl>
10791
+ <dd>
10792
+
10793
+ **request:** `Vital.CreateRegistrableTestkitOrderRequest`
10794
+
10795
+ </dd>
10796
+ </dl>
10797
+
10798
+ <dl>
10799
+ <dd>
10800
+
10801
+ **requestOptions:** `Testkit.RequestOptions`
10802
+
10803
+ </dd>
10804
+ </dl>
10805
+ </dd>
10806
+ </dl>
10807
+
10808
+ </dd>
10809
+ </dl>
10810
+ </details>
10811
+
10812
+ ## Order
10813
+
10814
+ <details><summary><code>client.order.<a href="/src/api/resources/order/client/Client.ts">resendEvents</a>({ ...params }) -> Vital.ResendWebhookResponse</code></summary>
10815
+ <dl>
10816
+ <dd>
10817
+
10818
+ #### 📝 Description
10819
+
10820
+ <dl>
10821
+ <dd>
10822
+
10823
+ <dl>
10824
+ <dd>
10825
+
10826
+ Replay a webhook for a given set of orders
10827
+
10828
+ </dd>
10829
+ </dl>
10830
+ </dd>
10831
+ </dl>
10832
+
10833
+ #### 🔌 Usage
10834
+
10835
+ <dl>
10836
+ <dd>
10837
+
10838
+ <dl>
10839
+ <dd>
10840
+
10841
+ ```typescript
10842
+ await client.order.resendEvents();
10843
+ ```
10844
+
10845
+ </dd>
10846
+ </dl>
10847
+ </dd>
10848
+ </dl>
10849
+
10850
+ #### ⚙️ Parameters
10851
+
10852
+ <dl>
10853
+ <dd>
10854
+
10855
+ <dl>
10856
+ <dd>
10857
+
10858
+ **request:** `Vital.ResendWebhookBody`
10859
+
10860
+ </dd>
10861
+ </dl>
10862
+
10863
+ <dl>
10864
+ <dd>
10865
+
10866
+ **requestOptions:** `Order.RequestOptions`
10867
+
10868
+ </dd>
10869
+ </dl>
10870
+ </dd>
10871
+ </dl>
10872
+
10873
+ </dd>
10874
+ </dl>
10875
+ </details>
10876
+
10877
+ ## Insurance
10878
+
10879
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchGetPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponse[]</code></summary>
10880
+ <dl>
10881
+ <dd>
10882
+
10883
+ #### 🔌 Usage
10884
+
10885
+ <dl>
10886
+ <dd>
10887
+
10888
+ <dl>
10889
+ <dd>
10890
+
10891
+ ```typescript
10892
+ await client.insurance.searchGetPayorInfo();
10893
+ ```
10894
+
10895
+ </dd>
10896
+ </dl>
10897
+ </dd>
10898
+ </dl>
10899
+
10900
+ #### ⚙️ Parameters
10901
+
10902
+ <dl>
10903
+ <dd>
10904
+
10905
+ <dl>
10906
+ <dd>
10907
+
10908
+ **request:** `Vital.InsuranceSearchGetPayorInfoRequest`
10909
+
10910
+ </dd>
10911
+ </dl>
10912
+
10913
+ <dl>
10914
+ <dd>
10915
+
10916
+ **requestOptions:** `Insurance.RequestOptions`
10917
+
10918
+ </dd>
10919
+ </dl>
10920
+ </dd>
10921
+ </dl>
10922
+
10923
+ </dd>
10924
+ </dl>
10925
+ </details>
10926
+
10927
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponseDeprecated[]</code></summary>
10928
+ <dl>
10929
+ <dd>
10930
+
10931
+ #### 🔌 Usage
10932
+
10933
+ <dl>
10934
+ <dd>
10935
+
10936
+ <dl>
10937
+ <dd>
10938
+
10939
+ ```typescript
10940
+ await client.insurance.searchPayorInfo();
10941
+ ```
10942
+
10943
+ </dd>
10944
+ </dl>
10945
+ </dd>
10946
+ </dl>
10947
+
10948
+ #### ⚙️ Parameters
10949
+
10950
+ <dl>
10951
+ <dd>
10952
+
10953
+ <dl>
10954
+ <dd>
10955
+
10956
+ **request:** `Vital.PayorSearchRequest`
10957
+
10958
+ </dd>
10959
+ </dl>
10960
+
10961
+ <dl>
10962
+ <dd>
10963
+
10964
+ **requestOptions:** `Insurance.RequestOptions`
10965
+
10966
+ </dd>
10967
+ </dl>
10968
+ </dd>
10969
+ </dl>
10970
+
10971
+ </dd>
10972
+ </dl>
10973
+ </details>
10974
+
10975
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchDiagnosis</a>({ ...params }) -> Vital.ClientFacingDiagnosisInformation[]</code></summary>
10976
+ <dl>
10977
+ <dd>
10978
+
10979
+ #### 🔌 Usage
10980
+
10981
+ <dl>
10982
+ <dd>
10983
+
10984
+ <dl>
10985
+ <dd>
10986
+
10987
+ ```typescript
10988
+ await client.insurance.searchDiagnosis({
10989
+ diagnosisQuery: "diagnosis_query",
10990
+ });
10991
+ ```
10992
+
10993
+ </dd>
10994
+ </dl>
10995
+ </dd>
10996
+ </dl>
10997
+
10998
+ #### ⚙️ Parameters
10999
+
11000
+ <dl>
11001
+ <dd>
11002
+
11003
+ <dl>
11004
+ <dd>
11005
+
11006
+ **request:** `Vital.InsuranceSearchDiagnosisRequest`
11007
+
11008
+ </dd>
11009
+ </dl>
11010
+
11011
+ <dl>
11012
+ <dd>
11013
+
11014
+ **requestOptions:** `Insurance.RequestOptions`
11015
+
11016
+ </dd>
11017
+ </dl>
11018
+ </dd>
11019
+ </dl>
11020
+
11021
+ </dd>
11022
+ </dl>
11023
+ </details>
11024
+
11025
+ ## Aggregate
11026
+
11027
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">queryOne</a>(userId, { ...params }) -> Vital.AggregationResponse</code></summary>
11028
+ <dl>
11029
+ <dd>
11030
+
11031
+ #### 🔌 Usage
11032
+
11033
+ <dl>
11034
+ <dd>
11035
+
11036
+ <dl>
11037
+ <dd>
11038
+
11039
+ ```typescript
11040
+ await client.aggregate.queryOne("user_id", {
11041
+ timeframe: {
11042
+ type: "relative",
11043
+ anchor: "anchor",
11044
+ past: {
11045
+ unit: "minute",
11046
+ },
11047
+ },
11048
+ queries: [
11049
+ {
11050
+ select: [
11051
+ {
11052
+ arg: {
11053
+ sleep: "session_start",
11054
+ },
11055
+ func: "mean",
11056
+ },
11057
+ ],
11058
+ },
11059
+ ],
11060
+ });
11061
+ ```
11062
+
11063
+ </dd>
11064
+ </dl>
11065
+ </dd>
11066
+ </dl>
11067
+
11068
+ #### ⚙️ Parameters
11069
+
11070
+ <dl>
11071
+ <dd>
11072
+
11073
+ <dl>
11074
+ <dd>
11075
+
11076
+ **userId:** `string`
11077
+
11078
+ </dd>
11079
+ </dl>
11080
+
11081
+ <dl>
11082
+ <dd>
11083
+
11084
+ **request:** `Vital.QueryBatch`
11085
+
11086
+ </dd>
11087
+ </dl>
11088
+
11089
+ <dl>
11090
+ <dd>
11091
+
11092
+ **requestOptions:** `Aggregate.RequestOptions`
11093
+
11094
+ </dd>
11095
+ </dl>
11096
+ </dd>
11097
+ </dl>
11098
+
11099
+ </dd>
11100
+ </dl>
11101
+ </details>
11102
+
11103
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">getResultTableForContinuousQuery</a>(userId, queryIdOrSlug) -> Vital.AggregationResult</code></summary>
11104
+ <dl>
11105
+ <dd>
11106
+
11107
+ #### 🔌 Usage
11108
+
11109
+ <dl>
11110
+ <dd>
11111
+
11112
+ <dl>
11113
+ <dd>
11114
+
11115
+ ```typescript
11116
+ await client.aggregate.getResultTableForContinuousQuery("user_id", "query_id_or_slug");
11117
+ ```
11118
+
11119
+ </dd>
11120
+ </dl>
11121
+ </dd>
11122
+ </dl>
11123
+
11124
+ #### ⚙️ Parameters
11125
+
11126
+ <dl>
11127
+ <dd>
11128
+
11129
+ <dl>
11130
+ <dd>
11131
+
11132
+ **userId:** `string`
11133
+
11134
+ </dd>
11135
+ </dl>
11136
+
11137
+ <dl>
11138
+ <dd>
11139
+
11140
+ **queryIdOrSlug:** `string`
11141
+
11142
+ </dd>
11143
+ </dl>
11144
+
11145
+ <dl>
11146
+ <dd>
11147
+
11148
+ **requestOptions:** `Aggregate.RequestOptions`
11149
+
11150
+ </dd>
11151
+ </dl>
11152
+ </dd>
11153
+ </dl>
11154
+
11155
+ </dd>
11156
+ </dl>
11157
+ </details>
11158
+
11159
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">getTaskHistoryForContinuousQuery</a>(userId, queryIdOrSlug, { ...params }) -> Vital.ContinuousQueryTaskHistoryResponse</code></summary>
11160
+ <dl>
11161
+ <dd>
11162
+
11163
+ #### 🔌 Usage
11164
+
11165
+ <dl>
11166
+ <dd>
11167
+
11168
+ <dl>
11169
+ <dd>
11170
+
11171
+ ```typescript
11172
+ await client.aggregate.getTaskHistoryForContinuousQuery("user_id", "query_id_or_slug");
11173
+ ```
11174
+
11175
+ </dd>
11176
+ </dl>
11177
+ </dd>
11178
+ </dl>
11179
+
11180
+ #### ⚙️ Parameters
11181
+
11182
+ <dl>
11183
+ <dd>
11184
+
11185
+ <dl>
11186
+ <dd>
11187
+
11188
+ **userId:** `string`
11189
+
11190
+ </dd>
11191
+ </dl>
11192
+
11193
+ <dl>
11194
+ <dd>
11195
+
11196
+ **queryIdOrSlug:** `string`
11197
+
11198
+ </dd>
11199
+ </dl>
11200
+
11201
+ <dl>
11202
+ <dd>
11203
+
11204
+ **request:** `Vital.AggregateGetTaskHistoryForContinuousQueryRequest`
11205
+
11206
+ </dd>
11207
+ </dl>
11208
+
11209
+ <dl>
11210
+ <dd>
11211
+
11212
+ **requestOptions:** `Aggregate.RequestOptions`
11213
+
11214
+ </dd>
11215
+ </dl>
11216
+ </dd>
11217
+ </dl>
11218
+
11219
+ </dd>
11220
+ </dl>
11221
+ </details>