benchling_sdk.services.v2.stable.app_service module

class AppService

Bases: benchling_sdk.services.v2.base_service.BaseService

Apps.

Create and manage Apps on your tenant.

See https://benchling.com/api/reference#/Apps

archive(app_ids: Iterable[str], reason: BenchlingAppsArchiveReason) → BenchlingAppsArchivalChange

Archive Apps (Deprecated).

Deprecated since version 1.8.0.

See https://benchling.com/api/reference#/Apps/archiveBenchlingApps

archive_canvases(canvas_ids: Iterable[str], reason: AppCanvasesArchiveReason) → AppCanvasesArchivalChange

Archive App Canvases.

See https://benchling.com/api/reference#/Apps/archiveAppCanvases

bulk_create_app_configuration_items(items: Iterable[Union[benchling_api_client.v2.stable.models.app_config_item_generic_create.AppConfigItemGenericCreate, benchling_api_client.v2.stable.models.app_config_item_boolean_create.AppConfigItemBooleanCreate, benchling_api_client.v2.stable.models.app_config_item_integer_create.AppConfigItemIntegerCreate, benchling_api_client.v2.stable.models.app_config_item_float_create.AppConfigItemFloatCreate, benchling_api_client.v2.stable.models.app_config_item_date_create.AppConfigItemDateCreate, benchling_api_client.v2.stable.models.app_config_item_datetime_create.AppConfigItemDatetimeCreate, benchling_api_client.v2.stable.models.app_config_item_json_create.AppConfigItemJsonCreate, benchling_api_client.v2.extensions.UnknownType]]) → AsyncTaskLink

Bulk create app configuration items.

See https://benchling.com/api/reference#/Apps/bulkCreateAppConfigurationItems

bulk_update_app_configuration_items(items: Iterable[Union[benchling_api_client.v2.stable.models.app_config_item_generic_bulk_update.AppConfigItemGenericBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_boolean_bulk_update.AppConfigItemBooleanBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_integer_bulk_update.AppConfigItemIntegerBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_float_bulk_update.AppConfigItemFloatBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_date_bulk_update.AppConfigItemDateBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_datetime_bulk_update.AppConfigItemDatetimeBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_json_bulk_update.AppConfigItemJsonBulkUpdate, benchling_api_client.v2.extensions.UnknownType]]) → AsyncTaskLink

Bulk update app configuration items.

See https://benchling.com/api/reference#/Apps/bulkUpdateAppConfigurationItems

create(app: BenchlingAppCreate) → BenchlingApp

Create an App (Deprecated).

Deprecated since version 1.8.0.

See https://benchling.com/api/reference#/Apps/createBenchlingApp

create_app_configuration_item(configuration_item: Union[benchling_api_client.v2.stable.models.app_config_item_generic_create.AppConfigItemGenericCreate, benchling_api_client.v2.stable.models.app_config_item_boolean_create.AppConfigItemBooleanCreate, benchling_api_client.v2.stable.models.app_config_item_integer_create.AppConfigItemIntegerCreate, benchling_api_client.v2.stable.models.app_config_item_float_create.AppConfigItemFloatCreate, benchling_api_client.v2.stable.models.app_config_item_date_create.AppConfigItemDateCreate, benchling_api_client.v2.stable.models.app_config_item_datetime_create.AppConfigItemDatetimeCreate, benchling_api_client.v2.stable.models.app_config_item_json_create.AppConfigItemJsonCreate, benchling_api_client.v2.extensions.UnknownType]) → Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]

Create app configuration item.

See https://benchling.com/api/reference#/Apps/createAppConfigurationItem

create_canvas(canvas: AppCanvasCreate) → AppCanvas

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

See https://benchling.com/api/reference#/Apps/createAppCanvas

create_session(session: AppSessionCreate) → AppSession

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

See https://benchling.com/api/v2/reference#/Apps/createAppSessions

get_app_configuration_item_by_id(item_id: str) → Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]

Get app configuration.

See https://benchling.com/api/reference#/Apps/getAppConfigurationItemById

get_by_id(app_id: str) → BenchlingApp

Get an App by ID.

See https://benchling.com/api/reference#/Apps/getBenchlingAppByID

get_canvas_by_id(canvas_id: str, returning: Optional[List[str]] = None) → AppCanvas

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

See https://benchling.com/api/reference#/Apps/getAppCanvas

get_session_by_id(session_id: str, returning: Optional[List[str]] = None) → AppSession

Get a Benchling App session.

See https://benchling.com/api/v2/reference#/Apps/getAppSessionById

list_app_configuration_items(*, app_id: Optional[str] = None, ids: Optional[Iterable[str]] = None, page_size: Optional[int] = 50, modified_at: Optional[str] = None, sort: Optional[Union[str, ListAppConfigurationItemsSort]] = None) → PageIterator[Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]

Get app configuration items.

See https://benchling.com/api/reference#/Apps/listAppConfigurationItems

list_apps(*, page_size: Optional[int] = 50, sort: Optional[Union[str, ListBenchlingAppsSort]] = None, ids: Optional[Iterable[str]] = None, modified_at: Optional[str] = None, name: Optional[str] = None, name_includes: Optional[str] = None, namesany_of: Optional[Iterable[str]] = None, namesany_ofcase_sensitive: Optional[Iterable[str]] = None, creator_ids: Optional[str] = None, member_of: Optional[str] = None, admin_of: Optional[str] = None) → PageIterator[BenchlingApp]

List Apps.

See https://benchling.com/api/reference#/Apps/listBenchlingApps

unarchive(app_ids: Iterable[str]) → BenchlingAppsArchivalChange

Unarchive Apps (Deprecated).

Deprecated since version 1.8.0.

See https://benchling.com/api/reference#/Apps/unarchiveBenchlingApps

unarchive_canvases(canvas_ids: Iterable[str]) → AppCanvasesArchivalChange

Unarchive App Canvases.

See https://benchling.com/api/reference#/Apps/unarchiveAppCanvases

update(app_id: str, app: BenchlingAppUpdate) → BenchlingApp

Update an App’s metadata (Deprecated).

Deprecated since version 1.8.0.

See https://benchling.com/api/reference#/Apps/patchBenchlingApp

update_app_configuration_item(item_id: str, configuration_item: Union[benchling_api_client.v2.stable.models.app_config_item_generic_update.AppConfigItemGenericUpdate, benchling_api_client.v2.stable.models.app_config_item_boolean_update.AppConfigItemBooleanUpdate, benchling_api_client.v2.stable.models.app_config_item_integer_update.AppConfigItemIntegerUpdate, benchling_api_client.v2.stable.models.app_config_item_float_update.AppConfigItemFloatUpdate, benchling_api_client.v2.stable.models.app_config_item_date_update.AppConfigItemDateUpdate, benchling_api_client.v2.stable.models.app_config_item_datetime_update.AppConfigItemDatetimeUpdate, benchling_api_client.v2.stable.models.app_config_item_json_update.AppConfigItemJsonUpdate, benchling_api_client.v2.extensions.UnknownType]) → Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]

Update app configuration item.

See https://benchling.com/api/reference#/Apps/updateAppConfigurationItem

update_canvas(canvas_id: str, canvas: AppCanvasUpdate) → AppCanvas

Update App Canvas.

See https://benchling.com/api/reference#/Apps/updateAppCanvas

update_session(session_id: str, session: AppSessionUpdate) → AppSession

Update Benchling App session.

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

See https://benchling.com/api/v2/reference#/Apps/updateAppSession