benchling_sdk.services.v2.stable.folder_service module

class FolderService

Bases: benchling_sdk.services.v2.base_service.BaseService

Folders.

Manage folder objects.

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

archive(folder_ids: Iterable[str], reason: FoldersArchiveReason) → FoldersArchivalChange

Archive folders.

See https://benchling.com/api/reference#/Folders/archiveFolders

create(folder: FolderCreate) → Folder

Create folder.

See https://benchling.com/api/reference#/Folders/createFolder

get_by_id(folder_id: str) → Folder

Get a folder by ID.

See https://benchling.com/api/reference#/Folders/getFolder

list(*, sort: Optional[Union[str, ListFoldersSort]] = None, archive_reason: Optional[str] = None, name_includes: Optional[str] = None, parent_folder_id: Optional[str] = None, project_id: Optional[str] = None, ids: Optional[Iterable[str]] = None, name: Optional[str] = None, section: Optional[ListFoldersSection] = None, page_size: Optional[int] = 50) → PageIterator[Folder]

List folders.

See https://benchling.com/api/reference#/Folders/listFolders

unarchive(folder_ids: Iterable[str]) → FoldersArchivalChange

Unarchive folders.

See https://benchling.com/api/reference#/Folders/unarchiveFolders