npm - @tryvital/vital-node - Versions diffs - 3.1.152 → 3.1.171 - Mend

@tryvital/vital-node 3.1.152 → 3.1.171

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (148) hide show

package/reference.md CHANGED Viewed

@@ -8519,1053 +8519,3 @@ await client.labTests.getPscAppointmentAvailability({
 </dd>
 </dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">bookPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.bookPscAppointment("order_id", {
-    bookingKey: "booking_key",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Vital.AppointmentBookingRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">reschedulePscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.reschedulePscAppointment("order_id", {
-    bookingKey: "booking_key",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Vital.AppointmentRescheduleRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelPscAppointment</a>(orderId, { ...params }) -> Vital.ClientFacingAppointment</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.cancelPscAppointment("order_id", {
-    cancellationReasonId: "cancellationReasonId",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointmentCancellationReason</a>() -> Vital.ClientFacingAppointmentCancellationReason[]</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.getPscAppointmentCancellationReason();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getPscAppointment</a>(orderId) -> Vital.ClientFacingAppointment</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get the appointment associated with an order.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.getPscAppointment("order_id");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrderRequistionPdf</a>(orderId) -> stream.Readable</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-GET requisition pdf for an order
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.getOrderRequistionPdf("string");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrder</a>(orderId) -> Vital.ClientFacingOrder</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-GET individual order by ID.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.getOrder("order_id");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-POST create new order
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```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",
-    },
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.CreateOrderRequestCompatible`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">cancelOrder</a>(orderId) -> Vital.PostOrderResponse</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-POST cancel order
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.cancelOrder("order_id");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string` — Your Order ID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">simulateOrderProcess</a>(orderId, { ...params }) -> unknown</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get available test kits.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.simulateOrderProcess("order_id");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**orderId:** `string`
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Vital.LabTestsSimulateOrderProcessRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.labTests.<a href="/src/api/resources/labTests/client/Client.ts">getOrders</a>({ ...params }) -> Vital.GetOrdersResponse</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-GET many orders with filters.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.labTests.getOrders();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.LabTestsGetOrdersRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `LabTests.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Testkit
-<details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">register</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.testkit.register({
-    userId: "user_id",
-    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",
-    },
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.RegisterTestkitRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Testkit.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.testkit.<a href="/src/api/resources/testkit/client/Client.ts">createOrder</a>({ ...params }) -> Vital.PostOrderResponse</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Creates an order for an unregistered testkit
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```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",
-    },
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.CreateRegistrableTestkitOrderRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Testkit.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Insurance
-<details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchGetPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponse[]</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.insurance.searchGetPayorInfo();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.InsuranceSearchGetPayorInfoRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Insurance.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchPayorInfo</a>({ ...params }) -> Vital.ClientFacingPayorSearchResponseDeprecated[]</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.insurance.searchPayorInfo();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.PayorSearchRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Insurance.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.insurance.<a href="/src/api/resources/insurance/client/Client.ts">searchDiagnosis</a>({ ...params }) -> Vital.ClientFacingDiagnosisInformation[]</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.insurance.searchDiagnosis({
-    diagnosisQuery: "diagnosis_query",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Vital.InsuranceSearchDiagnosisRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Insurance.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Aggregate
-<details><summary><code>client.aggregate.<a href="/src/api/resources/aggregate/client/Client.ts">queryOne</a>(userId, { ...params }) -> Vital.AggregationResponse</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.aggregate.queryOne("user_id", {
-    timeframe: {
-        type: "relative",
-        anchor: "anchor",
-        past: {
-            unit: "minute",
-        },
-    },
-    queries: [
-        {
-            select: [
-                {
-                    arg: {
-                        sleep: "session_start",
-                    },
-                    func: "mean",
-                },
-            ],
-        },
-    ],
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**userId:** `string`
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Vital.QueryBatch`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Aggregate.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>