Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"cliVersion": "3.35.1",
"cliVersion": "4.65.1",
"generatorName": "fernapi/fern-typescript-sdk",
"generatorVersion": "3.43.1",
"generatorVersion": "3.51.3",
"generatorConfig": {
"namespaceExport": "Vital",
"inlineFileProperties": false,
Expand All @@ -11,5 +11,6 @@
"omitUndefined": false,
"skipResponseValidation": false
},
"sdkVersion": "3.1.551"
"originGitCommit": "93b118c09288b028a3a9676ad6adfbbcb23a7f8c",
"sdkVersion": "4.0.0"
}
1 change: 1 addition & 0 deletions .fernignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Specify files that shouldn't be modified by Fern

README.md
changelog.md
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/2.3.1/schema.json",
"$schema": "https://biomejs.dev/schemas/2.4.3/schema.json",
"root": true,
"vcs": {
"enabled": false
Expand Down
22 changes: 22 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 4.0.0 - 2026-04-09
* Several breaking changes have been made to the Link bulk operation request types and enum values:
* The `teamId` optional property has been removed from `BulkExportConnectionsBody`, `BulkImportConnectionsBody`, `BulkPauseConnectionsBody`, and `BulkTriggerHistoricalPullBody`. Remove any usage of this field from your request objects.
* The exported enum types `LinkBulkExportRequestTeamId`, `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`, `LinkBulkTriggerHistoricalPullRequestTeamId`, and `LinkListBulkOpsRequestTeamId` have been deleted. Remove any imports or references to these types.
* The `insulin_injection` value has been removed from the `IntervalTimeseriesExprTimeseries` enum. Update any code that references `IntervalTimeseriesExprTimeseries.InsulinInjection`.
* New enum values have also been added: `sonora_quest` is now available in `AppointmentPscLabs`, `AppointmentProvider`, and `ClientFacingLabs`; `apero` and `pverify` have been added to `PayorCodeExternalProvider`; and `derived_readiness` has been added to `IndexColumnExprIndex`.
* The `labReport.parserCreateJob` method now accepts an **array** of files (`core.file.Uploadable[]`) instead of a single file, allowing multiple files to be uploaded in one parse job. Callers must wrap existing single-file arguments in an array (e.g., `parserCreateJob([file], request)`).
* Three new resource namespaces are now available on the SDK client: `compendium`, `labAccount`, and `orderTransaction`.
* The `bookPscAppointment` method on `LabTestsClient` now accepts a `LabTestsBookPscAppointmentRequest` instead of `AppointmentBookingRequest`. The booking payload should be passed under the `body` key of the new request object, and the new object also supports optional `idempotencyKey` and `idempotencyError` fields for idempotency header control. Additionally, new optional fields have been added: `clinicalNotes` on `CreateOrderRequestCompatible`, `orderTransactionId` on the get-orders request, `allowStale` on the PSC appointment availability request, and `labSlug` on the get-markers request.
* The `teamId` field has been removed from `LinkListBulkOpsRequest`, `BulkImportConnectionsBody`, `BulkTriggerHistoricalPullBody`, `BulkExportConnectionsBody`, and `BulkPauseConnectionsBody` — remove any `teamId` property from calls to `listBulkOps`, `bulkImport`, `bulkTriggerHistoricalPull`, `bulkExport`, and `bulkPause`. The `address` field in `UserInfoCreateRequest` now requires type `Vital.UserAddress` instead of `Vital.Address` — update any code passing an `address` to that request type accordingly. The `connectManualProvider` method now reads `vitalIosSdkVersion` and `vitalAndroidSdkVersion` from the request object and sends them as HTTP headers rather than body fields.
* Several breaking type changes have been introduced in this release:
* **`ParsingJob.jobId`** (required `string`) has been **removed**. Update any code reading this field; the new optional `failureReason` field is available for error context.
* **`ResultMetadata`** fields `patientFirstName`, `patientLastName`, `dob`, and `labName` changed from **required to optional**. Existing code that treats these as always-present will need null-guard updates. A new optional `gender` field has also been added.
* **`UserInfo.address`** type changed from `Vital.Address` to `Vital.UserAddress`. Update type annotations accordingly.
* Several boolean fields have been narrowed to literal types (`true`/`false`): `ClientFacingActivity.wheelchairUse`, `ClientFacingProfile.wheelchairUse`, `HistoricalPullCompleted.isFinal`, `Placeholder.placeholder`, `UserRefreshSuccessResponse.success`, and `UserRefreshErrorResponse.success`. Code relying on these as `boolean` may require type annotation updates.
* New additions include optional `deliveryMode`, `deliveryForm`, and `bolusPurpose` fields on `ClientFacingInsulinInjectionSample`; new `OrderStatus` and `OrderLowLevelStatus` enum values for corrected results and lab processing blocks; new labs (`sonora_quest`, `crl`); and new providers (`samsung_health`, `tandem_source`).
* Three new resource clients are now available on `VitalClient`: `compendium` (with `search()` and `convert()` methods), `labAccount` (with `getTeamLabAccounts()`), and `orderTransaction`. Several existing types have been updated: `ResultMetadata` fields `patientFirstName`, `patientLastName`, `dob`, and `labName` are now optional (previously required), and `UserRefreshSuccessResponse.success` / `UserRefreshErrorResponse.success` have been narrowed to boolean literals `true` / `false` respectively — callers relying on `success: boolean` may need type updates. `UserInfo` now uses `UserAddress` instead of `Address` for the `address` field.
* The SDK now includes a new `OrderTransactionClient` (accessible via `client.orderTransaction`) with methods to retrieve order transactions (`getTransaction`), raw lab results (`getTransactionResult`), and PDF results (`getTransactionResultPdf`). New types and enum values have been added across the board, including insulin injection timeseries support, lab account management types (`ClientFacingLabAccount`, `LabAccountStatus`, `LabAccountDelegatedFlow`), order transaction status tracking, and expanded enums for `AppointmentProvider`, `Labs`, `ManualProviders`, and device source types. Several existing types have been extended with new optional fields such as `ClientFacingOrder.lastEvent`, `ClientFacingOrder.origin`, `ClientFacingSleep.recoveryReadinessScore`, and appointment booking/reschedule notes.
* The SDK now supports compendium search and conversion with new `SearchCompendiumResponse`, `ConvertCompendiumResponse`, `CanonicalCandidate`, `PerLabCandidate`, and `RelatedCandidate` types. New providers `TandemSource` and `SamsungHealth` have been added, along with `Apero` and `Pverify` for `PayorCodeExternalProvider`. Several address types now include an optional `accessNotes` field, new query expression variants (`DerivedReadinessColumnExpr`, `AwakeningsValueMacroExpr`, `InsulinInjectionTimeseriesExpr`) are available in `QuerySelectItem` and `QueryGroupByItem`, and appointment and order types have been expanded with additional optional fields and new event types.
* The SDK now supports insulin pump as a source type across ECG, menstrual cycle, and sleep cycle data. New optional fields have been added to `ClientFacingInsulinInjectionSample` (`deliveryMode`, `deliveryForm`, `bolusPurpose`), `ClientFacingOrder` (`clinicalNotes`, `lastEvent`, `origin`, `orderTransaction`), `ClientFacingOrderEvent` (`statusDetail`), and `ClientFacingSleep` (`recoveryReadinessScore`). New types are available for order transactions (`ClientFacingOrderTransaction`, `GetOrderTransactionResponse`), lab accounts (`ClientFacingLabAccount`, `GetTeamLabAccountsResponse`), lab report parsing job events, and compendium conversion responses.
* The SDK now supports lab compendium search with new types (`SearchCompendiumResponse`, `SearchMode`, `PerLabCandidate`, `RelatedCandidate`, `ProviderIdConversionResponse`) and order transaction tracking (`ClientFacingOrderTransaction`, `GetOrderTransactionResponse`, `OrderTransactionStatus`). New providers `tandem_source` and `samsung_health` are available in the `Providers` enum, address types now include an optional `accessNotes` field, and new query expression types (`DerivedReadinessColumnExpr`, `AwakeningsValueMacroExpr`, `InsulinInjectionTimeseriesExpr`) are supported in select and group-by queries.

7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@tryvital/vital-node",
"version": "3.1.551",
"version": "4.0.0",
"private": false,
"repository": {
"type": "git",
Expand Down Expand Up @@ -65,13 +65,14 @@
"msw": "2.11.2",
"@types/node": "^18.19.70",
"typescript": "~5.7.2",
"@biomejs/biome": "2.3.1"
"@biomejs/biome": "2.4.3"
},
"browser": {
"fs": false,
"os": false,
"path": false,
"stream": false
"stream": false,
"crypto": false
},
"packageManager": "pnpm@10.20.0",
"engines": {
Expand Down
Loading
Loading