feat: remove teamId fields and add new enum values across link and lab types#175
Open
fern-api[bot] wants to merge 1 commit intomasterfrom
Open
feat: remove teamId fields and add new enum values across link and lab types#175fern-api[bot] wants to merge 1 commit intomasterfrom
fern-api[bot] wants to merge 1 commit intomasterfrom
Conversation
…b types Remove deprecated `teamId` optional properties from all bulk link operation request types and delete the associated `LinkBulk*RequestTeamId` enum types. Add `sonora_quest` to appointment and lab enums, `apero` and `pverify` to `PayorCodeExternalProvider`, `derived_readiness` to `IndexColumnExprIndex`, and remove `insulin_injection` from `IntervalTimeseriesExprTimeseries`. Also refactor the internal object schema builder for lazy property computation and improved `passthrough` behavior. Migration guide for breaking changes: - Remove any references to `teamId` on `BulkExportConnectionsBody`, `BulkImportConnectionsBody`, `BulkPauseConnectionsBody`, and `BulkTriggerHistoricalPullBody` — these fields no longer exist. - Remove any imports of `LinkBulkExportRequestTeamId`, `LinkBulkImportRequestTeamId`, `LinkBulkPauseRequestTeamId`, `LinkBulkTriggerHistoricalPullRequestTeamId`, and `LinkListBulkOpsRequestTeamId` — these types have been deleted. - Remove any references to `IntervalTimeseriesExprTimeseries.InsulinInjection` (`"insulin_injection"`) — this enum value has been removed. Key changes: - Removed `teamId` optional property from all four bulk link request interfaces - Deleted `LinkBulk*RequestTeamId` exported enum types and their serializers - Removed `insulin_injection` from `IntervalTimeseriesExprTimeseries` enum - Added `sonora_quest` to `AppointmentPscLabs`, `AppointmentProvider`, and `ClientFacingLabs` - Added `apero` and `pverify` to `PayorCodeExternalProvider` - Added `derived_readiness` to `IndexColumnExprIndex` - Refactored object schema builder to use lazy property computation (internal) 🌿 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: MAJOR because exported symbols were removed: the
teamIdproperty was deleted from four public request interfaces, fiveLinkBulk*RequestTeamIdenum types were fully removed, andInsulinInjectionwas removed fromIntervalTimeseriesExprTimeseries— all of which will cause compile errors for existing callers.Several breaking changes have been made to the Link bulk operation request types and enum values:
The
teamIdoptional property has been removed fromBulkExportConnectionsBody,BulkImportConnectionsBody,BulkPauseConnectionsBody, andBulkTriggerHistoricalPullBody. Remove any usage of this field from your request objects.The exported enum types
LinkBulkExportRequestTeamId,LinkBulkImportRequestTeamId,LinkBulkPauseRequestTeamId,LinkBulkTriggerHistoricalPullRequestTeamId, andLinkListBulkOpsRequestTeamIdhave been deleted. Remove any imports or references to these types.The
insulin_injectionvalue has been removed from theIntervalTimeseriesExprTimeseriesenum. Update any code that referencesIntervalTimeseriesExprTimeseries.InsulinInjection.New enum values have also been added:
sonora_questis now available inAppointmentPscLabs,AppointmentProvider, andClientFacingLabs;aperoandpverifyhave been added toPayorCodeExternalProvider; andderived_readinesshas been added toIndexColumnExprIndex.labReport.parserCreateJobmethod 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, andorderTransaction.The
bookPscAppointmentmethod onLabTestsClientnow accepts aLabTestsBookPscAppointmentRequestinstead ofAppointmentBookingRequest. The booking payload should be passed under thebodykey of the new request object, and the new object also supports optionalidempotencyKeyandidempotencyErrorfields for idempotency header control. Additionally, new optional fields have been added:clinicalNotesonCreateOrderRequestCompatible,orderTransactionIdon the get-orders request,allowStaleon the PSC appointment availability request, andlabSlugon the get-markers request.The
teamIdfield has been removed fromLinkListBulkOpsRequest,BulkImportConnectionsBody,BulkTriggerHistoricalPullBody,BulkExportConnectionsBody, andBulkPauseConnectionsBody— remove anyteamIdproperty from calls tolistBulkOps,bulkImport,bulkTriggerHistoricalPull,bulkExport, andbulkPause. Theaddressfield inUserInfoCreateRequestnow requires typeVital.UserAddressinstead ofVital.Address— update any code passing anaddressto that request type accordingly. TheconnectManualProvidermethod now readsvitalIosSdkVersionandvitalAndroidSdkVersionfrom 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(requiredstring) has been removed. Update any code reading this field; the new optionalfailureReasonfield is available for error context.ResultMetadatafieldspatientFirstName,patientLastName,dob, andlabNamechanged from required to optional. Existing code that treats these as always-present will need null-guard updates. A new optionalgenderfield has also been added.UserInfo.addresstype changed fromVital.AddresstoVital.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, andUserRefreshErrorResponse.success. Code relying on these asbooleanmay require type annotation updates.New additions include optional
deliveryMode,deliveryForm, andbolusPurposefields onClientFacingInsulinInjectionSample; newOrderStatusandOrderLowLevelStatusenum values for corrected results and lab processing blocks; new labs (sonora_quest,crl); and new providers (samsung_health,tandem_source).VitalClient:compendium(withsearch()andconvert()methods),labAccount(withgetTeamLabAccounts()), andorderTransaction. Several existing types have been updated:ResultMetadatafieldspatientFirstName,patientLastName,dob, andlabNameare now optional (previously required), andUserRefreshSuccessResponse.success/UserRefreshErrorResponse.successhave been narrowed to boolean literalstrue/falserespectively — callers relying onsuccess: booleanmay need type updates.UserInfonow usesUserAddressinstead ofAddressfor theaddressfield.OrderTransactionClient(accessible viaclient.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 forAppointmentProvider,Labs,ManualProviders, and device source types. Several existing types have been extended with new optional fields such asClientFacingOrder.lastEvent,ClientFacingOrder.origin,ClientFacingSleep.recoveryReadinessScore, and appointment booking/reschedule notes.SearchCompendiumResponse,ConvertCompendiumResponse,CanonicalCandidate,PerLabCandidate, andRelatedCandidatetypes. New providersTandemSourceandSamsungHealthhave been added, along withAperoandPverifyforPayorCodeExternalProvider. Several address types now include an optionalaccessNotesfield, new query expression variants (DerivedReadinessColumnExpr,AwakeningsValueMacroExpr,InsulinInjectionTimeseriesExpr) are available inQuerySelectItemandQueryGroupByItem, and appointment and order types have been expanded with additional optional fields and new event types.ClientFacingInsulinInjectionSample(deliveryMode,deliveryForm,bolusPurpose),ClientFacingOrder(clinicalNotes,lastEvent,origin,orderTransaction),ClientFacingOrderEvent(statusDetail), andClientFacingSleep(recoveryReadinessScore). New types are available for order transactions (ClientFacingOrderTransaction,GetOrderTransactionResponse), lab accounts (ClientFacingLabAccount,GetTeamLabAccountsResponse), lab report parsing job events, and compendium conversion responses.SearchCompendiumResponse,SearchMode,PerLabCandidate,RelatedCandidate,ProviderIdConversionResponse) and order transaction tracking (ClientFacingOrderTransaction,GetOrderTransactionResponse,OrderTransactionStatus). New providerstandem_sourceandsamsung_healthare available in theProvidersenum, address types now include an optionalaccessNotesfield, and new query expression types (DerivedReadinessColumnExpr,AwakeningsValueMacroExpr,InsulinInjectionTimeseriesExpr) are supported in select and group-by queries.