@tryvital/vital-node 3.0.6 → 3.0.8

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

@@ -13,6 +13,7 @@ export declare namespace LabTests {
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
+        maxRetries?: number;
     }
 }
 export declare class LabTests {
@@ -20,6 +21,9 @@ export declare class LabTests {
     constructor(_options: LabTests.Options);
     /**
      * GET all the lab tests the team has access to.
+     *
+     * @example
+     *     await vital.labTests.get()
      */
     get(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLabTest[]>;
     /**
@@ -29,10 +33,16 @@ export declare class LabTests {
     /**
      * GET all the markers for the given lab.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getMarkers({})
      */
     getMarkers(request?: Vital.LabTestsGetMarkersRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.GetMarkersResponse>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getMarkersForLabTest("lab-test-id", {})
      */
     getMarkersForLabTest(labTestId: string, request?: Vital.LabTestsGetMarkersForLabTestRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.GetMarkersResponse>;
     /**
@@ -42,6 +52,9 @@ export declare class LabTests {
     getMarkersByLabAndProviderId(providerId: string, labId: number, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingMarker>;
     /**
      * GET all the labs.
+     *
+     * @example
+     *     await vital.labTests.getLabs()
      */
     getLabs(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingLab[]>;
     /**
@@ -60,6 +73,11 @@ export declare class LabTests {
      * @throws {@link Vital.UnprocessableEntityError}
      */
     bookPhlebotomyAppointment(orderId: string, request: Vital.AppointmentBookingRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
+    /**
+     * Request an at-home phlebotomy appointment.
+     * @throws {@link Vital.UnprocessableEntityError}
+     */
+    requestPhlebotomyAppointment(orderId: string, request: Vital.RequestAppointmentRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
      * Reschedule a previously booked at-home phlebotomy appointment.
      * @throws {@link Vital.UnprocessableEntityError}
@@ -72,6 +90,9 @@ export declare class LabTests {
     cancelPhlebotomyAppointment(orderId: string, request: Vital.AppointmentCancelRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointment>;
     /**
      * Get the list of reasons for cancelling an at-home phlebotomy appointment.
+     *
+     * @example
+     *     await vital.labTests.getPhlebotomyAppointmentCancellationReason()
      */
     getPhlebotomyAppointmentCancellationReason(requestOptions?: LabTests.RequestOptions): Promise<Vital.ClientFacingAppointmentCancellationReason[]>;
     /**
@@ -83,7 +104,8 @@ export declare class LabTests {
      * GET information about an area with respect to lab-testing.
      *
      * Information returned:
-     * * Whether a given zip code is served by our Phlebotomy network.
+     *
+     * - Whether a given zip code is served by our Phlebotomy network.
      * @throws {@link Vital.UnprocessableEntityError}
      */
     getAreaInfo(request: Vital.LabTestsGetAreaInfoRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.AreaInfo>;
@@ -130,6 +152,9 @@ export declare class LabTests {
     /**
      * GET many orders with filters.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.labTests.getOrders({})
      */
     getOrders(request?: Vital.LabTestsGetOrdersRequest, requestOptions?: LabTests.RequestOptions): Promise<Vital.GetOrdersResponse>;
 }