benchling_sdk.services.v2.alpha.v2_alpha_app_service module

class V2AlphaAppService

Bases: benchling_sdk.services.v2.base_service.BaseService

V2-Alpha Apps.

Create and manage Apps on your tenant.

https://benchling.com/api/v2-alpha/reference?stability=not-available#/Apps

archive_canvases(canvas_ids: Iterable[str], reason: benchling_api_client.v2.alpha.models.canvases_archive_reason.CanvasesArchiveReason) → benchling_api_client.v2.alpha.models.canvases_archival_change.CanvasesArchivalChange

Archive App Canvases.

See https://benchling.com/api/v2-alpha/reference?stability=not-available#/Apps/archiveCanvases

create_canvas(canvas: benchling_api_client.v2.alpha.models.canvas_create.CanvasCreate) → benchling_api_client.v2.alpha.models.canvas.Canvas

Create an App Canvas that a Benchling App can write to and read user interaction from.

See https://benchling.com/api/v2-alpha/reference?stability=not-available#/Apps/createCanvas

get_canvas(canvas_id: str) → benchling_api_client.v2.alpha.models.canvas.Canvas

Get the current state of the App Canvas, including user input elements.

See https://benchling.com/api/v2-alpha/reference?stability=not-available#/Apps/getCanvas

get_configuration_by_id(configuration_id: str) → benchling_api_client.v2.alpha.models.benchling_app_configuration.BenchlingAppConfiguration

Get app configuration.

See https://benchling.com/api/v2-alpha/reference?stability=la#/Apps/getBenchlingAppConfiguration

get_manifest(app_id: str) → benchling_api_client.v2.alpha.models.benchling_app_manifest.BenchlingAppManifest

Get app manifest.

See https://benchling.com/api/v2-alpha/reference?stability=la/Apps/getBenchlingAppManifest

list_configurations(*, app_id: Optional[str] = None, page_size: Optional[int] = 50, modified_at: Optional[str] = None) → PageIterator[benchling_api_client.v2.alpha.models.benchling_app_configuration.BenchlingAppConfiguration]

Get app configurations.

See https://benchling.com/api/v2-alpha/reference?stability=la#/Apps/listAppConfigurations

unarchive_canvases(canvas_ids: Iterable[str]) → benchling_api_client.v2.alpha.models.canvases_archival_change.CanvasesArchivalChange

Unarchive App Canvases.

See https://benchling.com/api/v2-alpha/reference?stability=not-available#/Apps/unarchiveCanvases

update_canvas(canvas_id: str, canvas: benchling_api_client.v2.alpha.models.canvas_update.CanvasUpdate) → benchling_api_client.v2.alpha.models.canvas.Canvas

Update App Canvas.

See https://benchling.com/api/v2-alpha/reference?stability=not-available#/Apps/updateCanvas

update_configuration(configuration_id: str, configuration: benchling_api_client.v2.alpha.models.benchling_app_configuration_update.BenchlingAppConfigurationUpdate) → benchling_api_client.v2.alpha.models.benchling_app_configuration.BenchlingAppConfiguration

Update app configuration.

See https://benchling.com/api/v2-alpha/reference?stability=la#/Apps/updateBenchlingAppConfiguration

update_manifest(app_id: str, manifest: benchling_api_client.v2.alpha.models.benchling_app_manifest.BenchlingAppManifest) → benchling_api_client.v2.alpha.models.benchling_app_manifest.BenchlingAppManifest

Update an app manifest.

See https://benchling.com/api/v2-alpha/reference?stability=la#/Apps/putBenchlingAppManifest