@tryvital/vital-node 3.1.68 → 3.1.70

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "../../../..";
+import * as Vital from "../../../../index";
 /**
  * @example
  *     {}

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "../../../..";
+import * as Vital from "../../../../index";
 /**
  * @example
  *     {}

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

@@ -1,2 +1,2 @@
-export { IntrospectGetUserResourcesRequest } from "./IntrospectGetUserResourcesRequest";
-export { IntrospectGetUserHistoricalPullsRequest } from "./IntrospectGetUserHistoricalPullsRequest";
+export { type IntrospectGetUserResourcesRequest } from "./IntrospectGetUserResourcesRequest";
+export { type IntrospectGetUserHistoricalPullsRequest } from "./IntrospectGetUserHistoricalPullsRequest";

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

@@ -4,33 +4,42 @@
 /// <reference types="node" />
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vital from "../../..";
+import * as Vital from "../../../index";
 import * as stream from "stream";
 export declare namespace LabTests {
     interface Options {
         environment?: core.Supplier<environments.VitalEnvironment | string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class LabTests {
     protected readonly _options: LabTests.Options;
-    constructor(_options: LabTests.Options);
+    constructor(_options?: LabTests.Options);
     /**
      * GET all the lab tests the team has access to.
      *
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
-     *     await vital.labTests.get()
+     *     await client.labTests.get()
      */
     get(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLabTest[]>;
     /**
+     * @param {Vital.CreateLabTestRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.create({
+     *     await client.labTests.create({
      *         name: "name",
      *         method: Vital.LabTestCollectionMethod.Testkit,
      *         description: "description"
@@ -39,49 +48,72 @@ export declare class LabTests {
     create(request: Vital.CreateLabTestRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLabTest>;
     /**
      * GET all the markers for the given lab.
+     *
+     * @param {Vital.LabTestsGetMarkersRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getMarkers()
+     *     await client.labTests.getMarkers()
      */
     getMarkers(request?: Vital.LabTestsGetMarkersRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.GetMarkersResponse>;
     /**
+     * @param {string} labTestId
+     * @param {Vital.LabTestsGetMarkersForLabTestRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getMarkersForLabTest("lab_test_id")
+     *     await client.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
+     *
+     * @param {string} providerId
+     * @param {number} labId
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getMarkersByLabAndProviderId("provider_id", 1)
+     *     await client.labTests.getMarkersByLabAndProviderId("provider_id", 1)
      */
     getMarkersByLabAndProviderId(providerId: string, labId: number, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingMarker>;
     /**
      * GET all the labs.
      *
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
-     *     await vital.labTests.getLabs()
+     *     await client.labTests.getLabs()
      */
     getLabs(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLab[]>;
     /**
      * GET all the lab tests the team has access to.
+     *
+     * @param {string} labTestId
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getById("lab_test_id")
+     *     await client.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.
+     *
+     * @param {Vital.UsAddress} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getPhlebotomyAppointmentAvailability({
+     *     await client.labTests.getPhlebotomyAppointmentAvailability({
      *         firstLine: "first_line",
      *         city: "city",
      *         state: "state",
@@ -91,20 +123,30 @@ export declare class LabTests {
     getPhlebotomyAppointmentAvailability(request: Vital.UsAddress, requestOptions?: LabTests.RequestOptions): Promise<Vital.AppointmentAvailabilitySlots>;
     /**
      * Book an at-home phlebotomy appointment.
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {Vital.AppointmentBookingRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.bookPhlebotomyAppointment("order_id", {
+     *     await client.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.
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {Vital.RequestAppointmentRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.requestPhlebotomyAppointment("order_id", {
+     *     await client.labTests.requestPhlebotomyAppointment("order_id", {
      *         address: {
      *             firstLine: "first_line",
      *             city: "city",
@@ -117,20 +159,30 @@ export declare class LabTests {
     requestPhlebotomyAppointment(orderId: string, request: Vital.RequestAppointmentRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
      * Reschedule a previously booked at-home phlebotomy appointment.
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {Vital.AppointmentRescheduleRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.reschedulePhlebotomyAppointment("order_id", {
+     *     await client.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.
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {Vital.AppointmentCancelRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.cancelPhlebotomyAppointment("order_id", {
+     *     await client.labTests.cancelPhlebotomyAppointment("order_id", {
      *         cancellationReasonId: "cancellation_reason_id"
      *     })
      */
@@ -138,16 +190,22 @@ export declare class LabTests {
     /**
      * Get the list of reasons for cancelling an at-home phlebotomy appointment.
      *
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
-     *     await vital.labTests.getPhlebotomyAppointmentCancellationReason()
+     *     await client.labTests.getPhlebotomyAppointmentCancellationReason()
      */
     getPhlebotomyAppointmentCancellationReason(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointmentCancellationReason[]>;
     /**
      * Get the appointment associated with an order.
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getPhlebotomyAppointment("order_id")
+     *     await client.labTests.getPhlebotomyAppointment("order_id")
      */
     getPhlebotomyAppointment(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
@@ -157,29 +215,40 @@ export declare class LabTests {
      *
      * - Whether a given zip code is served by our Phlebotomy network.
      * - List of Lab locations in the area.
+     *
+     * @param {Vital.LabTestsGetAreaInfoRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getAreaInfo({
+     *     await client.labTests.getAreaInfo({
      *         zipCode: "zip_code"
      *     })
      */
     getAreaInfo(request: Vital.LabTestsGetAreaInfoRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.AreaInfo>;
     /**
+     * @param {Vital.LabTestsGetPscInfoRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getPscInfo({
+     *     await client.labTests.getPscInfo({
      *         zipCode: "zip_code",
      *         labId: 1
      *     })
      */
     getPscInfo(request: Vital.LabTestsGetPscInfoRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.PscInfo>;
     /**
+     * @param {string} orderId - Your Order ID.
+     * @param {Vital.LabTestsGetOrderPscInfoRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getOrderPscInfo("order_id")
+     *     await client.labTests.getOrderPscInfo("order_id")
      */
     getOrderPscInfo(orderId: string, request?: Vital.LabTestsGetOrderPscInfoRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.PscInfo>;
     /**
@@ -190,18 +259,26 @@ export declare class LabTests {
     /**
      * Return metadata related to order results, such as lab metadata,
      * provider and sample dates.
+     *
+     * @param {string} orderId
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getResultMetadata("order_id")
+     *     await client.labTests.getResultMetadata("order_id")
      */
     getResultMetadata(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.LabResultsMetadata>;
     /**
      * Return both metadata and raw json test data
+     *
+     * @param {string} orderId
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getResultRaw("order_id")
+     *     await client.labTests.getResultRaw("order_id")
      */
     getResultRaw(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.LabResultsRaw>;
     /**
@@ -216,36 +293,83 @@ export declare class LabTests {
     getOrderRequistionPdf(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<stream.Readable>;
     /**
      * GET individual order by ID.
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.labTests.getOrder("order_id")
      */
     getOrder(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingOrder>;
     /**
      * POST create new order
+     *
+     * @param {Vital.CreateOrderRequestCompatible} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.labTests.createOrder({
+     *         userId: "user_id",
+     *         patientDetails: {
+     *             firstName: "first_name",
+     *             lastName: "last_name",
+     *             dob: "2024-01-15T09:30:00Z",
+     *             gender: Vital.Gender.Female,
+     *             phoneNumber: "phone_number",
+     *             email: "email"
+     *         },
+     *         patientAddress: {
+     *             firstLine: "first_line",
+     *             city: "city",
+     *             state: "state",
+     *             zip: "zip",
+     *             country: "country"
+     *         }
+     *     })
      */
     createOrder(request: Vital.CreateOrderRequestCompatible, requestOptions?: LabTests.RequestOptions): Promise<Vital.PostOrderResponse>;
     /**
      * POST cancel order
+     *
+     * @param {string} orderId - Your Order ID.
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.labTests.cancelOrder("order_id")
      */
     cancelOrder(orderId: string, requestOptions?: LabTests.RequestOptions): Promise<Vital.PostOrderResponse>;
     /**
      * Get available test kits.
+     *
+     * @param {string} orderId
+     * @param {Vital.LabTestsSimulateOrderProcessRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.simulateOrderProcess("order_id")
+     *     await client.labTests.simulateOrderProcess("order_id")
      */
     simulateOrderProcess(orderId: string, request?: Vital.LabTestsSimulateOrderProcessRequest, requestOptions?: LabTests.RequestOptions): Promise<unknown>;
     /**
      * GET many orders with filters.
+     *
+     * @param {Vital.LabTestsGetOrdersRequest} request
+     * @param {LabTests.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.labTests.getOrders()
+     *     await client.labTests.getOrders()
      */
     getOrders(request?: Vital.LabTestsGetOrdersRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.GetOrdersResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-vital-api-key": string;
+        "x-vital-api-key": string | undefined;
     }>;
 }