@tryvital/vital-node 3.1.315 → 3.1.316

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 (50) 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/payor/client/Client.js +1 -1
  14. package/api/resources/profile/client/Client.js +2 -2
  15. package/api/resources/providers/client/Client.js +1 -1
  16. package/api/resources/sleep/client/Client.js +3 -3
  17. package/api/resources/sleepCycle/client/Client.js +1 -1
  18. package/api/resources/team/client/Client.js +7 -7
  19. package/api/resources/testkit/client/Client.js +2 -2
  20. package/api/resources/user/client/Client.js +16 -16
  21. package/api/resources/vitals/client/Client.js +78 -78
  22. package/api/resources/workouts/client/Client.js +3 -3
  23. package/dist/api/resources/activity/client/Client.js +2 -2
  24. package/dist/api/resources/aggregate/client/Client.js +3 -3
  25. package/dist/api/resources/body/client/Client.js +2 -2
  26. package/dist/api/resources/devices/client/Client.js +1 -1
  27. package/dist/api/resources/electrocardiogram/client/Client.js +1 -1
  28. package/dist/api/resources/insurance/client/Client.js +3 -3
  29. package/dist/api/resources/introspect/client/Client.js +2 -2
  30. package/dist/api/resources/labTests/client/Client.js +41 -41
  31. package/dist/api/resources/link/client/Client.js +19 -19
  32. package/dist/api/resources/meal/client/Client.js +1 -1
  33. package/dist/api/resources/menstrualCycle/client/Client.js +1 -1
  34. package/dist/api/resources/order/client/Client.js +1 -1
  35. package/dist/api/resources/payor/client/Client.js +1 -1
  36. package/dist/api/resources/profile/client/Client.js +2 -2
  37. package/dist/api/resources/providers/client/Client.js +1 -1
  38. package/dist/api/resources/sleep/client/Client.js +3 -3
  39. package/dist/api/resources/sleepCycle/client/Client.js +1 -1
  40. package/dist/api/resources/team/client/Client.js +7 -7
  41. package/dist/api/resources/testkit/client/Client.js +2 -2
  42. package/dist/api/resources/user/client/Client.js +16 -16
  43. package/dist/api/resources/vitals/client/Client.js +78 -78
  44. package/dist/api/resources/workouts/client/Client.js +3 -3
  45. package/dist/version.d.ts +1 -1
  46. package/dist/version.js +1 -1
  47. package/package.json +1 -1
  48. package/reference.md +3463 -0
  49. package/version.d.ts +1 -1
  50. package/version.js +1 -1
package/reference.md CHANGED
@@ -7742,3 +7742,3466 @@ await client.user.deregisterProvider("user_id", "oura");
7742
7742
 
7743
7743
  </dd>
7744
7744
  </dl>
