improved
SDK Version 1.18.0 Release Notes
19 days ago by Eli Bishop
Version 1.18.0 of the Benchling SDK adds support for new API endpoints and model properties, and removes deprecated code.
What’s Changing?
Added
- New service
benchling.v2.stable.instrument_queries
. See API reference for Instrument Queries. - New beta service
benchling.v2.beta.app_definitions
. See API reference for App Definitions . - New beta service
benchling.v2.beta.analyses
. See API reference for Analyses. - New beta service
benchling.v2.beta.audit
. See API reference for Audit. - New alpha service
benchling.v2.alpha.assemblies
. See API reference for Assemblies . - In
benchling.v2.beta.entries
, added a beta version ofupdate_entry
. Unlike the stable version, this allows you to update custom fields. See API reference for Update a notebook entry's metadata. - In
benchling_sdk.models.Container
,ContainerWithCoordinates
,ContainerUpdate
, andWell
, new propertyrole
(with corresponding classExperimentalWellRole
). - In
benchling_sdk.models.webhooks.v0
, new webhook classCanvasCreatedWebhookV2Beta
. - In
benchling_api_client.v2.beta.models.benchling_app_manifest_features_item.BenchlingAppManifestFeaturesItem
, new propertylocations
, for specifying whether a canvas for a feature can be embedded in a notebook entry or entry template. - In
benchling.sdk.models.EntitySchemaType
, added the valueRNA_SEQUENCE
which was mistakenly omitted from the API spec. - In workflow node classes such as
benchling_sdk.models.WorkflowTaskNodeDetails
, added the propertynode_type
.
Changed
- In
benchling_sdk.models.WorkflowOutput
, thetask
property has been renamed toworkflow_task
. Thetask
name was a mistake in both the SDK and the OpenAPI spec; both have now been fixed to match the actual data that the Benchling API has always returned. - In
benchling_api_client.v2.beta.models.collaboration.Collaboration
, some properties had incorrect type hints indicating that they might beNone
. In reality, these properties are never null soNone
is no longer in the type hints.
Removed
- Removed
benchling.v2.beta.organizations
andbenchling.v2.beta.teams
. These services were previously promoted to the stable API. - In
benchling.v2.beta.entries
, removedcreate_entry
. This was already deprecated in the API and had no differences from the stable version. - Removed
benchling_sdk.apps.config.helpers
andbenchling_sdk.apps.config.mock_config
. These were obsolete, left over from the old v1 app configuration APIs which were previously removed.
Fixed
- Fixed the deserialization of workflow node classes such as
benchling_sdk.models.WorkflowTaskNodeDetails
. Previously, these items were always being converted to the classWorkflowOutputNodeDetails
regardless of the actual node type.
Version 1.18.0 of the Benchling SDK is now live! Find the SDK in PyPI .