@tryvital/vital-node 3.1.78 → 3.1.80

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 (42) hide show
  1. package/api/resources/activity/client/Client.js +2 -2
  2. package/api/resources/aggregate/client/Client.js +1 -1
  3. package/api/resources/body/client/Client.js +2 -2
  4. package/api/resources/devices/client/Client.js +1 -1
  5. package/api/resources/insurance/client/Client.js +2 -2
  6. package/api/resources/introspect/client/Client.js +2 -2
  7. package/api/resources/labTests/client/Client.js +28 -28
  8. package/api/resources/link/client/Client.js +14 -14
  9. package/api/resources/meal/client/Client.js +1 -1
  10. package/api/resources/menstrualCycle/client/Client.js +1 -1
  11. package/api/resources/profile/client/Client.js +2 -2
  12. package/api/resources/providers/client/Client.js +1 -1
  13. package/api/resources/sleep/client/Client.js +4 -4
  14. package/api/resources/team/client/Client.js +7 -7
  15. package/api/resources/testkit/client/Client.js +2 -2
  16. package/api/resources/user/client/Client.js +16 -16
  17. package/api/resources/vitals/client/Client.js +56 -56
  18. package/api/resources/workouts/client/Client.js +3 -3
  19. package/dist/api/resources/activity/client/Client.js +2 -2
  20. package/dist/api/resources/aggregate/client/Client.js +1 -1
  21. package/dist/api/resources/body/client/Client.js +2 -2
  22. package/dist/api/resources/devices/client/Client.js +1 -1
  23. package/dist/api/resources/insurance/client/Client.js +2 -2
  24. package/dist/api/resources/introspect/client/Client.js +2 -2
  25. package/dist/api/resources/labTests/client/Client.js +28 -28
  26. package/dist/api/resources/link/client/Client.js +14 -14
  27. package/dist/api/resources/meal/client/Client.js +1 -1
  28. package/dist/api/resources/menstrualCycle/client/Client.js +1 -1
  29. package/dist/api/resources/profile/client/Client.js +2 -2
  30. package/dist/api/resources/providers/client/Client.js +1 -1
  31. package/dist/api/resources/sleep/client/Client.js +4 -4
  32. package/dist/api/resources/team/client/Client.js +7 -7
  33. package/dist/api/resources/testkit/client/Client.js +2 -2
  34. package/dist/api/resources/user/client/Client.js +16 -16
  35. package/dist/api/resources/vitals/client/Client.js +56 -56
  36. package/dist/api/resources/workouts/client/Client.js +3 -3
  37. package/dist/version.d.ts +1 -1
  38. package/dist/version.js +1 -1
  39. package/package.json +1 -1
  40. package/reference.md +3337 -0
  41. package/version.d.ts +1 -1
  42. package/version.js +1 -1
package/reference.md CHANGED
@@ -5603,3 +5603,3340 @@ await client.user.getConnectedProviders("user_id");
5603
5603
 
5604
5604
  </dd>
5605
5605
  </dl>
