@tryvital/vital-node 3.1.68 → 3.1.70

package/dist/api/resources/labTests/client/requests/CreateLabTestRequest.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/dist/api/resources/labTests/client/requests/CreateOrderRequestCompatible.d.ts

@@ -1,10 +1,33 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "../../../..";
+import * as Vital from "../../../../index";
+/**
+ * @example
+ *     {
+ *         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"
+ *         }
+ *     }
+ */
 export interface CreateOrderRequestCompatible {
     userId: string;
-    labTestId: string;
+    labTestId?: string;
+    orderSet?: Vital.OrderSetRequest;
+    collectionMethod?: Vital.LabTestCollectionMethod;
     physician?: Vital.PhysicianCreateRequest;
     healthInsurance?: Vital.HealthInsuranceCreateRequest;
     /** Defines whether order is priority or not. For some labs, this refers to a STAT order. */
@@ -12,6 +35,7 @@ export interface CreateOrderRequestCompatible {
     billingType?: Vital.Billing;
     icdCodes?: string[];
     consents?: Vital.Consent[];
+    /** Schedule an Order to be processed in a future date. */
     activateBy?: string;
     aoeAnswers?: Vital.AoEAnswer[];
     passthrough?: string;

package/dist/api/resources/labTests/client/requests/LabTestsGetAreaInfoRequest.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/dist/api/resources/labTests/client/requests/LabTestsGetLabelsPdfRequest.d.ts

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         numberOfLabels: 1,
+ *         collectionDate: "2024-01-15T09:30:00Z"
+ *     }
+ */
 export interface LabTestsGetLabelsPdfRequest {
     /**
      * Number of labels to generate

package/dist/api/resources/labTests/client/requests/LabTestsGetMarkersRequest.d.ts

@@ -14,6 +14,7 @@ export interface LabTestsGetMarkersRequest {
      * The name or test code of an individual biomarker or a panel.
      */
     name?: string;
+    aLaCarteEnabled?: boolean;
     page?: number;
     size?: number;
 }

package/dist/api/resources/labTests/client/requests/LabTestsGetOrderPscInfoRequest.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/dist/api/resources/labTests/client/requests/LabTestsGetOrdersRequest.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/dist/api/resources/labTests/client/requests/LabTestsGetPscInfoRequest.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/dist/api/resources/labTests/client/requests/LabTestsSimulateOrderProcessRequest.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/dist/api/resources/labTests/client/requests/RequestAppointmentRequest.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/dist/api/resources/labTests/client/requests/index.d.ts

@@ -1,14 +1,14 @@
-export { CreateLabTestRequest } from "./CreateLabTestRequest";
-export { LabTestsGetMarkersRequest } from "./LabTestsGetMarkersRequest";
-export { LabTestsGetMarkersForLabTestRequest } from "./LabTestsGetMarkersForLabTestRequest";
-export { AppointmentBookingRequest } from "./AppointmentBookingRequest";
-export { RequestAppointmentRequest } from "./RequestAppointmentRequest";
-export { AppointmentRescheduleRequest } from "./AppointmentRescheduleRequest";
-export { AppointmentCancelRequest } from "./AppointmentCancelRequest";
-export { LabTestsGetAreaInfoRequest } from "./LabTestsGetAreaInfoRequest";
-export { LabTestsGetPscInfoRequest } from "./LabTestsGetPscInfoRequest";
-export { LabTestsGetOrderPscInfoRequest } from "./LabTestsGetOrderPscInfoRequest";
-export { LabTestsGetLabelsPdfRequest } from "./LabTestsGetLabelsPdfRequest";
-export { CreateOrderRequestCompatible } from "./CreateOrderRequestCompatible";
-export { LabTestsSimulateOrderProcessRequest } from "./LabTestsSimulateOrderProcessRequest";
-export { LabTestsGetOrdersRequest } from "./LabTestsGetOrdersRequest";
+export { type CreateLabTestRequest } from "./CreateLabTestRequest";
+export { type LabTestsGetMarkersRequest } from "./LabTestsGetMarkersRequest";
+export { type LabTestsGetMarkersForLabTestRequest } from "./LabTestsGetMarkersForLabTestRequest";
+export { type AppointmentBookingRequest } from "./AppointmentBookingRequest";
+export { type RequestAppointmentRequest } from "./RequestAppointmentRequest";
+export { type AppointmentRescheduleRequest } from "./AppointmentRescheduleRequest";
+export { type AppointmentCancelRequest } from "./AppointmentCancelRequest";
+export { type LabTestsGetAreaInfoRequest } from "./LabTestsGetAreaInfoRequest";
+export { type LabTestsGetPscInfoRequest } from "./LabTestsGetPscInfoRequest";
+export { type LabTestsGetOrderPscInfoRequest } from "./LabTestsGetOrderPscInfoRequest";
+export { type LabTestsGetLabelsPdfRequest } from "./LabTestsGetLabelsPdfRequest";
+export { type CreateOrderRequestCompatible } from "./CreateOrderRequestCompatible";
+export { type LabTestsSimulateOrderProcessRequest } from "./LabTestsSimulateOrderProcessRequest";
+export { type LabTestsGetOrdersRequest } from "./LabTestsGetOrdersRequest";

package/dist/api/resources/link/client/Client.d.ts

@@ -3,20 +3,24 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vital from "../../..";
+import * as Vital from "../../../index";
 export declare namespace Link {
     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 Link {
     protected readonly _options: Link.Options;
-    constructor(_options: Link.Options);
+    constructor(_options?: Link.Options);
     /**
      * Endpoint to generate a user link token, to be used throughout the vital
      * link process. The vital link token is a one time use token, that
@@ -24,29 +28,40 @@ export declare class Link {
      * with a specific provider, pass in a provider in the body. If you would
      * like to redirect to a custom url after successful or error connection,
      * pass in your own custom redirect_url parameter.
+     *
+     * @param {Vital.LinkTokenExchange} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.token({
+     *     await client.link.token({
      *         userId: "user_id"
      *     })
      */
     token(request: Vital.LinkTokenExchange, requestOptions?: Link.RequestOptions): Promise<Vital.LinkTokenExchangeResponse>;
     /**
+     * @param {Vital.LinkTokenBase} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.isTokenValid({
+     *     await client.link.isTokenValid({
      *         token: "token"
      *     })
      */
     isTokenValid(request: Vital.LinkTokenBase, requestOptions?: Link.RequestOptions): Promise<Record<string, unknown>>;
     /**
      * Generate a token to invite a user of Vital mobile app to your team
+     *
+     * @param {Vital.LinkCodeCreateRequest} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.codeCreate({
+     *     await client.link.codeCreate({
      *         userId: "user_id"
      *     })
      */
@@ -54,10 +69,14 @@ export declare class Link {
     /**
      * REQUEST_SOURCE: VITAL-LINK
      * Start link token process
+     *
+     * @param {Vital.BeginLinkTokenRequest} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.startConnect({
+     *     await client.link.startConnect({
      *         linkToken: "link_token",
      *         provider: Vital.Providers.Oura
      *     })
@@ -66,18 +85,26 @@ export declare class Link {
     /**
      * REQUEST_SOURCE: VITAL-LINK
      * Check link token state - can be hit continuously used as heartbeat
+     *
+     * @param {Vital.LinkTokenStateRequest} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.tokenState()
+     *     await client.link.tokenState()
      */
     tokenState(request?: Vital.LinkTokenStateRequest, requestOptions?: Link.RequestOptions): Promise<Record<string, unknown>>;
     /**
      * Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
+     *
+     * @param {Vital.EmailAuthLink} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.emailAuth({
+     *     await client.link.emailAuth({
      *         email: "email",
      *         provider: Vital.Providers.Oura,
      *         authType: Vital.AuthType.Password
@@ -86,10 +113,14 @@ export declare class Link {
     emailAuth(request: Vital.EmailAuthLink, requestOptions?: Link.RequestOptions): Promise<Vital.ConnectionStatus>;
     /**
      * Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
+     *
+     * @param {Vital.PasswordAuthLink} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.passwordAuth({
+     *     await client.link.passwordAuth({
      *         username: "username",
      *         password: "password",
      *         provider: Vital.Providers.Oura,
@@ -99,18 +130,28 @@ export declare class Link {
     passwordAuth(request: Vital.PasswordAuthLink, requestOptions?: Link.RequestOptions): Promise<Vital.ConnectionStatus>;
     /**
      * This endpoint generates an OAuth link for oauth provider
+     *
+     * @param {Vital.OAuthProviders} oauthProvider
+     * @param {Vital.LinkGenerateOauthLinkRequest} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.generateOauthLink(Vital.OAuthProviders.Oura)
+     *     await client.link.generateOauthLink(Vital.OAuthProviders.Oura)
      */
     generateOauthLink(oauthProvider: Vital.OAuthProviders, request?: Vital.LinkGenerateOauthLinkRequest, requestOptions?: Link.RequestOptions): Promise<Vital.Source>;
     /**
      * This connects auth providers that are password based.
+     *
+     * @param {Vital.PasswordProviders} provider
+     * @param {Vital.IndividualProviderData} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.connectPasswordProvider(Vital.PasswordProviders.Whoop, {
+     *     await client.link.connectPasswordProvider(Vital.PasswordProviders.Whoop, {
      *         username: "username",
      *         password: "password"
      *     })
@@ -118,53 +159,75 @@ export declare class Link {
     connectPasswordProvider(provider: Vital.PasswordProviders, request: Vital.IndividualProviderData, requestOptions?: Link.RequestOptions): Promise<Vital.ProviderLinkResponse>;
     /**
      * This connects auth providers that are password based.
+     *
+     * @param {Vital.PasswordProviders} provider
+     * @param {Vital.CompletePasswordProviderMfaBody} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.completePasswordProviderMfa(Vital.PasswordProviders.Whoop, {
+     *     await client.link.completePasswordProviderMfa(Vital.PasswordProviders.Whoop, {
      *         mfaCode: "mfa_code"
      *     })
      */
     completePasswordProviderMfa(provider: Vital.PasswordProviders, request: Vital.CompletePasswordProviderMfaBody, requestOptions?: Link.RequestOptions): Promise<Vital.ProviderLinkResponse>;
     /**
      * This connects auth providers that are email based.
+     *
+     * @param {Vital.EmailProviders} provider
+     * @param {Vital.EmailProviderAuthLink} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.connectEmailAuthProvider("freestyle_libre", {
+     *     await client.link.connectEmailAuthProvider("freestyle_libre", {
      *         email: "email"
      *     })
      */
     connectEmailAuthProvider(provider: Vital.EmailProviders, request: Vital.EmailProviderAuthLink, requestOptions?: Link.RequestOptions): Promise<Vital.ConnectionStatus>;
     /**
      * GET List of all available providers given the generated link token.
+     *
+     * @param {Vital.LinkGetAllProvidersRequest} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.getAllProviders()
+     *     await client.link.getAllProviders()
      */
     getAllProviders(request?: Vital.LinkGetAllProvidersRequest, requestOptions?: Link.RequestOptions): Promise<Vital.SourceLink[]>;
     /**
+     * @param {Vital.ManualProviders} provider
+     * @param {Vital.ManualConnectionData} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.connectManualProvider(Vital.ManualProviders.BeurerBle, {
+     *     await client.link.connectManualProvider(Vital.ManualProviders.BeurerBle, {
      *         userId: "user_id"
      *     })
      */
     connectManualProvider(provider: Vital.ManualProviders, request: Vital.ManualConnectionData, requestOptions?: Link.RequestOptions): Promise<Record<string, boolean>>;
     /**
      * POST Connect the given Vital user to a demo provider.
+     *
+     * @param {Vital.DemoConnectionCreationPayload} request
+     * @param {Link.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.link.connectDemoProvider({
+     *     await client.link.connectDemoProvider({
      *         userId: "user_id",
      *         provider: Vital.DemoProviders.AppleHealthKit
      *     })
      */
     connectDemoProvider(request: Vital.DemoConnectionCreationPayload, requestOptions?: Link.RequestOptions): Promise<Vital.DemoConnectionStatus>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-vital-api-key": string;
+        "x-vital-api-key": string | undefined;
     }>;
 }