benchling_sdk.services.v2.beta.v2_beta_app_service module

class V2BetaAppService

Bases: benchling_sdk.services.v2.base_service.BaseService

V2-Beta Apps.

Create and manage Apps on your tenant.

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

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

Archive App Canvases.

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

create_canvas(canvas: benchling_api_client.v2.beta.models.canvas_create.CanvasCreate) → benchling_api_client.v2.beta.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-beta/reference?stability=not-available#/Apps/createCanvas

create_session(session: benchling_api_client.v2.beta.models.session_create.SessionCreate) → benchling_api_client.v2.beta.models.session.Session

Create a new session. Sessions cannot be archived once created.

See https://benchling.com/api/v2-beta/reference?availability=not-available#/Apps/createSession

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

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

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

get_configuration_by_app_id(app_id: str) → benchling_api_client.v2.beta.models.benchling_app_configuration.BenchlingAppConfiguration

Get an app’s configuration by app id.

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

Deprecated in favor of apps.list_app_configuration_items.

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

Get app manifest.

See https://benchling.com/api/v2-beta/reference#/Apps/getBenchlingAppManifest

get_session_by_id(session_id: str) → benchling_api_client.v2.beta.models.session.Session

Get a session.

See https://benchling.com/api/v2-beta/reference?availability=not-available#/Apps/getSessionById

list_sessions(app_id: Optional[str] = None, page_size: Optional[int] = None) → PageIterator[benchling_api_client.v2.beta.models.session.Session]

List all sessions.

See https://benchling.com/api/v2-beta/reference?availability=not-available#/Apps/listSessions

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

Unarchive App Canvases.

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

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

Update App Canvas.

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

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

Update an app manifest.

See https://benchling.com/api/v2-beta/reference#/Apps/putBenchlingAppManifest

update_session(session_id: str, session: benchling_api_client.v2.beta.models.session_update.SessionUpdate) → benchling_api_client.v2.beta.models.session.Session

Update session.

Raises AppSessionClosedError if trying to update a Session that has already been closed.

See https://benchling.com/api/v2-beta/reference?availability=not-available#/Apps/updateSession