Skip to content

feat!: remove teamId fields from bulk link requests and drop insulin_injection timeseries value#178

Open
fern-api[bot] wants to merge 1 commit intomasterfrom
fern-bot/2026-04-13T22-04Z
Open

feat!: remove teamId fields from bulk link requests and drop insulin_injection timeseries value#178
fern-api[bot] wants to merge 1 commit intomasterfrom
fern-bot/2026-04-13T22-04Z

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api bot commented Apr 13, 2026

Version Bump: Existing callers will get compile errors due to the removal of the exported types LinkBulkExportRequestTeamId, LinkBulkImportRequestTeamId, LinkBulkPauseRequestTeamId, LinkBulkTriggerHistoricalPullRequestTeamId, and LinkListBulkOpsRequestTeamId, the removal of the teamId property from four request interfaces, and the removal of InsulinInjection from IntervalTimeseriesExprTimeseries.

  • Several breaking changes have been made to the Link bulk-operation request types and the IntervalTimeseriesExprTimeseries enum:

  • The teamId optional property has been removed from BulkExportConnectionsBody, BulkImportConnectionsBody, BulkPauseConnectionsBody, and BulkTriggerHistoricalPullBody. Remove any code that sets this field.

  • The exported types LinkBulkExportRequestTeamId, LinkBulkImportRequestTeamId, LinkBulkPauseRequestTeamId, LinkBulkTriggerHistoricalPullRequestTeamId, and LinkListBulkOpsRequestTeamId have been deleted. Remove any imports or references to these types.

  • The InsulinInjection ("insulin_injection") value has been removed from IntervalTimeseriesExprTimeseries. Update any exhaustive switch/if-else handling of this enum.

New additions (non-breaking): "sonora_quest" added to AppointmentPscLabs, AppointmentProvider, and ClientFacingLabs; "apero" and "pverify" added to PayorCodeExternalProvider; "derived_readiness" added to IndexColumnExprIndex.

  • The labReport.parserCreateJob method now accepts an array of files (core.file.Uploadable[]) instead of a single file (core.file.Uploadable), enabling multiple files to be uploaded in a single parse job. Migration: wrap any existing single-file call in an array, e.g. parserCreateJob([file], request).

New resource modules compendium, labAccount, and orderTransaction are now available on the SDK client.

  • The bookPscAppointment method on LabTestsClient now accepts a LabTestsBookPscAppointmentRequest instead of AppointmentBookingRequest. The booking payload must now be nested under the body property, and idempotency headers (idempotencyKey, idempotencyError) can now be passed directly on the request object. Update all calls to wrap the booking payload: { body: { bookingKey: "..." } }.

Several new optional parameters have also been added: labSlug on getMarkers, allowStale on getPscAppointmentAvailability, orderTransactionId on getOrders, and clinicalNotes on CreateOrderRequestCompatible.

  • Several breaking changes have been made to request types in this release:

  • The teamId field has been removed from LinkListBulkOpsRequest, BulkImportConnectionsBody, BulkTriggerHistoricalPullBody, BulkExportConnectionsBody, and BulkPauseConnectionsBody. Remove any usage of teamId from calls to listBulkOps, bulkImport, bulkTriggerHistoricalPull, bulkExport, and bulkPause.

  • The address field in UserInfoCreateRequest has changed from type Vital.Address to Vital.UserAddress. Update any references accordingly.

  • The vitalIosSdkVersion and vitalAndroidSdkVersion fields are now extracted from the ManualConnectionData request body and sent as HTTP headers (x-vital-ios-sdk-version and x-vital-android-sdk-version) rather than as body properties.

  • Several breaking type changes have been introduced in this release.

Breaking changes requiring migration:

  • ParsingJob.jobId (required string) has been removed. Remove any code that reads parsingJob.jobId.
  • UserInfo.address type has changed from Address to UserAddress. Update any code that typed this field as Address.
  • ResultMetadata fields patientFirstName, patientLastName, dob, and labName have changed from required to optional (stringstring | undefined). Add null-checks where these fields are accessed.
  • wheelchairUse on ClientFacingActivity and ClientFacingProfile has narrowed from boolean to true. Code that assigned or checked for false will no longer type-check.
  • HistoricalPullCompleted.isFinal, UserRefreshSuccessResponse.success, UserRefreshErrorResponse.success, and Placeholder.placeholder have been narrowed to literal types (true or false).