7745
+ </details>
7746
+
7747
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
7748
+ <dl>
7749
+ <dd>
7750
+
7751
+ #### 🔌 Usage
7752
+
7753
+ <dl>
7754
+ <dd>
7755
+
7756
+ <dl>
7757
+ <dd>
7758
+
7759
+ ```typescript
7760
+ await client.user.undoDelete();
7761
+ ```
7762
+
7763
+ </dd>
7764
+ </dl>
7765
+ </dd>
7766
+ </dl>
7767
+
7768
+ #### ⚙️ Parameters
7769
+
7770
+ <dl>
7771
+ <dd>
7772
+
7773
+ <dl>
7774
+ <dd>
7775
+
7776
+ **request:** `Vital.UserUndoDeleteRequest`
7777
+
7778
+ </dd>
7779
+ </dl>
7780
+
7781
+ <dl>
7782
+ <dd>
7783
+
7784
+ **requestOptions:** `User.RequestOptions`
7785
+
7786
+ </dd>
7787
+ </dl>
7788
+ </dd>
7789
+ </dl>
7790
+
7791
+ </dd>
7792
+ </dl>
7793
+ </details>
7794
+
7795
+ <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
7796
+ <dl>
7797
+ <dd>
7798
+
7799
+ #### 📝 Description
7800
+
7801
+ <dl>
7802
+ <dd>
7803
+
7804
+ <dl>
7805
+ <dd>
7806
+
7807
+ Trigger a manual refresh for a specific user
7808
+
7809
+ </dd>
7810
+ </dl>
7811
+ </dd>
7812
+ </dl>
7813
+
7814
+ #### 🔌 Usage
7815
+
7816
+ <dl>
7817
+ <dd>
7818
+
7819
+ <dl>
7820
+ <dd>
7821
+
7822
+ ```typescript
7823
+ await client.user.refresh("user_id");
7824
+ ```
7825
+
7826
+ </dd>
7827
+ </dl>
7828
+ </dd>
7829
+ </dl>
7830
+
7831
+ #### ⚙️ Parameters
7832
+
7833
+ <dl>
7834
+ <dd>
7835
+
7836
+ <dl>
7837
+ <dd>
7838
+
7839
+ **userId:** `string`
7840
+
7841
+ </dd>
7842
+ </dl>
7843
+
7844
+ <dl>
7845
+ <dd>
7846
+
7847
+ **request:** `Vital.UserRefreshRequest`
7848
+
7849
+ </dd>
7850
+ </dl>
7851
+
7852
+ <dl>
7853
+ <dd>
7854
+
7855
+ **requestOptions:** `User.RequestOptions`
7856
+
7857
+ </dd>
7858
+ </dl>
7859
+ </dd>
7860
+ </dl>
7861
+
7862
+ </dd>
7863
+ </dl>
7864
+ </details>
7865
+
7866
+ ## Team
7867
+
7868
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getLinkConfig</a>({ ...params }) -> Record<string, unknown></code></summary>
7869
+ <dl>
7870
+ <dd>
7871
+
7872
+ #### 📝 Description
7873
+
7874
+ <dl>
7875
+ <dd>
7876
+
7877
+ <dl>
7878
+ <dd>
7879
+
7880
+ Post teams.
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.team.getLinkConfig();
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
+ **request:** `Vital.TeamGetLinkConfigRequest`
7913
+
7914
+ </dd>
7915
+ </dl>
7916
+
7917
+ <dl>
7918
+ <dd>
7919
+
7920
+ **requestOptions:** `Team.RequestOptions`
7921
+
7922
+ </dd>
7923
+ </dl>
7924
+ </dd>
7925
+ </dl>
7926
+
7927
+ </dd>
7928
+ </dl>
7929
+ </details>
7930
+
7931
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">get</a>(teamId) -> Vital.ClientFacingTeam</code></summary>
7932
+ <dl>
7933
+ <dd>
7934
+
7935
+ #### 📝 Description
7936
+
7937
+ <dl>
7938
+ <dd>
7939
+
7940
+ <dl>
7941
+ <dd>
7942
+
7943
+ Get team.
7944
+
7945
+ </dd>
7946
+ </dl>
7947
+ </dd>
7948
+ </dl>
7949
+
7950
+ #### 🔌 Usage
7951
+
7952
+ <dl>
7953
+ <dd>
7954
+
7955
+ <dl>
7956
+ <dd>
7957
+
7958
+ ```typescript
7959
+ await client.team.get("team_id");
7960
+ ```
7961
+
7962
+ </dd>
7963
+ </dl>
7964
+ </dd>
7965
+ </dl>
7966
+
7967
+ #### ⚙️ Parameters
7968
+
7969
+ <dl>
7970
+ <dd>
7971
+
7972
+ <dl>
7973
+ <dd>
7974
+
7975
+ **teamId:** `string`
7976
+
7977
+ </dd>
7978
+ </dl>
7979
+
7980
+ <dl>
7981
+ <dd>
7982
+
7983
+ **requestOptions:** `Team.RequestOptions`
7984
+
7985
+ </dd>
7986
+ </dl>
7987
+ </dd>
7988
+ </dl>
7989
+
7990
+ </dd>
7991
+ </dl>
7992
+ </details>
7993
+
7994
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getUserById</a>({ ...params }) -> Vital.ClientFacingUser[]</code></summary>
7995
+ <dl>
7996
+ <dd>
7997
+
7998
+ #### 📝 Description
7999
+
8000
+ <dl>
8001
+ <dd>
8002
+
8003
+ <dl>
8004
+ <dd>
8005
+
8006
+ Search team users by user_id
8007
+
8008
+ </dd>
8009
+ </dl>
8010
+ </dd>
8011
+ </dl>
8012
+
8013
+ #### 🔌 Usage
8014
+
8015
+ <dl>
8016
+ <dd>
8017
+
8018
+ <dl>
8019
+ <dd>
8020
+
8021
+ ```typescript
8022
+ await client.team.getUserById();
8023
+ ```
8024
+
8025
+ </dd>
8026
+ </dl>
8027
+ </dd>
8028
+ </dl>
8029
+
8030
+ #### ⚙️ Parameters
8031
+
8032
+ <dl>
8033
+ <dd>
8034
+
8035
+ <dl>
8036
+ <dd>
8037
+
8038
+ **request:** `Vital.TeamGetUserByIdRequest`
8039
+
8040
+ </dd>
8041
+ </dl>
8042
+
8043
+ <dl>
8044
+ <dd>
8045
+
8046
+ **requestOptions:** `Team.RequestOptions`
8047
+
8048
+ </dd>
8049
+ </dl>
8050
+ </dd>
8051
+ </dl>
8052
+
8053
+ </dd>
8054
+ </dl>
8055
+ </details>
8056
+
8057
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSvixUrl</a>() -> Record<string, unknown></code></summary>
8058
+ <dl>
8059
+ <dd>
8060
+
8061
+ #### 🔌 Usage
8062
+
8063
+ <dl>
8064
+ <dd>
8065
+
8066
+ <dl>
8067
+ <dd>
8068
+
8069
+ ```typescript
8070
+ await client.team.getSvixUrl();
8071
+ ```
8072
+
8073
+ </dd>
8074
+ </dl>
8075
+ </dd>
8076
+ </dl>
8077
+
8078
+ #### ⚙️ Parameters
8079
+
8080
+ <dl>
8081
+ <dd>
8082
+
8083
+ <dl>
8084
+ <dd>
8085
+
8086
+ **requestOptions:** `Team.RequestOptions`
8087
+
8088
+ </dd>
8089
+ </dl>
8090
+ </dd>
8091
+ </dl>
8092
+
8093
+ </dd>
8094
+ </dl>
8095
+ </details>
8096
+
8097
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getSourcePriorities</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
8098
+ <dl>
8099
+ <dd>
8100
+
8101
+ #### 📝 Description
8102
+
8103
+ <dl>
8104
+ <dd>
8105
+
8106
+ <dl>
8107
+ <dd>
8108
+
8109
+ GET source priorities.
8110
+
8111
+ </dd>
8112
+ </dl>
8113
+ </dd>
8114
+ </dl>
8115
+
8116
+ #### 🔌 Usage
8117
+
8118
+ <dl>
8119
+ <dd>
8120
+
8121
+ <dl>
8122
+ <dd>
8123
+
8124
+ ```typescript
8125
+ await client.team.getSourcePriorities();
8126
+ ```
8127
+
8128
+ </dd>
8129
+ </dl>
8130
+ </dd>
8131
+ </dl>
8132
+
8133
+ #### ⚙️ Parameters
8134
+
8135
+ <dl>
8136
+ <dd>
8137
+
8138
+ <dl>
8139
+ <dd>
8140
+
8141
+ **request:** `Vital.TeamGetSourcePrioritiesRequest`
8142
+
8143
+ </dd>
8144
+ </dl>
8145
+
8146
+ <dl>
8147
+ <dd>
8148
+
8149
+ **requestOptions:** `Team.RequestOptions`
8150
+
8151
+ </dd>
8152
+ </dl>
8153
+ </dd>
8154
+ </dl>
8155
+
8156
+ </dd>
8157
+ </dl>
8158
+ </details>
8159
+
8160
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">updateSourcePriorities</a>() -> Record<string, unknown>[]</code></summary>
8161
+ <dl>
8162
+ <dd>
8163
+
8164
+ #### 📝 Description
8165
+
8166
+ <dl>
8167
+ <dd>
8168
+
8169
+ <dl>
8170
+ <dd>
8171
+
8172
+ Patch source priorities.
8173
+
8174
+ </dd>
8175
+ </dl>
8176
+ </dd>
8177
+ </dl>
8178
+
8179
+ #### 🔌 Usage
8180
+
8181
+ <dl>
8182
+ <dd>
8183
+
8184
+ <dl>
8185
+ <dd>
8186
+
8187
+ ```typescript
8188
+ await client.team.updateSourcePriorities();
8189
+ ```
8190
+
8191
+ </dd>
8192
+ </dl>
8193
+ </dd>
8194
+ </dl>
8195
+
8196
+ #### ⚙️ Parameters
8197
+
8198
+ <dl>
8199
+ <dd>
8200
+
8201
+ <dl>
8202
+ <dd>
8203
+
8204
+ **requestOptions:** `Team.RequestOptions`
8205
+
8206
+ </dd>
8207
+ </dl>
8208
+ </dd>
8209
+ </dl>
8210
+
8211
+ </dd>
8212
+ </dl>
8213
+ </details>
8214
+
8215
+ <details><summary><code>client.team.<a href="/src/api/resources/team/client/Client.ts">getPhysicians</a>(teamId) -> Vital.ClientFacingPhysician[]</code></summary>
8216
+ <dl>
8217
+ <dd>
8218
+
8219
+ #### 🔌 Usage
8220
+
8221
+ <dl>
8222
+ <dd>
8223
+
8224
+ <dl>
8225
+ <dd>
8226
+
8227
+ ```typescript
8228
+ await client.team.getPhysicians("team_id");
8229
+ ```
8230
+
8231
+ </dd>
8232
+ </dl>
8233
+ </dd>
8234
+ </dl>
8235
+
8236
+ #### ⚙️ Parameters
8237
+
8238
+ <dl>
8239
+ <dd>
8240
+
8241
+ <dl>
8242
+ <dd>
8243
+
8244
+ **teamId:** `string`
8245
+
8246
+ </dd>
8247
+ </dl>
8248
+
8249
+ <dl>
8250
+ <dd>
8251
+
8252
+ **requestOptions:** `Team.RequestOptions`
8253
+
8254
+ </dd>
8255
+ </dl>
8256
+ </dd>
8257
+ </dl>
8258
+
8259
+ </dd>
8260
+ </dl>
8261
+ </details>
8262
+
8263
+ ## Providers
8264
+
8265
+ <details><summary><code>client.providers.<a href="/src/api/resources/providers/client/Client.ts">getAll</a>({ ...params }) -> Vital.ClientFacingProviderDetailed[]</code></summary>
8266
+ <dl>
8267
+ <dd>
8268
+
8269
+ #### 📝 Description
8270
+
8271
+ <dl>
8272
+ <dd>
8273
+
8274
+ <dl>
8275
+ <dd>
8276
+
8277
+ Get Provider list
8278
+
8279
+ </dd>
8280
+ </dl>
8281
+ </dd>
8282
+ </dl>
8283
+
8284
+ #### 🔌 Usage
8285
+
8286
+ <dl>
8287
+ <dd>
8288
+
8289
+ <dl>
8290
+ <dd>
8291
+
8292
+ ```typescript
8293
+ await client.providers.getAll();
8294
+ ```
8295
+
8296
+ </dd>
8297
+ </dl>
8298
+ </dd>
8299
+ </dl>
8300
+
8301
+ #### ⚙️ Parameters
8302
+
8303
+ <dl>
8304
+ <dd>
8305
+
8306
+ <dl>
8307
+ <dd>
8308
+
8309
+ **request:** `Vital.ProvidersGetAllRequest`
8310
+
8311
+ </dd>
8312
+ </dl>
8313
+
8314
+ <dl>
8315
+ <dd>
8316
+
8317
+ **requestOptions:** `Providers.RequestOptions`
8318
+
8319
+ </dd>
8320
+ </dl>
8321
+ </dd>
8322
+ </dl>
8323
+
8324
+ </dd>
8325
+ </dl>
8326
+ </details>
8327
+
8328
+ ## Introspect
8329
+
8330
+ <details><summary><code>client.introspect.<a href="/src/api/resources/introspect/client/Client.ts">getUserResources</a>({ ...params }) -> Vital.UserResourcesResponse</code></summary>
8331
+ <dl>
8332
+ <dd>
8333
+
8334
+ #### 🔌 Usage
8335
+
8336
+ <dl>
8337
+ <dd>
8338
+
8339
+ <dl>
8340
+ <dd>
8341
+
8342
+ ```typescript
8343
+ await client.introspect.getUserResources();
8344
+ ```
8345
+
8346
+ </dd>
8347
+ </dl>
8348
+ </dd>
8349
+ </dl>
8350
+
8351
+ #### ⚙️ Parameters
8352
+
8353
+ <dl>
8354
+ <dd>
8355
+
8356
+ <dl>
8357
+ <dd>
8358
+
8359
+ **request:** `Vital.IntrospectGetUserResourcesRequest`
8360
+
8361
+ </dd>
8362
+ </dl>
8363
+
8364
+ <dl>
8365
+ <dd>
8366
+
8367
+ **requestOptions:** `Introspect.RequestOptions`
8368
+
8369
+ </dd>
8370
+ </dl>
8371
+ </dd>
8372
+ </dl>
8373
+
8374
+ </dd>
8375
+ </dl>
8376
+ </details>
8377
+
8378
+ <details><summary><code>client.introspect.<a href="/src/api/resources/introspect/client/Client.ts">getUserHistoricalPulls</a>({ ...params }) -> Vital.UserHistoricalPullsResponse</code></summary>
8379
+ <dl>
8380
+ <dd>
8381
+
8382
+ #### 🔌 Usage
8383
+
8384
+ <dl>
8385
+ <dd>
8386
+
8387
+ <dl>
8388
+ <dd>
8389
+
8390
+ ```typescript
8391
+ await client.introspect.getUserHistoricalPulls();
8392
+ ```
8393
+
8394
+ </dd>
8395
+ </dl>
8396
+ </dd>
8397
+ </dl>
8398
+
8399
+ #### ⚙️ Parameters
8400
+
8401
+ <dl>
8402
+ <dd>
8403
+
8404
+ <dl>
8405
+ <dd>
8406
+
8407
+ **request:** `Vital.IntrospectGetUserHistoricalPullsRequest`
8408
+
8409
+ </dd>
8410
+ </dl>
8411
+
8412
+ <dl>
8413
+ <dd>
8414
+
8415
+ **requestOptions:** `Introspect.RequestOptions`
8416
+
8417
+ </dd>
8418
+ </dl>
8419
+ </dd>
8420
+ </dl>
8421
+
8422
+ </dd>
8423
+ </dl>
8424
+ </details>
8425
+
8426
+ ## LabTests
8427
+
8428
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">get</a>({ ...params }) -> Vital.ClientFacingLabTest[]</code></summary>
8429
+ <dl>
8430
+ <dd>
8431
+
8432
+ #### 📝 Description
8433
+
8434
+ <dl>
8435
+ <dd>
8436
+
8437
+ <dl>
8438
+ <dd>
8439
+
8440
+ GET all the lab tests the team has access to.
8441
+
8442
+ </dd>
8443
+ </dl>
8444
+ </dd>
8445
+ </dl>
8446
+
8447
+ #### 🔌 Usage
8448
+
8449
+ <dl>
8450
+ <dd>
8451
+
8452
+ <dl>
8453
+ <dd>
8454
+
8455
+ ```typescript
8456
+ await client.labTests.get();
8457
+ ```
8458
+
8459
+ </dd>
8460
+ </dl>
8461
+ </dd>
8462
+ </dl>
8463
+
8464
+ #### ⚙️ Parameters
8465
+
8466
+ <dl>
8467
+ <dd>
8468
+
8469
+ <dl>
8470
+ <dd>
8471
+
8472
+ **request:** `Vital.LabTestsGetRequest`
8473
+
8474
+ </dd>
8475
+ </dl>
8476
+
8477
+ <dl>
8478
+ <dd>
8479
+
8480
+ **requestOptions:** `LabTests.RequestOptions`
8481
+
8482
+ </dd>
8483
+ </dl>
8484
+ </dd>
8485
+ </dl>
8486
+
8487
+ </dd>
8488
+ </dl>
8489
+ </details>
8490
+
8491
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">create</a>({ ...params }) -> Vital.ClientFacingLabTest</code></summary>
8492
+ <dl>
8493
+ <dd>
8494
+
8495
+ #### 🔌 Usage
8496
+
8497
+ <dl>
8498
+ <dd>
8499
+
8500
+ <dl>
8501
+ <dd>
8502
+
8503
+ ```typescript
8504
+ await client.labTests.create({
8505
+ name: "name",
8506
+ method: "testkit",
8507
+ description: "description",
8508
+ });
8509
+ ```
8510
+
8511
+ </dd>
8512
+ </dl>
8513
+ </dd>
8514
+ </dl>
8515
+
8516
+ #### ⚙️ Parameters
8517
+
8518
+ <dl>
8519
+ <dd>
8520
+
8521
+ <dl>
8522
+ <dd>
8523
+
8524
+ **request:** `Vital.CreateLabTestRequest`
8525
+
8526
+ </dd>
8527
+ </dl>
8528
+
8529
+ <dl>
8530
+ <dd>
8531
+
8532
+ **requestOptions:** `LabTests.RequestOptions`
8533
+
8534
+ </dd>
8535
+ </dl>
8536
+ </dd>
8537
+ </dl>
8538
+
8539
+ </dd>
8540
+ </dl>
8541
+ </details>
8542
+
8543
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getById</a>(labTestId) -> Vital.ClientFacingLabTest</code></summary>
8544
+ <dl>
8545
+ <dd>
8546
+
8547
+ #### 📝 Description
8548
+
8549
+ <dl>
8550
+ <dd>
8551
+
8552
+ <dl>
8553
+ <dd>
8554
+
8555
+ GET all the lab tests the team has access to.
8556
+
8557
+ </dd>
8558
+ </dl>
8559
+ </dd>
8560
+ </dl>
8561
+
8562
+ #### 🔌 Usage
8563
+
8564
+ <dl>
8565
+ <dd>
8566
+
8567
+ <dl>
8568
+ <dd>
8569
+
8570
+ ```typescript
8571
+ await client.labTests.getById("lab_test_id");
8572
+ ```
8573
+
8574
+ </dd>
8575
+ </dl>
8576
+ </dd>
8577
+ </dl>
8578
+
8579
+ #### ⚙️ Parameters
8580
+
8581
+ <dl>
8582
+ <dd>
8583
+
8584
+ <dl>
8585
+ <dd>
8586
+
8587
+ **labTestId:** `string`
8588
+
8589
+ </dd>
8590
+ </dl>
8591
+
8592
+ <dl>
8593
+ <dd>
8594
+
8595
+ **requestOptions:** `LabTests.RequestOptions`
8596
+
8597
+ </dd>
8598
+ </dl>
8599
+ </dd>
8600
+ </dl>
8601
+
8602
+ </dd>
8603
+ </dl>
8604
+ </details>
8605
+
8606
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">updateLabTest</a>(labTestId, { ...params }) -> Vital.ClientFacingLabTest</code></summary>
8607
+ <dl>
8608
+ <dd>
8609
+
8610
+ #### 🔌 Usage
8611
+
8612
+ <dl>
8613
+ <dd>
8614
+
8615
+ <dl>
8616
+ <dd>
8617
+
8618
+ ```typescript
8619
+ await client.labTests.updateLabTest("lab_test_id");
8620
+ ```
8621
+
8622
+ </dd>
8623
+ </dl>
8624
+ </dd>
8625
+ </dl>
8626
+
8627
+ #### ⚙️ Parameters
8628
+
8629
+ <dl>
8630
+ <dd>
8631
+
8632
+ <dl>
8633
+ <dd>
8634
+
8635
+ **labTestId:** `string`
8636
+
8637
+ </dd>
8638
+ </dl>
8639
+
8640
+ <dl>
8641
+ <dd>
8642
+
8643
+ **request:** `Vital.UpdateLabTestRequest`
8644
+
8645
+ </dd>
8646
+ </dl>
8647
+
8648
+ <dl>
8649
+ <dd>
8650
+
8651
+ **requestOptions:** `LabTests.RequestOptions`
8652
+
8653
+ </dd>
8654
+ </dl>
8655
+ </dd>
8656
+ </dl>
8657
+
8658
+ </dd>
8659
+ </dl>
8660
+ </details>
8661
+
8662
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkers</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
8663
+ <dl>
8664
+ <dd>
8665
+
8666
+ #### 📝 Description
8667
+
8668
+ <dl>
8669
+ <dd>
8670
+
8671
+ <dl>
8672
+ <dd>
8673
+
8674
+ GET all the markers for the given lab.
8675
+
8676
+ </dd>
8677
+ </dl>
8678
+ </dd>
8679
+ </dl>
8680
+
8681
+ #### 🔌 Usage
8682
+
8683
+ <dl>
8684
+ <dd>
8685
+
8686
+ <dl>
8687
+ <dd>
8688
+
8689
+ ```typescript
8690
+ await client.labTests.getMarkers();
8691
+ ```
8692
+
8693
+ </dd>
8694
+ </dl>
8695
+ </dd>
8696
+ </dl>
8697
+
8698
+ #### ⚙️ Parameters
8699
+
8700
+ <dl>
8701
+ <dd>
8702
+
8703
+ <dl>
8704
+ <dd>
8705
+
8706
+ **request:** `Vital.LabTestsGetMarkersRequest`
8707
+
8708
+ </dd>
8709
+ </dl>
8710
+
8711
+ <dl>
8712
+ <dd>
8713
+
8714
+ **requestOptions:** `LabTests.RequestOptions`
8715
+
8716
+ </dd>
8717
+ </dl>
8718
+ </dd>
8719
+ </dl>
8720
+
8721
+ </dd>
8722
+ </dl>
8723
+ </details>
8724
+
8725
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForOrderSet</a>({ ...params }) -> Vital.GetMarkersResponse</code></summary>
8726
+ <dl>
8727
+ <dd>
8728
+
8729
+ #### 🔌 Usage
8730
+
8731
+ <dl>
8732
+ <dd>
8733
+
8734
+ <dl>
8735
+ <dd>
8736
+
8737
+ ```typescript
8738
+ await client.labTests.getMarkersForOrderSet({
8739
+ body: {},
8740
+ });
8741
+ ```
8742
+
8743
+ </dd>
8744
+ </dl>
8745
+ </dd>
8746
+ </dl>
8747
+
8748
+ #### ⚙️ Parameters
8749
+
8750
+ <dl>
8751
+ <dd>
8752
+
8753
+ <dl>
8754
+ <dd>
8755
+
8756
+ **request:** `Vital.LabTestsGetMarkersForOrderSetRequest`
8757
+
8758
+ </dd>
8759
+ </dl>
8760
+
8761
+ <dl>
8762
+ <dd>
8763
+
8764
+ **requestOptions:** `LabTests.RequestOptions`
8765
+
8766
+ </dd>
8767
+ </dl>
8768
+ </dd>
8769
+ </dl>
8770
+
8771
+ </dd>
8772
+ </dl>
8773
+ </details>
8774
+
8775
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersForLabTest</a>(labTestId, { ...params }) -> Vital.GetMarkersResponse</code></summary>
8776
+ <dl>
8777
+ <dd>
8778
+
8779
+ #### 🔌 Usage
8780
+
8781
+ <dl>
8782
+ <dd>
8783
+
8784
+ <dl>
8785
+ <dd>
8786
+
8787
+ ```typescript
8788
+ await client.labTests.getMarkersForLabTest("lab_test_id");
8789
+ ```
8790
+
8791
+ </dd>
8792
+ </dl>
8793
+ </dd>
8794
+ </dl>
8795
+
8796
+ #### ⚙️ Parameters
8797
+
8798
+ <dl>
8799
+ <dd>
8800
+
8801
+ <dl>
8802
+ <dd>
8803
+
8804
+ **labTestId:** `string`
8805
+
8806
+ </dd>
8807
+ </dl>
8808
+
8809
+ <dl>
8810
+ <dd>
8811
+
8812
+ **request:** `Vital.LabTestsGetMarkersForLabTestRequest`
8813
+
8814
+ </dd>
8815
+ </dl>
8816
+
8817
+ <dl>
8818
+ <dd>
8819
+
8820
+ **requestOptions:** `LabTests.RequestOptions`
8821
+
8822
+ </dd>
8823
+ </dl>
8824
+ </dd>
8825
+ </dl>
8826
+
8827
+ </dd>
8828
+ </dl>
8829
+ </details>
8830
+
8831
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getMarkersByLabAndProviderId</a>(providerId, labId) -> Vital.ClientFacingMarker</code></summary>
8832
+ <dl>
8833
+ <dd>
8834
+
8835
+ #### 📝 Description
8836
+
8837
+ <dl>
8838
+ <dd>
8839
+
8840
+ <dl>
8841
+ <dd>
8842
+
8843
+ GET a specific marker for the given lab and provider_id
8844
+
8845
+ </dd>
8846
+ </dl>
8847
+ </dd>
8848
+ </dl>
8849
+
8850
+ #### 🔌 Usage
8851
+
8852
+ <dl>
8853
+ <dd>
8854
+
8855
+ <dl>
8856
+ <dd>
8857
+
8858
+ ```typescript
8859
+ await client.labTests.getMarkersByLabAndProviderId("provider_id", 1);
8860
+ ```
8861
+
8862
+ </dd>
8863
+ </dl>
8864
+ </dd>
8865
+ </dl>
8866
+
8867
+ #### ⚙️ Parameters
8868
+
8869
+ <dl>
8870
+ <dd>
8871
+
8872
+ <dl>
8873
+ <dd>
8874
+
8875
+ **providerId:** `string`
8876
+
8877
+ </dd>
8878
+ </dl>
8879
+
8880
+ <dl>
8881
+ <dd>
8882
+
8883
+ **labId:** `number`
8884
+
8885
+ </dd>
8886
+ </dl>
8887
+
8888
+ <dl>
8889
+ <dd>
8890
+
8891
+ **requestOptions:** `LabTests.RequestOptions`
8892
+
8893
+ </dd>
8894
+ </dl>
8895
+ </dd>
8896
+ </dl>
8897
+
8898
+ </dd>
8899
+ </dl>
8900
+ </details>
8901
+
8902
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getLabs</a>() -> Vital.ClientFacingLab[]</code></summary>
8903
+ <dl>
8904
+ <dd>
8905
+
8906
+ #### 📝 Description
8907
+
8908
+ <dl>
8909
+ <dd>
8910
+
8911
+ <dl>
8912
+ <dd>
8913
+
8914
+ GET all the labs.
8915
+
8916
+ </dd>
8917
+ </dl>
8918
+ </dd>
8919
+ </dl>
8920
+
8921
+ #### 🔌 Usage
8922
+
8923
+ <dl>
8924
+ <dd>
8925
+
8926
+ <dl>
8927
+ <dd>
8928
+
8929
+ ```typescript
8930
+ await client.labTests.getLabs();
8931
+ ```
8932
+
8933
+ </dd>
8934
+ </dl>
8935
+ </dd>
8936
+ </dl>
8937
+
8938
+ #### ⚙️ Parameters
8939
+
8940
+ <dl>
8941
+ <dd>
8942
+
8943
+ <dl>
8944
+ <dd>
8945
+
8946
+ **requestOptions:** `LabTests.RequestOptions`
8947
+
8948
+ </dd>
8949
+ </dl>
8950
+ </dd>
8951
+ </dl>
8952
+
8953
+ </dd>
8954
+ </dl>
8955
+ </details>
8956
+
8957
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPaginated</a>({ ...params }) -> Vital.LabTestResourcesResponse</code></summary>
8958
+ <dl>
8959
+ <dd>
8960
+
8961
+ #### 📝 Description
8962
+
8963
+ <dl>
8964
+ <dd>
8965
+
8966
+ <dl>
8967
+ <dd>
8968
+
8969
+ GET lab tests the team has access to as a paginated list.
8970
+
8971
+ </dd>
8972
+ </dl>
8973
+ </dd>
8974
+ </dl>
8975
+
8976
+ #### 🔌 Usage
8977
+
8978
+ <dl>
8979
+ <dd>
8980
+
8981
+ <dl>
8982
+ <dd>
8983
+
8984
+ ```typescript
8985
+ await client.labTests.getPaginated();
8986
+ ```
8987
+
8988
+ </dd>
8989
+ </dl>
8990
+ </dd>
8991
+ </dl>
8992
+
8993
+ #### ⚙️ Parameters
8994
+
8995
+ <dl>
8996
+ <dd>
8997
+
8998
+ <dl>
8999
+ <dd>
9000
+
9001
+ **request:** `Vital.LabTestsGetPaginatedRequest`
9002
+
9003
+ </dd>
9004
+ </dl>
9005
+
9006
+ <dl>
9007
+ <dd>
9008
+
9009
+ **requestOptions:** `LabTests.RequestOptions`
9010
+
9011
+ </dd>
9012
+ </dl>
9013
+ </dd>
9014
+ </dl>
9015
+
9016
+ </dd>
9017
+ </dl>
9018
+ </details>
9019
+
9020
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
9021
+ <dl>
9022
+ <dd>
9023
+
9024
+ #### 📝 Description
9025
+
9026
+ <dl>
9027
+ <dd>
9028
+
9029
+ <dl>
9030
+ <dd>
9031
+
9032
+ Return the available time slots to book an appointment with a phlebotomist
9033
+ for the given address and order.
9034
+
9035
+ </dd>
9036
+ </dl>
9037
+ </dd>
9038
+ </dl>
9039
+
9040
+ #### 🔌 Usage
9041
+
9042
+ <dl>
9043
+ <dd>
9044
+
9045
+ <dl>
9046
+ <dd>
9047
+
9048
+ ```typescript
9049
+ await client.labTests.getPhlebotomyAppointmentAvailability({
9050
+ body: {
9051
+ firstLine: "first_line",
9052
+ city: "city",
9053
+ state: "state",
9054
+ zipCode: "zip_code",
9055
+ },
9056
+ });
9057
+ ```
9058
+
9059
+ </dd>
9060
+ </dl>
9061
+ </dd>
9062
+ </dl>
9063
+
9064
+ #### ⚙️ Parameters
9065
+
9066
+ <dl>
9067
+ <dd>
9068
+
9069
+ <dl>
9070
+ <dd>
9071
+
9072
+ **request:** `Vital.LabTestsGetPhlebotomyAppointmentAvailabilityRequest`
9073
+
9074
+ </dd>
9075
+ </dl>
9076
+
9077
+ <dl>
9078
+ <dd>
9079
+
9080
+ **requestOptions:** `LabTests.RequestOptions`
9081
+
9082
+ </dd>
9083
+ </dl>
9084
+ </dd>
9085
+ </dl>
9086
+
9087
+ </dd>
9088
+ </dl>
9089
+ </details>
9090
+
9091
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9092
+ <dl>
9093
+ <dd>
9094
+
9095
+ #### 📝 Description
9096
+
9097
+ <dl>
9098
+ <dd>
9099
+
9100
+ <dl>
9101
+ <dd>
9102
+
9103
+ Book an at-home phlebotomy appointment.
9104
+
9105
+ </dd>
9106
+ </dl>
9107
+ </dd>
9108
+ </dl>
9109
+
9110
+ #### 🔌 Usage
9111
+
9112
+ <dl>
9113
+ <dd>
9114
+
9115
+ <dl>
9116
+ <dd>
9117
+
9118
+ ```typescript
9119
+ await client.labTests.bookPhlebotomyAppointment("order_id", {
9120
+ bookingKey: "booking_key",
9121
+ });
9122
+ ```
9123
+
9124
+ </dd>
9125
+ </dl>
9126
+ </dd>
9127
+ </dl>
9128
+
9129
+ #### ⚙️ Parameters
9130
+
9131
+ <dl>
9132
+ <dd>
9133
+
9134
+ <dl>
9135
+ <dd>
9136
+
9137
+ **orderId:** `string` — Your Order ID.
9138
+
9139
+ </dd>
9140
+ </dl>
9141
+
9142
+ <dl>
9143
+ <dd>
9144
+
9145
+ **request:** `Vital.AppointmentBookingRequest`
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">requestPhlebotomyAppointment</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
+ Request 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.requestPhlebotomyAppointment("order_id", {
9193
+ address: {
9194
+ firstLine: "first_line",
9195
+ city: "city",
9196
+ state: "state",
9197
+ zipCode: "zip_code",
9198
+ },
9199
+ provider: "getlabs",
9200
+ });
9201
+ ```
9202
+
9203
+ </dd>
9204
+ </dl>
9205
+ </dd>
9206
+ </dl>
9207
+
9208
+ #### ⚙️ Parameters
9209
+
9210
+ <dl>
9211
+ <dd>
9212
+
9213
+ <dl>
9214
+ <dd>
9215
+
9216
+ **orderId:** `string` — Your Order ID.
9217
+
9218
+ </dd>
9219
+ </dl>
9220
+
9221
+ <dl>
9222
+ <dd>
9223
+
9224
+ **request:** `Vital.RequestAppointmentRequest`
9225
+
9226
+ </dd>
9227
+ </dl>
9228
+
9229
+ <dl>
9230
+ <dd>
9231
+
9232
+ **requestOptions:** `LabTests.RequestOptions`
9233
+
9234
+ </dd>
9235
+ </dl>
9236
+ </dd>
9237
+ </dl>
9238
+
9239
+ </dd>
9240
+ </dl>
9241
+ </details>
9242
+
9243
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePhlebotomyAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9244
+ <dl>
9245
+ <dd>
9246
+
9247
+ #### 📝 Description
9248
+
9249
+ <dl>
9250
+ <dd>
9251
+
9252
+ <dl>
9253
+ <dd>
9254
+
9255
+ Reschedule a previously booked at-home phlebotomy appointment.
9256
+
9257
+ </dd>
9258
+ </dl>
9259
+ </dd>
9260
+ </dl>
9261
+
9262
+ #### 🔌 Usage
9263
+
9264
+ <dl>
9265
+ <dd>
9266
+
9267
+ <dl>
9268
+ <dd>
9269
+
9270
+ ```typescript
9271
+ await client.labTests.reschedulePhlebotomyAppointment("order_id", {
9272
+ bookingKey: "booking_key",
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.AppointmentRescheduleRequest`
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">cancelPhlebotomyAppointment</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
+ Cancel 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.cancelPhlebotomyAppointment("order_id", {
9345
+ cancellationReasonId: "cancellation_reason_id",
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.ApiApiV1EndpointsVitalApiLabTestingOrdersHelpersAppointmentCancelRequest`
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">getPhlebotomyAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
9390
+ <dl>
9391
+ <dd>
9392
+
9393
+ #### 📝 Description
9394
+
9395
+ <dl>
9396
+ <dd>
9397
+
9398
+ <dl>
9399
+ <dd>
9400
+
9401
+ Get the list of reasons for cancelling an 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.getPhlebotomyAppointmentCancellationReason();
9418
+ ```
9419
+
9420
+ </dd>
9421
+ </dl>
9422
+ </dd>
9423
+ </dl>
9424
+
9425
+ #### ⚙️ Parameters
9426
+
9427
+ <dl>
9428
+ <dd>
9429
+
9430
+ <dl>
9431
+ <dd>
9432
+
9433
+ **requestOptions:** `LabTests.RequestOptions`
9434
+
9435
+ </dd>
9436
+ </dl>
9437
+ </dd>
9438
+ </dl>
9439
+
9440
+ </dd>
9441
+ </dl>
9442
+ </details>
9443
+
9444
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPhlebotomyAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
9445
+ <dl>
9446
+ <dd>
9447
+
9448
+ #### 📝 Description
9449
+
9450
+ <dl>
9451
+ <dd>
9452
+
9453
+ <dl>
9454
+ <dd>
9455
+
9456
+ Get the appointment associated with an order.
9457
+
9458
+ </dd>
9459
+ </dl>
9460
+ </dd>
9461
+ </dl>
9462
+
9463
+ #### 🔌 Usage
9464
+
9465
+ <dl>
9466
+ <dd>
9467
+
9468
+ <dl>
9469
+ <dd>
9470
+
9471
+ ```typescript
9472
+ await client.labTests.getPhlebotomyAppointment("order_id");
9473
+ ```
9474
+
9475
+ </dd>
9476
+ </dl>
9477
+ </dd>
9478
+ </dl>
9479
+
9480
+ #### ⚙️ Parameters
9481
+
9482
+ <dl>
9483
+ <dd>
9484
+
9485
+ <dl>
9486
+ <dd>
9487
+
9488
+ **orderId:** `string` — Your Order ID.
9489
+
9490
+ </dd>
9491
+ </dl>
9492
+
9493
+ <dl>
9494
+ <dd>
9495
+
9496
+ **requestOptions:** `LabTests.RequestOptions`
9497
+
9498
+ </dd>
9499
+ </dl>
9500
+ </dd>
9501
+ </dl>
9502
+
9503
+ </dd>
9504
+ </dl>
9505
+ </details>
9506
+
9507
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getAreaInfo</a>({ ...params }) -> Vital.AreaInfo</code></summary>
9508
+ <dl>
9509
+ <dd>
9510
+
9511
+ #### 📝 Description
9512
+
9513
+ <dl>
9514
+ <dd>
9515
+
9516
+ <dl>
9517
+ <dd>
9518
+
9519
+ GET information about an area with respect to lab-testing.
9520
+
9521
+ Information returned:
9522
+
9523
+ - Whether a given zip code is served by our Phlebotomy network.
9524
+ - List of Lab locations in the area.
9525
+ </dd>
9526
+ </dl>
9527
+ </dd>
9528
+ </dl>
9529
+
9530
+ #### 🔌 Usage
9531
+
9532
+ <dl>
9533
+ <dd>
9534
+
9535
+ <dl>
9536
+ <dd>
9537
+
9538
+ ```typescript
9539
+ await client.labTests.getAreaInfo({
9540
+ zipCode: "zip_code",
9541
+ });
9542
+ ```
9543
+
9544
+ </dd>
9545
+ </dl>
9546
+ </dd>
9547
+ </dl>
9548
+
9549
+ #### ⚙️ Parameters
9550
+
9551
+ <dl>
9552
+ <dd>
9553
+
9554
+ <dl>
9555
+ <dd>
9556
+
9557
+ **request:** `Vital.LabTestsGetAreaInfoRequest`
9558
+
9559
+ </dd>
9560
+ </dl>
9561
+
9562
+ <dl>
9563
+ <dd>
9564
+
9565
+ **requestOptions:** `LabTests.RequestOptions`
9566
+
9567
+ </dd>
9568
+ </dl>
9569
+ </dd>
9570
+ </dl>
9571
+
9572
+ </dd>
9573
+ </dl>
9574
+ </details>
9575
+
9576
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscInfo</a>({ ...params }) -> Vital.PscInfo</code></summary>
9577
+ <dl>
9578
+ <dd>
9579
+
9580
+ #### 🔌 Usage
9581
+
9582
+ <dl>
9583
+ <dd>
9584
+
9585
+ <dl>
9586
+ <dd>
9587
+
9588
+ ```typescript
9589
+ await client.labTests.getPscInfo({
9590
+ zipCode: "zip_code",
9591
+ labId: 1,
9592
+ });
9593
+ ```
9594
+
9595
+ </dd>
9596
+ </dl>
9597
+ </dd>
9598
+ </dl>
9599
+
9600
+ #### ⚙️ Parameters
9601
+
9602
+ <dl>
9603
+ <dd>
9604
+
9605
+ <dl>
9606
+ <dd>
9607
+
9608
+ **request:** `Vital.LabTestsGetPscInfoRequest`
9609
+
9610
+ </dd>
9611
+ </dl>
9612
+
9613
+ <dl>
9614
+ <dd>
9615
+
9616
+ **requestOptions:** `LabTests.RequestOptions`
9617
+
9618
+ </dd>
9619
+ </dl>
9620
+ </dd>
9621
+ </dl>
9622
+
9623
+ </dd>
9624
+ </dl>
9625
+ </details>
9626
+
9627
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderPscInfo</a>(orderId, { ...params }) -> Vital.PscInfo</code></summary>
9628
+ <dl>
9629
+ <dd>
9630
+
9631
+ #### 🔌 Usage
9632
+
9633
+ <dl>
9634
+ <dd>
9635
+
9636
+ <dl>
9637
+ <dd>
9638
+
9639
+ ```typescript
9640
+ await client.labTests.getOrderPscInfo("order_id");
9641
+ ```
9642
+
9643
+ </dd>
9644
+ </dl>
9645
+ </dd>
9646
+ </dl>
9647
+
9648
+ #### ⚙️ Parameters
9649
+
9650
+ <dl>
9651
+ <dd>
9652
+
9653
+ <dl>
9654
+ <dd>
9655
+
9656
+ **orderId:** `string` — Your Order ID.
9657
+
9658
+ </dd>
9659
+ </dl>
9660
+
9661
+ <dl>
9662
+ <dd>
9663
+
9664
+ **request:** `Vital.LabTestsGetOrderPscInfoRequest`
9665
+
9666
+ </dd>
9667
+ </dl>
9668
+
9669
+ <dl>
9670
+ <dd>
9671
+
9672
+ **requestOptions:** `LabTests.RequestOptions`
9673
+
9674
+ </dd>
9675
+ </dl>
9676
+ </dd>
9677
+ </dl>
9678
+
9679
+ </dd>
9680
+ </dl>
9681
+ </details>
9682
+
9683
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultMetadata</a>(orderId) -> Vital.LabResultsMetadata</code></summary>
9684
+ <dl>
9685
+ <dd>
9686
+
9687
+ #### 📝 Description
9688
+
9689
+ <dl>
9690
+ <dd>
9691
+
9692
+ <dl>
9693
+ <dd>
9694
+
9695
+ Return metadata related to order results, such as lab metadata,
9696
+ provider and sample dates.
9697
+
9698
+ </dd>
9699
+ </dl>
9700
+ </dd>
9701
+ </dl>
9702
+
9703
+ #### 🔌 Usage
9704
+
9705
+ <dl>
9706
+ <dd>
9707
+
9708
+ <dl>
9709
+ <dd>
9710
+
9711
+ ```typescript
9712
+ await client.labTests.getResultMetadata("order_id");
9713
+ ```
9714
+
9715
+ </dd>
9716
+ </dl>
9717
+ </dd>
9718
+ </dl>
9719
+
9720
+ #### ⚙️ Parameters
9721
+
9722
+ <dl>
9723
+ <dd>
9724
+
9725
+ <dl>
9726
+ <dd>
9727
+
9728
+ **orderId:** `string`
9729
+
9730
+ </dd>
9731
+ </dl>
9732
+
9733
+ <dl>
9734
+ <dd>
9735
+
9736
+ **requestOptions:** `LabTests.RequestOptions`
9737
+
9738
+ </dd>
9739
+ </dl>
9740
+ </dd>
9741
+ </dl>
9742
+
9743
+ </dd>
9744
+ </dl>
9745
+ </details>
9746
+
9747
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getResultRaw</a>(orderId) -> Vital.LabResultsRaw</code></summary>
9748
+ <dl>
9749
+ <dd>
9750
+
9751
+ #### 📝 Description
9752
+
9753
+ <dl>
9754
+ <dd>
9755
+
9756
+ <dl>
9757
+ <dd>
9758
+
9759
+ Return both metadata and raw json test data
9760
+
9761
+ </dd>
9762
+ </dl>
9763
+ </dd>
9764
+ </dl>
9765
+
9766
+ #### 🔌 Usage
9767
+
9768
+ <dl>
9769
+ <dd>
9770
+
9771
+ <dl>
9772
+ <dd>
9773
+
9774
+ ```typescript
9775
+ await client.labTests.getResultRaw("order_id");
9776
+ ```
9777
+
9778
+ </dd>
9779
+ </dl>
9780
+ </dd>
9781
+ </dl>
9782
+
9783
+ #### ⚙️ Parameters
9784
+
9785
+ <dl>
9786
+ <dd>
9787
+
9788
+ <dl>
9789
+ <dd>
9790
+
9791
+ **orderId:** `string`
9792
+
9793
+ </dd>
9794
+ </dl>
9795
+
9796
+ <dl>
9797
+ <dd>
9798
+
9799
+ **requestOptions:** `LabTests.RequestOptions`
9800
+
9801
+ </dd>
9802
+ </dl>
9803
+ </dd>
9804
+ </dl>
9805
+
9806
+ </dd>
9807
+ </dl>
9808
+ </details>
9809
+
9810
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentAvailability</a>({ ...params }) -> Vital.AppointmentAvailabilitySlots</code></summary>
9811
+ <dl>
9812
+ <dd>
9813
+
9814
+ #### 🔌 Usage
9815
+
9816
+ <dl>
9817
+ <dd>
9818
+
9819
+ <dl>
9820
+ <dd>
9821
+
9822
+ ```typescript
9823
+ await client.labTests.getPscAppointmentAvailability({
9824
+ lab: "quest",
9825
+ });
9826
+ ```
9827
+
9828
+ </dd>
9829
+ </dl>
9830
+ </dd>
9831
+ </dl>
9832
+
9833
+ #### ⚙️ Parameters
9834
+
9835
+ <dl>
9836
+ <dd>
9837
+
9838
+ <dl>
9839
+ <dd>
9840
+
9841
+ **request:** `Vital.LabTestsGetPscAppointmentAvailabilityRequest`
9842
+
9843
+ </dd>
9844
+ </dl>
9845
+
9846
+ <dl>
9847
+ <dd>
9848
+
9849
+ **requestOptions:** `LabTests.RequestOptions`
9850
+
9851
+ </dd>
9852
+ </dl>
9853
+ </dd>
9854
+ </dl>
9855
+
9856
+ </dd>
9857
+ </dl>
9858
+ </details>
9859
+
9860
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9861
+ <dl>
9862
+ <dd>
9863
+
9864
+ #### 🔌 Usage
9865
+
9866
+ <dl>
9867
+ <dd>
9868
+
9869
+ <dl>
9870
+ <dd>
9871
+
9872
+ ```typescript
9873
+ await client.labTests.bookPscAppointment("order_id", {
9874
+ bookingKey: "booking_key",
9875
+ });
9876
+ ```
9877
+
9878
+ </dd>
9879
+ </dl>
9880
+ </dd>
9881
+ </dl>
9882
+
9883
+ #### ⚙️ Parameters
9884
+
9885
+ <dl>
9886
+ <dd>
9887
+
9888
+ <dl>
9889
+ <dd>
9890
+
9891
+ **orderId:** `string` — Your Order ID.
9892
+
9893
+ </dd>
9894
+ </dl>
9895
+
9896
+ <dl>
9897
+ <dd>
9898
+
9899
+ **request:** `Vital.AppointmentBookingRequest`
9900
+
9901
+ </dd>
9902
+ </dl>
9903
+
9904
+ <dl>
9905
+ <dd>
9906
+
9907
+ **requestOptions:** `LabTests.RequestOptions`
9908
+
9909
+ </dd>
9910
+ </dl>
9911
+ </dd>
9912
+ </dl>
9913
+
9914
+ </dd>
9915
+ </dl>
9916
+ </details>
9917
+
9918
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9919
+ <dl>
9920
+ <dd>
9921
+
9922
+ #### 🔌 Usage
9923
+
9924
+ <dl>
9925
+ <dd>
9926
+
9927
+ <dl>
9928
+ <dd>
9929
+
9930
+ ```typescript
9931
+ await client.labTests.reschedulePscAppointment("order_id", {
9932
+ bookingKey: "booking_key",
9933
+ });
9934
+ ```
9935
+
9936
+ </dd>
9937
+ </dl>
9938
+ </dd>
9939
+ </dl>
9940
+
9941
+ #### ⚙️ Parameters
9942
+
9943
+ <dl>
9944
+ <dd>
9945
+
9946
+ <dl>
9947
+ <dd>
9948
+
9949
+ **orderId:** `string` — Your Order ID.
9950
+
9951
+ </dd>
9952
+ </dl>
9953
+
9954
+ <dl>
9955
+ <dd>
9956
+
9957
+ **request:** `Vital.AppointmentRescheduleRequest`
9958
+
9959
+ </dd>
9960
+ </dl>
9961
+
9962
+ <dl>
9963
+ <dd>
9964
+
9965
+ **requestOptions:** `LabTests.RequestOptions`
9966
+
9967
+ </dd>
9968
+ </dl>
9969
+ </dd>
9970
+ </dl>
9971
+
9972
+ </dd>
9973
+ </dl>
9974
+ </details>
9975
+
9976
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
9977
+ <dl>
9978
+ <dd>
9979
+
9980
+ #### 🔌 Usage
9981
+
9982
+ <dl>
9983
+ <dd>
9984
+
9985
+ <dl>
9986
+ <dd>
9987
+
9988
+ ```typescript
9989
+ await client.labTests.cancelPscAppointment("order_id", {
9990
+ cancellationReasonId: "cancellationReasonId",
9991
+ });
9992
+ ```
9993
+
9994
+ </dd>
9995
+ </dl>
9996
+ </dd>
9997
+ </dl>
9998
+
9999
+ #### ⚙️ Parameters
10000
+
10001
+ <dl>
10002
+ <dd>
10003
+
10004
+ <dl>
10005
+ <dd>
10006
+
10007
+ **orderId:** `string` — Your Order ID.
10008
+
10009
+ </dd>
10010
+ </dl>
10011
+
10012
+ <dl>
10013
+ <dd>
10014
+
10015
+ **request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
10016
+
10017
+ </dd>
10018
+ </dl>
10019
+
10020
+ <dl>
10021
+ <dd>
10022
+
10023
+ **requestOptions:** `LabTests.RequestOptions`
10024
+
10025
+ </dd>
10026
+ </dl>
10027
+ </dd>
10028
+ </dl>
10029
+
10030
+ </dd>
10031
+ </dl>
10032
+ </details>
10033
+
10034
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
10035
+ <dl>
10036
+ <dd>
10037
+
10038
+ #### 🔌 Usage
10039
+
10040
+ <dl>
10041
+ <dd>
10042
+
10043
+ <dl>
10044
+ <dd>
10045
+
10046
+ ```typescript
10047
+ await client.labTests.getPscAppointmentCancellationReason();
10048
+ ```
10049
+
10050
+ </dd>
10051
+ </dl>
10052
+ </dd>
10053
+ </dl>
10054
+
10055
+ #### ⚙️ Parameters
10056
+
10057
+ <dl>
10058
+ <dd>
10059
+
10060
+ <dl>
10061
+ <dd>
10062
+
10063
+ **requestOptions:** `LabTests.RequestOptions`
10064
+
10065
+ </dd>
10066
+ </dl>
10067
+ </dd>
10068
+ </dl>
10069
+
10070
+ </dd>
10071
+ </dl>
10072
+ </details>
10073
+
10074
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
10075
+ <dl>
10076
+ <dd>
10077
+
10078
+ #### 📝 Description
10079
+
10080
+ <dl>
10081
+ <dd>
10082
+
10083
+ <dl>
10084
+ <dd>
10085
+
10086
+ Get the appointment associated with an order.
10087
+
10088
+ </dd>
10089
+ </dl>
10090
+ </dd>
10091
+ </dl>
10092
+
10093
+ #### 🔌 Usage
10094
+
10095
+ <dl>
10096
+ <dd>
10097
+
10098
+ <dl>
10099
+ <dd>
10100
+
10101
+ ```typescript
10102
+ await client.labTests.getPscAppointment("order_id");
10103
+ ```
10104
+
10105
+ </dd>
10106
+ </dl>
10107
+ </dd>
10108
+ </dl>
10109
+
10110
+ #### ⚙️ Parameters
10111
+
10112
+ <dl>
10113
+ <dd>
10114
+
10115
+ <dl>
10116
+ <dd>
10117
+
10118
+ **orderId:** `string` — Your Order ID.
10119
+
10120
+ </dd>
10121
+ </dl>
10122
+
10123
+ <dl>
10124
+ <dd>
10125
+
10126
+ **requestOptions:** `LabTests.RequestOptions`
10127
+
10128
+ </dd>
10129
+ </dl>
10130
+ </dd>
10131
+ </dl>
10132
+
10133
+ </dd>
10134
+ </dl>
10135
+ </details>
10136
+
10137
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrder</a>(orderId) -> Vital.ClientFacingOrder</code></summary>
10138
+ <dl>
10139
+ <dd>
10140
+
10141
+ #### 📝 Description
10142
+
10143
+ <dl>
10144
+ <dd>
10145
+
10146
+ <dl>
10147
+ <dd>
10148
+
10149
+ GET individual order by ID.
10150
+
10151
+ </dd>
10152
+ </dl>
10153
+ </dd>
10154
+ </dl>
10155
+
10156
+ #### 🔌 Usage
10157
+
10158
+ <dl>
10159
+ <dd>
10160
+
10161
+ <dl>
10162
+ <dd>
10163
+
10164
+ ```typescript
10165
+ await client.labTests.getOrder("order_id");
10166
+ ```
10167
+
10168
+ </dd>
10169
+ </dl>
10170
+ </dd>
10171
+ </dl>
10172
+
10173
+ #### ⚙️ Parameters
10174
+
10175
+ <dl>
10176
+ <dd>
10177
+
10178
+ <dl>
10179
+ <dd>
10180
+
10181
+ **orderId:** `string` — Your Order ID.
10182
+
10183
+ </dd>
10184
+ </dl>
10185
+
10186
+ <dl>
10187
+ <dd>
10188
+
10189
+ **requestOptions:** `LabTests.RequestOptions`
10190
+
10191
+ </dd>
10192
+ </dl>
10193
+ </dd>
10194
+ </dl>
10195
+
10196
+ </dd>
10197
+ </dl>
10198
+ </details>
10199
+
10200
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10201
+ <dl>
10202
+ <dd>
10203
+
10204
+ #### 🔌 Usage
10205
+
10206
+ <dl>
10207
+ <dd>
10208
+
10209
+ <dl>
10210
+ <dd>
10211
+
10212
+ ```typescript
10213
+ await client.labTests.createOrder({
10214
+ userId: "user_id",
10215
+ patientDetails: {
10216
+ firstName: "first_name",
10217
+ lastName: "last_name",
10218
+ dob: "dob",
10219
+ gender: "female",
10220
+ phoneNumber: "phone_number",
10221
+ email: "email",
10222
+ },
10223
+ patientAddress: {
10224
+ firstLine: "first_line",
10225
+ city: "city",
10226
+ state: "state",
10227
+ zip: "zip",
10228
+ country: "country",
10229
+ },
10230
+ });
10231
+ ```
10232
+
10233
+ </dd>
10234
+ </dl>
10235
+ </dd>
10236
+ </dl>
10237
+
10238
+ #### ⚙️ Parameters
10239
+
10240
+ <dl>
10241
+ <dd>
10242
+
10243
+ <dl>
10244
+ <dd>
10245
+
10246
+ **request:** `Vital.CreateOrderRequestCompatible`
10247
+
10248
+ </dd>
10249
+ </dl>
10250
+
10251
+ <dl>
10252
+ <dd>
10253
+
10254
+ **requestOptions:** `LabTests.RequestOptions`
10255
+
10256
+ </dd>
10257
+ </dl>
10258
+ </dd>
10259
+ </dl>
10260
+
10261
+ </dd>
10262
+ </dl>
10263
+ </details>
10264
+
10265
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">importOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10266
+ <dl>
10267
+ <dd>
10268
+
10269
+ #### 🔌 Usage
10270
+
10271
+ <dl>
10272
+ <dd>
10273
+
10274
+ <dl>
10275
+ <dd>
10276
+
10277
+ ```typescript
10278
+ await client.labTests.importOrder({
10279
+ userId: "user_id",
10280
+ billingType: "client_bill",
10281
+ orderSet: {},
10282
+ collectionMethod: "testkit",
10283
+ patientDetails: {
10284
+ firstName: "first_name",
10285
+ lastName: "last_name",
10286
+ dob: "dob",
10287
+ gender: "female",
10288
+ phoneNumber: "phone_number",
10289
+ email: "email",
10290
+ },
10291
+ patientAddress: {
10292
+ receiverName: "receiver_name",
10293
+ firstLine: "first_line",
10294
+ city: "city",
10295
+ state: "state",
10296
+ zip: "zip",
10297
+ country: "country",
10298
+ },
10299
+ sampleId: "sample_id",
10300
+ });
10301
+ ```
10302
+
10303
+ </dd>
10304
+ </dl>
10305
+ </dd>
10306
+ </dl>
10307
+
10308
+ #### ⚙️ Parameters
10309
+
10310
+ <dl>
10311
+ <dd>
10312
+
10313
+ <dl>
10314
+ <dd>
10315
+
10316
+ **request:** `Vital.ImportOrderBody`
10317
+
10318
+ </dd>
10319
+ </dl>
10320
+
10321
+ <dl>
10322
+ <dd>
10323
+
10324
+ **requestOptions:** `LabTests.RequestOptions`
10325
+
10326
+ </dd>
10327
+ </dl>
10328
+ </dd>
10329
+ </dl>
10330
+
10331
+ </dd>
10332
+ </dl>
10333
+ </details>
10334
+
10335
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelOrder</a>(orderId) -> Vital.PostOrderResponse</code></summary>
10336
+ <dl>
10337
+ <dd>
10338
+
10339
+ #### 📝 Description
10340
+
10341
+ <dl>
10342
+ <dd>
10343
+
10344
+ <dl>
10345
+ <dd>
10346
+
10347
+ POST cancel order
10348
+
10349
+ </dd>
10350
+ </dl>
10351
+ </dd>
10352
+ </dl>
10353
+
10354
+ #### 🔌 Usage
10355
+
10356
+ <dl>
10357
+ <dd>
10358
+
10359
+ <dl>
10360
+ <dd>
10361
+
10362
+ ```typescript
10363
+ await client.labTests.cancelOrder("order_id");
10364
+ ```
10365
+
10366
+ </dd>
10367
+ </dl>
10368
+ </dd>
10369
+ </dl>
10370
+
10371
+ #### ⚙️ Parameters
10372
+
10373
+ <dl>
10374
+ <dd>
10375
+
10376
+ <dl>
10377
+ <dd>
10378
+
10379
+ **orderId:** `string` — Your Order ID.
10380
+
10381
+ </dd>
10382
+ </dl>
10383
+
10384
+ <dl>
10385
+ <dd>
10386
+
10387
+ **requestOptions:** `LabTests.RequestOptions`
10388
+
10389
+ </dd>
10390
+ </dl>
10391
+ </dd>
10392
+ </dl>
10393
+
10394
+ </dd>
10395
+ </dl>
10396
+ </details>
10397
+
10398
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">simulateOrderProcess</a>(orderId, { ...params }) -> unknown</code></summary>
10399
+ <dl>
10400
+ <dd>
10401
+
10402
+ #### 📝 Description
10403
+
10404
+ <dl>
10405
+ <dd>
10406
+
10407
+ <dl>
10408
+ <dd>
10409
+
10410
+ Get available test kits.
10411
+
10412
+ </dd>
10413
+ </dl>
10414
+ </dd>
10415
+ </dl>
10416
+
10417
+ #### 🔌 Usage
10418
+
10419
+ <dl>
10420
+ <dd>
10421
+
10422
+ <dl>
10423
+ <dd>
10424
+
10425
+ ```typescript
10426
+ await client.labTests.simulateOrderProcess("order_id", {
10427
+ body: undefined,
10428
+ });
10429
+ ```
10430
+
10431
+ </dd>
10432
+ </dl>
10433
+ </dd>
10434
+ </dl>
10435
+
10436
+ #### ⚙️ Parameters
10437
+
10438
+ <dl>
10439
+ <dd>
10440
+
10441
+ <dl>
10442
+ <dd>
10443
+
10444
+ **orderId:** `string`
10445
+
10446
+ </dd>
10447
+ </dl>
10448
+
10449
+ <dl>
10450
+ <dd>
10451
+
10452
+ **request:** `Vital.LabTestsSimulateOrderProcessRequest`
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">updateOnSiteCollectionOrderDrawCompleted</a>(orderId) -> Vital.PostOrderResponse</code></summary>
10472
+ <dl>
10473
+ <dd>
10474
+
10475
+ #### 📝 Description
10476
+
10477
+ <dl>
10478
+ <dd>
10479
+
10480
+ <dl>
10481
+ <dd>
10482
+
10483
+ PATCH update on site collection order when draw is completed
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.updateOnSiteCollectionOrderDrawCompleted("order_id");
10500
+ ```
10501
+
10502
+ </dd>
10503
+ </dl>
10504
+ </dd>
10505
+ </dl>
10506
+
10507
+ #### ⚙️ Parameters
10508
+
10509
+ <dl>
10510
+ <dd>
10511
+
10512
+ <dl>
10513
+ <dd>
10514
+
10515
+ **orderId:** `string` — Your Order ID.
10516
+
10517
+ </dd>
10518
+ </dl>
10519
+
10520
+ <dl>
10521
+ <dd>
10522
+
10523
+ **requestOptions:** `LabTests.RequestOptions`
10524
+
10525
+ </dd>
10526
+ </dl>
10527
+ </dd>
10528
+ </dl>
10529
+
10530
+ </dd>
10531
+ </dl>
10532
+ </details>
10533
+
10534
+ <details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrders</a>({ ...params }) -> Vital.GetOrdersResponse</code></summary>
10535
+ <dl>
10536
+ <dd>
10537
+
10538
+ #### 📝 Description
10539
+
10540
+ <dl>
10541
+ <dd>
10542
+
10543
+ <dl>
10544
+ <dd>
10545
+
10546
+ GET many orders with filters.
10547
+
10548
+ </dd>
10549
+ </dl>
10550
+ </dd>
10551
+ </dl>
10552
+
10553
+ #### 🔌 Usage
10554
+
10555
+ <dl>
10556
+ <dd>
10557
+
10558
+ <dl>
10559
+ <dd>
10560
+
10561
+ ```typescript
10562
+ await client.labTests.getOrders();
10563
+ ```
10564
+
10565
+ </dd>
10566
+ </dl>
10567
+ </dd>
10568
+ </dl>
10569
+
10570
+ #### ⚙️ Parameters
10571
+
10572
+ <dl>
10573
+ <dd>
10574
+
10575
+ <dl>
10576
+ <dd>
10577
+
10578
+ **request:** `Vital.LabTestsGetOrdersRequest`
10579
+
10580
+ </dd>
10581
+ </dl>
10582
+
10583
+ <dl>
10584
+ <dd>
10585
+
10586
+ **requestOptions:** `LabTests.RequestOptions`
10587
+
10588
+ </dd>
10589
+ </dl>
10590
+ </dd>
10591
+ </dl>
10592
+
10593
+ </dd>
10594
+ </dl>
10595
+ </details>
10596
+
10597
+ ## Testkit
10598
+
10599
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">register</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10600
+ <dl>
10601
+ <dd>
10602
+
10603
+ #### 🔌 Usage
10604
+
10605
+ <dl>
10606
+ <dd>
10607
+
10608
+ <dl>
10609
+ <dd>
10610
+
10611
+ ```typescript
10612
+ await client.testkit.register({
10613
+ sampleId: "sample_id",
10614
+ patientDetails: {
10615
+ firstName: "first_name",
10616
+ lastName: "last_name",
10617
+ dob: "dob",
10618
+ gender: "female",
10619
+ phoneNumber: "phone_number",
10620
+ email: "email",
10621
+ },
10622
+ patientAddress: {
10623
+ firstLine: "first_line",
10624
+ city: "city",
10625
+ state: "state",
10626
+ zip: "zip",
10627
+ country: "country",
10628
+ },
10629
+ });
10630
+ ```
10631
+
10632
+ </dd>
10633
+ </dl>
10634
+ </dd>
10635
+ </dl>
10636
+
10637
+ #### ⚙️ Parameters
10638
+
10639
+ <dl>
10640
+ <dd>
10641
+
10642
+ <dl>
10643
+ <dd>
10644
+
10645
+ **request:** `Vital.RegisterTestkitRequest`
10646
+
10647
+ </dd>
10648
+ </dl>
10649
+
10650
+ <dl>
10651
+ <dd>
10652
+
10653
+ **requestOptions:** `Testkit.RequestOptions`
10654
+
10655
+ </dd>
10656
+ </dl>
10657
+ </dd>
10658
+ </dl>
10659
+
10660
+ </dd>
10661
+ </dl>
10662
+ </details>
10663
+
10664
+ <details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
10665
+ <dl>
10666
+ <dd>
10667
+
10668
+ #### 📝 Description
10669
+
10670
+ <dl>
10671
+ <dd>
10672
+
10673
+ <dl>
10674
+ <dd>
10675
+
10676
+ Creates an order for an unregistered testkit
10677
+
10678
+ </dd>
10679
+ </dl>
10680
+ </dd>
10681
+ </dl>
10682
+
10683
+ #### 🔌 Usage
10684
+
10685
+ <dl>
10686
+ <dd>
10687
+
10688
+ <dl>
10689
+ <dd>
10690
+
10691
+ ```typescript
10692
+ await client.testkit.createOrder({
10693
+ userId: "user_id",
10694
+ labTestId: "lab_test_id",
10695
+ shippingDetails: {
10696
+ receiverName: "receiver_name",
10697
+ firstLine: "first_line",
10698
+ city: "city",
10699
+ state: "state",
10700
+ zip: "zip",
10701
+ country: "country",
10702
+ phoneNumber: "phone_number",
10703
+ },
10704
+ });
10705
+ ```
10706
+
10707
+ </dd>
10708
+ </dl>
10709
+ </dd>
10710
+ </dl>
10711
+
10712
+ #### ⚙️ Parameters
10713
+
10714
+ <dl>
10715
+ <dd>
10716
+
10717
+ <dl>
10718
+ <dd>
10719
+
10720
+ **request:** `Vital.CreateRegistrableTestkitOrderRequest`
10721
+
10722
+ </dd>
10723
+ </dl>
10724
+
10725
+ <dl>
10726
+ <dd>
10727
+
10728
+ **requestOptions:** `Testkit.RequestOptions`
10729
+
10730
+ </dd>
10731
+ </dl>
10732
+ </dd>
10733
+ </dl>
10734
+
10735
+ </dd>
10736
+ </dl>
10737
+ </details>
10738
+
10739
+ ## Order
10740
+
10741
+ <details><summary><code>client.order.<a href="/src/api/resources/order/client/Client.ts">resendEvents</a>({ ...params }) -> Vital.ResendWebhookResponse</code></summary>
10742
+ <dl>
10743
+ <dd>
10744
+
10745
+ #### 📝 Description
10746
+
10747
+ <dl>
10748
+ <dd>
10749
+
10750
+ <dl>
10751
+ <dd>
10752
+
10753
+ Replay a webhook for a given set of orders
10754
+
10755
+ </dd>
10756
+ </dl>
10757
+ </dd>
10758
+ </dl>
10759
+
10760
+ #### 🔌 Usage
10761
+
10762
+ <dl>
10763
+ <dd>
10764
+
10765
+ <dl>
10766
+ <dd>
10767
+
10768
+ ```typescript
10769
+ await client.order.resendEvents();
10770
+ ```
10771
+
10772
+ </dd>
10773
+ </dl>
10774
+ </dd>
10775
+ </dl>
10776
+
10777
+ #### ⚙️ Parameters
10778
+
10779
+ <dl>
10780
+ <dd>
10781
+
10782
+ <dl>
10783
+ <dd>
10784
+
10785
+ **request:** `Vital.ResendWebhookBody`
10786
+
10787
+ </dd>
10788
+ </dl>
10789
+
10790
+ <dl>
10791
+ <dd>
10792
+
10793
+ **requestOptions:** `Order.RequestOptions`
10794
+
10795
+ </dd>
10796
+ </dl>
10797
+ </dd>
10798
+ </dl>
10799
+
10800
+ </dd>
10801
+ </dl>
10802
+ </details>
10803
+
10804
+ ## Insurance
10805
+
10806
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchGetPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponse[]</code></summary>
10807
+ <dl>
10808
+ <dd>
10809
+
10810
+ #### 🔌 Usage
10811
+
10812
+ <dl>
10813
+ <dd>
10814
+
10815
+ <dl>
10816
+ <dd>
10817
+
10818
+ ```typescript
10819
+ await client.insurance.searchGetPayorInfo();
10820
+ ```
10821
+
10822
+ </dd>
10823
+ </dl>
10824
+ </dd>
10825
+ </dl>
10826
+
10827
+ #### ⚙️ Parameters
10828
+
10829
+ <dl>
10830
+ <dd>
10831
+
10832
+ <dl>
10833
+ <dd>
10834
+
10835
+ **request:** `Vital.InsuranceSearchGetPayorInfoRequest`
10836
+
10837
+ </dd>
10838
+ </dl>
10839
+
10840
+ <dl>
10841
+ <dd>
10842
+
10843
+ **requestOptions:** `Insurance.RequestOptions`
10844
+
10845
+ </dd>
10846
+ </dl>
10847
+ </dd>
10848
+ </dl>
10849
+
10850
+ </dd>
10851
+ </dl>
10852
+ </details>
10853
+
10854
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponseDeprecated[]</code></summary>
10855
+ <dl>
10856
+ <dd>
10857
+
10858
+ #### 🔌 Usage
10859
+
10860
+ <dl>
10861
+ <dd>
10862
+
10863
+ <dl>
10864
+ <dd>
10865
+
10866
+ ```typescript
10867
+ await client.insurance.searchPayorInfo();
10868
+ ```
10869
+
10870
+ </dd>
10871
+ </dl>
10872
+ </dd>
10873
+ </dl>
10874
+
10875
+ #### ⚙️ Parameters
10876
+
10877
+ <dl>
10878
+ <dd>
10879
+
10880
+ <dl>
10881
+ <dd>
10882
+
10883
+ **request:** `Vital.PayorSearchRequest`
10884
+
10885
+ </dd>
10886
+ </dl>
10887
+
10888
+ <dl>
10889
+ <dd>
10890
+
10891
+ **requestOptions:** `Insurance.RequestOptions`
10892
+
10893
+ </dd>
10894
+ </dl>
10895
+ </dd>
10896
+ </dl>
10897
+
10898
+ </dd>
10899
+ </dl>
10900
+ </details>
10901
+
10902
+ <details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchDiagnosis</a>({ ...params }) -> Vital.ClientFacingDiagnosisInformation[]</code></summary>
10903
+ <dl>
10904
+ <dd>
10905
+
10906
+ #### 🔌 Usage
10907
+
10908
+ <dl>
10909
+ <dd>
10910
+
10911
+ <dl>
10912
+ <dd>
10913
+
10914
+ ```typescript
10915
+ await client.insurance.searchDiagnosis({
10916
+ diagnosisQuery: "diagnosis_query",
10917
+ });
10918
+ ```
10919
+
10920
+ </dd>
10921
+ </dl>
10922
+ </dd>
10923
+ </dl>
10924
+
10925
+ #### ⚙️ Parameters
10926
+
10927
+ <dl>
10928
+ <dd>
10929
+
10930
+ <dl>
10931
+ <dd>
10932
+
10933
+ **request:** `Vital.InsuranceSearchDiagnosisRequest`
10934
+
10935
+ </dd>
10936
+ </dl>
10937
+
10938
+ <dl>
10939
+ <dd>
10940
+
10941
+ **requestOptions:** `Insurance.RequestOptions`
10942
+
10943
+ </dd>
10944
+ </dl>
10945
+ </dd>
10946
+ </dl>
10947
+
10948
+ </dd>
10949
+ </dl>
10950
+ </details>
10951
+
10952
+ ## Payor
10953
+
10954
+ <details><summary><code>client.payor.<a href="/src/api/resources/payor/client/Client.ts">createPayor</a>({ ...params }) -> Vital.ClientFacingPayor</code></summary>
10955
+ <dl>
10956
+ <dd>
10957
+
10958
+ #### 🔌 Usage
10959
+
10960
+ <dl>
10961
+ <dd>
10962
+
10963
+ <dl>
10964
+ <dd>
10965
+
10966
+ ```typescript
10967
+ await client.payor.createPayor({
10968
+ name: "name",
10969
+ address: {
10970
+ firstLine: "first_line",
10971
+ country: "country",
10972
+ zip: "zip",
10973
+ city: "city",
10974
+ state: "state",
10975
+ },
10976
+ });
10977
+ ```
10978
+
10979
+ </dd>
10980
+ </dl>
10981
+ </dd>
10982
+ </dl>
10983
+
10984
+ #### ⚙️ Parameters
10985
+
10986
+ <dl>
10987
+ <dd>
10988
+
10989
+ <dl>
10990
+ <dd>
10991
+
10992
+ **request:** `Vital.CreatePayorBody`
10993
+
10994
+ </dd>
10995
+ </dl>
10996
+
10997
+ <dl>
10998
+ <dd>
10999
+
11000
+ **requestOptions:** `Payor.RequestOptions`
11001
+
11002
+ </dd>
11003
+ </dl>
11004
+ </dd>
11005
+ </dl>
11006
+
11007
+ </dd>
11008
+ </dl>
11009
+ </details>
11010
+
11011
+ ## Aggregate
11012
+
11013
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">queryOne</a>(userId, { ...params }) -> Vital.AggregationResponse</code></summary>
11014
+ <dl>
11015
+ <dd>
11016
+
11017
+ #### 🔌 Usage
11018
+
11019
+ <dl>
11020
+ <dd>
11021
+
11022
+ <dl>
11023
+ <dd>
11024
+
11025
+ ```typescript
11026
+ await client.aggregate.queryOne("user_id", {
11027
+ timeframe: {
11028
+ type: "relative",
11029
+ anchor: "anchor",
11030
+ past: {
11031
+ unit: "minute",
11032
+ },
11033
+ },
11034
+ queries: [
11035
+ {
11036
+ select: [
11037
+ {
11038
+ arg: {
11039
+ sleep: "session_start",
11040
+ },
11041
+ func: "mean",
11042
+ },
11043
+ ],
11044
+ },
11045
+ ],
11046
+ });
11047
+ ```
11048
+
11049
+ </dd>
11050
+ </dl>
11051
+ </dd>
11052
+ </dl>
11053
+
11054
+ #### ⚙️ Parameters
11055
+
11056
+ <dl>
11057
+ <dd>
11058
+
11059
+ <dl>
11060
+ <dd>
11061
+
11062
+ **userId:** `string`
11063
+
11064
+ </dd>
11065
+ </dl>
11066
+
11067
+ <dl>
11068
+ <dd>
11069
+
11070
+ **request:** `Vital.QueryBatch`
11071
+
11072
+ </dd>
11073
+ </dl>
11074
+
11075
+ <dl>
11076
+ <dd>
11077
+
11078
+ **requestOptions:** `Aggregate.RequestOptions`
11079
+
11080
+ </dd>
11081
+ </dl>
11082
+ </dd>
11083
+ </dl>
11084
+
11085
+ </dd>
11086
+ </dl>
11087
+ </details>
11088
+
11089
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">getResultTableForContinuousQuery</a>(userId, queryIdOrSlug) -> Vital.AggregationResult</code></summary>
11090
+ <dl>
11091
+ <dd>
11092
+
11093
+ #### 🔌 Usage
11094
+
11095
+ <dl>
11096
+ <dd>
11097
+
11098
+ <dl>
11099
+ <dd>
11100
+
11101
+ ```typescript
11102
+ await client.aggregate.getResultTableForContinuousQuery("user_id", "query_id_or_slug");
11103
+ ```
11104
+
11105
+ </dd>
11106
+ </dl>
11107
+ </dd>
11108
+ </dl>
11109
+
11110
+ #### ⚙️ Parameters
11111
+
11112
+ <dl>
11113
+ <dd>
11114
+
11115
+ <dl>
11116
+ <dd>
11117
+
11118
+ **userId:** `string`
11119
+
11120
+ </dd>
11121
+ </dl>
11122
+
11123
+ <dl>
11124
+ <dd>
11125
+
11126
+ **queryIdOrSlug:** `string`
11127
+
11128
+ </dd>
11129
+ </dl>
11130
+
11131
+ <dl>
11132
+ <dd>
11133
+
11134
+ **requestOptions:** `Aggregate.RequestOptions`
11135
+
11136
+ </dd>
11137
+ </dl>
11138
+ </dd>
11139
+ </dl>
11140
+
11141
+ </dd>
11142
+ </dl>
11143
+ </details>
11144
+
11145
+ <details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">getTaskHistoryForContinuousQuery</a>(userId, queryIdOrSlug, { ...params }) -> Vital.ContinuousQueryTaskHistoryResponse</code></summary>
11146
+ <dl>
11147
+ <dd>
11148
+
11149
+ #### 🔌 Usage
11150
+
11151
+ <dl>
11152
+ <dd>
11153
+
11154
+ <dl>
11155
+ <dd>
11156
+
11157
+ ```typescript
11158
+ await client.aggregate.getTaskHistoryForContinuousQuery("user_id", "query_id_or_slug");
11159
+ ```
11160
+
11161
+ </dd>
11162
+ </dl>
11163
+ </dd>
11164
+ </dl>
11165
+
11166
+ #### ⚙️ Parameters
11167
+
11168
+ <dl>
11169
+ <dd>
11170
+
11171
+ <dl>
11172
+ <dd>
11173
+
11174
+ **userId:** `string`
11175
+
11176
+ </dd>
11177
+ </dl>
11178
+
11179
+ <dl>
11180
+ <dd>
11181
+
11182
+ **queryIdOrSlug:** `string`
11183
+
11184
+ </dd>
11185
+ </dl>
11186
+
11187
+ <dl>
11188
+ <dd>
11189
+
11190
+ **request:** `Vital.AggregateGetTaskHistoryForContinuousQueryRequest`
11191
+
11192
+ </dd>
11193
+ </dl>
11194
+
11195
+ <dl>
11196
+ <dd>
11197
+
11198
+ **requestOptions:** `Aggregate.RequestOptions`
11199
+
11200
+ </dd>
11201
+ </dl>
11202
+ </dd>
11203
+ </dl>
11204
+
11205
+ </dd>
11206
+ </dl>
11207
+ </details>