From aa502dbd5112a1eca899c1f58a86becddbbe4afe Mon Sep 17 00:00:00 2001
From: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Date: Mon, 20 Jan 2025 18:06:54 +0000
Subject: [PATCH] Release 3.1.172
---
package.json | 2 +-
reference.md | 1049 +++++++++++++++++
src/api/resources/activity/client/Client.ts | 8 +-
src/api/resources/aggregate/client/Client.ts | 4 +-
src/api/resources/body/client/Client.ts | 8 +-
src/api/resources/devices/client/Client.ts | 4 +-
.../electrocardiogram/client/Client.ts | 4 +-
src/api/resources/insurance/client/Client.ts | 12 +-
src/api/resources/introspect/client/Client.ts | 8 +-
src/api/resources/labTests/client/Client.ts | 136 +--
src/api/resources/link/client/Client.ts | 56 +-
src/api/resources/meal/client/Client.ts | 4 +-
.../resources/menstrualCycle/client/Client.ts | 4 +-
src/api/resources/profile/client/Client.ts | 8 +-
src/api/resources/providers/client/Client.ts | 4 +-
src/api/resources/sleep/client/Client.ts | 16 +-
src/api/resources/sleepCycle/client/Client.ts | 4 +-
src/api/resources/team/client/Client.ts | 28 +-
src/api/resources/testkit/client/Client.ts | 8 +-
src/api/resources/user/client/Client.ts | 64 +-
src/api/resources/vitals/client/Client.ts | 232 ++--
src/api/resources/workouts/client/Client.ts | 12 +-
src/version.ts | 2 +-
23 files changed, 1363 insertions(+), 314 deletions(-)
diff --git a/package.json b/package.json
index 65249e3f..fc3e65ff 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@tryvital/vital-node",
- "version": "3.1.171",
+ "version": "3.1.172",
"private": false,
"repository": "https://github.com/tryVital/vital-node",
"main": "./index.js",
diff --git a/reference.md b/reference.md
index 540e8c9d..78834742 100644
--- a/reference.md
+++ b/reference.md
@@ -8519,3 +8519,1052 @@ await client.labTests.getPscAppointmentAvailability({
+
+
+client.labTests.bookPscAppointment(orderId, { ...params }) -> Vital.ClientFacingAppointment
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.bookPscAppointment("order_id", {
+ bookingKey: "booking_key",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**request:** `Vital.AppointmentBookingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.reschedulePscAppointment(orderId, { ...params }) -> Vital.ClientFacingAppointment
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.reschedulePscAppointment("order_id", {
+ bookingKey: "booking_key",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**request:** `Vital.AppointmentRescheduleRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.cancelPscAppointment(orderId, { ...params }) -> Vital.ClientFacingAppointment
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.cancelPscAppointment("order_id", {
+ cancellationReasonId: "cancellationReasonId",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.getPscAppointmentCancellationReason() -> Vital.ClientFacingAppointmentCancellationReason[]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.getPscAppointmentCancellationReason();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.getPscAppointment(orderId) -> Vital.ClientFacingAppointment
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the appointment associated with an order.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.getPscAppointment("order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.getOrderRequistionPdf(orderId) -> stream.Readable
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+GET requisition pdf for an order
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.getOrderRequistionPdf("string");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.getOrder(orderId) -> Vital.ClientFacingOrder
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+GET individual order by ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.getOrder("order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.createOrder({ ...params }) -> Vital.PostOrderResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+POST create new order
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.createOrder({
+ userId: "user_id",
+ patientDetails: {
+ firstName: "first_name",
+ lastName: "last_name",
+ dob: "2024-01-15T09:30:00Z",
+ gender: "female",
+ phoneNumber: "phone_number",
+ email: "email",
+ },
+ patientAddress: {
+ firstLine: "first_line",
+ city: "city",
+ state: "state",
+ zip: "zip",
+ country: "country",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.CreateOrderRequestCompatible`
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.cancelOrder(orderId) -> Vital.PostOrderResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+POST cancel order
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.cancelOrder("order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string` — Your Order ID.
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.simulateOrderProcess(orderId, { ...params }) -> unknown
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get available test kits.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.simulateOrderProcess("order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**orderId:** `string`
+
+
+
+
+
+-
+
+**request:** `Vital.LabTestsSimulateOrderProcessRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.labTests.getOrders({ ...params }) -> Vital.GetOrdersResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+GET many orders with filters.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.labTests.getOrders();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.LabTestsGetOrdersRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LabTests.RequestOptions`
+
+
+
+
+
+
+
+
+client.testkit.register({ ...params }) -> Vital.PostOrderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.testkit.register({
+ sampleId: "sample_id",
+ patientDetails: {
+ firstName: "first_name",
+ lastName: "last_name",
+ dob: "2024-01-15T09:30:00Z",
+ gender: "female",
+ phoneNumber: "phone_number",
+ email: "email",
+ },
+ patientAddress: {
+ firstLine: "first_line",
+ city: "city",
+ state: "state",
+ zip: "zip",
+ country: "country",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.RegisterTestkitRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Testkit.RequestOptions`
+
+
+
+
+
+
+
+
+client.testkit.createOrder({ ...params }) -> Vital.PostOrderResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an order for an unregistered testkit
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.testkit.createOrder({
+ userId: "user_id",
+ labTestId: "lab_test_id",
+ shippingDetails: {
+ receiverName: "receiver_name",
+ firstLine: "first_line",
+ city: "city",
+ state: "state",
+ zip: "zip",
+ country: "country",
+ phoneNumber: "phone_number",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.CreateRegistrableTestkitOrderRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Testkit.RequestOptions`
+
+
+
+
+
+
+
+
+client.insurance.searchGetPayorInfo({ ...params }) -> Vital.ClientFacingPayorSearchResponse[]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.insurance.searchGetPayorInfo();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.InsuranceSearchGetPayorInfoRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Insurance.RequestOptions`
+
+
+
+
+
+
+
+
+client.insurance.searchPayorInfo({ ...params }) -> Vital.ClientFacingPayorSearchResponseDeprecated[]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.insurance.searchPayorInfo();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.PayorSearchRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Insurance.RequestOptions`
+
+
+
+
+
+
+
+
+client.insurance.searchDiagnosis({ ...params }) -> Vital.ClientFacingDiagnosisInformation[]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.insurance.searchDiagnosis({
+ diagnosisQuery: "diagnosis_query",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Vital.InsuranceSearchDiagnosisRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Insurance.RequestOptions`
+
+
+
+
+
+
+
+
+client.aggregate.queryOne(userId, { ...params }) -> Vital.AggregationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.aggregate.queryOne("user_id", {
+ timeframe: {
+ type: "relative",
+ anchor: "anchor",
+ past: {
+ unit: "minute",
+ },
+ },
+ queries: [
+ {
+ select: [
+ {
+ arg: {
+ sleep: "session_start",
+ },
+ func: "mean",
+ },
+ ],
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**userId:** `string`
+
+
+
+
+
+-
+
+**request:** `Vital.QueryBatch`
+
+
+
+
+
+-
+
+**requestOptions:** `Aggregate.RequestOptions`
+
+
+
+
+
+
+
+
+