benchling_sdk.services.v2.stable.box_service module

class BoxService

Bases: benchling_sdk.services.v2.base_service.BaseService

Boxes.

Boxes are a structured storage type, consisting of a grid of positions that can each hold one container. Unlike locations, there are a maximum number of containers that a box can hold (one per position).

Boxes are all associated with schemas, which define the type of the box (e.g. “10x10 Cryo Box”) along with the fields that are tracked and the dimensions of the box.

Like all storage, every Box has a barcode that is unique across the registry.

archive(box_ids: Iterable[str], reason: BoxesArchiveReason, should_remove_barcodes: bool) → BoxesArchivalChange

Archive boxes and any containers of the boxes.

See https://benchling.com/api/reference#/Boxes/archiveBoxes

bulk_get(*, box_ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None) → Optional[List[Box]]

Bulk get boxes.

See https://benchling.com/api/reference#/Boxes/bulkGetBoxes

create(box: BoxCreate) → Box

Create a box.

See https://benchling.com/api/reference#/Boxes/createBox

get_by_id(box_id: str) → Box

Get a box.

See https://benchling.com/api/reference#/Boxes/getBox

list(*, sort: Optional[ListBoxesSort] = None, schema_id: Optional[str] = None, modified_at: Optional[str] = None, name: Optional[str] = None, name_includes: Optional[str] = None, ancestor_storage_id: Optional[str] = None, storage_contents_id: Optional[str] = None, storage_contents_ids: Optional[List[str]] = None, empty_positions: Optional[int] = None, empty_positions_gte: Optional[int] = None, empty_positions_gt: Optional[int] = None, empty_positions_lte: Optional[int] = None, empty_positions_lt: Optional[int] = None, empty_containers: Optional[int] = None, empty_containers_gte: Optional[int] = None, empty_containers_gt: Optional[int] = None, empty_containers_lte: Optional[int] = None, empty_containers_lt: Optional[int] = None, ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None, names_any_of: Optional[Iterable[str]] = None, names_any_of_case_sensitive: Optional[Iterable[str]] = None, creator_ids: Optional[Iterable[str]] = None, archive_reason: Optional[str] = None, schema_fields: Optional[Dict[str, Any]] = None, page_size: Optional[int] = None) → PageIterator[Box]

List boxes.

See https://benchling.com/api/reference#/Boxes/listBoxes

list_box_contents()

List a box’s contents.

See https://benchling.com/api/reference#/Boxes/listBoxContents

unarchive(box_ids: Iterable[str]) → BoxesArchivalChange

Unarchive boxes and the containers that were archived along with them.

See https://benchling.com/api/reference#/Boxes/unarchiveBoxes

update(box_id: str, box: BoxUpdate) → Box

Update a box.

See https://benchling.com/api/reference#/Boxes/updateBox