@tryvital/vital-node 3.1.7 → 3.1.8

package/api/errors/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./BadRequestError";
 export * from "./UnprocessableEntityError";
+export * from "./BadRequestError";

package/api/errors/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./BadRequestError"), exports);
 __exportStar(require("./UnprocessableEntityError"), exports);
+__exportStar(require("./BadRequestError"), exports);

package/api/resources/activity/client/Client.d.ts

@@ -22,8 +22,8 @@ export declare class Activity {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.activity.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.activity.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId: string, request: Vital.ActivityGetRequest, requestOptions?: Activity.RequestOptions): Promise<Vital.ClientActivityResponse>;
@@ -32,8 +32,8 @@ export declare class Activity {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.activity.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.activity.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId: string, request: Vital.ActivityGetRawRequest, requestOptions?: Activity.RequestOptions): Promise<Vital.RawActivity>;

package/api/resources/activity/client/Client.js

@@ -54,8 +54,8 @@ class Activity {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.activity.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.activity.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId, request, requestOptions) {
@@ -73,7 +73,7 @@ class Activity {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/activity/${userId}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -123,8 +123,8 @@ class Activity {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.activity.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.activity.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId, request, requestOptions) {
@@ -142,7 +142,7 @@ class Activity {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/activity/${userId}/raw`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/activity/client/requests/ActivityGetRawRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface ActivityGetRawRequest {

package/api/resources/activity/client/requests/ActivityGetRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface ActivityGetRequest {

package/api/resources/body/client/Client.d.ts

@@ -22,8 +22,8 @@ export declare class Body {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.body.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.body.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId: string, request: Vital.BodyGetRequest, requestOptions?: Body.RequestOptions): Promise<Vital.ClientBodyResponse>;
@@ -32,8 +32,8 @@ export declare class Body {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.body.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.body.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId: string, request: Vital.BodyGetRawRequest, requestOptions?: Body.RequestOptions): Promise<Vital.RawBody>;

package/api/resources/body/client/Client.js

@@ -54,8 +54,8 @@ class Body {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.body.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.body.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId, request, requestOptions) {
@@ -73,7 +73,7 @@ class Body {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/body/${userId}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -123,8 +123,8 @@ class Body {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.body.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.body.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId, request, requestOptions) {
@@ -142,7 +142,7 @@ class Body {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/body/${userId}/raw`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/body/client/requests/BodyGetRawRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface BodyGetRawRequest {

package/api/resources/body/client/requests/BodyGetRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface BodyGetRequest {

package/api/resources/devices/client/Client.d.ts

@@ -22,7 +22,7 @@ export declare class Devices {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.devices.getRaw("user-id")
+     *     await vital.devices.getRaw("user_id")
      */
     getRaw(userId: string, request?: Vital.DevicesGetRawRequest, requestOptions?: Devices.RequestOptions): Promise<Vital.RawDevices>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/api/resources/devices/client/Client.js

@@ -54,7 +54,7 @@ class Devices {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.devices.getRaw("user-id")
+     *     await vital.devices.getRaw("user_id")
      */
     getRaw(userId, request = {}, requestOptions) {
         var _a;
@@ -67,7 +67,7 @@ class Devices {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/devices/${userId}/raw`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/insurance/client/Client.d.ts

@@ -19,6 +19,11 @@ export declare class Insurance {
     constructor(_options: Insurance.Options);
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.insurance.searchPayorInfo({
+     *         insuranceName: "insurance_name"
+     *     })
      */
     searchPayorInfo(request: Vital.PayorSearchRequest, requestOptions?: Insurance.RequestOptions): Promise<Vital.ClientFacingPayorSearchResponse[]>;
     /**
@@ -26,7 +31,7 @@ export declare class Insurance {
      *
      * @example
      *     await vital.insurance.searchDiagnosis({
-     *         diagnosisQuery: "diagnosis-query"
+     *         diagnosisQuery: "diagnosis_query"
      *     })
      */
     searchDiagnosis(request: Vital.InsuranceSearchDiagnosisRequest, requestOptions?: Insurance.RequestOptions): Promise<Vital.ClientFacingDiagnosisInformation[]>;

package/api/resources/insurance/client/Client.js

@@ -51,6 +51,11 @@ class Insurance {
     }
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.insurance.searchPayorInfo({
+     *         insuranceName: "insurance_name"
+     *     })
      */
     searchPayorInfo(request, requestOptions) {
         var _a;
@@ -58,7 +63,7 @@ class Insurance {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v3/insurance/search/payor"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PayorSearchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -108,7 +113,7 @@ class Insurance {
      *
      * @example
      *     await vital.insurance.searchDiagnosis({
-     *         diagnosisQuery: "diagnosis-query"
+     *         diagnosisQuery: "diagnosis_query"
      *     })
      */
     searchDiagnosis(request, requestOptions) {
@@ -120,7 +125,7 @@ class Insurance {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v3/insurance/search/diagnosis"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/insurance/client/requests/InsuranceSearchDiagnosisRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         diagnosisQuery: "diagnosis-query"
+ *         diagnosisQuery: "diagnosis_query"
  *     }
  */
 export interface InsuranceSearchDiagnosisRequest {

package/api/resources/insurance/client/requests/PayorSearchRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         insuranceName: "insurance_name"
+ *     }
+ */
 export interface PayorSearchRequest {
     insuranceName: string;
     insuranceState?: string;

package/api/resources/introspect/client/Client.d.ts

@@ -21,18 +21,14 @@ export declare class Introspect {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.introspect.getUserResources({
-     *         provider: Vital.Providers.Oura
-     *     })
+     *     await vital.introspect.getUserResources()
      */
     getUserResources(request?: Vital.IntrospectGetUserResourcesRequest, requestOptions?: Introspect.RequestOptions): Promise<Vital.UserResourcesResponse>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.introspect.getUserHistoricalPulls({
-     *         provider: Vital.Providers.Oura
-     *     })
+     *     await vital.introspect.getUserHistoricalPulls()
      */
     getUserHistoricalPulls(request?: Vital.IntrospectGetUserHistoricalPullsRequest, requestOptions?: Introspect.RequestOptions): Promise<Vital.UserHistoricalPullsResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/api/resources/introspect/client/Client.js

@@ -53,9 +53,7 @@ class Introspect {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.introspect.getUserResources({
-     *         provider: Vital.Providers.Oura
-     *     })
+     *     await vital.introspect.getUserResources()
      */
     getUserResources(request = {}, requestOptions) {
         var _a;
@@ -77,7 +75,7 @@ class Introspect {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/introspect/resources"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -126,9 +124,7 @@ class Introspect {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.introspect.getUserHistoricalPulls({
-     *         provider: Vital.Providers.Oura
-     *     })
+     *     await vital.introspect.getUserHistoricalPulls()
      */
     getUserHistoricalPulls(request = {}, requestOptions) {
         var _a;
@@ -150,7 +146,7 @@ class Introspect {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/introspect/historical_pull"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/introspect/client/requests/IntrospectGetUserHistoricalPullsRequest.d.ts

@@ -4,9 +4,7 @@
 import * as Vital from "../../../..";
 /**
  * @example
- *     {
- *         provider: Vital.Providers.Oura
- *     }
+ *     {}
  */
 export interface IntrospectGetUserHistoricalPullsRequest {
     userId?: string;

package/api/resources/introspect/client/requests/IntrospectGetUserResourcesRequest.d.ts

@@ -4,9 +4,7 @@
 import * as Vital from "../../../..";
 /**
  * @example
- *     {
- *         provider: Vital.Providers.Oura
- *     }
+ *     {}
  */
 export interface IntrospectGetUserResourcesRequest {
     userId?: string;

package/api/resources/labTests/client/Client.d.ts

@@ -28,6 +28,16 @@ export declare class LabTests {
     get(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLabTest[]>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.create({
+     *         markerIds: [1],
+     *         labId: 1,
+     *         name: "name",
+     *         method: Vital.LabTestCollectionMethod.Testkit,
+     *         sampleType: Vital.LabTestSampleType.DriedBloodSpot,
+     *         description: "description"
+     *     })
      */
     create(request: Vital.CreateLabTestRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLabTest>;
     /**
@@ -42,12 +52,15 @@ export declare class LabTests {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getMarkersForLabTest("lab-test-id")
+     *     await vital.labTests.getMarkersForLabTest("lab_test_id")
      */
     getMarkersForLabTest(labTestId: string, request?: Vital.LabTestsGetMarkersForLabTestRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.GetMarkersResponse>;
     /**
      * GET a specific marker for the given lab and provider_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getMarkersByLabAndProviderId("provider_id", 1)
      */
     getMarkersByLabAndProviderId(providerId: string, labId: number, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingMarker>;
     /**
@@ -60,32 +73,69 @@ export declare class LabTests {
     /**
      * GET all the lab tests the team has access to.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getById("lab_test_id")
      */
     getById(labTestId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLabTest>;
     /**
      * Return the available time slots to book an appointment with a phlebotomist
      * for the given address and order.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getPhlebotomyAppointmentAvailability({
+     *         firstLine: "first_line",
+     *         city: "city",
+     *         state: "state",
+     *         zipCode: "zip_code"
+     *     })
      */
     getPhlebotomyAppointmentAvailability(request: Vital.UsAddress, requestOptions?: LabTests.RequestOptions): Promise<Vital.AppointmentAvailabilitySlots>;
     /**
      * Book an at-home phlebotomy appointment.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.bookPhlebotomyAppointment("order_id", {
+     *         bookingKey: "booking_key"
+     *     })
      */
     bookPhlebotomyAppointment(orderId: string, request: Vital.AppointmentBookingRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
      * Request an at-home phlebotomy appointment.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.requestPhlebotomyAppointment("order_id", {
+     *         address: {
+     *             firstLine: "first_line",
+     *             city: "city",
+     *             state: "state",
+     *             zipCode: "zip_code"
+     *         },
+     *         provider: Vital.AppointmentProvider.Getlabs
+     *     })
      */
     requestPhlebotomyAppointment(orderId: string, request: Vital.RequestAppointmentRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
      * Reschedule a previously booked at-home phlebotomy appointment.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.reschedulePhlebotomyAppointment("order_id", {
+     *         bookingKey: "booking_key"
+     *     })
      */
     reschedulePhlebotomyAppointment(orderId: string, request: Vital.AppointmentRescheduleRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
      * Cancel a previously booked at-home phlebotomy appointment.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.cancelPhlebotomyAppointment("order_id", {
+     *         cancellationReasonId: "cancellation_reason_id"
+     *     })
      */
     cancelPhlebotomyAppointment(orderId: string, request: Vital.AppointmentCancelRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
@@ -98,6 +148,9 @@ export declare class LabTests {
     /**
      * Get the appointment associated with an order.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getPhlebotomyAppointment("order_id")
      */
     getPhlebotomyAppointment(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
@@ -107,25 +160,38 @@ export declare class LabTests {
      *
      * - Whether a given zip code is served by our Phlebotomy network.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getAreaInfo({
+     *         zipCode: "zip_code"
+     *     })
      */
     getAreaInfo(request: Vital.LabTestsGetAreaInfoRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.AreaInfo>;
     /**
      * This endpoint returns the lab results for the order.
+     * @throws {@link Vital.UnprocessableEntityError}
      */
     getResultPdf(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<stream.Readable>;
     /**
      * Return metadata related to order results, such as lab metadata,
      * provider and sample dates.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getResultMetadata("order_id")
      */
     getResultMetadata(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.LabResultsMetadata>;
     /**
      * Return both metadata and raw json test data
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getResultRaw("order_id")
      */
     getResultRaw(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.LabResultsRaw>;
     /**
      * GET requisition pdf for an order
+     * @throws {@link Vital.UnprocessableEntityError}
      */
     getOrderRequistionPdf(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<stream.Readable>;
     /**
@@ -146,6 +212,9 @@ export declare class LabTests {
     /**
      * Get available test kits.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.simulateOrderProcess("order_id")
      */
     simulateOrderProcess(orderId: string, request?: Vital.LabTestsSimulateOrderProcessRequest, requestOptions?: LabTests.RequestOptions): Promise<unknown>;
     /**