5606
+ </details>
5607
+
5608
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Vital.ClientFacingUser</code></summary>
5609
+ <dl>
5610
+ <dd>
5611
+
5612
+ #### 📝 Description
5613
+
5614
+ <dl>
5615
+ <dd>
5616
+
5617
+ <dl>
5618
+ <dd>
5619
+
5620
+ GET User details given the user_id.
5621
+
5622
+ </dd>
5623
+ </dl>
5624
+ </dd>
5625
+ </dl>
5626
+
5627
+ #### 🔌 Usage
5628
+
5629
+ <dl>
5630
+ <dd>
5631
+
5632
+ <dl>
5633
+ <dd>
5634
+
5635
+ ```typescript
5636
+ await client.user.get("user_id");
5637
+ ```
5638
+
5639
+ </dd>
5640
+ </dl>
5641
+ </dd>
5642
+ </dl>
5643
+
5644
+ #### ⚙️ Parameters
5645
+
5646
+ <dl>
5647
+ <dd>
5648
+
5649
+ <dl>
5650
+ <dd>
5651
+
5652
+ **userId:** `string`
5653
+
5654
+ </dd>
5655
+ </dl>
5656
+
5657
+ <dl>
5658
+ <dd>
5659
+
5660
+ **requestOptions:** `User.RequestOptions`
5661
+
5662
+ </dd>
5663
+ </dl>
5664
+ </dd>
5665
+ </dl>
5666
+
5667
+ </dd>
5668
+ </dl>
5669
+ </details>
5670
+
5671
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Vital.UserSuccessResponse</code></summary>
5672
+ <dl>
5673
+ <dd>
5674
+
5675
+ #### 🔌 Usage
5676
+
5677
+ <dl>
5678
+ <dd>
5679
+
5680
+ <dl>
5681
+ <dd>
5682
+
5683
+ ```typescript
5684
+ await client.user.delete("user_id");
5685
+ ```
5686
+
5687
+ </dd>
5688
+ </dl>
5689
+ </dd>
5690
+ </dl>
5691
+
5692
+ #### ⚙️ Parameters
5693
+
5694
+ <dl>
5695
+ <dd>
5696
+
5697
+ <dl>
5698
+ <dd>
5699
+
5700
+ **userId:** `string`
5701
+
5702
+ </dd>
5703
+ </dl>
5704
+
5705
+ <dl>
5706
+ <dd>
5707
+
5708
+ **requestOptions:** `User.RequestOptions`
5709
+
5710
+ </dd>
5711
+ </dl>
5712
+ </dd>
5713
+ </dl>
5714
+
5715
+ </dd>
5716
+ </dl>
5717
+ </details>
5718
+
5719
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">patch</a>(userId, { ...params }) -> void</code></summary>
5720
+ <dl>
5721
+ <dd>
5722
+
5723
+ #### 🔌 Usage
5724
+
5725
+ <dl>
5726
+ <dd>
5727
+
5728
+ <dl>
5729
+ <dd>
5730
+
5731
+ ```typescript
5732
+ await client.user.patch("user_id");
5733
+ ```
5734
+
5735
+ </dd>
5736
+ </dl>
5737
+ </dd>
5738
+ </dl>
5739
+
5740
+ #### ⚙️ Parameters
5741
+
5742
+ <dl>
5743
+ <dd>
5744
+
5745
+ <dl>
5746
+ <dd>
5747
+
5748
+ **userId:** `string`
5749
+
5750
+ </dd>
5751
+ </dl>
5752
+
5753
+ <dl>
5754
+ <dd>
5755
+
5756
+ **request:** `Vital.UserPatchBody`
5757
+
5758
+ </dd>
5759
+ </dl>
5760
+
5761
+ <dl>
5762
+ <dd>
5763
+
5764
+ **requestOptions:** `User.RequestOptions`
5765
+
5766
+ </dd>
5767
+ </dl>
5768
+ </dd>
5769
+ </dl>
5770
+
5771
+ </dd>
5772
+ </dl>
5773
+ </details>
5774
+
5775
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestUserInfo</a>(userId) -> Vital.UserInfo</code></summary>
5776
+ <dl>
5777
+ <dd>
5778
+
5779
+ #### 🔌 Usage
5780
+
5781
+ <dl>
5782
+ <dd>
5783
+
5784
+ <dl>
5785
+ <dd>
5786
+
5787
+ ```typescript
5788
+ await client.user.getLatestUserInfo("user_id");
5789
+ ```
5790
+
5791
+ </dd>
5792
+ </dl>
5793
+ </dd>
5794
+ </dl>
5795
+
5796
+ #### ⚙️ Parameters
5797
+
5798
+ <dl>
5799
+ <dd>
5800
+
5801
+ <dl>
5802
+ <dd>
5803
+
5804
+ **userId:** `string`
5805
+
5806
+ </dd>
5807
+ </dl>
5808
+
5809
+ <dl>
5810
+ <dd>
5811
+
5812
+ **requestOptions:** `User.RequestOptions`
5813
+
5814
+ </dd>
5815
+ </dl>
5816
+ </dd>
5817
+ </dl>
5818
+
5819
+ </dd>
5820
+ </dl>
5821
+ </details>
5822
+
5823
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createInsurance</a>(userId, { ...params }) -> Vital.ClientFacingInsurance</code></summary>
5824
+ <dl>
5825
+ <dd>
5826
+
5827
+ #### 🔌 Usage
5828
+
5829
+ <dl>
5830
+ <dd>
5831
+
5832
+ <dl>
5833
+ <dd>
5834
+
5835
+ ```typescript
5836
+ await client.user.createInsurance("user_id", {
5837
+ payorCode: "payor_code",
5838
+ memberId: "member_id",
5839
+ relationship: Vital.ResponsibleRelationship.Self,
5840
+ insured: {
5841
+ firstName: "first_name",
5842
+ lastName: "last_name",
5843
+ gender: Vital.Gender.Female,
5844
+ address: {
5845
+ firstLine: "first_line",
5846
+ country: "country",
5847
+ zip: "zip",
5848
+ city: "city",
5849
+ state: "state",
5850
+ },
5851
+ dob: "dob",
5852
+ email: "email",
5853
+ phoneNumber: "phone_number",
5854
+ },
5855
+ });
5856
+ ```
5857
+
5858
+ </dd>
5859
+ </dl>
5860
+ </dd>
5861
+ </dl>
5862
+
5863
+ #### ⚙️ Parameters
5864
+
5865
+ <dl>
5866
+ <dd>
5867
+
5868
+ <dl>
5869
+ <dd>
5870
+
5871
+ **userId:** `string`
5872
+
5873
+ </dd>
5874
+ </dl>
5875
+
5876
+ <dl>
5877
+ <dd>
5878
+
5879
+ **request:** `Vital.CreateInsuranceRequest`
5880
+
5881
+ </dd>
5882
+ </dl>
5883
+
5884
+ <dl>
5885
+ <dd>
5886
+
5887
+ **requestOptions:** `User.RequestOptions`
5888
+
5889
+ </dd>
5890
+ </dl>
5891
+ </dd>
5892
+ </dl>
5893
+
5894
+ </dd>
5895
+ </dl>
5896
+ </details>
5897
+
5898
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestInsurance</a>(userId) -> Vital.ClientFacingInsurance</code></summary>
5899
+ <dl>
5900
+ <dd>
5901
+
5902
+ #### 🔌 Usage
5903
+
5904
+ <dl>
5905
+ <dd>
5906
+
5907
+ <dl>
5908
+ <dd>
5909
+
5910
+ ```typescript
5911
+ await client.user.getLatestInsurance("user_id");
5912
+ ```
5913
+
5914
+ </dd>
5915
+ </dl>
5916
+ </dd>
5917
+ </dl>
5918
+
5919
+ #### ⚙️ Parameters
5920
+
5921
+ <dl>
5922
+ <dd>
5923
+
5924
+ <dl>
5925
+ <dd>
5926
+
5927
+ **userId:** `string`
5928
+
5929
+ </dd>
5930
+ </dl>
5931
+
5932
+ <dl>
5933
+ <dd>
5934
+
5935
+ **requestOptions:** `User.RequestOptions`
5936
+
5937
+ </dd>
5938
+ </dl>
5939
+ </dd>
5940
+ </dl>
5941
+
5942
+ </dd>
5943
+ </dl>
5944
+ </details>
5945
+
5946
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">upsertUserInfo</a>(userId, { ...params }) -> Vital.UserInfo</code></summary>
5947
+ <dl>
5948
+ <dd>
5949
+
5950
+ #### 🔌 Usage
5951
+
5952
+ <dl>
5953
+ <dd>
5954
+
5955
+ <dl>
5956
+ <dd>
5957
+
5958
+ ```typescript
5959
+ await client.user.upsertUserInfo("user_id", {
5960
+ firstName: "first_name",
5961
+ lastName: "last_name",
5962
+ email: "email",
5963
+ phoneNumber: "phone_number",
5964
+ gender: "gender",
5965
+ dob: "dob",
5966
+ address: {
5967
+ firstLine: "first_line",
5968
+ country: "country",
5969
+ zip: "zip",
5970
+ city: "city",
5971
+ state: "state",
5972
+ },
5973
+ });
5974
+ ```
5975
+
5976
+ </dd>
5977
+ </dl>
5978
+ </dd>
5979
+ </dl>
5980
+
5981
+ #### ⚙️ Parameters
5982
+
5983
+ <dl>
5984
+ <dd>
5985
+
5986
+ <dl>
5987
+ <dd>
5988
+
5989
+ **userId:** `string`
5990
+
5991
+ </dd>
5992
+ </dl>
5993
+
5994
+ <dl>
5995
+ <dd>
5996
+
5997
+ **request:** `Vital.UserInfoCreateRequest`
5998
+
5999
+ </dd>
6000
+ </dl>
6001
+
6002
+ <dl>
6003
+ <dd>
6004
+
6005
+ **requestOptions:** `User.RequestOptions`
6006
+
6007
+ </dd>
6008
+ </dl>
6009
+ </dd>
6010
+ </dl>
6011
+
6012
+ </dd>
6013
+ </dl>
6014
+ </details>
6015
+
6016
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getByClientUserId</a>(clientUserId) -> Vital.ClientFacingUser</code></summary>
6017
+ <dl>
6018
+ <dd>
6019
+
6020
+ #### 📝 Description
6021
+
6022
+ <dl>
6023
+ <dd>
6024
+
6025
+ <dl>
6026
+ <dd>
6027
+
6028
+ GET user_id from client_user_id.
6029
+
6030
+ </dd>
6031
+ </dl>
6032
+ </dd>
6033
+ </dl>
6034
+
6035
+ #### 🔌 Usage
6036
+
6037
+ <dl>
6038
+ <dd>
6039
+
6040
+ <dl>
6041
+ <dd>
6042
+
6043
+ ```typescript
6044
+ await client.user.getByClientUserId("client_user_id");
6045
+ ```
6046
+
6047
+ </dd>
6048
+ </dl>
6049
+ </dd>
6050
+ </dl>
6051
+
6052
+ #### ⚙️ Parameters
6053
+
6054
+ <dl>
6055
+ <dd>
6056
+
6057
+ <dl>
6058
+ <dd>
6059
+
6060
+ **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.
6061
+
6062
+ </dd>
6063
+ </dl>
6064
+
6065
+ <dl>
6066
+ <dd>
6067
+
6068
+ **requestOptions:** `User.RequestOptions`
6069
+
6070
+ </dd>
6071
+ </dl>
6072
+ </dd>
6073
+ </dl>
6074
+
6075
+ </dd>
6076
+ </dl>
6077
+ </details>
6078
+
6079
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deregisterProvider</a>(userId, provider) -> Vital.UserSuccessResponse</code></summary>
6080
+ <dl>
6081
+ <dd>
6082
+
6083
+ #### 🔌 Usage
6084
+
6085
+ <dl>
6086
+ <dd>
6087
+
6088
+ <dl>
6089
+ <dd>
6090
+
6091
+ ```typescript
6092
+ await client.user.deregisterProvider("user_id", Vital.Providers.Oura);
6093
+ ```
6094
+
6095
+ </dd>
6096
+ </dl>
6097
+ </dd>
6098
+ </dl>
6099
+
6100
+ #### ⚙️ Parameters
6101
+
6102
+ <dl>
6103
+ <dd>
6104
+
6105
+ <dl>
6106
+ <dd>
6107
+
6108
+ **userId:** `string`
6109
+
6110
+ </dd>
6111
+ </dl>
6112
+
6113
+ <dl>
6114
+ <dd>
6115
+
6116
+ **provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
6117
+
6118
+ </dd>
6119
+ </dl>
6120
+
6121
+ <dl>
6122
+ <dd>
6123
+
6124
+ **requestOptions:** `User.RequestOptions`
6125
+
6126
+ </dd>
6127
+ </dl>
6128
+ </dd>
6129
+ </dl>
6130
+
6131
+ </dd>
6132
+ </dl>
6133
+ </details>
6134
+
6135
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
6136
+ <dl>
6137
+ <dd>
6138
+
6139
+ #### 🔌 Usage
6140
+
6141
+ <dl>
6142
+ <dd>
6143
+
6144
+ <dl>
6145
+ <dd>
6146
+
6147
+ ```typescript
6148
+ await client.user.undoDelete();
6149
+ ```
6150
+
6151
+ </dd>
6152
+ </dl>
6153
+ </dd>
6154
+ </dl>
6155
+
6156
+ #### ⚙️ Parameters
6157
+
6158
+ <dl>
6159
+ <dd>
6160
+
6161
+ <dl>
6162
+ <dd>
6163
+
6164
+ **request:** `Vital.UserUndoDeleteRequest`
6165
+
6166
+ </dd>
6167
+ </dl>
6168
+
6169
+ <dl>
6170
+ <dd>
6171
+
6172
+ **requestOptions:** `User.RequestOptions`
6173
+
6174
+ </dd>
6175
+ </dl>
6176
+ </dd>
6177
+ </dl>
6178
+
6179
+ </dd>
6180
+ </dl>
6181
+ </details>
6182
+
6183
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
6184
+ <dl>
6185
+ <dd>
6186
+
6187
+ #### 📝 Description
6188
+
6189
+ <dl>
6190
+ <dd>
6191
+
6192
+ <dl>
6193
+ <dd>
6194
+
6195
+ Trigger a manual refresh for a specific user
6196
+
6197
+ </dd>
6198
+ </dl>
6199
+ </dd>
6200
+ </dl>
6201
+
6202
+ #### 🔌 Usage
6203
+
6204
+ <dl>
6205
+ <dd>
6206
+
6207
+ <dl>
6208
+ <dd>
6209
+
6210
+ ```typescript
6211
+ await client.user.refresh("user_id");
6212
+ ```
6213
+
6214
+ </dd>
6215
+ </dl>
6216
+ </dd>
6217
+ </dl>
6218
+
6219
+ #### ⚙️ Parameters
6220
+
6221
+ <dl>
6222
+ <dd>
6223
+
6224
+ <dl>
6225
+ <dd>
6226
+
6227
+ **userId:** `string`
6228
+
6229
+ </dd>
6230
+ </dl>
6231
+
6232
+ <dl>
6233
+ <dd>
6234
+
6235
+ **request:** `Vital.UserRefreshRequest`
6236
+
6237
+ </dd>
6238
+ </dl>
6239
+
6240
+ <dl>
6241
+ <dd>
6242
+
6243
+ **requestOptions:** `User.RequestOptions`
6244
+
6245
+ </dd>
6246
+ </dl>
6247
+ </dd>
6248
+ </dl>
6249
+
6250
+ </dd>
6251
+ </dl>
6252
+ </details>
6253
+
6254
+ ## Team
6255
+
6256
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getLinkConfig</a>({ ...params }) -> Record<string, unknown></code></summary>
6257
+ <dl>
6258
+ <dd>
6259
+
6260
+ #### 📝 Description
6261
+
6262
+ <dl>
6263
+ <dd>
6264
+
6265
+ <dl>
6266
+ <dd>
6267
+
6268
+ Post teams.
6269
+
6270
+ </dd>
6271
+ </dl>
6272
+ </dd>
6273
+ </dl>
6274
+
6275
+ #### 🔌 Usage
6276
+
6277
+ <dl>
6278
+ <dd>
6279
+
6280
+ <dl>
6281
+ <dd>
6282
+
6283
+ ```typescript
6284
+ await client.team.getLinkConfig();
6285
+ ```
6286
+
6287
+ </dd>
6288
+ </dl>
6289
+ </dd>
6290
+ </dl>
6291
+
6292
+ #### ⚙️ Parameters
6293
+
6294
+ <dl>
6295
+ <dd>
6296
+
6297
+ <dl>
6298
+ <dd>
6299
+
6300
+ **request:** `Vital.TeamGetLinkConfigRequest`
6301
+
6302
+ </dd>
6303
+ </dl>
6304
+
6305
+ <dl>
6306
+ <dd>
6307
+
6308
+ **requestOptions:** `Team.RequestOptions`
6309
+
6310
+ </dd>
6311
+ </dl>
6312
+ </dd>
6313
+ </dl>
6314
+
6315
+ </dd>
6316
+ </dl>
6317
+ </details>
6318
+
6319
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">get</a>(teamId) -> Vital.ClientFacingTeam</code></summary>
6320
+ <dl>
6321
+ <dd>
6322
+
6323
+ #### 📝 Description
6324
+
6325
+ <dl>
6326
+ <dd>
6327
+
6328
+ <dl>
6329
+ <dd>
6330
+
6331
+ Get team.
6332
+
6333
+ </dd>
6334
+ </dl>
6335
+ </dd>
6336
+ </dl>
6337
+
6338
+ #### 🔌 Usage
6339
+
6340
+ <dl>
6341
+ <dd>
6342
+
6343
+ <dl>
6344
+ <dd>
6345
+
6346
+ ```typescript
6347
+ await client.team.get("team_id");
6348
+ ```
6349
+
6350
+ </dd>
6351
+ </dl>
6352
+ </dd>
6353
+ </dl>
6354
+
6355
+ #### ⚙️ Parameters
6356
+
6357
+ <dl>
6358
+ <dd>
6359
+
6360
+ <dl>
6361
+ <dd>
6362
+
6363
+ **teamId:** `string`
6364
+
6365
+ </dd>
6366
+ </dl>
6367
+
6368
+ <dl>
6369
+ <dd>
6370
+
6371
+ **requestOptions:** `Team.RequestOptions`
6372
+
6373
+ </dd>
6374
+ </dl>
6375
+ </dd>
6376
+ </dl>
6377
+
6378
+ </dd>
6379
+ </dl>
6380
+ </details>
6381
+
6382
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getUserById</a>({ ...params }) -> Vital.ClientFacingUser[]</code></summary>
6383
+ <dl>
6384
+ <dd>
6385
+
6386
+ #### 📝 Description
6387
+
6388
+ <dl>
6389
+ <dd>
6390
+
6391
+ <dl>
6392
+ <dd>
6393
+
6394
+ Search team users by user_id
6395
+
6396
+ </dd>
6397
+ </dl>
6398
+ </dd>
6399
+ </dl>
6400
+
6401
+ #### 🔌 Usage
6402
+
6403
+ <dl>
6404
+ <dd>
6405
+
6406
+ <dl>
6407
+ <dd>
6408
+
6409
+ ```typescript
6410
+ await client.team.getUserById();
6411
+ ```
6412
+
6413
+ </dd>
6414
+ </dl>
6415
+ </dd>
6416
+ </dl>
6417
+
6418
+ #### ⚙️ Parameters
6419
+
6420
+ <dl>
6421
+ <dd>
6422
+
6423
+ <dl>
6424
+ <dd>
6425
+
6426
+ **request:** `Vital.TeamGetUserByIdRequest`
6427
+
6428
+ </dd>
6429
+ </dl>
6430
+
6431
+ <dl>
6432
+ <dd>
6433
+
6434
+ **requestOptions:** `Team.RequestOptions`
6435
+
6436
+ </dd>
6437
+ </dl>
6438
+ </dd>
6439
+ </dl>
6440
+
6441
+ </dd>
6442
+ </dl>
6443
+ </details>
6444
+
6445
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSvixUrl</a>() -> Record<string, unknown></code></summary>
6446
+ <dl>
6447
+ <dd>
6448
+
6449
+ #### 🔌 Usage
6450
+
6451
+ <dl>
6452
+ <dd>
6453
+
6454
+ <dl>
6455
+ <dd>
6456
+
6457
+ ```typescript
6458
+ await client.team.getSvixUrl();
6459
+ ```
6460
+
6461
+ </dd>
6462
+ </dl>
6463
+ </dd>
6464
+ </dl>
6465
+
6466
+ #### ⚙️ Parameters
6467
+
6468
+ <dl>
6469
+ <dd>
6470
+
6471
+ <dl>
6472
+ <dd>
6473
+
6474
+ **requestOptions:** `Team.RequestOptions`
6475
+
6476
+ </dd>
6477
+ </dl>
6478
+ </dd>
6479
+ </dl>
6480
+
6481
+ </dd>
6482
+ </dl>
6483
+ </details>
6484
+
6485
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSourcePriorities</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
6486
+ <dl>
6487
+ <dd>
6488
+
6489
+ #### 📝 Description
6490
+
6491
+ <dl>
6492
+ <dd>
6493
+
6494
+ <dl>
6495
+ <dd>
6496
+
6497
+ GET source priorities.
6498
+
6499
+ </dd>
6500
+ </dl>
6501
+ </dd>
6502
+ </dl>
6503
+
6504
+ #### 🔌 Usage
6505
+
6506
+ <dl>
6507
+ <dd>
6508
+
6509
+ <dl>
6510
+ <dd>
6511
+
6512
+ ```typescript
6513
+ await client.team.getSourcePriorities();
6514
+ ```
6515
+
6516
+ </dd>
6517
+ </dl>
6518
+ </dd>
6519
+ </dl>
6520
+
6521
+ #### ⚙️ Parameters
6522
+
6523
+ <dl>
6524
+ <dd>
6525
+
6526
+ <dl>
6527
+ <dd>
6528
+
6529
+ **request:** `Vital.TeamGetSourcePrioritiesRequest`
6530
+
6531
+ </dd>
6532
+ </dl>
6533
+
6534
+ <dl>
6535
+ <dd>
6536
+
6537
+ **requestOptions:** `Team.RequestOptions`
6538
+
6539
+ </dd>
6540
+ </dl>
6541
+ </dd>
6542
+ </dl>
6543
+
6544
+ </dd>
6545
+ </dl>
6546
+ </details>
6547
+
6548
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">updateSourcePriorities</a>() -> Record<string, unknown>[]</code></summary>
6549
+ <dl>
6550
+ <dd>
6551
+
6552
+ #### 📝 Description
6553
+
6554
+ <dl>
6555
+ <dd>
6556
+
6557
+ <dl>
6558
+ <dd>
6559
+
6560
+ Patch source priorities.
6561
+
6562
+ </dd>
6563
+ </dl>
6564
+ </dd>
6565
+ </dl>
6566
+
6567
+ #### 🔌 Usage
6568
+
6569
+ <dl>
6570
+ <dd>
6571
+
6572
+ <dl>
6573
+ <dd>
6574
+
6575
+ ```typescript
6576
+ await client.team.updateSourcePriorities();
6577
+ ```
6578
+
6579
+ </dd>
6580
+ </dl>
6581
+ </dd>
6582
+ </dl>
6583
+
6584
+ #### ⚙️ Parameters
6585
+
6586
+ <dl>
6587
+ <dd>
6588
+
6589
+ <dl>
6590
+ <dd>
6591
+
6592
+ **requestOptions:** `Team.RequestOptions`
6593
+
6594
+ </dd>
6595
+ </dl>
6596
+ </dd>
6597
+ </dl>
6598
+
6599
+ </dd>
6600
+ </dl>
6601
+ </details>
6602
+
6603
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getPhysicians</a>(teamId) -> Vital.ClientFacingPhysician[]</code></summary>
6604
+ <dl>
6605
+ <dd>
6606
+
6607
+ #### 🔌 Usage
6608
+
6609
+ <dl>
6610
+ <dd>
6611
+
6612
+ <dl>
6613
+ <dd>
6614
+
6615
+ ```typescript
6616
+ await client.team.getPhysicians("team_id");
6617
+ ```
6618
+
6619
+ </dd>
6620
+ </dl>
6621
+ </dd>
6622
+ </dl>
6623
+
6624
+ #### ⚙️ Parameters
6625
+
6626
+ <dl>
6627
+ <dd>
6628
+
6629
+ <dl>
6630
+ <dd>
6631
+
6632
+ **teamId:** `string`
6633
+
6634
+ </dd>
6635
+ </dl>
6636
+
6637
+ <dl>
6638
+ <dd>
6639
+
6640
+ **requestOptions:** `Team.RequestOptions`
6641
+
6642
+ </dd>
6643
+ </dl>
6644
+ </dd>
6645
+ </dl>
6646
+
6647
+ </dd>
6648
+ </dl>
6649
+ </details>
6650
+
6651
+ ## Providers
6652
+
6653
+ <details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">getAll</a>({ ...params }) -> Vital.ClientFacingProviderDetailed[]</code></summary>
6654
+ <dl>
6655
+ <dd>
6656
+
6657
+ #### 📝 Description
6658
+
6659
+ <dl>
6660
+ <dd>
6661
+
6662
+ <dl>
6663
+ <dd>
6664
+
6665
+ Get Provider list
6666
+
6667
+ </dd>
6668
+ </dl>
6669
+ </dd>
6670
+ </dl>
6671
+
6672
+ #### 🔌 Usage
6673
+
6674
+ <dl>
6675
+ <dd>
6676
+
6677
+ <dl>
6678
+ <dd>
6679
+
6680
+ ```typescript
6681
+ await client.providers.getAll();
6682
+ ```
6683
+
6684
+ </dd>
6685
+ </dl>
6686
+ </dd>
6687
+ </dl>
6688
+
6689
+ #### ⚙️ Parameters
6690
+
6691
+ <dl>
6692
+ <dd>
6693
+
6694
+ <dl>
6695
+ <dd>
6696
+
6697
+ **request:** `Vital.ProvidersGetAllRequest`
6698
+
6699
+ </dd>
6700
+ </dl>
6701
+
6702
+ <dl>
6703
+ <dd>
6704
+
6705
+ **requestOptions:** `Providers.RequestOptions`
6706
+
6707
+ </dd>
6708
+ </dl>
6709
+ </dd>
6710
+ </dl>
6711
+
6712
+ </dd>
6713
+ </dl>
6714
+ </details>
6715
+
6716
+ ## Introspect
6717
+
6718
+ <details><summary><code>client.introspect.<a href="/src/api/resources/introspect/client/Client.ts">getUserResources</a>({ ...params }) -> Vital.UserResourcesResponse</code></summary>
6719
+ <dl>
6720
+ <dd>
6721
+
6722
+ #### 🔌 Usage
6723
+
6724
+ <dl>
6725
+ <dd>
6726
+
6727
+ <dl>
6728
+ <dd>
6729
+
6730
+ ```typescript
6731
+ await client.introspect.getUserResources();
6732
+ ```
6733
+
6734
+ </dd>
6735
+ </dl>
6736
+ </dd>
6737
+ </dl>
6738
+
6739
+ #### ⚙️ Parameters
6740
+
6741
+ <dl>
6742
+ <dd>
6743
+
6744
+ <dl>
6745
+ <dd>
6746
+
6747
+ **request:** `Vital.IntrospectGetUserResourcesRequest`
6748
+
6749
+ </dd>
6750
+ </dl>
6751
+
6752
+ <dl>
6753
+ <dd>
6754
+
6755
+ **requestOptions:** `Introspect.RequestOptions`
6756
+
6757
+ </dd>
6758
+ </dl>
6759
+ </dd>
6760
+ </dl>
6761
+
6762
+ </dd>
6763
+ </dl>
6764
+ </details>
6765
+
6766
+ <details><summary><code>client.introspect.<a href="/src/api/resources/introspect/client/Client.ts">getUserHistoricalPulls</a>({ ...params }) -> Vital.UserHistoricalPullsResponse</code></summary>
6767
+ <dl>
6768
+ <dd>
6769
+
6770
+ #### 🔌 Usage
6771
+
6772
+ <dl>
6773
+ <dd>
6774
+
6775
+ <dl>
6776
+ <dd>
6777
+
6778
+ ```typescript
6779
+ await client.introspect.getUserHistoricalPulls();
6780
+ ```
6781
+
6782
+ </dd>
6783
+ </dl>
6784
+ </dd>
6785
+ </dl>
6786
+
6787
+ #### ⚙️ Parameters
6788
+
6789
+ <dl>
6790
+ <dd>
6791
+
6792
+ <dl>
6793
+ <dd>
6794
+
6795
+ **request:** `Vital.IntrospectGetUserHistoricalPullsRequest`
6796
+
6797
+ </dd>
6798
+ </dl>
6799
+
6800
+ <dl>
6801
+ <dd>
6802
+
6803
+ **requestOptions:** `Introspect.RequestOptions`
6804
+
6805
+ </dd>
6806
+ </dl>
6807
+ </dd>
6808
+ </dl>
6809
+
6810
+ </dd>
6811
+ </dl>
6812
+ </details>
6813
+
6814
+ ## LabTests
6815
+
6816
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">get</a>() -> Vital.ClientFacingLabTest[]</code></summary>
6817
+ <dl>
6818
+ <dd>
6819
+
6820
+ #### 📝 Description
6821
+
6822
+ <dl>
6823
+ <dd>
6824
+
6825
+ <dl>
6826
+ <dd>
6827
+
6828
+ GET all the lab tests the team has access to.
6829
+
6830
+ </dd>
6831
+ </dl>
6832
+ </dd>
6833
+ </dl>
6834
+
6835
+ #### 🔌 Usage
6836
+
6837
+ <dl>
6838
+ <dd>
6839
+
6840
+ <dl>
6841
+ <dd>
6842
+
6843
+ ```typescript
6844
+ await client.labTests.get();
6845
+ ```
6846
+
6847
+ </dd>
6848
+ </dl>
6849
+ </dd>
6850
+ </dl>
6851
+
6852
+ #### ⚙️ Parameters
6853
+
6854
+ <dl>
6855
+ <dd>
6856
+
6857
+ <dl>
6858
+ <dd>
6859
+
6860
+ **requestOptions:** `LabTests.RequestOptions`
6861
+
6862
+ </dd>
6863
+ </dl>
6864
+ </dd>
6865
+ </dl>
6866
+
6867
+ </dd>
6868
+ </dl>
6869
+ </details>
6870
+
6871
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingLabTest</code></summary>
6872
+ <dl>
6873
+ <dd>
6874
+
6875
+ #### 🔌 Usage
6876
+
6877
+ <dl>
6878
+ <dd>
6879
+
6880
+ <dl>
6881
+ <dd>
6882
+
6883
+ ```typescript
6884
+ await client.labTests.create({
6885
+ name: "name",
6886
+ method: Vital.LabTestCollectionMethod.Testkit,
6887
+ description: "description",
6888
+ });
6889
+ ```
6890
+
6891
+ </dd>
6892
+ </dl>
6893
+ </dd>
6894
+ </dl>
6895
+
6896
+ #### ⚙️ Parameters
6897
+
6898
+ <dl>
6899
+ <dd>
6900
+
6901
+ <dl>
6902
+ <dd>
6903
+
6904
+ **request:** `Vital.CreateLabTestRequest`
6905
+
6906
+ </dd>
6907
+ </dl>
6908
+
6909
+ <dl>
6910
+ <dd>
6911
+
6912
+ **requestOptions:** `LabTests.RequestOptions`
6913
+
6914
+ </dd>
6915
+ </dl>
6916
+ </dd>
6917
+ </dl>
6918
+
6919
+ </dd>
6920
+ </dl>
6921
+ </details>
6922
+
6923
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkers</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
6924
+ <dl>
6925
+ <dd>
6926
+
6927
+ #### 📝 Description
6928
+
6929
+ <dl>
6930
+ <dd>
6931
+
6932
+ <dl>
6933
+ <dd>
6934
+
6935
+ GET all the markers for the given lab.
6936
+
6937
+ </dd>
6938
+ </dl>
6939
+ </dd>
6940
+ </dl>
6941
+
6942
+ #### 🔌 Usage
6943
+
6944
+ <dl>
6945
+ <dd>
6946
+
6947
+ <dl>
6948
+ <dd>
6949
+
6950
+ ```typescript
6951
+ await client.labTests.getMarkers();
6952
+ ```
6953
+
6954
+ </dd>
6955
+ </dl>
6956
+ </dd>
6957
+ </dl>
6958
+
6959
+ #### ⚙️ Parameters
6960
+
6961
+ <dl>
6962
+ <dd>
6963
+
6964
+ <dl>
6965
+ <dd>
6966
+
6967
+ **request:** `Vital.LabTestsGetMarkersRequest`
6968
+
6969
+ </dd>
6970
+ </dl>
6971
+
6972
+ <dl>
6973
+ <dd>
6974
+
6975
+ **requestOptions:** `LabTests.RequestOptions`
6976
+
6977
+ </dd>
6978
+ </dl>
6979
+ </dd>
6980
+ </dl>
6981
+
6982
+ </dd>
6983
+ </dl>
6984
+ </details>
6985
+
6986
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForOrderSet</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
6987
+ <dl>
6988
+ <dd>
6989
+
6990
+ #### 🔌 Usage
6991
+
6992
+ <dl>
6993
+ <dd>
6994
+
6995
+ <dl>
6996
+ <dd>
6997
+
6998
+ ```typescript
6999
+ await client.labTests.getMarkersForOrderSet({
7000
+ body: {},
7001
+ });
7002
+ ```
7003
+
7004
+ </dd>
7005
+ </dl>
7006
+ </dd>
7007
+ </dl>
7008
+
7009
+ #### ⚙️ Parameters
7010
+
7011
+ <dl>
7012
+ <dd>
7013
+
7014
+ <dl>
7015
+ <dd>
7016
+
7017
+ **request:** `Vital.LabTestsGetMarkersForOrderSetRequest`
7018
+
7019
+ </dd>
7020
+ </dl>
7021
+
7022
+ <dl>
7023
+ <dd>
7024
+
7025
+ **requestOptions:** `LabTests.RequestOptions`
7026
+
7027
+ </dd>
7028
+ </dl>
7029
+ </dd>
7030
+ </dl>
7031
+
7032
+ </dd>
7033
+ </dl>
7034
+ </details>
7035
+
7036
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForLabTest</a>(labTestId, { ...params }) -> Vital.GetMarkersResponse</code></summary>
7037
+ <dl>
7038
+ <dd>
7039
+
7040
+ #### 🔌 Usage
7041
+
7042
+ <dl>
7043
+ <dd>
7044
+
7045
+ <dl>
7046
+ <dd>
7047
+
7048
+ ```typescript
7049
+ await client.labTests.getMarkersForLabTest("lab_test_id");
7050
+ ```
7051
+
7052
+ </dd>
7053
+ </dl>
7054
+ </dd>
7055
+ </dl>
7056
+
7057
+ #### ⚙️ Parameters
7058
+
7059
+ <dl>
7060
+ <dd>
7061
+
7062
+ <dl>
7063
+ <dd>
7064
+
7065
+ **labTestId:** `string`
7066
+
7067
+ </dd>
7068
+ </dl>
7069
+
7070
+ <dl>
7071
+ <dd>
7072
+
7073
+ **request:** `Vital.LabTestsGetMarkersForLabTestRequest`
7074
+
7075
+ </dd>
7076
+ </dl>
7077
+
7078
+ <dl>
7079
+ <dd>
7080
+
7081
+ **requestOptions:** `LabTests.RequestOptions`
7082
+
7083
+ </dd>
7084
+ </dl>
7085
+ </dd>
7086
+ </dl>
7087
+
7088
+ </dd>
7089
+ </dl>
7090
+ </details>
7091
+
7092
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersByLabAndProviderId</a>(providerId, labId) -> Vital.ClientFacingMarker</code></summary>
7093
+ <dl>
7094
+ <dd>
7095
+
7096
+ #### 📝 Description
7097
+
7098
+ <dl>
7099
+ <dd>
7100
+
7101
+ <dl>
7102
+ <dd>
7103
+
7104
+ GET a specific marker for the given lab and provider_id
7105
+
7106
+ </dd>
7107
+ </dl>
7108
+ </dd>
7109
+ </dl>
7110
+
7111
+ #### 🔌 Usage
7112
+
7113
+ <dl>
7114
+ <dd>
7115
+
7116
+ <dl>
7117
+ <dd>
7118
+
7119
+ ```typescript
7120
+ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
7121
+ ```
7122
+
7123
+ </dd>
7124
+ </dl>
7125
+ </dd>
7126
+ </dl>
7127
+
7128
+ #### ⚙️ Parameters
7129
+
7130
+ <dl>
7131
+ <dd>
7132
+
7133
+ <dl>
7134
+ <dd>
7135
+
7136
+ **providerId:** `string`
7137
+
7138
+ </dd>
7139
+ </dl>
7140
+
7141
+ <dl>
7142
+ <dd>
7143
+
7144
+ **labId:** `number`
7145
+
7146
+ </dd>
7147
+ </dl>
7148
+
7149
+ <dl>
7150
+ <dd>
7151
+
7152
+ **requestOptions:** `LabTests.RequestOptions`
7153
+
7154
+ </dd>
7155
+ </dl>
7156
+ </dd>
7157
+ </dl>
7158
+
7159
+ </dd>
7160
+ </dl>
7161
+ </details>
7162
+
7163
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getLabs</a>() -> Vital.ClientFacingLab[]</code></summary>
7164
+ <dl>
7165
+ <dd>
7166
+
7167
+ #### 📝 Description
7168
+
7169
+ <dl>
7170
+ <dd>
7171
+
7172
+ <dl>
7173
+ <dd>
7174
+
7175
+ GET all the labs.
7176
+
7177
+ </dd>
7178
+ </dl>
7179
+ </dd>
7180
+ </dl>
7181
+
7182
+ #### 🔌 Usage
7183
+
7184
+ <dl>
7185
+ <dd>
7186
+
7187
+ <dl>
7188
+ <dd>
7189
+
7190
+ ```typescript
7191
+ await client.labTests.getLabs();
7192
+ ```
7193
+
7194
+ </dd>
7195
+ </dl>
7196
+ </dd>
7197
+ </dl>
7198
+
7199
+ #### ⚙️ Parameters
7200
+
7201
+ <dl>
7202
+ <dd>
7203
+
7204
+ <dl>
7205
+ <dd>
7206
+
7207
+ **requestOptions:** `LabTests.RequestOptions`
7208
+
7209
+ </dd>
7210
+ </dl>
7211
+ </dd>
7212
+ </dl>
7213
+
7214
+ </dd>
7215
+ </dl>
7216
+ </details>
7217
+
7218
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getById</a>(labTestId) -> Vital.ClientFacingLabTest</code></summary>
7219
+ <dl>
7220
+ <dd>
7221
+
7222
+ #### 📝 Description
7223
+
7224
+ <dl>
7225
+ <dd>
7226
+
7227
+ <dl>
7228
+ <dd>
7229
+
7230
+ GET all the lab tests the team has access to.
7231
+
7232
+ </dd>
7233
+ </dl>
7234
+ </dd>
7235
+ </dl>
7236
+
7237
+ #### 🔌 Usage
7238
+
7239
+ <dl>
7240
+ <dd>
7241
+
7242
+ <dl>
7243
+ <dd>
7244
+
7245
+ ```typescript
7246
+ await client.labTests.getById("lab_test_id");
7247
+ ```
7248
+
7249
+ </dd>
7250
+ </dl>
7251
+ </dd>
7252
+ </dl>
7253
+
7254
+ #### ⚙️ Parameters
7255
+
7256
+ <dl>
7257
+ <dd>
7258
+
7259
+ <dl>
7260
+ <dd>
7261
+
7262
+ **labTestId:** `string`
7263
+
7264
+ </dd>
7265
+ </dl>
7266
+
7267
+ <dl>
7268
+ <dd>
7269
+
7270
+ **requestOptions:** `LabTests.RequestOptions`
7271
+
7272
+ </dd>
7273
+ </dl>
7274
+ </dd>
7275
+ </dl>
7276
+
7277
+ </dd>
7278
+ </dl>
7279
+ </details>
7280
+
7281
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
7282
+ <dl>
7283
+ <dd>
7284
+
7285
+ #### 📝 Description
7286
+
7287
+ <dl>
7288
+ <dd>
7289
+
7290
+ <dl>
7291
+ <dd>
7292
+
7293
+ Return the available time slots to book an appointment with a phlebotomist
7294
+ for the given address and order.
7295
+
7296
+ </dd>
7297
+ </dl>
7298
+ </dd>
7299
+ </dl>
7300
+
7301
+ #### 🔌 Usage
7302
+
7303
+ <dl>
7304
+ <dd>
7305
+
7306
+ <dl>
7307
+ <dd>
7308
+
7309
+ ```typescript
7310
+ await client.labTests.getPhlebotomyAppointmentAvailability({
7311
+ body: {
7312
+ firstLine: "first_line",
7313
+ city: "city",
7314
+ state: "state",
7315
+ zipCode: "zip_code",
7316
+ },
7317
+ });
7318
+ ```
7319
+
7320
+ </dd>
7321
+ </dl>
7322
+ </dd>
7323
+ </dl>
7324
+
7325
+ #### ⚙️ Parameters
7326
+
7327
+ <dl>
7328
+ <dd>
7329
+
7330
+ <dl>
7331
+ <dd>
7332
+
7333
+ **request:** `Vital.LabTestsGetPhlebotomyAppointmentAvailabilityRequest`
7334
+
7335
+ </dd>
7336
+ </dl>
7337
+
7338
+ <dl>
7339
+ <dd>
7340
+
7341
+ **requestOptions:** `LabTests.RequestOptions`
7342
+
7343
+ </dd>
7344
+ </dl>
7345
+ </dd>
7346
+ </dl>
7347
+
7348
+ </dd>
7349
+ </dl>
7350
+ </details>
7351
+
7352
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
7353
+ <dl>
7354
+ <dd>
7355
+
7356
+ #### 📝 Description
7357
+
7358
+ <dl>
7359
+ <dd>
7360
+
7361
+ <dl>
7362
+ <dd>
7363
+
7364
+ Book an at-home phlebotomy appointment.
7365
+
7366
+ </dd>
7367
+ </dl>
7368
+ </dd>
7369
+ </dl>
7370
+
7371
+ #### 🔌 Usage
7372
+
7373
+ <dl>
7374
+ <dd>
7375
+
7376
+ <dl>
7377
+ <dd>
7378
+
7379
+ ```typescript
7380
+ await client.labTests.bookPhlebotomyAppointment("order_id", {
7381
+ bookingKey: "booking_key",
7382
+ });
7383
+ ```
7384
+
7385
+ </dd>
7386
+ </dl>
7387
+ </dd>
7388
+ </dl>
7389
+
7390
+ #### ⚙️ Parameters
7391
+
7392
+ <dl>
7393
+ <dd>
7394
+
7395
+ <dl>
7396
+ <dd>
7397
+
7398
+ **orderId:** `string` — Your Order ID.
7399
+
7400
+ </dd>
7401
+ </dl>
7402
+
7403
+ <dl>
7404
+ <dd>
7405
+
7406
+ **request:** `Vital.AppointmentBookingRequest`
7407
+
7408
+ </dd>
7409
+ </dl>
7410
+
7411
+ <dl>
7412
+ <dd>
7413
+
7414
+ **requestOptions:** `LabTests.RequestOptions`
7415
+
7416
+ </dd>
7417
+ </dl>
7418
+ </dd>
7419
+ </dl>
7420
+
7421
+ </dd>
7422
+ </dl>
7423
+ </details>
7424
+
7425
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">requestPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
7426
+ <dl>
7427
+ <dd>
7428
+
7429
+ #### 📝 Description
7430
+
7431
+ <dl>
7432
+ <dd>
7433
+
7434
+ <dl>
7435
+ <dd>
7436
+
7437
+ Request an at-home phlebotomy appointment.
7438
+
7439
+ </dd>
7440
+ </dl>
7441
+ </dd>
7442
+ </dl>
7443
+
7444
+ #### 🔌 Usage
7445
+
7446
+ <dl>
7447
+ <dd>
7448
+
7449
+ <dl>
7450
+ <dd>
7451
+
7452
+ ```typescript
7453
+ await client.labTests.requestPhlebotomyAppointment("order_id", {
7454
+ address: {
7455
+ firstLine: "first_line",
7456
+ city: "city",
7457
+ state: "state",
7458
+ zipCode: "zip_code",
7459
+ },
7460
+ provider: Vital.AppointmentProvider.Getlabs,
7461
+ });
7462
+ ```
7463
+
7464
+ </dd>
7465
+ </dl>
7466
+ </dd>
7467
+ </dl>
7468
+
7469
+ #### ⚙️ Parameters
7470
+
7471
+ <dl>
7472
+ <dd>
7473
+
7474
+ <dl>
7475
+ <dd>
7476
+
7477
+ **orderId:** `string` — Your Order ID.
7478
+
7479
+ </dd>
7480
+ </dl>
7481
+
7482
+ <dl>
7483
+ <dd>
7484
+
7485
+ **request:** `Vital.RequestAppointmentRequest`
7486
+
7487
+ </dd>
7488
+ </dl>
7489
+
7490
+ <dl>
7491
+ <dd>
7492
+
7493
+ **requestOptions:** `LabTests.RequestOptions`
7494
+
7495
+ </dd>
7496
+ </dl>
7497
+ </dd>
7498
+ </dl>
7499
+
7500
+ </dd>
7501
+ </dl>
7502
+ </details>
7503
+
7504
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
7505
+ <dl>
7506
+ <dd>
7507
+
7508
+ #### 📝 Description
7509
+
7510
+ <dl>
7511
+ <dd>
7512
+
7513
+ <dl>
7514
+ <dd>
7515
+
7516
+ Reschedule a previously booked at-home phlebotomy appointment.
7517
+
7518
+ </dd>
7519
+ </dl>
7520
+ </dd>
7521
+ </dl>
7522
+
7523
+ #### 🔌 Usage
7524
+
7525
+ <dl>
7526
+ <dd>
7527
+
7528
+ <dl>
7529
+ <dd>
7530
+
7531
+ ```typescript
7532
+ await client.labTests.reschedulePhlebotomyAppointment("order_id", {
7533
+ bookingKey: "booking_key",
7534
+ });
7535
+ ```
7536
+
7537
+ </dd>
7538
+ </dl>
7539
+ </dd>
7540
+ </dl>
7541
+
7542
+ #### ⚙️ Parameters
7543
+
7544
+ <dl>
7545
+ <dd>
7546
+
7547
+ <dl>
7548
+ <dd>
7549
+
7550
+ **orderId:** `string` — Your Order ID.
7551
+
7552
+ </dd>
7553
+ </dl>
7554
+
7555
+ <dl>
7556
+ <dd>
7557
+
7558
+ **request:** `Vital.AppointmentRescheduleRequest`
7559
+
7560
+ </dd>
7561
+ </dl>
7562
+
7563
+ <dl>
7564
+ <dd>
7565
+
7566
+ **requestOptions:** `LabTests.RequestOptions`
7567
+
7568
+ </dd>
7569
+ </dl>
7570
+ </dd>
7571
+ </dl>
7572
+
7573
+ </dd>
7574
+ </dl>
7575
+ </details>
7576
+
7577
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
7578
+ <dl>
7579
+ <dd>
7580
+
7581
+ #### 📝 Description
7582
+
7583
+ <dl>
7584
+ <dd>
7585
+
7586
+ <dl>
7587
+ <dd>
7588
+
7589
+ Cancel a previously booked at-home phlebotomy appointment.
7590
+
7591
+ </dd>
7592
+ </dl>
7593
+ </dd>
7594
+ </dl>
7595
+
7596
+ #### 🔌 Usage
7597
+
7598
+ <dl>
7599
+ <dd>
7600
+
7601
+ <dl>
7602
+ <dd>
7603
+
7604
+ ```typescript
7605
+ await client.labTests.cancelPhlebotomyAppointment("order_id", {
7606
+ cancellationReasonId: "cancellation_reason_id",
7607
+ });
7608
+ ```
7609
+
7610
+ </dd>
7611
+ </dl>
7612
+ </dd>
7613
+ </dl>
7614
+
7615
+ #### ⚙️ Parameters
7616
+
7617
+ <dl>
7618
+ <dd>
7619
+
7620
+ <dl>
7621
+ <dd>
7622
+
7623
+ **orderId:** `string` — Your Order ID.
7624
+
7625
+ </dd>
7626
+ </dl>
7627
+
7628
+ <dl>
7629
+ <dd>
7630
+
7631
+ **request:** `Vital.AppointmentCancelRequest`
7632
+
7633
+ </dd>
7634
+ </dl>
7635
+
7636
+ <dl>
7637
+ <dd>
7638
+
7639
+ **requestOptions:** `LabTests.RequestOptions`
7640
+
7641
+ </dd>
7642
+ </dl>
7643
+ </dd>
7644
+ </dl>
7645
+
7646
+ </dd>
7647
+ </dl>
7648
+ </details>
7649
+
7650
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
7651
+ <dl>
7652
+ <dd>
7653
+
7654
+ #### 📝 Description
7655
+
7656
+ <dl>
7657
+ <dd>
7658
+
7659
+ <dl>
7660
+ <dd>
7661
+
7662
+ Get the list of reasons for cancelling an at-home phlebotomy appointment.
7663
+
7664
+ </dd>
7665
+ </dl>
7666
+ </dd>
7667
+ </dl>
7668
+
7669
+ #### 🔌 Usage
7670
+
7671
+ <dl>
7672
+ <dd>
7673
+
7674
+ <dl>
7675
+ <dd>
7676
+
7677
+ ```typescript
7678
+ await client.labTests.getPhlebotomyAppointmentCancellationReason();
7679
+ ```
7680
+
7681
+ </dd>
7682
+ </dl>
7683
+ </dd>
7684
+ </dl>
7685
+
7686
+ #### ⚙️ Parameters
7687
+
7688
+ <dl>
7689
+ <dd>
7690
+
7691
+ <dl>
7692
+ <dd>
7693
+
7694
+ **requestOptions:** `LabTests.RequestOptions`
7695
+
7696
+ </dd>
7697
+ </dl>
7698
+ </dd>
7699
+ </dl>
7700
+
7701
+ </dd>
7702
+ </dl>
7703
+ </details>
7704
+
7705
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
7706
+ <dl>
7707
+ <dd>
7708
+
7709
+ #### 📝 Description
7710
+
7711
+ <dl>
7712
+ <dd>
7713
+
7714
+ <dl>
7715
+ <dd>
7716
+
7717
+ Get the appointment associated with an order.
7718
+
7719
+ </dd>
7720
+ </dl>
7721
+ </dd>
7722
+ </dl>
7723
+
7724
+ #### 🔌 Usage
7725
+
7726
+ <dl>
7727
+ <dd>
7728
+
7729
+ <dl>
7730
+ <dd>
7731
+
7732
+ ```typescript
7733
+ await client.labTests.getPhlebotomyAppointment("order_id");
7734
+ ```
7735
+
7736
+ </dd>
7737
+ </dl>
7738
+ </dd>
7739
+ </dl>
7740
+
7741
+ #### ⚙️ Parameters
7742
+
7743
+ <dl>
7744
+ <dd>
7745
+
7746
+ <dl>
7747
+ <dd>
7748
+
7749
+ **orderId:** `string` — Your Order ID.
7750
+
7751
+ </dd>
7752
+ </dl>
7753
+
7754
+ <dl>
7755
+ <dd>
7756
+
7757
+ **requestOptions:** `LabTests.RequestOptions`
7758
+
7759
+ </dd>
7760
+ </dl>
7761
+ </dd>
7762
+ </dl>
7763
+
7764
+ </dd>
7765
+ </dl>
7766
+ </details>
7767
+
7768
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getAreaInfo</a>({ ...params }) -> Vital.AreaInfo</code></summary>
7769
+ <dl>
7770
+ <dd>
7771
+
7772
+ #### 📝 Description
7773
+
7774
+ <dl>
7775
+ <dd>
7776
+
7777
+ <dl>
7778
+ <dd>
7779
+
7780
+ GET information about an area with respect to lab-testing.
7781
+
7782
+ Information returned:
7783
+
7784
+ - Whether a given zip code is served by our Phlebotomy network.
7785
+ - List of Lab locations in the area.
7786
+ </dd>
7787
+ </dl>
7788
+ </dd>
7789
+ </dl>
7790
+
7791
+ #### 🔌 Usage
7792
+
7793
+ <dl>
7794
+ <dd>
7795
+
7796
+ <dl>
7797
+ <dd>
7798
+
7799
+ ```typescript
7800
+ await client.labTests.getAreaInfo({
7801
+ zipCode: "zip_code",
7802
+ });
7803
+ ```
7804
+
7805
+ </dd>
7806
+ </dl>
7807
+ </dd>
7808
+ </dl>
7809
+
7810
+ #### ⚙️ Parameters
7811
+
7812
+ <dl>
7813
+ <dd>
7814
+
7815
+ <dl>
7816
+ <dd>
7817
+
7818
+ **request:** `Vital.LabTestsGetAreaInfoRequest`
7819
+
7820
+ </dd>
7821
+ </dl>
7822
+
7823
+ <dl>
7824
+ <dd>
7825
+
7826
+ **requestOptions:** `LabTests.RequestOptions`
7827
+
7828
+ </dd>
7829
+ </dl>
7830
+ </dd>
7831
+ </dl>
7832
+
7833
+ </dd>
7834
+ </dl>
7835
+ </details>
7836
+
7837
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscInfo</a>({ ...params }) -> Vital.PscInfo</code></summary>
7838
+ <dl>
7839
+ <dd>
7840
+
7841
+ #### 🔌 Usage
7842
+
7843
+ <dl>
7844
+ <dd>
7845
+
7846
+ <dl>
7847
+ <dd>
7848
+
7849
+ ```typescript
7850
+ await client.labTests.getPscInfo({
7851
+ zipCode: "zip_code",
7852
+ labId: 1,
7853
+ });
7854
+ ```
7855
+
7856
+ </dd>
7857
+ </dl>
7858
+ </dd>
7859
+ </dl>
7860
+
7861
+ #### ⚙️ Parameters
7862
+
7863
+ <dl>
7864
+ <dd>
7865
+
7866
+ <dl>
7867
+ <dd>
7868
+
7869
+ **request:** `Vital.LabTestsGetPscInfoRequest`
7870
+
7871
+ </dd>
7872
+ </dl>
7873
+
7874
+ <dl>
7875
+ <dd>
7876
+
7877
+ **requestOptions:** `LabTests.RequestOptions`
7878
+
7879
+ </dd>
7880
+ </dl>
7881
+ </dd>
7882
+ </dl>
7883
+
7884
+ </dd>
7885
+ </dl>
7886
+ </details>
7887
+
7888
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderPscInfo</a>(orderId, { ...params }) -> Vital.PscInfo</code></summary>
7889
+ <dl>
7890
+ <dd>
7891
+
7892
+ #### 🔌 Usage
7893
+
7894
+ <dl>
7895
+ <dd>
7896
+
7897
+ <dl>
7898
+ <dd>
7899
+
7900
+ ```typescript
7901
+ await client.labTests.getOrderPscInfo("order_id");
7902
+ ```
7903
+
7904
+ </dd>
7905
+ </dl>
7906
+ </dd>
7907
+ </dl>
7908
+
7909
+ #### ⚙️ Parameters
7910
+
7911
+ <dl>
7912
+ <dd>
7913
+
7914
+ <dl>
7915
+ <dd>
7916
+
7917
+ **orderId:** `string` — Your Order ID.
7918
+
7919
+ </dd>
7920
+ </dl>
7921
+
7922
+ <dl>
7923
+ <dd>
7924
+
7925
+ **request:** `Vital.LabTestsGetOrderPscInfoRequest`
7926
+
7927
+ </dd>
7928
+ </dl>
7929
+
7930
+ <dl>
7931
+ <dd>
7932
+
7933
+ **requestOptions:** `LabTests.RequestOptions`
7934
+
7935
+ </dd>
7936
+ </dl>
7937
+ </dd>
7938
+ </dl>
7939
+
7940
+ </dd>
7941
+ </dl>
7942
+ </details>
7943
+
7944
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultPdf</a>(orderId) -> stream.Readable</code></summary>
7945
+ <dl>
7946
+ <dd>
7947
+
7948
+ #### 📝 Description
7949
+
7950
+ <dl>
7951
+ <dd>
7952
+
7953
+ <dl>
7954
+ <dd>
7955
+
7956
+ This endpoint returns the lab results for the order.
7957
+
7958
+ </dd>
7959
+ </dl>
7960
+ </dd>
7961
+ </dl>
7962
+
7963
+ #### 🔌 Usage
7964
+
7965
+ <dl>
7966
+ <dd>
7967
+
7968
+ <dl>
7969
+ <dd>
7970
+
7971
+ ```typescript
7972
+ await client.labTests.getResultPdf("string");
7973
+ ```
7974
+
7975
+ </dd>
7976
+ </dl>
7977
+ </dd>
7978
+ </dl>
7979
+
7980
+ #### ⚙️ Parameters
7981
+
7982
+ <dl>
7983
+ <dd>
7984
+
7985
+ <dl>
7986
+ <dd>
7987
+
7988
+ **orderId:** `string`
7989
+
7990
+ </dd>
7991
+ </dl>
7992
+
7993
+ <dl>
7994
+ <dd>
7995
+
7996
+ **requestOptions:** `LabTests.RequestOptions`
7997
+
7998
+ </dd>
7999
+ </dl>
8000
+ </dd>
8001
+ </dl>
8002
+
8003
+ </dd>
8004
+ </dl>
8005
+ </details>
8006
+
8007
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultMetadata</a>(orderId) -> Vital.LabResultsMetadata</code></summary>
8008
+ <dl>
8009
+ <dd>
8010
+
8011
+ #### 📝 Description
8012
+
8013
+ <dl>
8014
+ <dd>
8015
+
8016
+ <dl>
8017
+ <dd>
8018
+
8019
+ Return metadata related to order results, such as lab metadata,
8020
+ provider and sample dates.
8021
+
8022
+ </dd>
8023
+ </dl>
8024
+ </dd>
8025
+ </dl>
8026
+
8027
+ #### 🔌 Usage
8028
+
8029
+ <dl>
8030
+ <dd>
8031
+
8032
+ <dl>
8033
+ <dd>
8034
+
8035
+ ```typescript
8036
+ await client.labTests.getResultMetadata("order_id");
8037
+ ```
8038
+
8039
+ </dd>
8040
+ </dl>
8041
+ </dd>
8042
+ </dl>
8043
+
8044
+ #### ⚙️ Parameters
8045
+
8046
+ <dl>
8047
+ <dd>
8048
+
8049
+ <dl>
8050
+ <dd>
8051
+
8052
+ **orderId:** `string`
8053
+
8054
+ </dd>
8055
+ </dl>
8056
+
8057
+ <dl>
8058
+ <dd>
8059
+
8060
+ **requestOptions:** `LabTests.RequestOptions`
8061
+
8062
+ </dd>
8063
+ </dl>
8064
+ </dd>
8065
+ </dl>
8066
+
8067
+ </dd>
8068
+ </dl>
8069
+ </details>
8070
+
8071
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultRaw</a>(orderId) -> Vital.LabResultsRaw</code></summary>
8072
+ <dl>
8073
+ <dd>
8074
+
8075
+ #### 📝 Description
8076
+
8077
+ <dl>
8078
+ <dd>
8079
+
8080
+ <dl>
8081
+ <dd>
8082
+
8083
+ Return both metadata and raw json test data
8084
+
8085
+ </dd>
8086
+ </dl>
8087
+ </dd>
8088
+ </dl>
8089
+
8090
+ #### 🔌 Usage
8091
+
8092
+ <dl>
8093
+ <dd>
8094
+
8095
+ <dl>
8096
+ <dd>
8097
+
8098
+ ```typescript
8099
+ await client.labTests.getResultRaw("order_id");
8100
+ ```
8101
+
8102
+ </dd>
8103
+ </dl>
8104
+ </dd>
8105
+ </dl>
8106
+
8107
+ #### ⚙️ Parameters
8108
+
8109
+ <dl>
8110
+ <dd>
8111
+
8112
+ <dl>
8113
+ <dd>
8114
+
8115
+ **orderId:** `string`
8116
+
8117
+ </dd>
8118
+ </dl>
8119
+
8120
+ <dl>
8121
+ <dd>
8122
+
8123
+ **requestOptions:** `LabTests.RequestOptions`
8124
+
8125
+ </dd>
8126
+ </dl>
8127
+ </dd>
8128
+ </dl>
8129
+
8130
+ </dd>
8131
+ </dl>
8132
+ </details>
8133
+
8134
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getLabelsPdf</a>(orderId, { ...params }) -> stream.Readable</code></summary>
8135
+ <dl>
8136
+ <dd>
8137
+
8138
+ #### 📝 Description
8139
+
8140
+ <dl>
8141
+ <dd>
8142
+
8143
+ <dl>
8144
+ <dd>
8145
+
8146
+ This endpoint returns the printed labels for the order.
8147
+
8148
+ </dd>
8149
+ </dl>
8150
+ </dd>
8151
+ </dl>
8152
+
8153
+ #### 🔌 Usage
8154
+
8155
+ <dl>
8156
+ <dd>
8157
+
8158
+ <dl>
8159
+ <dd>
8160
+
8161
+ ```typescript
8162
+ await client.labTests.getLabelsPdf("string", {
8163
+ numberOfLabels: 1,
8164
+ collectionDate: "2024-01-15T09:30:00Z",
8165
+ });
8166
+ ```
8167
+
8168
+ </dd>
8169
+ </dl>
8170
+ </dd>
8171
+ </dl>
8172
+
8173
+ #### ⚙️ Parameters
8174
+
8175
+ <dl>
8176
+ <dd>
8177
+
8178
+ <dl>
8179
+ <dd>
8180
+
8181
+ **orderId:** `string`
8182
+
8183
+ </dd>
8184
+ </dl>
8185
+
8186
+ <dl>
8187
+ <dd>
8188
+
8189
+ **request:** `Vital.LabTestsGetLabelsPdfRequest`
8190
+
8191
+ </dd>
8192
+ </dl>
8193
+
8194
+ <dl>
8195
+ <dd>
8196
+
8197
+ **requestOptions:** `LabTests.RequestOptions`
8198
+
8199
+ </dd>
8200
+ </dl>
8201
+ </dd>
8202
+ </dl>
8203
+
8204
+ </dd>
8205
+ </dl>
8206
+ </details>
8207
+
8208
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderRequistionPdf</a>(orderId) -> stream.Readable</code></summary>
8209
+ <dl>
8210
+ <dd>
8211
+
8212
+ #### 📝 Description
8213
+
8214
+ <dl>
8215
+ <dd>
8216
+
8217
+ <dl>
8218
+ <dd>
8219
+
8220
+ GET requisition pdf for an order
8221
+
8222
+ </dd>
8223
+ </dl>
8224
+ </dd>
8225
+ </dl>
8226
+
8227
+ #### 🔌 Usage
8228
+
8229
+ <dl>
8230
+ <dd>
8231
+
8232
+ <dl>
8233
+ <dd>
8234
+
8235
+ ```typescript
8236
+ await client.labTests.getOrderRequistionPdf("string");
8237
+ ```
8238
+
8239
+ </dd>
8240
+ </dl>
8241
+ </dd>
8242
+ </dl>
8243
+
8244
+ #### ⚙️ Parameters
8245
+
8246
+ <dl>
8247
+ <dd>
8248
+
8249
+ <dl>
8250
+ <dd>
8251
+
8252
+ **orderId:** `string` — Your Order ID.
8253
+
8254
+ </dd>
8255
+ </dl>
8256
+
8257
+ <dl>
8258
+ <dd>
8259
+
8260
+ **requestOptions:** `LabTests.RequestOptions`
8261
+
8262
+ </dd>
8263
+ </dl>
8264
+ </dd>
8265
+ </dl>
8266
+
8267
+ </dd>
8268
+ </dl>
8269
+ </details>
8270
+
8271
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrder</a>(orderId) -> Vital.ClientFacingOrder</code></summary>
8272
+ <dl>
8273
+ <dd>
8274
+
8275
+ #### 📝 Description
8276
+
8277
+ <dl>
8278
+ <dd>
8279
+
8280
+ <dl>
8281
+ <dd>
8282
+
8283
+ GET individual order by ID.
8284
+
8285
+ </dd>
8286
+ </dl>
8287
+ </dd>
8288
+ </dl>
8289
+
8290
+ #### 🔌 Usage
8291
+
8292
+ <dl>
8293
+ <dd>
8294
+
8295
+ <dl>
8296
+ <dd>
8297
+
8298
+ ```typescript
8299
+ await client.labTests.getOrder("order_id");
8300
+ ```
8301
+
8302
+ </dd>
8303
+ </dl>
8304
+ </dd>
8305
+ </dl>
8306
+
8307
+ #### ⚙️ Parameters
8308
+
8309
+ <dl>
8310
+ <dd>
8311
+
8312
+ <dl>
8313
+ <dd>
8314
+
8315
+ **orderId:** `string` — Your Order ID.
8316
+
8317
+ </dd>
8318
+ </dl>
8319
+
8320
+ <dl>
8321
+ <dd>
8322
+
8323
+ **requestOptions:** `LabTests.RequestOptions`
8324
+
8325
+ </dd>
8326
+ </dl>
8327
+ </dd>
8328
+ </dl>
8329
+
8330
+ </dd>
8331
+ </dl>
8332
+ </details>
8333
+
8334
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
8335
+ <dl>
8336
+ <dd>
8337
+
8338
+ #### 📝 Description
8339
+
8340
+ <dl>
8341
+ <dd>
8342
+
8343
+ <dl>
8344
+ <dd>
8345
+
8346
+ POST create new order
8347
+
8348
+ </dd>
8349
+ </dl>
8350
+ </dd>
8351
+ </dl>
8352
+
8353
+ #### 🔌 Usage
8354
+
8355
+ <dl>
8356
+ <dd>
8357
+
8358
+ <dl>
8359
+ <dd>
8360
+
8361
+ ```typescript
8362
+ await client.labTests.createOrder({
8363
+ userId: "user_id",
8364
+ patientDetails: {
8365
+ firstName: "first_name",
8366
+ lastName: "last_name",
8367
+ dob: "2024-01-15T09:30:00Z",
8368
+ gender: Vital.Gender.Female,
8369
+ phoneNumber: "phone_number",
8370
+ email: "email",
8371
+ },
8372
+ patientAddress: {
8373
+ firstLine: "first_line",
8374
+ city: "city",
8375
+ state: "state",
8376
+ zip: "zip",
8377
+ country: "country",
8378
+ },
8379
+ });
8380
+ ```
8381
+
8382
+ </dd>
8383
+ </dl>
8384
+ </dd>
8385
+ </dl>
8386
+
8387
+ #### ⚙️ Parameters
8388
+
8389
+ <dl>
8390
+ <dd>
8391
+
8392
+ <dl>
8393
+ <dd>
8394
+
8395
+ **request:** `Vital.CreateOrderRequestCompatible`
8396
+
8397
+ </dd>
8398
+ </dl>
8399
+
8400
+ <dl>
8401
+ <dd>
8402
+
8403
+ **requestOptions:** `LabTests.RequestOptions`
8404
+
8405
+ </dd>
8406
+ </dl>
8407
+ </dd>
8408
+ </dl>
8409
+
8410
+ </dd>
8411
+ </dl>
8412
+ </details>
8413
+
8414
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelOrder</a>(orderId) -> Vital.PostOrderResponse</code></summary>
8415
+ <dl>
8416
+ <dd>
8417
+
8418
+ #### 📝 Description
8419
+
8420
+ <dl>
8421
+ <dd>
8422
+
8423
+ <dl>
8424
+ <dd>
8425
+
8426
+ POST cancel order
8427
+
8428
+ </dd>
8429
+ </dl>
8430
+ </dd>
8431
+ </dl>
8432
+
8433
+ #### 🔌 Usage
8434
+
8435
+ <dl>
8436
+ <dd>
8437
+
8438
+ <dl>
8439
+ <dd>
8440
+
8441
+ ```typescript
8442
+ await client.labTests.cancelOrder("order_id");
8443
+ ```
8444
+
8445
+ </dd>
8446
+ </dl>
8447
+ </dd>
8448
+ </dl>
8449
+
8450
+ #### ⚙️ Parameters
8451
+
8452
+ <dl>
8453
+ <dd>
8454
+
8455
+ <dl>
8456
+ <dd>
8457
+
8458
+ **orderId:** `string` — Your Order ID.
8459
+
8460
+ </dd>
8461
+ </dl>
8462
+
8463
+ <dl>
8464
+ <dd>
8465
+
8466
+ **requestOptions:** `LabTests.RequestOptions`
8467
+
8468
+ </dd>
8469
+ </dl>
8470
+ </dd>
8471
+ </dl>
8472
+
8473
+ </dd>
8474
+ </dl>
8475
+ </details>
8476
+
8477
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">simulateOrderProcess</a>(orderId, { ...params }) -> unknown</code></summary>
8478
+ <dl>
8479
+ <dd>
8480
+
8481
+ #### 📝 Description
8482
+
8483
+ <dl>
8484
+ <dd>
8485
+
8486
+ <dl>
8487
+ <dd>
8488
+
8489
+ Get available test kits.
8490
+
8491
+ </dd>
8492
+ </dl>
8493
+ </dd>
8494
+ </dl>
8495
+
8496
+ #### 🔌 Usage
8497
+
8498
+ <dl>
8499
+ <dd>
8500
+
8501
+ <dl>
8502
+ <dd>
8503
+
8504
+ ```typescript
8505
+ await client.labTests.simulateOrderProcess("order_id");
8506
+ ```
8507
+
8508
+ </dd>
8509
+ </dl>
8510
+ </dd>
8511
+ </dl>
8512
+
8513
+ #### ⚙️ Parameters
8514
+
8515
+ <dl>
8516
+ <dd>
8517
+
8518
+ <dl>
8519
+ <dd>
8520
+
8521
+ **orderId:** `string`
8522
+
8523
+ </dd>
8524
+ </dl>
8525
+
8526
+ <dl>
8527
+ <dd>
8528
+
8529
+ **request:** `Vital.LabTestsSimulateOrderProcessRequest`
8530
+
8531
+ </dd>
8532
+ </dl>
8533
+
8534
+ <dl>
8535
+ <dd>
8536
+
8537
+ **requestOptions:** `LabTests.RequestOptions`
8538
+
8539
+ </dd>
8540
+ </dl>
8541
+ </dd>
8542
+ </dl>
8543
+
8544
+ </dd>
8545
+ </dl>
8546
+ </details>
8547
+
8548
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrders</a>({ ...params }) -> Vital.GetOrdersResponse</code></summary>
8549
+ <dl>
8550
+ <dd>
8551
+
8552
+ #### 📝 Description
8553
+
8554
+ <dl>
8555
+ <dd>
8556
+
8557
+ <dl>
8558
+ <dd>
8559
+
8560
+ GET many orders with filters.
8561
+
8562
+ </dd>
8563
+ </dl>
8564
+ </dd>
8565
+ </dl>
8566
+
8567
+ #### 🔌 Usage
8568
+
8569
+ <dl>
8570
+ <dd>
8571
+
8572
+ <dl>
8573
+ <dd>
8574
+
8575
+ ```typescript
8576
+ await client.labTests.getOrders();
8577
+ ```
8578
+
8579
+ </dd>
8580
+ </dl>
8581
+ </dd>
8582
+ </dl>
8583
+
8584
+ #### ⚙️ Parameters
8585
+
8586
+ <dl>
8587
+ <dd>
8588
+
8589
+ <dl>
8590
+ <dd>
8591
+
8592
+ **request:** `Vital.LabTestsGetOrdersRequest`
8593
+
8594
+ </dd>
8595
+ </dl>
8596
+
8597
+ <dl>
8598
+ <dd>
8599
+
8600
+ **requestOptions:** `LabTests.RequestOptions`
8601
+
8602
+ </dd>
8603
+ </dl>
8604
+ </dd>
8605
+ </dl>
8606
+
8607
+ </dd>
8608
+ </dl>
8609
+ </details>
8610
+
8611
+ ## Testkit
8612
+
8613
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">register</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
8614
+ <dl>
8615
+ <dd>
8616
+
8617
+ #### 🔌 Usage
8618
+
8619
+ <dl>
8620
+ <dd>
8621
+
8622
+ <dl>
8623
+ <dd>
8624
+
8625
+ ```typescript
8626
+ await client.testkit.register({
8627
+ userId: "user_id",
8628
+ sampleId: "sample_id",
8629
+ patientDetails: {
8630
+ firstName: "first_name",
8631
+ lastName: "last_name",
8632
+ dob: "2024-01-15T09:30:00Z",
8633
+ gender: Vital.Gender.Female,
8634
+ phoneNumber: "phone_number",
8635
+ email: "email",
8636
+ },
8637
+ patientAddress: {
8638
+ firstLine: "first_line",
8639
+ city: "city",
8640
+ state: "state",
8641
+ zip: "zip",
8642
+ country: "country",
8643
+ },
8644
+ });
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
+ **request:** `Vital.RegisterTestkitRequest`
8661
+
8662
+ </dd>
8663
+ </dl>
8664
+
8665
+ <dl>
8666
+ <dd>
8667
+
8668
+ **requestOptions:** `Testkit.RequestOptions`
8669
+
8670
+ </dd>
8671
+ </dl>
8672
+ </dd>
8673
+ </dl>
8674
+
8675
+ </dd>
8676
+ </dl>
8677
+ </details>
8678
+
8679
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
8680
+ <dl>
8681
+ <dd>
8682
+
8683
+ #### 📝 Description
8684
+
8685
+ <dl>
8686
+ <dd>
8687
+
8688
+ <dl>
8689
+ <dd>
8690
+
8691
+ Creates an order for an unregistered testkit
8692
+
8693
+ </dd>
8694
+ </dl>
8695
+ </dd>
8696
+ </dl>
8697
+
8698
+ #### 🔌 Usage
8699
+
8700
+ <dl>
8701
+ <dd>
8702
+
8703
+ <dl>
8704
+ <dd>
8705
+
8706
+ ```typescript
8707
+ await client.testkit.createOrder({
8708
+ userId: "user_id",
8709
+ labTestId: "lab_test_id",
8710
+ shippingDetails: {
8711
+ receiverName: "receiver_name",
8712
+ firstLine: "first_line",
8713
+ city: "city",
8714
+ state: "state",
8715
+ zip: "zip",
8716
+ country: "country",
8717
+ phoneNumber: "phone_number",
8718
+ },
8719
+ });
8720
+ ```
8721
+
8722
+ </dd>
8723
+ </dl>
8724
+ </dd>
8725
+ </dl>
8726
+
8727
+ #### ⚙️ Parameters
8728
+
8729
+ <dl>
8730
+ <dd>
8731
+
8732
+ <dl>
8733
+ <dd>
8734
+
8735
+ **request:** `Vital.CreateRegistrableTestkitOrderRequest`
8736
+
8737
+ </dd>
8738
+ </dl>
8739
+
8740
+ <dl>
8741
+ <dd>
8742
+
8743
+ **requestOptions:** `Testkit.RequestOptions`
8744
+
8745
+ </dd>
8746
+ </dl>
8747
+ </dd>
8748
+ </dl>
8749
+
8750
+ </dd>
8751
+ </dl>
8752
+ </details>
8753
+
8754
+ ## Insurance
8755
+
8756
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponse[]</code></summary>
8757
+ <dl>
8758
+ <dd>
8759
+
8760
+ #### 🔌 Usage
8761
+
8762
+ <dl>
8763
+ <dd>
8764
+
8765
+ <dl>
8766
+ <dd>
8767
+
8768
+ ```typescript
8769
+ await client.insurance.searchPayorInfo({
8770
+ insuranceName: "insurance_name",
8771
+ });
8772
+ ```
8773
+
8774
+ </dd>
8775
+ </dl>
8776
+ </dd>
8777
+ </dl>
8778
+
8779
+ #### ⚙️ Parameters
8780
+
8781
+ <dl>
8782
+ <dd>
8783
+
8784
+ <dl>
8785
+ <dd>
8786
+
8787
+ **request:** `Vital.PayorSearchRequest`
8788
+
8789
+ </dd>
8790
+ </dl>
8791
+
8792
+ <dl>
8793
+ <dd>
8794
+
8795
+ **requestOptions:** `Insurance.RequestOptions`
8796
+
8797
+ </dd>
8798
+ </dl>
8799
+ </dd>
8800
+ </dl>
8801
+
8802
+ </dd>
8803
+ </dl>
8804
+ </details>
8805
+
8806
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchDiagnosis</a>({ ...params }) -> Vital.ClientFacingDiagnosisInformation[]</code></summary>
8807
+ <dl>
8808
+ <dd>
8809
+
8810
+ #### 🔌 Usage
8811
+
8812
+ <dl>
8813
+ <dd>
8814
+
8815
+ <dl>
8816
+ <dd>
8817
+
8818
+ ```typescript
8819
+ await client.insurance.searchDiagnosis({
8820
+ diagnosisQuery: "diagnosis_query",
8821
+ });
8822
+ ```
8823
+
8824
+ </dd>
8825
+ </dl>
8826
+ </dd>
8827
+ </dl>
8828
+
8829
+ #### ⚙️ Parameters
8830
+
8831
+ <dl>
8832
+ <dd>
8833
+
8834
+ <dl>
8835
+ <dd>
8836
+
8837
+ **request:** `Vital.InsuranceSearchDiagnosisRequest`
8838
+
8839
+ </dd>
8840
+ </dl>
8841
+
8842
+ <dl>
8843
+ <dd>
8844
+
8845
+ **requestOptions:** `Insurance.RequestOptions`
8846
+
8847
+ </dd>
8848
+ </dl>
8849
+ </dd>
8850
+ </dl>
8851
+
8852
+ </dd>
8853
+ </dl>
8854
+ </details>
8855
+
8856
+ ## Aggregate
8857
+
8858
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">queryOne</a>(userId, { ...params }) -> unknown</code></summary>
8859
+ <dl>
8860
+ <dd>
8861
+
8862
+ #### 🔌 Usage
8863
+
8864
+ <dl>
8865
+ <dd>
8866
+
8867
+ <dl>
8868
+ <dd>
8869
+
8870
+ ```typescript
8871
+ await client.aggregate.queryOne("user_id", {
8872
+ timeframe: {
8873
+ type: "relative",
8874
+ anchor: "anchor",
8875
+ past: {
8876
+ unit: Vital.PeriodUnit.Minute,
8877
+ },
8878
+ },
8879
+ instructions: [
8880
+ {
8881
+ select: [
8882
+ {
8883
+ arg: {
8884
+ sleep: Vital.SleepColumnExprSleep.SessionStart,
8885
+ },
8886
+ func: Vital.AggregateExprFunc.Mean,
8887
+ },
8888
+ ],
8889
+ groupBy: [
8890
+ {
8891
+ dateTrunc: {
8892
+ unit: Vital.PeriodUnit.Minute,
8893
+ },
8894
+ arg: {
8895
+ index: Vital.IndexColumnExprIndex.Sleep,
8896
+ },
8897
+ },
8898
+ ],
8899
+ },
8900
+ ],
8901
+ });
8902
+ ```
8903
+
8904
+ </dd>
8905
+ </dl>
8906
+ </dd>
8907
+ </dl>
8908
+
8909
+ #### ⚙️ Parameters
8910
+
8911
+ <dl>
8912
+ <dd>
8913
+
8914
+ <dl>
8915
+ <dd>
8916
+
8917
+ **userId:** `string`
8918
+
8919
+ </dd>
8920
+ </dl>
8921
+
8922
+ <dl>
8923
+ <dd>
8924
+
8925
+ **request:** `Vital.Query`
8926
+
8927
+ </dd>
8928
+ </dl>
8929
+
8930
+ <dl>
8931
+ <dd>
8932
+
8933
+ **requestOptions:** `Aggregate.RequestOptions`
8934
+
8935
+ </dd>
8936
+ </dl>
8937
+ </dd>
8938
+ </dl>
8939
+
8940
+ </dd>
8941
+ </dl>
8942
+ </details>