New additions:

  • ClientFacingInsulinInjectionSample now includes optional deliveryMode, deliveryForm, and bolusPurpose fields.
  • New OrderStatus and OrderLowLevelStatus enum values for corrected results and lab processing blocked states.
  • New lab providers: sonora_quest, crl; new manual provider: samsung_health; new password provider: tandem_source.
  • ResultMetadata gains an optional gender field.
  • The SDK now exposes three new resource clients on VitalClient: compendium (with search() and convert() methods for lab test compendium queries), labAccount (with getTeamLabAccounts()), and orderTransaction. Several existing request types have been extended with new optional fields including labSlug, orderTransactionId, appointmentNotes, labAccountId, and mobile SDK version metadata on ManualConnectionData. ResultMetadata response fields (patientFirstName, patientLastName, dob, labName) are now optional, and UserRefreshSuccessResponse/UserRefreshErrorResponse use boolean literal types (true/false) for their success discriminant field.
  • The SDK now includes a new OrderTransactionClient (accessible via client.orderTransaction) with getTransaction, getTransactionResult, and getTransactionResultPdf methods for managing order transactions. New types for insulin injection timeseries, sleep recovery/readiness scores, lab accounts, lab report parsing jobs, and order status details have been added. Several enums have been expanded with new values including SonoraQuest for lab/appointment providers, SamsungHealth for manual providers, and InsulinPump for device source types. New optional fields are available on AppointmentBookingRequest, AppointmentRescheduleRequest, ClientFacingAppointment, ClientFacingOrder, and Address.
  • The SDK now supports new providers (TandemSource, SamsungHealth), new payor code external providers (Apero, Pverify), and an optional accessNotes field on address types (PatientAddress, PatientAddressCompatible, PatientAddressWithValidation, UsAddress, UserAddress). New types have been added for compendium search and conversion (SearchCompendiumResponse, SearchMode, CanonicalCandidate, PerLabCandidate, RelatedCandidate, ConvertCompendiumResponse), parsing job failure reasons (ParsingJobFailureReason), and US state codes (UsState). Query expression union types (QueryGroupByItem, QuerySelectItem) now include DerivedReadinessColumnExpr, AwakeningsValueMacroExpr, and InsulinInjectionTimeseriesExpr variants. Appointment-related types now support optional appointmentNotes and async confirmation fields.
  • The SDK now supports insulin pump as a source type across ECG, menstrual cycle, and sleep cycle data. New optional fields (deliveryMode, deliveryForm, bolusPurpose) have been added to ClientFacingInsulinInjectionSample, and recoveryReadinessScore is now available on ClientFacingSleep. Order tracking has been expanded with new ClientFacingOrderTransaction, OrderOrigin, OrderStatusDetail, and related types, while new ClientFacingLabAccount types and ConvertCompendiumResponse enable lab account management and compendium conversion workflows.
  • The SDK now supports new providers (tandem_source, samsung_health), an optional access_notes field on address types, and a new UsState enum. New types have been added for compendium search (SearchCompendiumResponse, PerLabCandidate, RelatedCandidate, ProviderIdConversionResponse), lab accounts (ClientFacingLabAccount, LabAccountStatus), order transactions (ClientFacingOrderTransaction, OrderTransactionStatus), and derived readiness and insulin injection timeseries query expressions (DerivedReadinessColumnExpr, InsulinInjectionTimeseriesExpr, AwakeningsValueMacroExpr). The SleepColumnExprSleep enum now includes recovery_readiness_score.

…injection timeseries value

This SDK regeneration removes several previously exported types and optional
properties from the Link bulk operation request interfaces, removes the
`insulin_injection` value from `IntervalTimeseriesExprTimeseries`, and adds
new enum values across multiple types. It also includes internal performance
improvements to the object schema builder.

Key changes:
- Remove `teamId` optional property from `BulkExportConnectionsBody`,
  `BulkImportConnectionsBody`, `BulkPauseConnectionsBody`, and
  `BulkTriggerHistoricalPullBody` interfaces
- Remove and stop exporting `LinkBulkExportRequestTeamId`,
  `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`,
  `LinkBulkTriggerHistoricalPullRequestTeamId`, and
  `LinkListBulkOpsRequestTeamId` types
- Remove `InsulinInjection` / `"insulin_injection"` from
  `IntervalTimeseriesExprTimeseries` enum
- Add `SonoraQuest` / `"sonora_quest"` to `AppointmentPscLabs`,
  `AppointmentProvider`, `ClientFacingLabs`; add `"apero"` and `"pverify"`
  to `PayorCodeExternalProvider`; add `"derived_readiness"` to
  `IndexColumnExprIndex`
- Refactor internal object schema builder to use lazy property computation
  and optimised required-key tracking (no public API surface change)

🌿 Generated with Fern
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants