feat: remove teamId fields from bulk link requests and add new enum values#173
Open
fern-api[bot] wants to merge 1 commit intomasterfrom
Open
feat: remove teamId fields from bulk link requests and add new enum values#173fern-api[bot] wants to merge 1 commit intomasterfrom
fern-api[bot] wants to merge 1 commit intomasterfrom
Conversation
…alues
Remove optional `teamId` fields from bulk link operation request types and
delete the associated `LinkBulk*RequestTeamId` enum types entirely. Add new
`sonora_quest` lab/provider values across appointment and labs enums, add
`apero` and `pverify` payor code external providers, add `derived_readiness`
to `IndexColumnExprIndex`, and remove `insulin_injection` from
`IntervalTimeseriesExprTimeseries`. Also includes internal object-schema
performance improvements with lazy property computation and reduced
per-call allocations.
Key changes:
- Remove `teamId` optional property from `BulkExportConnectionsBody`, `BulkImportConnectionsBody`, `BulkPauseConnectionsBody`, and `BulkTriggerHistoricalPullBody`
- Delete exported types `LinkBulkExportRequestTeamId`, `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`, `LinkBulkTriggerHistoricalPullRequestTeamId`, and `LinkListBulkOpsRequestTeamId`
- Add `SonoraQuest` ("sonora_quest") to `AppointmentPscLabs`, `AppointmentProvider`, and `ClientFacingLabs`
- Add `apero` and `pverify` to `PayorCodeExternalProvider`
- Add `derived_readiness` to `IndexColumnExprIndex`
- Remove `insulin_injection` from `IntervalTimeseriesExprTimeseries`
- Refactor internal object schema builder for lazy evaluation and lower allocation overhead
🌿 Generated with Fern
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Version Bump: Removing exported types
LinkBulkExportRequestTeamId,LinkBulkImportRequestTeamId,LinkBulkPauseRequestTeamId,LinkBulkTriggerHistoricalPullRequestTeamId, andLinkListBulkOpsRequestTeamId, removing properties from request interfaces, and removing theinsulin_injectionenum value are all breaking changes that will cause compile errors for existing callers.teamIdoptional property has been removed fromBulkExportConnectionsBody,BulkImportConnectionsBody,BulkPauseConnectionsBody, andBulkTriggerHistoricalPullBody— remove any references toteamIdin calls to these APIs. The exported enum typesLinkBulkExportRequestTeamId,LinkBulkImportRequestTeamId,LinkBulkPauseRequestTeamId,LinkBulkTriggerHistoricalPullRequestTeamId, andLinkListBulkOpsRequestTeamIdhave been deleted — remove all imports and usages of these types. Additionally,insulin_injectionhas been removed fromIntervalTimeseriesExprTimeseries. New values have been added:sonora_questtoAppointmentPscLabs,AppointmentProvider, andClientFacingLabs;aperoandpverifytoPayorCodeExternalProvider; andderived_readinesstoIndexColumnExprIndex.labReport.parserCreateJob()method now accepts an array of files (Uploadable[]) instead of a single file (Uploadable), enabling multiple files to be uploaded in a single parse job. Migration: wrap existing single-file calls in an array, e.g. changeparserCreateJob(file, request)toparserCreateJob([file], request).Three new resource namespaces are now available:
compendium,labAccount, andorderTransaction.bookPscAppointmentmethod onLabTestsClientnow accepts aLabTestsBookPscAppointmentRequestinstead ofAppointmentBookingRequestdirectly. The booking payload must now be passed under abodyproperty, and the new type supports optionalidempotencyKeyandidempotencyErrorheader fields. Callers must update their usage to wrap the booking request:{ body: { bookingKey: "..." } }.Additional optional parameters have been added across several endpoints:
labSlugongetMarkers,allowStaleongetPscAppointmentAvailability,orderTransactionIdongetOrders, andclinicalNotesonCreateOrderRequestCompatible.The
teamIdoptional field has been removed fromLinkListBulkOpsRequest,BulkImportConnectionsBody,BulkTriggerHistoricalPullBody,BulkExportConnectionsBody, andBulkPauseConnectionsBody— callers passingteamIdin these requests must remove that field. Theaddressfield type inUserInfoCreateRequesthas changed fromVital.AddresstoVital.UserAddress; update any type annotations or assignments accordingly. TheconnectManualProvidermethod now supports newvitalIosSdkVersionandvitalAndroidSdkVersionfields onManualConnectionDatawhich are forwarded as HTTP headers.Several breaking type changes have been introduced in this release:
ParsingJob.jobId(a requiredstringfield) has been removed. Update any code accessingparsingJob.jobIdto use the new optionalparsingJob.failureReasonfield instead.ResultMetadatafieldspatientFirstName,patientLastName,dob, andlabNameare now optional (were previously required). Code that assumes these are always present will need null/undefined checks.UserInfo.addressnow has typeVital.UserAddressinstead ofVital.Address. Update any code passing or receiving anAddressobject in this field to useUserAddress.Several boolean fields have been narrowed to literal types (
trueorfalse):wheelchairUse,HistoricalPullCompleted.isFinal,UserRefreshSuccessResponse.success,UserRefreshErrorResponse.success, andPlaceholder.placeholder. Existing code assigningfalsetowheelchairUseorisFinalwill no longer type-check.New additions include optional
deliveryMode,deliveryForm, andbolusPurposefields onClientFacingInsulinInjectionSample, newcompendiumresource exports, new provider values (samsung_health,tandem_source,sonora_quest,crl), and new order status values including corrected and lab-processing-blocked states.VitalClient:compendium(withsearch()andconvert()methods),labAccount(withgetTeamLabAccounts()), andorderTransaction. SeveralResultMetadatafields (patientFirstName,patientLastName,dob,labName) have changed from requiredstringto optionalstring | null— callers that previously assumed these fields were always present will need to add null checks. Additionally,UserInfo.addressnow uses theUserAddresstype instead ofAddress, and thesuccessfield onUserRefreshErrorResponse/UserRefreshSuccessResponsehas been narrowed to the literal typesfalse/truerespectively.OrderTransactionClient(accessible viaclient.orderTransaction) with methods to retrieve order transactions (getTransaction), their raw lab results (getTransactionResult), and PDF results (getTransactionResultPdf). Many new types have been added includingClientFacingOrderTransaction,OrderOrigin,OrderStatusDetail, lab account types (ClientFacingLabAccount,LabAccountStatus,LabAccountDelegatedFlow), insulin injection timeseries types, and lab report parsing job webhook event types. Existing types such asClientFacingOrder,ClientFacingAppointment,ClientFacingSleep,AppointmentBookingRequest, andAddresshave been expanded with new optional fields, and several enums have new values includingSonoraQuestforAppointmentProvider/Labs/ClientFacingLabsandSamsungHealthforManualProviders.TandemSource,SamsungHealth), new payor code providers (Apero,Pverify), and an optionalaccessNotesfield on address types. New compendium search and convert capabilities are available via new request/response types (SearchCompendiumBody,ConvertCompendiumBody,SearchCompendiumResponse,ConvertCompendiumResponse). Additional new types cover order transactions, lab accounts, lab report parsing job events, analytics query expressions (DerivedReadinessColumnExpr,AwakeningsValueMacroExpr,InsulinInjectionTimeseriesExpr), and appointment booking enhancements (appointmentNotes, async confirmation options).deliveryMode,deliveryForm, andbolusPurpose— for richer insulin tracking. Orders expose additional metadata includingclinicalNotes,lastEvent,origin, andorderTransaction, and order events now carry an optionalstatusDetail. New types for lab account management (ClientFacingLabAccount,GetTeamLabAccountsResponse), order transactions (ClientFacingOrderTransaction,GetOrderTransactionResponse), lab report parsing job events, and compendium conversion are also available.SearchCompendiumResponse,PerLabCandidate,RelatedCandidate,ProviderIdConversionResponse), order transaction tracking (ClientFacingOrderTransaction,GetOrderTransactionResponse), lab account management (ClientFacingLabAccount,GetTeamLabAccountsResponse), and extended address models with an optionalaccessNotesfield. New providerstandem_sourceandsamsung_healthare now supported, and query expressions have been expanded withInsulinInjectionTimeseriesExpr,DerivedReadinessColumnExpr,AwakeningsValueMacroExpr, and therecovery_readiness_scoresleep column.