benchling_sdk.models package¶
- class AaSequence¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class AaSequence.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Array of annotation objects on the AA sequence.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence.T ¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class AaSequenceBulkCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class AaSequenceBulkCreate.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence_bulk_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class AaSequenceBulkUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class AaSequenceBulkUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property custom_fields: CustomFields¶
- class AaSequenceCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class AaSequenceCreate.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class AaSequenceUpdate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class AaSequenceUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property custom_fields: CustomFields¶
- class AaSequenceUpsert¶
Bases:
object
- __init__(name: str, schema_id: str, registry_id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet] = attr_dict['_archive_record'].default) None ¶
Method generated by attrs for class AaSequenceUpsert.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property archive_record: benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet¶
Currently, we only support setting a null value for archiveRecord, which unarchives the item
- property custom_fields: CustomFields¶
- property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶
- class AaSequenceWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.aa_sequence_with_entity_type_entity_type.AaSequenceWithEntityTypeEntityType] = attr_dict['_entity_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class AaSequenceWithEntityType.
- property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Array of annotation objects on the AA sequence.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property entity_type: benchling_api_client.v2.stable.models.aa_sequence_with_entity_type_entity_type.AaSequenceWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence_with_entity_type.T ¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class AaSequencesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of AA sequences along with any IDs of batches that were archived / unarchived.
- __init__(aa_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aa_sequence_ids'].default, batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default) None ¶
Method generated by attrs for class AaSequencesArchivalChange.
- class AaSequencesArchive¶
Bases:
object
The request body for archiving AA sequences.
- __init__(aa_sequence_ids: List[str], reason: EntityArchiveReason) None ¶
Method generated by attrs for class AaSequencesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequences_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class AaSequencesBulkCreateRequest¶
Bases:
object
- __init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequenceBulkCreate]] = attr_dict['_aa_sequences'].default) None ¶
Method generated by attrs for class AaSequencesBulkCreateRequest.
- property aa_sequences: List[AaSequenceBulkCreate]¶
- class AaSequencesBulkUpdateRequest¶
Bases:
object
- __init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequenceBulkUpdate]] = attr_dict['_aa_sequences'].default) None ¶
Method generated by attrs for class AaSequencesBulkUpdateRequest.
- property aa_sequences: List[AaSequenceBulkUpdate]¶
- class AaSequencesBulkUpsertRequest¶
Bases:
object
- __init__(aa_sequences: List[benchling_api_client.v2.stable.models.aa_sequence_bulk_upsert_request.AaSequenceBulkUpsertRequest]) None ¶
Method generated by attrs for class AaSequencesBulkUpsertRequest.
- property aa_sequences: List[benchling_api_client.v2.stable.models.aa_sequence_bulk_upsert_request.AaSequenceBulkUpsertRequest]¶
- class AaSequencesFindMatchingRegion¶
Bases:
object
- __init__(schema_id: str, target_aa_sequence_ids: List[str], registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default) None ¶
Method generated by attrs for class AaSequencesFindMatchingRegion.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequences_find_matching_region.T ¶
- class AaSequencesPaginatedList¶
Bases:
object
- __init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequence]] = attr_dict['_aa_sequences'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AaSequencesPaginatedList.
- property aa_sequences: List[AaSequence]¶
- class AaSequencesUnarchive¶
Bases:
object
The request body for unarchiving AA sequences.
- __init__(aa_sequence_ids: List[str]) None ¶
Method generated by attrs for class AaSequencesUnarchive.
- class AppCanvas¶
Bases:
object
- __init__(app: Union[benchling_api_client.v2.types.Unset, AppCanvasApp] = attr_dict['_app'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.app_canvas_base_archive_record.AppCanvasBaseArchiveRecord] = attr_dict['_archive_record'].default, data: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_data'].default, enabled: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_enabled'].default, feature_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_id'].default, resource_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_resource_id'].default, session_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_session_id'].default, blocks: Union[benchling_api_client.v2.types.Unset, List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SectionUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, TableUiBlock, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_blocks'].default) None ¶
Method generated by attrs for class AppCanvas.
- property app: AppCanvasApp¶
- property archive_record: Optional[benchling_api_client.v2.stable.models.app_canvas_base_archive_record.AppCanvasBaseArchiveRecord]¶
- property blocks: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SectionUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, TableUiBlock, benchling_api_client.v2.extensions.UnknownType]]¶
- property data: Optional[str]¶
Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won’t be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.
- property enabled: bool¶
Overall control for whether the canvas is interactable or not. If false, every block is disabled and will override the individual block’s enabled property. If true or absent, the interactivity status will defer to the block’s enabled property.
- property feature_id: str¶
Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_canvas.T ¶
- class AppCanvasApp¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class AppCanvasApp.
- class AppCanvasCreate¶
Bases:
object
- __init__(app_id: str, data: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_data'].default, enabled: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_enabled'].default, feature_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_id'].default, resource_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_resource_id'].default, session_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_session_id'].default, blocks: Union[benchling_api_client.v2.types.Unset, List[Union[ButtonUiBlockCreate, ChipUiBlockCreate, DropdownUiBlockCreate, DropdownMultiValueUiBlockCreate, MarkdownUiBlockCreate, SearchInputUiBlockCreate, SearchInputMultiValueUiBlockCreate, SectionUiBlockCreate, SelectorInputUiBlockCreate, SelectorInputMultiValueUiBlockCreate, TextInputUiBlockCreate, TableUiBlockCreate, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_blocks'].default) None ¶
Method generated by attrs for class AppCanvasCreate.
- property app_id: str¶
Identifier of the app owning this canvas. For backwards compatibility, this property will be temporarily optional until the requisite time window for breaking changes in beta endpoints has passed.
- property blocks: List[Union[ButtonUiBlockCreate, ChipUiBlockCreate, DropdownUiBlockCreate, DropdownMultiValueUiBlockCreate, MarkdownUiBlockCreate, SearchInputUiBlockCreate, SearchInputMultiValueUiBlockCreate, SectionUiBlockCreate, SelectorInputUiBlockCreate, SelectorInputMultiValueUiBlockCreate, TextInputUiBlockCreate, TableUiBlockCreate, benchling_api_client.v2.extensions.UnknownType]]¶
- property data: Optional[str]¶
Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won’t be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.
- property enabled: bool¶
Overall control for whether the canvas is interactable or not. If false, every block is disabled and will override the individual block’s enabled property. If true or absent, the interactivity status will defer to the block’s enabled property.
- property feature_id: str¶
Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_canvas_create.T ¶
- class AppCanvasUpdate¶
Bases:
object
- __init__(data: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_data'].default, enabled: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_enabled'].default, feature_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_id'].default, resource_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_resource_id'].default, session_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_session_id'].default, blocks: Union[benchling_api_client.v2.types.Unset, List[Union[ButtonUiBlockUpdate, ChipUiBlockUpdate, DropdownUiBlockUpdate, DropdownMultiValueUiBlockUpdate, MarkdownUiBlockUpdate, SearchInputUiBlockUpdate, SearchInputMultiValueUiBlockUpdate, SectionUiBlockUpdate, SelectorInputUiBlockUpdate, SelectorInputMultiValueUiBlockUpdate, TextInputUiBlockUpdate, TableUiBlockUpdate, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_blocks'].default) None ¶
Method generated by attrs for class AppCanvasUpdate.
- property blocks: List[Union[ButtonUiBlockUpdate, ChipUiBlockUpdate, DropdownUiBlockUpdate, DropdownMultiValueUiBlockUpdate, MarkdownUiBlockUpdate, SearchInputUiBlockUpdate, SearchInputMultiValueUiBlockUpdate, SectionUiBlockUpdate, SelectorInputUiBlockUpdate, SelectorInputMultiValueUiBlockUpdate, TextInputUiBlockUpdate, TableUiBlockUpdate, benchling_api_client.v2.extensions.UnknownType]]¶
- property data: Optional[str]¶
Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won’t be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.
- property enabled: bool¶
Overall control for whether the canvas is interactable or not. If false, every block is disabled and will override the individual block’s enabled property. If true or absent, the interactivity status will defer to the block’s enabled property.
- property feature_id: str¶
Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_canvas_update.T ¶
- class AppCanvasesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived. This includes the IDs of canvases that were archived / unarchived.
- __init__(canvas_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_canvas_ids'].default) None ¶
Method generated by attrs for class AppCanvasesArchivalChange.
- class AppCanvasesArchive¶
Bases:
object
- __init__(canvas_ids: List[str], reason: AppCanvasesArchiveReason) None ¶
Method generated by attrs for class AppCanvasesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_canvases_archive.T ¶
- property reason: AppCanvasesArchiveReason¶
Reason that canvases are being archived. Actual reason enum varies by tenant.
- class AppCanvasesArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- OTHER = 'Other'¶
- static of_unknown(val: str) AppCanvasesArchiveReason ¶
- class AppCanvasesPaginatedList¶
Bases:
object
- __init__(app_canvases: Union[benchling_api_client.v2.types.Unset, List[AppCanvas]] = attr_dict['_app_canvases'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AppCanvasesPaginatedList.
- class AppCanvasesUnarchive¶
Bases:
object
- class AppConfigItemsBulkCreateRequest¶
Bases:
object
- __init__(app_configuration_items: List[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]]) None ¶
Method generated by attrs for class AppConfigItemsBulkCreateRequest.
- property app_configuration_items: List[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]]¶
- class AppConfigItemsBulkUpdateRequest¶
Bases:
object
- __init__(app_configuration_items: List[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]]) None ¶
Method generated by attrs for class AppConfigItemsBulkUpdateRequest.
- property app_configuration_items: List[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]]¶
- class AppConfigurationPaginatedList¶
Bases:
object
- __init__(app_configuration_items: Union[benchling_api_client.v2.types.Unset, List[Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_app_configuration_items'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AppConfigurationPaginatedList.
- property app_configuration_items: List[Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]¶
- class AppSession¶
Bases:
object
- __init__(app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_session_app.AppSessionApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, messages: Union[benchling_api_client.v2.types.Unset, None, List[benchling_api_client.v2.stable.models.app_session_message.AppSessionMessage]] = attr_dict['_messages'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, status: Union[benchling_api_client.v2.types.Unset, AppSessionStatus] = attr_dict['_status'].default, timeout_seconds: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_timeout_seconds'].default) None ¶
Method generated by attrs for class AppSession.
- property app: benchling_api_client.v2.stable.models.app_session_app.AppSessionApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_session.T ¶
- property messages: Optional[List[benchling_api_client.v2.stable.models.app_session_message.AppSessionMessage]]¶
An array of SessionMessage describing the current session state.
- property name: str¶
A brief description of the app’s actions for users. Length must be between 3-100 chars. It becomes immutable once a value is set.
- property status: AppSessionStatus¶
All possible values of a Session’s status, including system-updated and user-updated values.
- class AppSessionCreate¶
Bases:
object
- __init__(app_id: str, name: str, timeout_seconds: int, messages: Union[benchling_api_client.v2.types.Unset, List[AppSessionMessageCreate]] = attr_dict['_messages'].default) None ¶
Method generated by attrs for class AppSessionCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_session_create.T ¶
- property messages: List[AppSessionMessageCreate]¶
An array of SessionMessage describing the current session state.
- property name: str¶
The name of the session. Length must be between 3-100 chars. Value is required and immutable once set.
- class AppSessionMessageCreate¶
Bases:
object
- __init__(content: str, style: Union[benchling_api_client.v2.types.Unset, AppSessionMessageStyle] = attr_dict['_style'].default) None ¶
Method generated by attrs for class AppSessionMessageCreate.
- property content: str¶
A message string, to be rendered as plain text with Benchling chips. References to Benchling items (up to 10 per msg) will be rendered as chips in the Benchling UX. A valid reference is a Benchling API id, prefixed with “id:” and contained by braces. For example: “{id:ent_a0SApq3}.”
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_session_message_create.T ¶
- property style: AppSessionMessageStyle¶
- class AppSessionMessageStyle¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- ERROR = 'ERROR'¶
- INFO = 'INFO'¶
- NONE = 'NONE'¶
- SUCCESS = 'SUCCESS'¶
- WARNING = 'WARNING'¶
- static of_unknown(val: str) AppSessionMessageStyle ¶
- class AppSessionStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- COMPLETED_WITH_WARNINGS = 'COMPLETED_WITH_WARNINGS'¶
- FAILED = 'FAILED'¶
- RUNNING = 'RUNNING'¶
- SUCCEEDED = 'SUCCEEDED'¶
- TIMEOUT = 'TIMEOUT'¶
- static of_unknown(val: str) AppSessionStatus ¶
- class AppSessionUpdate¶
Bases:
object
Update a session’s messages or increase timeoutSeconds.
- __init__(messages: Union[benchling_api_client.v2.types.Unset, List[AppSessionMessageCreate]] = attr_dict['_messages'].default, status: Union[benchling_api_client.v2.types.Unset, AppSessionUpdateStatus] = attr_dict['_status'].default, timeout_seconds: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_timeout_seconds'].default) None ¶
Method generated by attrs for class AppSessionUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.app_session_update.T ¶
- property messages: List[AppSessionMessageCreate]¶
An array of SessionMessage describing the current session state.
- property status: AppSessionUpdateStatus¶
Values that can be specified when updating the status of a Session
- class AppSessionUpdateStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- COMPLETED_WITH_WARNINGS = 'COMPLETED_WITH_WARNINGS'¶
- FAILED = 'FAILED'¶
- SUCCEEDED = 'SUCCEEDED'¶
- static of_unknown(val: str) AppSessionUpdateStatus ¶
- class AppSessionsPaginatedList¶
Bases:
object
- __init__(app_sessions: Union[benchling_api_client.v2.types.Unset, List[AppSession]] = attr_dict['_app_sessions'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AppSessionsPaginatedList.
- property app_sessions: List[AppSession]¶
- class ArrayElementAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, ArrayElementAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class ArrayElementAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.array_element_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: ArrayElementAppConfigItemType¶
- class ArrayElementAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- ARRAY_ELEMENT = 'array_element'¶
- static of_unknown(val: str) ArrayElementAppConfigItemType ¶
- class AssayResult¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, field_validation: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_result_field_validation.AssayResultFieldValidation] = attr_dict['_field_validation'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_reviewed: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_reviewed'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_status'].default) None ¶
Method generated by attrs for class AssayResult.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property field_validation: benchling_api_client.v2.stable.models.assay_result_field_validation.AssayResultFieldValidation¶
Object mapping field names to a UserValidation Resource object for that field. To set validation for a result, you must use this object.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_result.T ¶
- property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶
- class AssayResultCreate¶
Bases:
object
- __init__(fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, field_validation: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_result_create_field_validation.AssayResultCreateFieldValidation] = attr_dict['_field_validation'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default) None ¶
Method generated by attrs for class AssayResultCreate.
- property field_validation: benchling_api_client.v2.stable.models.assay_result_create_field_validation.AssayResultCreateFieldValidation¶
Dictionary mapping field names to UserValidation Resources.
- property fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]¶
Dictionary of result fields. Please note the field keys must be the field’s warehouse name, not display name.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_result_create.T ¶
- class AssayResultIdsRequest¶
Bases:
object
- __init__(assay_result_ids: List[str]) None ¶
Method generated by attrs for class AssayResultIdsRequest.
- class AssayResultIdsResponse¶
Bases:
object
- __init__(assay_result_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_result_ids'].default) None ¶
Method generated by attrs for class AssayResultIdsResponse.
- class AssayResultSchema¶
Bases:
object
- __init__(modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_result_schema_type.AssayResultSchemaType] = attr_dict['_type'].default, derived_from: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_derived_from'].default, organization: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class AssayResultSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_result_schema.T ¶
- property organization: benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization¶
- property type: benchling_api_client.v2.stable.models.assay_result_schema_type.AssayResultSchemaType¶
- class AssayResultSchemasPaginatedList¶
Bases:
object
- __init__(assay_result_schemas: Union[benchling_api_client.v2.types.Unset, List[AssayResultSchema]] = attr_dict['_assay_result_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AssayResultSchemasPaginatedList.
- property assay_result_schemas: List[AssayResultSchema]¶
- class AssayResultTransactionCreateResponse¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class AssayResultTransactionCreateResponse.
- class AssayResultsArchive¶
Bases:
object
- __init__(assay_result_ids: List[str], reason: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_results_archive_reason.AssayResultsArchiveReason] = attr_dict['_reason'].default) None ¶
Method generated by attrs for class AssayResultsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_results_archive.T ¶
- property reason: benchling_api_client.v2.stable.models.assay_results_archive_reason.AssayResultsArchiveReason¶
The reason for archiving the provided results. Accepted reasons may differ based on tenant configuration
- class AssayResultsBulkCreateInTableRequest¶
Bases:
object
- __init__(assay_results: List[AssayResultCreate], table_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_table_id'].default) None ¶
Method generated by attrs for class AssayResultsBulkCreateInTableRequest.
- property assay_results: List[AssayResultCreate]¶
- class AssayResultsBulkCreateRequest¶
Bases:
object
- __init__(assay_results: List[AssayResultCreate]) None ¶
Method generated by attrs for class AssayResultsBulkCreateRequest.
- property assay_results: List[AssayResultCreate]¶
- class AssayResultsCreateResponse¶
Bases:
object
- __init__(assay_results: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_results'].default) None ¶
Method generated by attrs for class AssayResultsCreateResponse.
- class AssayResultsPaginatedList¶
Bases:
object
- __init__(assay_results: Union[benchling_api_client.v2.types.Unset, List[AssayResult]] = attr_dict['_assay_results'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AssayResultsPaginatedList.
- property assay_results: List[AssayResult]¶
- class AssayRun¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_reviewed: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_reviewed'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus] = attr_dict['_validation_status'].default) None ¶
Method generated by attrs for class AssayRun.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_run.T ¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property validation_status: benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus¶
Must be either VALID or INVALID
- class AssayRunCreate¶
Bases:
object
- __init__(fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus] = attr_dict['_validation_status'].default) None ¶
Method generated by attrs for class AssayRunCreate.
- property fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]¶
Object of assay run fields
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_run_create.T ¶
- property project_id: str¶
The project that the assay run should be uploaded to. Only users with read access to the project will be able to read the assay run. Leaving this empty will result in only the creator having read access.
- property validation_status: benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus¶
Must be either VALID or INVALID
- class AssayRunSchema¶
Bases:
object
- __init__(automation_input_file_configs: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.assay_run_schema_automation_input_file_configs_item.AssayRunSchemaAutomationInputFileConfigsItem]] = attr_dict['_automation_input_file_configs'].default, automation_output_file_configs: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.assay_run_schema_automation_output_file_configs_item.AssayRunSchemaAutomationOutputFileConfigsItem]] = attr_dict['_automation_output_file_configs'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_run_schema_type.AssayRunSchemaType] = attr_dict['_type'].default, derived_from: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_derived_from'].default, organization: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class AssayRunSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property automation_input_file_configs: List[benchling_api_client.v2.stable.models.assay_run_schema_automation_input_file_configs_item.AssayRunSchemaAutomationInputFileConfigsItem]¶
- property automation_output_file_configs: List[benchling_api_client.v2.stable.models.assay_run_schema_automation_output_file_configs_item.AssayRunSchemaAutomationOutputFileConfigsItem]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_run_schema.T ¶
- property organization: benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization¶
- property type: benchling_api_client.v2.stable.models.assay_run_schema_type.AssayRunSchemaType¶
- class AssayRunSchemasPaginatedList¶
Bases:
object
- __init__(assay_run_schemas: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchema]] = attr_dict['_assay_run_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AssayRunSchemasPaginatedList.
- property assay_run_schemas: List[AssayRunSchema]¶
- class AssayRunUpdate¶
Bases:
object
- __init__(fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) None ¶
Method generated by attrs for class AssayRunUpdate.
- class AssayRunsArchivalChange¶
Bases:
object
IDs of all Assay Runs that were archived / unarchived.
- __init__(assay_run_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_run_ids'].default) None ¶
Method generated by attrs for class AssayRunsArchivalChange.
- class AssayRunsArchive¶
Bases:
object
The request body for archiving Assay Runs.
- __init__(assay_run_ids: List[str], reason: AssayRunsArchiveReason) None ¶
Method generated by attrs for class AssayRunsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_runs_archive.T ¶
- property reason: AssayRunsArchiveReason¶
The reason for archiving the provided Assay Runs. Accepted reasons may differ based on tenant configuration.
- class AssayRunsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- ARCHIVED = 'Archived'¶
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- static of_unknown(val: str) AssayRunsArchiveReason ¶
- class AssayRunsBulkCreateRequest¶
Bases:
object
- __init__(assay_runs: List[AssayRunCreate]) None ¶
Method generated by attrs for class AssayRunsBulkCreateRequest.
- property assay_runs: List[AssayRunCreate]¶
- class AssayRunsBulkCreateResponse¶
Bases:
object
- __init__(assay_runs: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_runs'].default) None ¶
Method generated by attrs for class AssayRunsBulkCreateResponse.
- class AssayRunsPaginatedList¶
Bases:
object
- __init__(assay_runs: Union[benchling_api_client.v2.types.Unset, List[AssayRun]] = attr_dict['_assay_runs'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AssayRunsPaginatedList.
- class AssayRunsUnarchive¶
Bases:
object
The request body for unarchiving Assay Runs.
- class AsyncTask¶
Bases:
object
- __init__(status: AsyncTaskStatus, errors: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.async_task_errors.AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, response: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.async_task_response.AsyncTaskResponse] = attr_dict['_response'].default) None ¶
Method generated by attrs for class AsyncTask.
- property errors: benchling_api_client.v2.stable.models.async_task_errors.AsyncTaskErrors¶
Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.async_task.T ¶
- property response: benchling_api_client.v2.stable.models.async_task_response.AsyncTaskResponse¶
Present only when status is SUCCEEDED. response can be empty if there is no data to be returned.
- property status: AsyncTaskStatus¶
The current state of the task.
- class AsyncTaskLink¶
Bases:
object
- __init__(task_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_task_id'].default) None ¶
Method generated by attrs for class AsyncTaskLink.
- class AsyncTaskStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- FAILED = 'FAILED'¶
- RUNNING = 'RUNNING'¶
- SUCCEEDED = 'SUCCEEDED'¶
- static of_unknown(val: str) AsyncTaskStatus ¶
- class AutoAnnotateAaSequences¶
Bases:
object
- __init__(aa_sequence_ids: List[str], feature_library_ids: List[str]) None ¶
Method generated by attrs for class AutoAnnotateAaSequences.
- class AutoAnnotateDnaSequences¶
Bases:
object
- __init__(dna_sequence_ids: List[str], feature_library_ids: List[str]) None ¶
Method generated by attrs for class AutoAnnotateDnaSequences.
- class AutoAnnotateRnaSequences¶
Bases:
object
- __init__(feature_library_ids: List[str], rna_sequence_ids: List[str]) None ¶
Method generated by attrs for class AutoAnnotateRnaSequences.
- class AutofillSequences¶
Bases:
object
- class AutomationFileInputsPaginatedList¶
Bases:
object
- __init__(automation_input_generators: Union[benchling_api_client.v2.types.Unset, List[AutomationInputGenerator]] = attr_dict['_automation_input_generators'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AutomationFileInputsPaginatedList.
- property automation_input_generators: List[AutomationInputGenerator]¶
- class AutomationInputGenerator¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, transforms: Union[benchling_api_client.v2.types.Unset, List[Optional[LabAutomationTransform]]] = attr_dict['_transforms'].default, assay_run_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_id'].default, automation_file_config: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.automation_file_automation_file_config.AutomationFileAutomationFileConfig] = attr_dict['_automation_file_config'].default, file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_file'].default, status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus] = attr_dict['_status'].default) None ¶
Method generated by attrs for class AutomationInputGenerator.
- property automation_file_config: benchling_api_client.v2.stable.models.automation_file_automation_file_config.AutomationFileAutomationFileConfig¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.automation_input_generator.T ¶
- property status: benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus¶
- property transforms: List[Optional[LabAutomationTransform]]¶
- class AutomationInputGeneratorUpdate¶
Bases:
object
- __init__(file_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_file_id'].default) None ¶
Method generated by attrs for class AutomationInputGeneratorUpdate.
- property file_id: Optional[str]¶
The ID of the file (blob) associated with the input generator. Set to null to remove an existing file from the generator.
- class AutomationOutputProcessor¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, complete_with_errors: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_complete_with_errors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, error_file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_error_file'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, progress_stats: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.automation_progress_stats.AutomationProgressStats] = attr_dict['_progress_stats'].default, transforms: Union[benchling_api_client.v2.types.Unset, List[Optional[LabAutomationTransform]]] = attr_dict['_transforms'].default, assay_run_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_id'].default, automation_file_config: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.automation_file_automation_file_config.AutomationFileAutomationFileConfig] = attr_dict['_automation_file_config'].default, file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_file'].default, status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus] = attr_dict['_status'].default) None ¶
Method generated by attrs for class AutomationOutputProcessor.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property automation_file_config: benchling_api_client.v2.stable.models.automation_file_automation_file_config.AutomationFileAutomationFileConfig¶
- property complete_with_errors: bool¶
Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, then failing rows and their errors will be saved to errorFile, and actions from successful rows will be committed.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.automation_output_processor.T ¶
- property progress_stats: benchling_api_client.v2.stable.models.automation_progress_stats.AutomationProgressStats¶
Processing progress information.
- property status: benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus¶
- property transforms: List[Optional[LabAutomationTransform]]¶
- class AutomationOutputProcessorArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of any linked Results that were archived / unarchived.
- __init__(automation_output_processor_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_automation_output_processor_ids'].default, result_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_result_ids'].default) None ¶
Method generated by attrs for class AutomationOutputProcessorArchivalChange.
- class AutomationOutputProcessorCreate¶
Bases:
object
- __init__(assay_run_id: str, automation_file_config_name: str, file_id: str, complete_with_errors: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_complete_with_errors'].default) None ¶
Method generated by attrs for class AutomationOutputProcessorCreate.
- property complete_with_errors: bool¶
Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, then failing rows and their errors will be saved to errorFile, and actions from successful rows will be committed.
- class AutomationOutputProcessorUpdate¶
Bases:
object
- class AutomationOutputProcessorsArchive¶
Bases:
object
- __init__(automation_output_processor_ids: List[str], reason: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessorsArchiveReason] = attr_dict['_reason'].default) None ¶
Method generated by attrs for class AutomationOutputProcessorsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.automation_output_processors_archive.T ¶
- property reason: AutomationOutputProcessorsArchiveReason¶
The reason that the output processors are being archived. Accepted reasons may differ based on tenant configuration.
- class AutomationOutputProcessorsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) AutomationOutputProcessorsArchiveReason ¶
- class AutomationOutputProcessorsPaginatedList¶
Bases:
object
A paginated list of automation output processors which have an attached file.
- __init__(automation_output_processors: Union[benchling_api_client.v2.types.Unset, List[AutomationOutputProcessor]] = attr_dict['_automation_output_processors'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AutomationOutputProcessorsPaginatedList.
- property automation_output_processors: List[AutomationOutputProcessor]¶
- class AutomationOutputProcessorsUnarchive¶
Bases:
object
- __init__(automation_output_processor_ids: List[str]) None ¶
Method generated by attrs for class AutomationOutputProcessorsUnarchive.
- class BadRequestError¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.bad_request_error_error.BadRequestErrorError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class BadRequestError.
- property error: benchling_api_client.v2.stable.models.bad_request_error_error.BadRequestErrorError¶
- class BadRequestErrorBulk¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, BadRequestErrorBulkError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class BadRequestErrorBulk.
- property error: BadRequestErrorBulkError¶
- class BadRequestErrorBulkError¶
Bases:
object
- __init__(errors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.bad_request_error_bulk_error_errors_item.BadRequestErrorBulkErrorErrorsItem]] = attr_dict['_errors'].default) None ¶
Method generated by attrs for class BadRequestErrorBulkError.
- property errors: List[benchling_api_client.v2.stable.models.bad_request_error_bulk_error_errors_item.BadRequestErrorBulkErrorErrorsItem]¶
- class BarcodeValidationResult¶
Bases:
object
- __init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, is_valid: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_valid'].default, message: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_message'].default) None ¶
Method generated by attrs for class BarcodeValidationResult.
- class BarcodesList¶
Bases:
object
- class BatchSchema¶
Bases:
object
- __init__(entity_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_schema_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) None ¶
Method generated by attrs for class BatchSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- class BatchSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, batch_schemas: Union[benchling_api_client.v2.types.Unset, List[BatchSchema]] = attr_dict['_batch_schemas'].default) None ¶
Method generated by attrs for class BatchSchemasPaginatedList.
- property batch_schemas: List[BatchSchema]¶
- class BenchlingApp¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app_definition: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.benchling_app_definition_summary.BenchlingAppDefinitionSummary] = attr_dict['_app_definition'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class BenchlingApp.
- property app_definition: Optional[benchling_api_client.v2.stable.models.benchling_app_definition_summary.BenchlingAppDefinitionSummary]¶
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- class BenchlingAppCreate¶
Bases:
object
- __init__(name: str, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default) None ¶
Method generated by attrs for class BenchlingAppCreate.
- class BenchlingAppUpdate¶
Bases:
object
- __init__(description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class BenchlingAppUpdate.
- class BenchlingAppsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of apps that were archived / unarchived.
- __init__(app_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_app_ids'].default) None ¶
Method generated by attrs for class BenchlingAppsArchivalChange.
- class BenchlingAppsArchive¶
Bases:
object
- __init__(app_ids: List[str], reason: BenchlingAppsArchiveReason) None ¶
Method generated by attrs for class BenchlingAppsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.benchling_apps_archive.T ¶
- property reason: BenchlingAppsArchiveReason¶
Reason that apps are being archived. Actual reason enum varies by tenant.
- class BenchlingAppsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) BenchlingAppsArchiveReason ¶
- class BenchlingAppsPaginatedList¶
Bases:
object
- __init__(apps: Union[benchling_api_client.v2.types.Unset, List[BenchlingApp]] = attr_dict['_apps'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class BenchlingAppsPaginatedList.
- property apps: List[BenchlingApp]¶
- class BenchlingAppsUnarchive¶
Bases:
object
- class Blob¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, mime_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mime_type'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.blob_type.BlobType] = attr_dict['_type'].default, upload_status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.blob_upload_status.BlobUploadStatus] = attr_dict['_upload_status'].default) None ¶
Method generated by attrs for class Blob.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob.T ¶
- property type: benchling_api_client.v2.stable.models.blob_type.BlobType¶
One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.
- property upload_status: benchling_api_client.v2.stable.models.blob_upload_status.BlobUploadStatus¶
- class BlobComplete¶
Bases:
object
- __init__(parts: Union[benchling_api_client.v2.types.Unset, List[BlobPart]] = attr_dict['_parts'].default) None ¶
Method generated by attrs for class BlobComplete.
- class BlobCreate¶
Bases:
object
- __init__(data64: str, md5: str, name: str, type: BlobCreateType, mime_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mime_type'].default) None ¶
Method generated by attrs for class BlobCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob_create.T ¶
- property md5: str¶
The MD5 hash of the blob part. Note: this should be the hash of the raw data of the blob part, not the hash of the base64 encoding.
- property type: BlobCreateType¶
One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.
- class BlobCreateType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- RAW_FILE = 'RAW_FILE'¶
- VISUALIZATION = 'VISUALIZATION'¶
- static of_unknown(val: str) BlobCreateType ¶
- class BlobMultipartCreate¶
Bases:
object
- __init__(name: str, type: BlobMultipartCreateType, mime_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mime_type'].default) None ¶
Method generated by attrs for class BlobMultipartCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob_multipart_create.T ¶
- property type: BlobMultipartCreateType¶
One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.
- class BlobMultipartCreateType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- RAW_FILE = 'RAW_FILE'¶
- VISUALIZATION = 'VISUALIZATION'¶
- static of_unknown(val: str) BlobMultipartCreateType ¶
- class BlobPart¶
Bases:
object
- __init__(e_tag: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_e_tag'].default, part_number: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_part_number'].default) None ¶
Method generated by attrs for class BlobPart.
- class BlobPartCreate¶
Bases:
object
- __init__(data64: str, md5: str, part_number: int) None ¶
Method generated by attrs for class BlobPartCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob_part_create.T ¶
- class BlobUrl¶
Bases:
object
- __init__(download_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_download_url'].default, expires_at: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_expires_at'].default) None ¶
Method generated by attrs for class BlobUrl.
- class BooleanAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, BooleanAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class BooleanAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.boolean_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: BooleanAppConfigItemType¶
- class BooleanAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- BOOLEAN = 'boolean'¶
- static of_unknown(val: str) BooleanAppConfigItemType ¶
- class Box¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, available_capacity: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_available_capacity'].default, barcode: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_barcode'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, empty_containers: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_empty_containers'].default, empty_positions: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_empty_positions'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, filled_positions: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_filled_positions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, occupied_capacity: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_occupied_capacity'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, size: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_size'].default, total_capacity: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_total_capacity'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Box.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property empty_positions: int¶
The number of empty positions for adding additional containers in the box.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.box.T ¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class BoxContentsPaginatedList¶
Bases:
object
- __init__(containers: Union[benchling_api_client.v2.types.Unset, List[ContainerWithCoordinates]] = attr_dict['_containers'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class BoxContentsPaginatedList.
- property containers: List[ContainerWithCoordinates]¶
- class BoxCreate¶
Bases:
object
- __init__(schema_id: str, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) None ¶
Method generated by attrs for class BoxCreate.
- class BoxSchema¶
Bases:
object
- __init__(container_schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.box_schema_container_schema.BoxSchemaContainerSchema] = attr_dict['_container_schema'].default, height: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_height'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.box_schema_type.BoxSchemaType] = attr_dict['_type'].default, width: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_width'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class BoxSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property container_schema: Optional[benchling_api_client.v2.stable.models.box_schema_container_schema.BoxSchemaContainerSchema]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.box_schema.T ¶
- property type: benchling_api_client.v2.stable.models.box_schema_type.BoxSchemaType¶
- class BoxSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, box_schemas: Union[benchling_api_client.v2.types.Unset, List[BoxSchema]] = attr_dict['_box_schemas'].default) None ¶
Method generated by attrs for class BoxSchemasPaginatedList.
- class BoxUpdate¶
Bases:
object
- __init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) None ¶
Method generated by attrs for class BoxUpdate.
- property barcode: str¶
Barcode of the box. The barcode must be unique within the registry and cannot be empty.
- class BoxesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of boxes along with any IDs of containers that were archived / unarchived.
- __init__(box_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_box_ids'].default, container_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_container_ids'].default) None ¶
Method generated by attrs for class BoxesArchivalChange.
- class BoxesArchive¶
Bases:
object
- __init__(box_ids: List[str], reason: BoxesArchiveReason, should_remove_barcodes: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_should_remove_barcodes'].default) None ¶
Method generated by attrs for class BoxesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.boxes_archive.T ¶
- property reason: BoxesArchiveReason¶
Reason that boxes are being archived.
- class BoxesArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) BoxesArchiveReason ¶
- class BoxesPaginatedList¶
Bases:
object
- __init__(boxes: Union[benchling_api_client.v2.types.Unset, List[Box]] = attr_dict['_boxes'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class BoxesPaginatedList.
- class BoxesUnarchive¶
Bases:
object
- class ButtonUiBlock¶
Bases:
object
- __init__(text: str, type: benchling_api_client.v2.stable.models.button_ui_block_type.ButtonUiBlockType, id: str, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class ButtonUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.button_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.button_ui_block_type.ButtonUiBlockType¶
- class ButtonUiBlockCreate¶
Bases:
object
- __init__(id: str, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.button_ui_block_type.ButtonUiBlockType] = attr_dict['_type'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class ButtonUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.button_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.button_ui_block_type.ButtonUiBlockType¶
- class ButtonUiBlockUpdate¶
Bases:
object
- __init__(id: str, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.button_ui_block_type.ButtonUiBlockType] = attr_dict['_type'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class ButtonUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.button_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.button_ui_block_type.ButtonUiBlockType¶
- class ChipUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType, value: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class ChipUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.chip_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType¶
- class ChipUiBlockCreate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_value'].default) None ¶
Method generated by attrs for class ChipUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.chip_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType¶
- class ChipUiBlockUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_value'].default) None ¶
Method generated by attrs for class ChipUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.chip_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType¶
- class ConflictError¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.conflict_error_error.ConflictErrorError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class ConflictError.
- property error: benchling_api_client.v2.stable.models.conflict_error_error.ConflictErrorError¶
- class Container¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, barcode: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_barcode'].default, checkout_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.checkout_record.CheckoutRecord] = attr_dict['_checkout_record'].default, contents: Union[benchling_api_client.v2.types.Unset, List[ContainerContent]] = attr_dict['_contents'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_storage_id'].default, parent_storage_schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_parent_storage_schema'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_quantity'].default, restricted_sample_parties: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_restricted_sample_parties'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owners: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_sample_owners'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_response.DeprecatedContainerVolumeForResponse] = attr_dict['_volume'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Container.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property checkout_record: benchling_api_client.v2.stable.models.checkout_record.CheckoutRecord¶
assignee field is set if status is “RESERVED” or “CHECKED_OUT”, or null if status is “AVAILABLE”.
comment field is set when container was last reserved, checked out, or checked into.
modifiedAt field is the date and time when container was last checked out, checked in, or reserved
- property contents: List[ContainerContent]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container.T ¶
- property parent_storage_schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property restricted_sample_parties: List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]¶
- property restriction_status: SampleRestrictionStatus¶
- property sample_owners: List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_response.DeprecatedContainerVolumeForResponse¶
- class ContainerBulkUpdateItem¶
Bases:
object
- __init__(container_id: str, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, concentration: Union[benchling_api_client.v2.types.Unset, Measurement] = attr_dict['_concentration'].default, quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_quantity'].default, volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput] = attr_dict['_volume'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, restricted_sample_party_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_restricted_sample_party_ids'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owner_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_owner_ids'].default) None ¶
Method generated by attrs for class ContainerBulkUpdateItem.
- property barcode: str¶
Barcode of the container. The barcode must be unique within the registry and cannot be empty.
- property concentration: Measurement¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container_bulk_update_item.T ¶
- property parent_storage_id: str¶
ID of containing parent inventory, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).
- property quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property restricted_sample_party_ids: List[str]¶
IDs of users or teams who have access to use a restricted container. Fixed plate wells and unrestricted containers do not have restricted sample parties.
- property restriction_status: SampleRestrictionStatus¶
- property sample_owner_ids: List[str]¶
IDs of users or teams who are sample owners for the container. Fixed plate wells do not have sample owners.
- property volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput¶
Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.
- class ContainerContent¶
Bases:
object
- __init__(batch: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.batch.Batch, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_batch'].default, concentration: Union[benchling_api_client.v2.types.Unset, Measurement] = attr_dict['_concentration'].default, entity: Union[benchling_api_client.v2.types.Unset, None, DnaSequence, AaSequence, Mixture, DnaOligo, RnaOligo, CustomEntity, benchling_api_client.v2.extensions.UnknownType, InaccessibleResource] = attr_dict['_entity'].default) None ¶
Method generated by attrs for class ContainerContent.
- property batch: Optional[Union[benchling_api_client.v2.stable.models.batch.Batch, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶
- property concentration: Measurement¶
- property entity: Optional[Union[DnaSequence, AaSequence, Mixture, DnaOligo, RnaOligo, CustomEntity, benchling_api_client.v2.extensions.UnknownType, InaccessibleResource]]¶
- class ContainerContentUpdate¶
Bases:
object
- __init__(concentration: Measurement) None ¶
Method generated by attrs for class ContainerContentUpdate.
- property concentration: Measurement¶
- class ContainerCreate¶
Bases:
object
- __init__(schema_id: str, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, restricted_sample_party_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_restricted_sample_party_ids'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owner_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_owner_ids'].default) None ¶
Method generated by attrs for class ContainerCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container_create.T ¶
- property parent_storage_id: str¶
ID of containing parent inventory, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).
- property restricted_sample_party_ids: List[str]¶
IDs of users or teams who have access to use a restricted container. Fixed plate wells and unrestricted containers do not have restricted sample parties.
- property restriction_status: SampleRestrictionStatus¶
- class ContainerSchema¶
Bases:
object
- __init__(modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_schema_type.ContainerSchemaType] = attr_dict['_type'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class ContainerSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container_schema.T ¶
- property type: benchling_api_client.v2.stable.models.container_schema_type.ContainerSchemaType¶
- class ContainerSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, container_schemas: Union[benchling_api_client.v2.types.Unset, List[ContainerSchema]] = attr_dict['_container_schemas'].default) None ¶
Method generated by attrs for class ContainerSchemasPaginatedList.
- property container_schemas: List[ContainerSchema]¶
- class ContainerTransfer¶
Bases:
object
- __init__(destination_contents: List[benchling_api_client.v2.stable.models.container_transfer_destination_contents_item.ContainerTransferDestinationContentsItem], destination_quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_destination_quantity'].default, destination_volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput] = attr_dict['_destination_volume'].default, restricted_sample_party_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_restricted_sample_party_ids'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owner_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_owner_ids'].default, source_batch_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_source_batch_id'].default, source_container_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_source_container_id'].default, source_entity_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_source_entity_id'].default, transfer_quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_transfer_quantity'].default, transfer_volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput] = attr_dict['_transfer_volume'].default) None ¶
Method generated by attrs for class ContainerTransfer.
- property destination_contents: List[benchling_api_client.v2.stable.models.container_transfer_destination_contents_item.ContainerTransferDestinationContentsItem]¶
This represents what the contents of the destination container should look like post-transfer.
- property destination_quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property destination_volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput¶
Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container_transfer.T ¶
- property restricted_sample_party_ids: List[str]¶
IDs of users or teams to be set as restricted sample parties for the destination container. If not specified, restricted sample parties from the source container, if present, will be added to those of the destination container. This only applies to stand-alone containers.
- property restriction_status: SampleRestrictionStatus¶
- property sample_owner_ids: List[str]¶
IDs of users or teams to be set as sample owners for the destination container. If not specified, restricted sample parties from the source container, if present, will be added to those of the destination container. This only applies to stand-alone containers.
- property source_batch_id: str¶
ID of the batch that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.
- property source_container_id: str¶
ID of the container that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.
- property source_entity_id: str¶
ID of the entity that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.
- property transfer_quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property transfer_volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput¶
Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.
- class ContainerUpdate¶
Bases:
object
- __init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_quantity'].default, volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput] = attr_dict['_volume'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, restricted_sample_party_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_restricted_sample_party_ids'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owner_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_owner_ids'].default) None ¶
Method generated by attrs for class ContainerUpdate.
- property barcode: str¶
Barcode of the container. The barcode must be unique within the registry and cannot be empty.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container_update.T ¶
- property parent_storage_id: str¶
ID of containing parent inventory, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).
- property quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property restricted_sample_party_ids: List[str]¶
IDs of users or teams who have access to use a restricted container. Fixed plate wells and unrestricted containers do not have restricted sample parties.
- property restriction_status: SampleRestrictionStatus¶
- property sample_owner_ids: List[str]¶
IDs of users or teams who are sample owners for the container. Fixed plate wells do not have sample owners.
- property volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput¶
Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.
- class ContainerWithCoordinates¶
Bases:
object
- __init__(grid_number: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_grid_number'].default, grid_position: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_grid_position'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, barcode: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_barcode'].default, checkout_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.checkout_record.CheckoutRecord] = attr_dict['_checkout_record'].default, contents: Union[benchling_api_client.v2.types.Unset, List[ContainerContent]] = attr_dict['_contents'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_storage_id'].default, parent_storage_schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_parent_storage_schema'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_quantity'].default, restricted_sample_parties: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_restricted_sample_parties'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owners: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_sample_owners'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_response.DeprecatedContainerVolumeForResponse] = attr_dict['_volume'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class ContainerWithCoordinates.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property checkout_record: benchling_api_client.v2.stable.models.checkout_record.CheckoutRecord¶
assignee field is set if status is “RESERVED” or “CHECKED_OUT”, or null if status is “AVAILABLE”.
comment field is set when container was last reserved, checked out, or checked into.
modifiedAt field is the date and time when container was last checked out, checked in, or reserved
- property contents: List[ContainerContent]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.container_with_coordinates.T ¶
- property parent_storage_schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property restricted_sample_parties: List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]¶
- property restriction_status: SampleRestrictionStatus¶
- property sample_owners: List[Union[benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.stable.models.team_summary.TeamSummary, benchling_api_client.v2.extensions.UnknownType]]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_response.DeprecatedContainerVolumeForResponse¶
- class ContainersArchivalChange¶
Bases:
object
IDs of all items that were unarchived, grouped by resource type. This includes the IDs of containers that were unarchived.
- __init__(container_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_container_ids'].default) None ¶
Method generated by attrs for class ContainersArchivalChange.
- class ContainersArchive¶
Bases:
object
- __init__(container_ids: List[str], reason: ContainersArchiveReason, should_remove_barcodes: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_should_remove_barcodes'].default) None ¶
Method generated by attrs for class ContainersArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.containers_archive.T ¶
- property reason: ContainersArchiveReason¶
Reason that containers are being archived.
- class ContainersArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) ContainersArchiveReason ¶
- class ContainersBulkCreateRequest¶
Bases:
object
- __init__(containers: List[ContainerCreate]) None ¶
Method generated by attrs for class ContainersBulkCreateRequest.
- property containers: List[ContainerCreate]¶
- class ContainersBulkUpdateRequest¶
Bases:
object
- __init__(containers: List[ContainerBulkUpdateItem]) None ¶
Method generated by attrs for class ContainersBulkUpdateRequest.
- property containers: List[ContainerBulkUpdateItem]¶
- class ContainersCheckin¶
Bases:
object
- __init__(container_ids: List[str], comments: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_comments'].default) None ¶
Method generated by attrs for class ContainersCheckin.
- class ContainersCheckout¶
Bases:
object
- __init__(assignee_id: str, container_ids: List[str], comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_comment'].default) None ¶
Method generated by attrs for class ContainersCheckout.
- class ContainersPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, containers: Union[benchling_api_client.v2.types.Unset, List[Container]] = attr_dict['_containers'].default) None ¶
Method generated by attrs for class ContainersPaginatedList.
- class ContainersUnarchive¶
Bases:
object
- class CustomEntitiesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of custom entities along with any IDs of batches that were archived (or unarchived).
- __init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default, custom_entity_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_custom_entity_ids'].default) None ¶
Method generated by attrs for class CustomEntitiesArchivalChange.
- class CustomEntitiesArchive¶
Bases:
object
The request body for archiving custom entities.
- __init__(custom_entity_ids: List[str], reason: EntityArchiveReason) None ¶
Method generated by attrs for class CustomEntitiesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.custom_entities_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class CustomEntitiesBulkCreateRequest¶
Bases:
object
- __init__(custom_entities: List[CustomEntityBulkCreate]) None ¶
Method generated by attrs for class CustomEntitiesBulkCreateRequest.
- property custom_entities: List[CustomEntityBulkCreate]¶
- class CustomEntitiesBulkUpdateRequest¶
Bases:
object
- __init__(custom_entities: List[CustomEntityBulkUpdate]) None ¶
Method generated by attrs for class CustomEntitiesBulkUpdateRequest.
- property custom_entities: List[CustomEntityBulkUpdate]¶
- class CustomEntitiesBulkUpsertRequest¶
Bases:
object
- __init__(custom_entities: List[benchling_api_client.v2.stable.models.custom_entity_bulk_upsert_request.CustomEntityBulkUpsertRequest]) None ¶
Method generated by attrs for class CustomEntitiesBulkUpsertRequest.
- property custom_entities: List[benchling_api_client.v2.stable.models.custom_entity_bulk_upsert_request.CustomEntityBulkUpsertRequest]¶
- class CustomEntitiesPaginatedList¶
Bases:
object
- __init__(custom_entities: Union[benchling_api_client.v2.types.Unset, List[CustomEntity]] = attr_dict['_custom_entities'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class CustomEntitiesPaginatedList.
- property custom_entities: List[CustomEntity]¶
- class CustomEntitiesUnarchive¶
Bases:
object
The request body for unarchiving custom entities.
- __init__(custom_entity_ids: List[str]) None ¶
Method generated by attrs for class CustomEntitiesUnarchive.
- class CustomEntity¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_authors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.custom_entity_creator.CustomEntityCreator] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class CustomEntity.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property authors: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
- property creator: benchling_api_client.v2.stable.models.custom_entity_creator.CustomEntityCreator¶
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.custom_entity.T ¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class CustomEntityBulkCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class CustomEntityBulkCreate.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.custom_entity_bulk_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class CustomEntityBulkUpdate¶
Bases:
object
- __init__(id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class CustomEntityBulkUpdate.
- property custom_fields: CustomFields¶
- class CustomEntityCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class CustomEntityCreate.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.custom_entity_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class CustomEntityUpdate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class CustomEntityUpdate.
- property custom_fields: CustomFields¶
- class CustomEntityUpsertRequest¶
Bases:
object
- __init__(name: str, schema_id: str, registry_id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet] = attr_dict['_archive_record'].default) None ¶
Method generated by attrs for class CustomEntityUpsertRequest.
- property archive_record: benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet¶
Currently, we only support setting a null value for archiveRecord, which unarchives the item
- property custom_fields: CustomFields¶
- property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶
- class CustomEntityWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.custom_entity_with_entity_type_entity_type.CustomEntityWithEntityTypeEntityType] = attr_dict['_entity_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_authors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.custom_entity_creator.CustomEntityCreator] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class CustomEntityWithEntityType.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property authors: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
- property creator: benchling_api_client.v2.stable.models.custom_entity_creator.CustomEntityCreator¶
- property custom_fields: CustomFields¶
- property entity_type: benchling_api_client.v2.stable.models.custom_entity_with_entity_type_entity_type.CustomEntityWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.custom_entity_with_entity_type.T ¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class CustomFields¶
Bases:
object
- class CustomNotation¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class CustomNotation.
- class CustomNotationsPaginatedList¶
Bases:
object
- __init__(custom_notations: Union[benchling_api_client.v2.types.Unset, List[CustomNotation]] = attr_dict['_custom_notations'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class CustomNotationsPaginatedList.
- property custom_notations: List[CustomNotation]¶
- class DateAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, DateAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class DateAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.date_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: DateAppConfigItemType¶
- class DateAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- DATE = 'date'¶
- static of_unknown(val: str) DateAppConfigItemType ¶
- class DatetimeAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, DatetimeAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class DatetimeAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.datetime_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: DatetimeAppConfigItemType¶
- class DatetimeAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- DATETIME = 'datetime'¶
- static of_unknown(val: str) DatetimeAppConfigItemType ¶
- class DnaAlignment¶
Bases:
object
- __init__(aligned_sequences: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aligned_sequence.AlignedSequence]] = attr_dict['_aligned_sequences'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, reference_sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_reference_sequence_id'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class DnaAlignment.
- property aligned_sequences: List[benchling_api_client.v2.stable.models.aligned_sequence.AlignedSequence]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_alignment.T ¶
- class DnaAlignmentSummary¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, reference_sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_reference_sequence_id'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class DnaAlignmentSummary.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_alignment_summary.T ¶
- class DnaAlignmentsPaginatedList¶
Bases:
object
- __init__(dna_alignments: Union[benchling_api_client.v2.types.Unset, List[DnaAlignmentSummary]] = attr_dict['_dna_alignments'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class DnaAlignmentsPaginatedList.
- property dna_alignments: List[DnaAlignmentSummary]¶
- class DnaConsensusAlignmentCreate¶
Bases:
object
- __init__(algorithm: benchling_api_client.v2.stable.models.dna_alignment_base_algorithm.DnaAlignmentBaseAlgorithm, files: List[Union[benchling_api_client.v2.stable.models.dna_alignment_base_files_item.DnaAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.dna_template_alignment_file.DnaTemplateAlignmentFile, benchling_api_client.v2.extensions.UnknownType]], new_sequence: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dna_consensus_alignment_create_new_sequence.DnaConsensusAlignmentCreateNewSequence] = attr_dict['_new_sequence'].default, sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_sequence_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class DnaConsensusAlignmentCreate.
- property algorithm: benchling_api_client.v2.stable.models.dna_alignment_base_algorithm.DnaAlignmentBaseAlgorithm¶
- property files: List[Union[benchling_api_client.v2.stable.models.dna_alignment_base_files_item.DnaAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.dna_template_alignment_file.DnaTemplateAlignmentFile, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_consensus_alignment_create.T ¶
- property new_sequence: benchling_api_client.v2.stable.models.dna_consensus_alignment_create_new_sequence.DnaConsensusAlignmentCreateNewSequence¶
- class DnaOligo¶
Bases:
object
- __init__(annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation'].default, custom_notation_name: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation_name'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, nucleotide_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.oligo_nucleotide_type.OligoNucleotideType] = attr_dict['_nucleotide_type'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class DnaOligo.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations on the Oligo.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property custom_notation: Optional[str]¶
Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.
- property custom_notation_name: Optional[str]¶
Name of the custom notation specified in the request. Null if no notation was specified.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_oligo.T ¶
- property helm: str¶
Representation of the oligo in HELM syntax, including any chemical modifications
- property nucleotide_type: benchling_api_client.v2.stable.models.oligo_nucleotide_type.OligoNucleotideType¶
Nucleotide type of the Oligo.
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class DnaOligoBulkUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class DnaOligoBulkUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations on the Oligo.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_oligo_bulk_update.T ¶
- class DnaOligoCreate¶
Bases:
object
- __init__(annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class DnaOligoCreate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations on the Oligo.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_oligo_create.T ¶
- property helm: str¶
Representation of the oligo in HELM syntax, including any chemical modifications
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class DnaOligoUpdate¶
Bases:
object
- __init__(annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class DnaOligoUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations on the Oligo.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_oligo_update.T ¶
- class DnaOligoWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dna_oligo_with_entity_type_entity_type.DnaOligoWithEntityTypeEntityType] = attr_dict['_entity_type'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation'].default, custom_notation_name: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation_name'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, nucleotide_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.oligo_nucleotide_type.OligoNucleotideType] = attr_dict['_nucleotide_type'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class DnaOligoWithEntityType.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations on the Oligo.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property custom_notation: Optional[str]¶
Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.
- property custom_notation_name: Optional[str]¶
Name of the custom notation specified in the request. Null if no notation was specified.
- property entity_type: benchling_api_client.v2.stable.models.dna_oligo_with_entity_type_entity_type.DnaOligoWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_oligo_with_entity_type.T ¶
- property helm: str¶
Representation of the oligo in HELM syntax, including any chemical modifications
- property nucleotide_type: benchling_api_client.v2.stable.models.oligo_nucleotide_type.OligoNucleotideType¶
Nucleotide type of the Oligo.
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class DnaOligosArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of DNA Oligos along with any IDs of batches that were archived / unarchived.
- __init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default, dna_oligo_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dna_oligo_ids'].default) None ¶
Method generated by attrs for class DnaOligosArchivalChange.
- class DnaOligosArchive¶
Bases:
object
The request body for archiving DNA Oligos.
- __init__(dna_oligo_ids: List[str], reason: EntityArchiveReason) None ¶
Method generated by attrs for class DnaOligosArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_oligos_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class DnaOligosBulkCreateRequest¶
Bases:
object
- __init__(dna_oligos: Union[benchling_api_client.v2.types.Unset, List[DnaOligoCreate]] = attr_dict['_dna_oligos'].default) None ¶
Method generated by attrs for class DnaOligosBulkCreateRequest.
- property dna_oligos: List[DnaOligoCreate]¶
- class DnaOligosBulkUpdateRequest¶
Bases:
object
- __init__(dna_oligos: Union[benchling_api_client.v2.types.Unset, List[DnaOligoBulkUpdate]] = attr_dict['_dna_oligos'].default) None ¶
Method generated by attrs for class DnaOligosBulkUpdateRequest.
- property dna_oligos: List[DnaOligoBulkUpdate]¶
- class DnaOligosBulkUpsertRequest¶
Bases:
object
- __init__(dna_oligos: List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]) None ¶
Method generated by attrs for class DnaOligosBulkUpsertRequest.
- property dna_oligos: List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]¶
- class DnaOligosPaginatedList¶
Bases:
object
- __init__(dna_oligos: Union[benchling_api_client.v2.types.Unset, List[DnaOligo]] = attr_dict['_dna_oligos'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class DnaOligosPaginatedList.
- class DnaOligosUnarchive¶
Bases:
object
The request body for unarchiving DNA Oligos.
- class DnaSequence¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class DnaSequence.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence.T ¶
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
- class DnaSequenceBulkCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default) None ¶
Method generated by attrs for class DnaSequenceBulkCreate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations to create on the DNA sequence.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence_bulk_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the DNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class DnaSequenceBulkUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default) None ¶
Method generated by attrs for class DnaSequenceBulkUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations to create on the DNA sequence.
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence_bulk_update.T ¶
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the DNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class DnaSequenceCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default) None ¶
Method generated by attrs for class DnaSequenceCreate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations to create on the DNA sequence.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the DNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class DnaSequenceUpdate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default) None ¶
Method generated by attrs for class DnaSequenceUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations to create on the DNA sequence.
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence_update.T ¶
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the DNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class DnaSequenceUpsertRequest¶
Bases:
object
- __init__(name: str, schema_id: str, registry_id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, archive_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet] = attr_dict['_archive_record'].default) None ¶
Method generated by attrs for class DnaSequenceUpsertRequest.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
Annotations to create on the DNA sequence.
- property archive_record: benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet¶
Currently, we only support setting a null value for archiveRecord, which unarchives the item
- property custom_fields: CustomFields¶
- property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence_upsert_request.T ¶
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the DNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class DnaSequenceWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dna_sequence_with_entity_type_entity_type.DnaSequenceWithEntityTypeEntityType] = attr_dict['_entity_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class DnaSequenceWithEntityType.
- property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property entity_type: benchling_api_client.v2.stable.models.dna_sequence_with_entity_type_entity_type.DnaSequenceWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequence_with_entity_type.T ¶
- property parts: List[benchling_api_client.v2.stable.models.dna_sequence_part.DnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
- class DnaSequencesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of DNA sequences along with any IDs of batches that were archived / unarchived.
- __init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default, dna_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dna_sequence_ids'].default) None ¶
Method generated by attrs for class DnaSequencesArchivalChange.
- class DnaSequencesArchive¶
Bases:
object
The request body for archiving DNA sequences.
- __init__(dna_sequence_ids: List[str], reason: EntityArchiveReason) None ¶
Method generated by attrs for class DnaSequencesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequences_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class DnaSequencesBulkCreateRequest¶
Bases:
object
- __init__(dna_sequences: Union[benchling_api_client.v2.types.Unset, List[DnaSequenceBulkCreate]] = attr_dict['_dna_sequences'].default) None ¶
Method generated by attrs for class DnaSequencesBulkCreateRequest.
- property dna_sequences: List[DnaSequenceBulkCreate]¶
- class DnaSequencesBulkUpdateRequest¶
Bases:
object
- __init__(dna_sequences: Union[benchling_api_client.v2.types.Unset, List[DnaSequenceBulkUpdate]] = attr_dict['_dna_sequences'].default) None ¶
Method generated by attrs for class DnaSequencesBulkUpdateRequest.
- property dna_sequences: List[DnaSequenceBulkUpdate]¶
- class DnaSequencesBulkUpsertRequest¶
Bases:
object
- __init__(dna_sequences: List[benchling_api_client.v2.stable.models.dna_sequence_bulk_upsert_request.DnaSequenceBulkUpsertRequest]) None ¶
Method generated by attrs for class DnaSequencesBulkUpsertRequest.
- property dna_sequences: List[benchling_api_client.v2.stable.models.dna_sequence_bulk_upsert_request.DnaSequenceBulkUpsertRequest]¶
- class DnaSequencesFindMatchingRegion¶
Bases:
object
- __init__(schema_id: str, target_dna_sequence_ids: List[str], registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default) None ¶
Method generated by attrs for class DnaSequencesFindMatchingRegion.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dna_sequences_find_matching_region.T ¶
- property schema_id: str¶
API ID for an Entity Schema. Restricts results to DNA Sequences of this schema type.
- class DnaSequencesPaginatedList¶
Bases:
object
- __init__(dna_sequences: Union[benchling_api_client.v2.types.Unset, List[DnaSequence]] = attr_dict['_dna_sequences'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class DnaSequencesPaginatedList.
- property dna_sequences: List[DnaSequence]¶
- class DnaSequencesUnarchive¶
Bases:
object
The request body for unarchiving DNA sequences.
- __init__(dna_sequence_ids: List[str]) None ¶
Method generated by attrs for class DnaSequencesUnarchive.
- class DnaTemplateAlignmentCreate¶
Bases:
object
- __init__(template_sequence_id: str, algorithm: benchling_api_client.v2.stable.models.dna_alignment_base_algorithm.DnaAlignmentBaseAlgorithm, files: List[Union[benchling_api_client.v2.stable.models.dna_alignment_base_files_item.DnaAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.dna_template_alignment_file.DnaTemplateAlignmentFile, benchling_api_client.v2.extensions.UnknownType]], name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class DnaTemplateAlignmentCreate.
- property algorithm: benchling_api_client.v2.stable.models.dna_alignment_base_algorithm.DnaAlignmentBaseAlgorithm¶
- property files: List[Union[benchling_api_client.v2.stable.models.dna_alignment_base_files_item.DnaAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.dna_template_alignment_file.DnaTemplateAlignmentFile, benchling_api_client.v2.extensions.UnknownType]]¶
- class Dropdown¶
Bases:
object
Dropdowns are registry-wide enums. Use dropdowns to standardize on spelling and naming conventions, especially for important metadata like resistance markers.
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, options: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dropdown_option.DropdownOption]] = attr_dict['_options'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class Dropdown.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown.T ¶
- property options: List[benchling_api_client.v2.stable.models.dropdown_option.DropdownOption]¶
Array of dropdown options
- class DropdownCreate¶
Bases:
object
- __init__(name: str, options: List[benchling_api_client.v2.stable.models.dropdown_option_create.DropdownOptionCreate], registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default) None ¶
Method generated by attrs for class DropdownCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_create.T ¶
- property options: List[benchling_api_client.v2.stable.models.dropdown_option_create.DropdownOptionCreate]¶
Options to set for the dropdown
- class DropdownMultiValueUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType, id: str, dropdown_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_dropdown_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class DropdownMultiValueUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType¶
- class DropdownMultiValueUiBlockCreate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType] = attr_dict['_type'].default, dropdown_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_dropdown_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class DropdownMultiValueUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType¶
- class DropdownMultiValueUiBlockUpdate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType] = attr_dict['_type'].default, dropdown_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_dropdown_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class DropdownMultiValueUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType¶
- class DropdownOptionsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived.
- __init__(dropdown_option_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dropdown_option_ids'].default) None ¶
Method generated by attrs for class DropdownOptionsArchivalChange.
- class DropdownOptionsArchive¶
Bases:
object
- __init__(dropdown_option_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dropdown_option_ids'].default, reason: Union[benchling_api_client.v2.types.Unset, DropdownOptionsArchiveReason] = attr_dict['_reason'].default) None ¶
Method generated by attrs for class DropdownOptionsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_options_archive.T ¶
- property reason: DropdownOptionsArchiveReason¶
Reason that dropdown options are being archived.
- class DropdownOptionsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) DropdownOptionsArchiveReason ¶
- class DropdownOptionsUnarchive¶
Bases:
object
- __init__(dropdown_option_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dropdown_option_ids'].default) None ¶
Method generated by attrs for class DropdownOptionsUnarchive.
- class DropdownSummariesPaginatedList¶
Bases:
object
- __init__(dropdowns: Union[benchling_api_client.v2.types.Unset, List[DropdownSummary]] = attr_dict['_dropdowns'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class DropdownSummariesPaginatedList.
- property dropdowns: List[DropdownSummary]¶
- class DropdownSummary¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class DropdownSummary.
- class DropdownUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType, id: str, dropdown_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_dropdown_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class DropdownUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType¶
- class DropdownUiBlockCreate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType] = attr_dict['_type'].default, dropdown_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_dropdown_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class DropdownUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType¶
- class DropdownUiBlockUpdate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType] = attr_dict['_type'].default, dropdown_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_dropdown_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class DropdownUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType¶
- class DropdownUpdate¶
Bases:
object
- __init__(options: List[benchling_api_client.v2.stable.models.dropdown_option_update.DropdownOptionUpdate]) None ¶
Method generated by attrs for class DropdownUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.dropdown_update.T ¶
- property options: List[benchling_api_client.v2.stable.models.dropdown_option_update.DropdownOptionUpdate]¶
Options to set for the dropdown
- class EntitiesBulkUpsertRequest¶
Bases:
object
- __init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aa_sequence_bulk_upsert_request.AaSequenceBulkUpsertRequest]] = attr_dict['_aa_sequences'].default, custom_entities: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.custom_entity_bulk_upsert_request.CustomEntityBulkUpsertRequest]] = attr_dict['_custom_entities'].default, dna_oligos: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]] = attr_dict['_dna_oligos'].default, dna_sequences: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.dna_sequence_bulk_upsert_request.DnaSequenceBulkUpsertRequest]] = attr_dict['_dna_sequences'].default, molecules: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.molecule_bulk_upsert_request.MoleculeBulkUpsertRequest]] = attr_dict['_molecules'].default, rna_oligos: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]] = attr_dict['_rna_oligos'].default) None ¶
Method generated by attrs for class EntitiesBulkUpsertRequest.
- property aa_sequences: List[benchling_api_client.v2.stable.models.aa_sequence_bulk_upsert_request.AaSequenceBulkUpsertRequest]¶
- property custom_entities: List[benchling_api_client.v2.stable.models.custom_entity_bulk_upsert_request.CustomEntityBulkUpsertRequest]¶
- property dna_oligos: List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]¶
- property dna_sequences: List[benchling_api_client.v2.stable.models.dna_sequence_bulk_upsert_request.DnaSequenceBulkUpsertRequest]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entities_bulk_upsert_request.T ¶
- property molecules: List[benchling_api_client.v2.stable.models.molecule_bulk_upsert_request.MoleculeBulkUpsertRequest]¶
- property rna_oligos: List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]¶
- class EntityArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) EntityArchiveReason ¶
- class EntitySchema¶
Bases:
object
- __init__(constraint: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.entity_schema_constraint.EntitySchemaConstraint] = attr_dict['_constraint'].default, containable_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.entity_schema_containable_type.EntitySchemaContainableType] = attr_dict['_containable_type'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.entity_schema_type.EntitySchemaType] = attr_dict['_type'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class EntitySchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property constraint: Optional[benchling_api_client.v2.stable.models.entity_schema_constraint.EntitySchemaConstraint]¶
- property containable_type: benchling_api_client.v2.stable.models.entity_schema_containable_type.EntitySchemaContainableType¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entity_schema.T ¶
- property type: benchling_api_client.v2.stable.models.entity_schema_type.EntitySchemaType¶
- class EntitySchemaAppConfigItem¶
Bases:
object
- __init__(subtype: Union[benchling_api_client.v2.types.Unset, SchemaDependencySubtypes] = attr_dict['_subtype'].default, type: Union[benchling_api_client.v2.types.Unset, EntitySchemaAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, linked_resource: Union[benchling_api_client.v2.types.Unset, None, LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_linked_resource'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class EntitySchemaAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entity_schema_app_config_item.T ¶
- property linked_resource: Optional[Union[LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property subtype: SchemaDependencySubtypes¶
- property type: EntitySchemaAppConfigItemType¶
- class EntitySchemaAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- ENTITY_SCHEMA = 'entity_schema'¶
- static of_unknown(val: str) EntitySchemaAppConfigItemType ¶
- class EntitySchemasPaginatedList¶
Bases:
object
- __init__(entity_schemas: Union[benchling_api_client.v2.types.Unset, List[EntitySchema]] = attr_dict['_entity_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class EntitySchemasPaginatedList.
- property entity_schemas: List[EntitySchema]¶
- class EntriesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of entries that changed..
- __init__(entry_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_entry_ids'].default) None ¶
Method generated by attrs for class EntriesArchivalChange.
- class EntriesArchive¶
Bases:
object
- __init__(entry_ids: List[str], reason: EntriesArchiveReason) None ¶
Method generated by attrs for class EntriesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entries_archive.T ¶
- property reason: EntriesArchiveReason¶
Reason that entries are being archived. One of [“Made in error”, “Retired”, “Other”].
- class EntriesArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) EntriesArchiveReason ¶
- class EntriesPaginatedList¶
Bases:
object
- __init__(entries: Union[benchling_api_client.v2.types.Unset, List[Entry]] = attr_dict['_entries'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class EntriesPaginatedList.
- class EntriesUnarchive¶
Bases:
object
- class Entry¶
Bases:
object
Entries are notes that users can take. They’re organized by “days” (which are user-configurable) and modeled within each day as a list of “notes.” Each note has a type - the simplest is a “text” type, but lists, tables, and external files are also supported.
Note: the current Entry resource has a few limitations: - Formatting information is not yet supported. Header formatting, bolding, and other stylistic information is not presented. - Data in tables is presented as text always - numeric values will need to be parsed into floats or integers, as appropriate.
Note: Data in Results tables are not accessible through this API call. Results table data can be called through the Results API calls.
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, assigned_reviewers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_assigned_reviewers'].default, authors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_authors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, days: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.entry_day.EntryDay]] = attr_dict['_days'].default, display_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_display_id'].default, entry_template_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_template_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, review_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.entry_review_record.EntryReviewRecord] = attr_dict['_review_record'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.entry_schema.EntrySchema] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Entry.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property assigned_reviewers: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
Array of users assigned to review the entry, if any.
- property authors: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
Array of UserSummary Resources of the authors of the entry. This defaults to the creator but can be manually changed.
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property days: List[benchling_api_client.v2.stable.models.entry_day.EntryDay]¶
Array of day objects. Each day object has a date field (string) and notes field (array of notes, expand further for details on note types).
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entry.T ¶
- property review_record: Optional[benchling_api_client.v2.stable.models.entry_review_record.EntryReviewRecord]¶
Review record if set
- property schema: Optional[benchling_api_client.v2.stable.models.entry_schema.EntrySchema]¶
Entry schema
- class EntryCreate¶
Bases:
object
- __init__(folder_id: str, name: str, author_ids: Union[benchling_api_client.v2.types.Unset, str, List[str], benchling_api_client.v2.extensions.UnknownType] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entry_template_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entry_template_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, initial_tables: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.initial_table.InitialTable]] = attr_dict['_initial_tables'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class EntryCreate.
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entry_create.T ¶
- property initial_tables: List[benchling_api_client.v2.stable.models.initial_table.InitialTable]¶
An array of table API IDs and blob id pairs to seed tables from the template while creating the entry. The entryTemplateId parameter must be set to use this parameter. The table API IDs should be the API Identifiers of the tables in the given template. - If a template table has one row, the values in that row act as default values for cloned entries. - If a template table has multiple rows, there is no default value and those rows are added to the cloned entry along with the provided csv data. - If a table has default values, they will be populated in any respective undefined columns in the csv data. - If a table has no default values, undefined columns from csv data will be empty. - If no csv data is provided for a table, the table in the entry will be populated with whatever values are in the respective template table.
- class EntryExternalFile¶
Bases:
object
The ExternalFile resource stores metadata about the file. The actual original file can be downloaded by using the ‘downloadURL’ property.
- __init__(download_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_download_url'].default, expires_at: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_expires_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, size: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_size'].default) None ¶
Method generated by attrs for class EntryExternalFile.
- class EntrySchemaDetailed¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.entry_schema_detailed_type.EntrySchemaDetailedType] = attr_dict['_type'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class EntrySchemaDetailed.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entry_schema_detailed.T ¶
- property type: benchling_api_client.v2.stable.models.entry_schema_detailed_type.EntrySchemaDetailedType¶
- class EntrySchemasPaginatedList¶
Bases:
object
- __init__(entry_schemas: Union[benchling_api_client.v2.types.Unset, List[EntrySchemaDetailed]] = attr_dict['_entry_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class EntrySchemasPaginatedList.
- property entry_schemas: List[EntrySchemaDetailed]¶
- class EntryTemplate¶
Bases:
object
Entry templates are templates that users can base new notebook entries off of.
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, days: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.entry_template_day.EntryTemplateDay]] = attr_dict['_days'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.entry_schema.EntrySchema] = attr_dict['_schema'].default, template_collection_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_template_collection_id'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class EntryTemplate.
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property days: List[benchling_api_client.v2.stable.models.entry_template_day.EntryTemplateDay]¶
Array of day objects. Each day object has a day index (integer) and notes field (array of notes, expand further for details on note types).
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.entry_template.T ¶
- property schema: Optional[benchling_api_client.v2.stable.models.entry_schema.EntrySchema]¶
Entry schema
- class EntryTemplateUpdate¶
Bases:
object
- __init__(fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, template_collection_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_template_collection_id'].default) None ¶
Method generated by attrs for class EntryTemplateUpdate.
- class EntryTemplatesPaginatedList¶
Bases:
object
- __init__(entry_templates: Union[benchling_api_client.v2.types.Unset, List[EntryTemplate]] = attr_dict['_entry_templates'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class EntryTemplatesPaginatedList.
- property entry_templates: List[EntryTemplate]¶
- class EntryUpdate¶
Bases:
object
- __init__(author_ids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_author_ids'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class EntryUpdate.
- class EventsPaginatedList¶
Bases:
object
- __init__(events: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.entity_registered_event.EntityRegisteredEvent, benchling_api_client.v2.stable.models.entry_created_event.EntryCreatedEvent, benchling_api_client.v2.stable.models.entry_updated_fields_event.EntryUpdatedFieldsEvent, benchling_api_client.v2.stable.models.entry_updated_review_record_event.EntryUpdatedReviewRecordEvent, benchling_api_client.v2.stable.models.stage_entry_created_event.StageEntryCreatedEvent, benchling_api_client.v2.stable.models.stage_entry_updated_fields_event.StageEntryUpdatedFieldsEvent, benchling_api_client.v2.stable.models.stage_entry_updated_review_record_event.StageEntryUpdatedReviewRecordEvent, benchling_api_client.v2.stable.models.request_created_event.RequestCreatedEvent, benchling_api_client.v2.stable.models.request_updated_fields_event.RequestUpdatedFieldsEvent, benchling_api_client.v2.stable.models.assay_run_created_event.AssayRunCreatedEvent, benchling_api_client.v2.stable.models.assay_run_updated_fields_event.AssayRunUpdatedFieldsEvent, benchling_api_client.v2.stable.models.automation_input_generator_completed_v2_beta_event.AutomationInputGeneratorCompletedV2BetaEvent, benchling_api_client.v2.stable.models.automation_output_processor_completed_v2_beta_event.AutomationOutputProcessorCompletedV2BetaEvent, benchling_api_client.v2.stable.models.automation_output_processor_uploaded_v2_beta_event.AutomationOutputProcessorUploadedV2BetaEvent, benchling_api_client.v2.stable.models.workflow_task_group_created_event.WorkflowTaskGroupCreatedEvent, benchling_api_client.v2.stable.models.workflow_task_created_event.WorkflowTaskCreatedEvent, benchling_api_client.v2.stable.models.workflow_task_updated_fields_event.WorkflowTaskUpdatedFieldsEvent, benchling_api_client.v2.stable.models.workflow_task_updated_status_event.WorkflowTaskUpdatedStatusEvent, benchling_api_client.v2.stable.models.workflow_task_updated_assignee_event.WorkflowTaskUpdatedAssigneeEvent, benchling_api_client.v2.stable.models.workflow_task_updated_scheduled_on_event.WorkflowTaskUpdatedScheduledOnEvent, benchling_api_client.v2.stable.models.workflow_task_group_updated_watchers_event.WorkflowTaskGroupUpdatedWatchersEvent, benchling_api_client.v2.stable.models.workflow_output_created_event.WorkflowOutputCreatedEvent, benchling_api_client.v2.stable.models.workflow_output_updated_fields_event.WorkflowOutputUpdatedFieldsEvent, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_events'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class EventsPaginatedList.
- property events: List[Union[benchling_api_client.v2.stable.models.entity_registered_event.EntityRegisteredEvent, benchling_api_client.v2.stable.models.entry_created_event.EntryCreatedEvent, benchling_api_client.v2.stable.models.entry_updated_fields_event.EntryUpdatedFieldsEvent, benchling_api_client.v2.stable.models.entry_updated_review_record_event.EntryUpdatedReviewRecordEvent, benchling_api_client.v2.stable.models.stage_entry_created_event.StageEntryCreatedEvent, benchling_api_client.v2.stable.models.stage_entry_updated_fields_event.StageEntryUpdatedFieldsEvent, benchling_api_client.v2.stable.models.stage_entry_updated_review_record_event.StageEntryUpdatedReviewRecordEvent, benchling_api_client.v2.stable.models.request_created_event.RequestCreatedEvent, benchling_api_client.v2.stable.models.request_updated_fields_event.RequestUpdatedFieldsEvent, benchling_api_client.v2.stable.models.assay_run_created_event.AssayRunCreatedEvent, benchling_api_client.v2.stable.models.assay_run_updated_fields_event.AssayRunUpdatedFieldsEvent, benchling_api_client.v2.stable.models.automation_input_generator_completed_v2_beta_event.AutomationInputGeneratorCompletedV2BetaEvent, benchling_api_client.v2.stable.models.automation_output_processor_completed_v2_beta_event.AutomationOutputProcessorCompletedV2BetaEvent, benchling_api_client.v2.stable.models.automation_output_processor_uploaded_v2_beta_event.AutomationOutputProcessorUploadedV2BetaEvent, benchling_api_client.v2.stable.models.workflow_task_group_created_event.WorkflowTaskGroupCreatedEvent, benchling_api_client.v2.stable.models.workflow_task_created_event.WorkflowTaskCreatedEvent, benchling_api_client.v2.stable.models.workflow_task_updated_fields_event.WorkflowTaskUpdatedFieldsEvent, benchling_api_client.v2.stable.models.workflow_task_updated_status_event.WorkflowTaskUpdatedStatusEvent, benchling_api_client.v2.stable.models.workflow_task_updated_assignee_event.WorkflowTaskUpdatedAssigneeEvent, benchling_api_client.v2.stable.models.workflow_task_updated_scheduled_on_event.WorkflowTaskUpdatedScheduledOnEvent, benchling_api_client.v2.stable.models.workflow_task_group_updated_watchers_event.WorkflowTaskGroupUpdatedWatchersEvent, benchling_api_client.v2.stable.models.workflow_output_created_event.WorkflowOutputCreatedEvent, benchling_api_client.v2.stable.models.workflow_output_updated_fields_event.WorkflowOutputUpdatedFieldsEvent, benchling_api_client.v2.extensions.UnknownType]]¶
- class ExportItemRequest¶
Bases:
object
- class Feature¶
Bases:
object
A feature from a feature library
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, match_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.feature_match_type.FeatureMatchType] = attr_dict['_match_type'].default, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, feature_library_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_library_id'].default, feature_type: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_feature_type'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pattern: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_pattern'].default) None ¶
Method generated by attrs for class Feature.
- property color: str¶
The color of the annotations generated by the feature. Must be a valid hex string
- property feature_type: Optional[str]¶
The type of feature, like gene, promoter, etc. Note: This is an arbitrary string, not an enum
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.feature.T ¶
- property match_type: benchling_api_client.v2.stable.models.feature_match_type.FeatureMatchType¶
The match type of the feature. Used to determine how auto-annotate matches are made.
- class FeatureBulkCreate¶
Bases:
object
- __init__(match_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.feature_create_match_type.FeatureCreateMatchType] = attr_dict['_match_type'].default, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, feature_library_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_library_id'].default, feature_type: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_feature_type'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pattern: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_pattern'].default) None ¶
Method generated by attrs for class FeatureBulkCreate.
- property color: str¶
The color of the annotations generated by the feature. Must be a valid hex string
- property feature_type: Optional[str]¶
The type of feature, like gene, promoter, etc. Note: This is an arbitrary string, not an enum
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.feature_bulk_create.T ¶
- property match_type: benchling_api_client.v2.stable.models.feature_create_match_type.FeatureCreateMatchType¶
The match type of the feature. Used to determine how auto-annotate matches are made.
- class FeatureCreate¶
Bases:
object
Inputs for a new feature
- __init__(match_type: benchling_api_client.v2.stable.models.feature_create_match_type.FeatureCreateMatchType, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, feature_library_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_library_id'].default, feature_type: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_feature_type'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pattern: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_pattern'].default) None ¶
Method generated by attrs for class FeatureCreate.
- property color: str¶
The color of the annotations generated by the feature. Must be a valid hex string
- property feature_type: Optional[str]¶
The type of feature, like gene, promoter, etc. Note: This is an arbitrary string, not an enum
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.feature_create.T ¶
- property match_type: benchling_api_client.v2.stable.models.feature_create_match_type.FeatureCreateMatchType¶
The match type of the feature. Used to determine how auto-annotate matches are made.
- class FeatureLibrariesPaginatedList¶
Bases:
object
A paginated list of feature libraries
- __init__(feature_libraries: Union[benchling_api_client.v2.types.Unset, List[FeatureLibrary]] = attr_dict['_feature_libraries'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class FeatureLibrariesPaginatedList.
- property feature_libraries: List[FeatureLibrary]¶
- class FeatureLibrary¶
Bases:
object
A feature library
- __init__(created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, owner: Union[benchling_api_client.v2.types.Unset, Organization, benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_owner'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class FeatureLibrary.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.feature_library.T ¶
- property owner: Union[Organization, benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.extensions.UnknownType]¶
- class FeatureLibraryCreate¶
Bases:
object
Inputs for creating a feature library
- __init__(organization_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_organization_id'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class FeatureLibraryCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.feature_library_create.T ¶
- class FeatureLibraryUpdate¶
Bases:
object
Inputs for updating a feature library
- __init__(description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class FeatureLibraryUpdate.
- class FeatureUpdate¶
Bases:
object
Inputs for updating a feature
- __init__(color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, feature_library_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_feature_library_id'].default, feature_type: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_feature_type'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pattern: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_pattern'].default) None ¶
Method generated by attrs for class FeatureUpdate.
- property color: str¶
The color of the annotations generated by the feature. Must be a valid hex string
- property feature_type: Optional[str]¶
The type of feature, like gene, promoter, etc. Note: This is an arbitrary string, not an enum
- class FeaturesBulkCreateRequest¶
Bases:
object
Inputs for bulk creating a new feature
- __init__(features: Union[benchling_api_client.v2.types.Unset, List[FeatureBulkCreate]] = attr_dict['_features'].default) None ¶
Method generated by attrs for class FeaturesBulkCreateRequest.
- property features: List[FeatureBulkCreate]¶
- class FeaturesPaginatedList¶
Bases:
object
A paginated list of features
- __init__(features: Union[benchling_api_client.v2.types.Unset, List[Feature]] = attr_dict['_features'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class FeaturesPaginatedList.
- class Field¶
Bases:
object
- __init__(value: Union[None, str, bool, float, benchling_api_client.v2.stable.models.field_value.FieldValue, List[str], benchling_api_client.v2.extensions.UnknownType], display_value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_display_value'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, text_value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_text_value'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.field_type.FieldType] = attr_dict['_type'].default, unit: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.unit_summary.UnitSummary] = attr_dict['_unit'].default) None ¶
Method generated by attrs for class Field.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.field.T ¶
- property type: benchling_api_client.v2.stable.models.field_type.FieldType¶
- property unit: Optional[benchling_api_client.v2.stable.models.unit_summary.UnitSummary]¶
- property value: Optional[Union[str, bool, float, benchling_api_client.v2.stable.models.field_value.FieldValue, List[str], benchling_api_client.v2.extensions.UnknownType]]¶
For single link fields, use the id of the item you want to link (eg. “seq_jdf8BV24”). For multi-link fields, use an array of ids of the items you want to link (eg. [“seq_jdf8BV24”])
- class FieldAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, FieldAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, linked_resource: Union[benchling_api_client.v2.types.Unset, None, LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_linked_resource'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class FieldAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.field_app_config_item.T ¶
- property linked_resource: Optional[Union[LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: FieldAppConfigItemType¶
- class FieldAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- FIELD = 'field'¶
- static of_unknown(val: str) FieldAppConfigItemType ¶
- class Fields¶
Bases:
object
- class FloatAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, FloatAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class FloatAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.float_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: FloatAppConfigItemType¶
- class FloatAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- FLOAT = 'float'¶
- static of_unknown(val: str) FloatAppConfigItemType ¶
- class Folder¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_folder_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) None ¶
Method generated by attrs for class Folder.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- class FolderCreate¶
Bases:
object
- class FoldersArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of folders along with any IDs of folder contents that were unarchived.
- __init__(aa_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aa_sequence_ids'].default, custom_entity_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_custom_entity_ids'].default, dna_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dna_sequence_ids'].default, entry_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_entry_ids'].default, folder_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_folder_ids'].default, mixture_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_mixture_ids'].default, oligo_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_oligo_ids'].default, protocol_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_protocol_ids'].default) None ¶
Method generated by attrs for class FoldersArchivalChange.
- class FoldersArchive¶
Bases:
object
- __init__(folder_ids: List[str], reason: FoldersArchiveReason) None ¶
Method generated by attrs for class FoldersArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.folders_archive.T ¶
- property reason: FoldersArchiveReason¶
The reason for archiving the provided folders. Accepted reasons may differ based on tenant configuration.
- class FoldersArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) FoldersArchiveReason ¶
- class FoldersPaginatedList¶
Bases:
object
- __init__(folders: Union[benchling_api_client.v2.types.Unset, List[Folder]] = attr_dict['_folders'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class FoldersPaginatedList.
- class FoldersUnarchive¶
Bases:
object
- class ForbiddenError¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.forbidden_error_error.ForbiddenErrorError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class ForbiddenError.
- property error: benchling_api_client.v2.stable.models.forbidden_error_error.ForbiddenErrorError¶
- class GenericApiIdentifiedAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, GenericApiIdentifiedAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, linked_resource: Union[benchling_api_client.v2.types.Unset, None, LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_linked_resource'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class GenericApiIdentifiedAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.generic_api_identified_app_config_item.T ¶
- property linked_resource: Optional[Union[LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: GenericApiIdentifiedAppConfigItemType¶
- class GenericApiIdentifiedAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- AA_SEQUENCE = 'aa_sequence'¶
- BOX = 'box'¶
- BOX_SCHEMA = 'box_schema'¶
- CONTAINER = 'container'¶
- CONTAINER_SCHEMA = 'container_schema'¶
- CUSTOM_ENTITY = 'custom_entity'¶
- DNA_OLIGO = 'dna_oligo'¶
- DNA_SEQUENCE = 'dna_sequence'¶
- DROPDOWN = 'dropdown'¶
- DROPDOWN_OPTION = 'dropdown_option'¶
- ENTRY = 'entry'¶
- ENTRY_SCHEMA = 'entry_schema'¶
- FOLDER = 'folder'¶
- LOCATION = 'location'¶
- LOCATION_SCHEMA = 'location_schema'¶
- MIXTURE = 'mixture'¶
- MOLECULE = 'molecule'¶
- PLATE = 'plate'¶
- PLATE_SCHEMA = 'plate_schema'¶
- PROJECT = 'project'¶
- REGISTRY = 'registry'¶
- REQUEST_SCHEMA = 'request_schema'¶
- RESULT_SCHEMA = 'result_schema'¶
- RNA_OLIGO = 'rna_oligo'¶
- RNA_SEQUENCE = 'rna_sequence'¶
- RUN_SCHEMA = 'run_schema'¶
- WORKFLOW_TASK_SCHEMA = 'workflow_task_schema'¶
- WORKFLOW_TASK_STATUS = 'workflow_task_status'¶
- WORKLIST = 'worklist'¶
- static of_unknown(val: str) GenericApiIdentifiedAppConfigItemType ¶
- class GetUserWarehouseLoginsResponse_200¶
Bases:
object
- __init__(warehouse_credentials: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.warehouse_credential_summary.WarehouseCredentialSummary]] = attr_dict['_warehouse_credentials'].default) None ¶
Method generated by attrs for class GetUserWarehouseLoginsResponse_200.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.get_user_warehouse_logins_response_200.T ¶
- property warehouse_credentials: List[benchling_api_client.v2.stable.models.warehouse_credential_summary.WarehouseCredentialSummary]¶
- class InaccessibleResource¶
Bases:
object
- __init__(inaccessible_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_inaccessible_id'].default, resource_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.inaccessible_resource_resource_type.InaccessibleResourceResourceType] = attr_dict['_resource_type'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) None ¶
Method generated by attrs for class InaccessibleResource.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.inaccessible_resource.T ¶
- property resource_type: benchling_api_client.v2.stable.models.inaccessible_resource_resource_type.InaccessibleResourceResourceType¶
- class IntegerAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, IntegerAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class IntegerAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.integer_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: IntegerAppConfigItemType¶
- class IntegerAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- INTEGER = 'integer'¶
- static of_unknown(val: str) IntegerAppConfigItemType ¶
- class JsonAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, JsonAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class JsonAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.json_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: JsonAppConfigItemType¶
- class JsonAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- JSON = 'json'¶
- static of_unknown(val: str) JsonAppConfigItemType ¶
- class LabAutomationTransform¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, blob_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_blob_id'].default, custom_transform_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_transform_id'].default, errors: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.lab_automation_benchling_app_errors.LabAutomationBenchlingAppErrors] = attr_dict['_errors'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, input_generator_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_input_generator_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, output_processor_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_output_processor_id'].default, status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.lab_automation_transform_status.LabAutomationTransformStatus] = attr_dict['_status'].default) None ¶
Method generated by attrs for class LabAutomationTransform.
- property errors: benchling_api_client.v2.stable.models.lab_automation_benchling_app_errors.LabAutomationBenchlingAppErrors¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.lab_automation_transform.T ¶
- property status: benchling_api_client.v2.stable.models.lab_automation_transform_status.LabAutomationTransformStatus¶
- class LabAutomationTransformUpdate¶
Bases:
object
- __init__(blob_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_blob_id'].default, errors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.lab_automation_benchling_app_error.LabAutomationBenchlingAppError]] = attr_dict['_errors'].default) None ¶
Method generated by attrs for class LabAutomationTransformUpdate.
- property errors: List[benchling_api_client.v2.stable.models.lab_automation_benchling_app_error.LabAutomationBenchlingAppError]¶
- class LabelTemplate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, zpl_template: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_zpl_template'].default) None ¶
Method generated by attrs for class LabelTemplate.
- class LinkedAppConfigResourceSummary¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class LinkedAppConfigResourceSummary.
- class ListAASequencesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListAASequencesSort ¶
- class ListAppCanvasesEnabled¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- FALSE = 'false'¶
- TRUE = 'true'¶
- static of_unknown(val: str) ListAppCanvasesEnabled ¶
- class ListAppCanvasesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- static of_unknown(val: str) ListAppCanvasesSort ¶
- class ListAppConfigurationItemsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- static of_unknown(val: str) ListAppConfigurationItemsSort ¶
- class ListAppSessionsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- static of_unknown(val: str) ListAppSessionsSort ¶
- class ListAssayResultsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- static of_unknown(val: str) ListAssayResultsSort ¶
- class ListBenchlingAppsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListBenchlingAppsSort ¶
- class ListBoxesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- BARCODE = 'barcode'¶
- BARCODEASC = 'barcode:asc'¶
- BARCODEDESC = 'barcode:desc'¶
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListBoxesSort ¶
- class ListContainersCheckoutStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- AVAILABLE = 'AVAILABLE'¶
- CHECKED_OUT = 'CHECKED_OUT'¶
- RESERVED = 'RESERVED'¶
- static of_unknown(val: str) ListContainersCheckoutStatus ¶
- class ListContainersSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- BARCODE = 'barcode'¶
- BARCODEASC = 'barcode:asc'¶
- BARCODEDESC = 'barcode:desc'¶
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListContainersSort ¶
- class ListCustomEntitiesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListCustomEntitiesSort ¶
- class ListDNAAlignmentsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListDNAAlignmentsSort ¶
- class ListDNAOligosSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListDNAOligosSort ¶
- class ListDNASequencesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListDNASequencesSort ¶
- class ListEntriesReviewStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- ACCEPTED = 'ACCEPTED'¶
- IN_PROGRESS = 'IN_PROGRESS'¶
- NEEDS_REVIEW = 'NEEDS_REVIEW'¶
- REJECTED = 'REJECTED'¶
- RETRACTED = 'RETRACTED'¶
- static of_unknown(val: str) ListEntriesReviewStatus ¶
- class ListEntriesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListEntriesSort ¶
- class ListFeatureLibrariesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListFeatureLibrariesSort ¶
- class ListFeaturesMatchType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- NUCLEOTIDE = 'nucleotide'¶
- PROTEIN = 'protein'¶
- static of_unknown(val: str) ListFeaturesMatchType ¶
- class ListFoldersSection¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- INVENTORY = 'INVENTORY'¶
- NOTEBOOK = 'NOTEBOOK'¶
- static of_unknown(val: str) ListFoldersSection ¶
- class ListFoldersSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListFoldersSort ¶
- class ListLocationsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- BARCODE = 'barcode'¶
- BARCODEASC = 'barcode:asc'¶
- BARCODEDESC = 'barcode:desc'¶
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListLocationsSort ¶
- class ListMixturesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListMixturesSort ¶
- class ListMoleculesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListMoleculesSort ¶
- class ListNucleotideAlignmentsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListNucleotideAlignmentsSort ¶
- class ListOligosSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListOligosSort ¶
- class ListOrganizationsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListOrganizationsSort ¶
- class ListPlatesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- BARCODE = 'barcode'¶
- BARCODEASC = 'barcode:asc'¶
- BARCODEDESC = 'barcode:desc'¶
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListPlatesSort ¶
- class ListProjectsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListProjectsSort ¶
- class ListRNAOligosSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListRNAOligosSort ¶
- class ListRNASequencesSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListRNASequencesSort ¶
- class ListTeamsSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListTeamsSort ¶
- class ListUsersSort¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CREATEDAT = 'createdAt'¶
- CREATEDATASC = 'createdAt:asc'¶
- CREATEDATDESC = 'createdAt:desc'¶
- MODIFIEDAT = 'modifiedAt'¶
- MODIFIEDATASC = 'modifiedAt:asc'¶
- MODIFIEDATDESC = 'modifiedAt:desc'¶
- NAME = 'name'¶
- NAMEASC = 'name:asc'¶
- NAMEDESC = 'name:desc'¶
- static of_unknown(val: str) ListUsersSort ¶
- class ListWorkflowTasksScheduledOn¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- NULL = 'null'¶
- static of_unknown(val: str) ListWorkflowTasksScheduledOn ¶
- class Location¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, available_capacity: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_available_capacity'].default, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, occupied_capacity: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_occupied_capacity'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_storage_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, total_capacity: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_total_capacity'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Location.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property available_capacity: Optional[int]¶
The number of available positions in this location. Null if totalCapacity is not set.
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.location.T ¶
- property occupied_capacity: Optional[int]¶
The number of plates, boxes, and containers currently in this location. Null if totalCapacity is not set.
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class LocationCreate¶
Bases:
object
- __init__(name: str, schema_id: str, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default) None ¶
Method generated by attrs for class LocationCreate.
- class LocationSchema¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.location_schema_type.LocationSchemaType] = attr_dict['_type'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class LocationSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.location_schema.T ¶
- property type: benchling_api_client.v2.stable.models.location_schema_type.LocationSchemaType¶
- class LocationSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, location_schemas: Union[benchling_api_client.v2.types.Unset, List[LocationSchema]] = attr_dict['_location_schemas'].default) None ¶
Method generated by attrs for class LocationSchemasPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.location_schemas_paginated_list.T ¶
- property location_schemas: List[LocationSchema]¶
- class LocationUpdate¶
Bases:
object
- __init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default) None ¶
Method generated by attrs for class LocationUpdate.
- property barcode: str¶
Barcode of the location. The barcode must be unique within the registry and cannot be empty.
- class LocationsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of locations along with any IDs of locations, boxes, plates, containers that were archived.
- __init__(box_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_box_ids'].default, container_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_container_ids'].default, location_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_location_ids'].default, plate_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_plate_ids'].default) None ¶
Method generated by attrs for class LocationsArchivalChange.
- class LocationsArchive¶
Bases:
object
- __init__(location_ids: List[str], reason: LocationsArchiveReason, should_remove_barcodes: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_should_remove_barcodes'].default) None ¶
Method generated by attrs for class LocationsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.locations_archive.T ¶
- property reason: LocationsArchiveReason¶
Reason that locations are being archived.
- class LocationsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) LocationsArchiveReason ¶
- class LocationsPaginatedList¶
Bases:
object
- __init__(locations: Union[benchling_api_client.v2.types.Unset, List[Location]] = attr_dict['_locations'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class LocationsPaginatedList.
- class LocationsUnarchive¶
Bases:
object
- class MarkdownUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType, value: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class MarkdownUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.markdown_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType¶
- class MarkdownUiBlockCreate¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType, value: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class MarkdownUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.markdown_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType¶
- class MarkdownUiBlockUpdate¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType, value: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class MarkdownUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.markdown_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType¶
- class MatchBasesRequest¶
Bases:
object
- __init__(bases: str, archive_reason: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.match_bases_request_archive_reason.MatchBasesRequestArchiveReason] = attr_dict['_archive_reason'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, page_size: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_page_size'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, sort: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.match_bases_request_sort.MatchBasesRequestSort] = attr_dict['_sort'].default) None ¶
Method generated by attrs for class MatchBasesRequest.
- property archive_reason: benchling_api_client.v2.stable.models.match_bases_request_archive_reason.MatchBasesRequestArchiveReason¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.match_bases_request.T ¶
- property registry_id: Optional[str]¶
ID of a registry. Restricts results to those registered in this registry. Specifying null returns unregistered items.
- property sort: benchling_api_client.v2.stable.models.match_bases_request_sort.MatchBasesRequestSort¶
- class Measurement¶
Bases:
object
- __init__(units: Optional[str], value: Optional[float]) None ¶
Method generated by attrs for class Measurement.
- class Mixture¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, allow_measured_ingredients: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_allow_measured_ingredients'].default, amount: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amount'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_authors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_creator.MixtureCreator] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, ingredients: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.ingredient.Ingredient]] = attr_dict['_ingredients'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, units: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits] = attr_dict['_units'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Mixture.
- property amount: str¶
The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property authors: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
- property creator: benchling_api_client.v2.stable.models.mixture_creator.MixtureCreator¶
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixture.T ¶
- property ingredients: List[benchling_api_client.v2.stable.models.ingredient.Ingredient]¶
List of ingredients on this mixture.
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶
- property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶
- class MixtureBulkUpdate¶
Bases:
object
- __init__(id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amount: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amount'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, ingredients: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.ingredient_write_params.IngredientWriteParams]] = attr_dict['_ingredients'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, units: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits] = attr_dict['_units'].default) None ¶
Method generated by attrs for class MixtureBulkUpdate.
- property amount: str¶
The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixture_bulk_update.T ¶
- property ingredients: List[benchling_api_client.v2.stable.models.ingredient_write_params.IngredientWriteParams]¶
Desired final state for the ingredients on this mixture. Each ingredient you specify will be matched with the existing ingredients on the mixture based on the component entity, and Benchling will create, update, or delete this mixture’s ingredients so that the final state of this mixture’s ingredients matches your request. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.
- property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶
- class MixtureCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amount: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amount'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, ingredients: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.ingredient_write_params.IngredientWriteParams]] = attr_dict['_ingredients'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, units: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits] = attr_dict['_units'].default) None ¶
Method generated by attrs for class MixtureCreate.
- property amount: str¶
The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixture_create.T ¶
- property ingredients: List[benchling_api_client.v2.stable.models.ingredient_write_params.IngredientWriteParams]¶
Desired final state for the ingredients on this mixture. Each ingredient you specify will be matched with the existing ingredients on the mixture based on the component entity, and Benchling will create, update, or delete this mixture’s ingredients so that the final state of this mixture’s ingredients matches your request. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶
- class MixtureUpdate¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amount: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amount'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, ingredients: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.ingredient_write_params.IngredientWriteParams]] = attr_dict['_ingredients'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, units: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits] = attr_dict['_units'].default) None ¶
Method generated by attrs for class MixtureUpdate.
- property amount: str¶
The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixture_update.T ¶
- property ingredients: List[benchling_api_client.v2.stable.models.ingredient_write_params.IngredientWriteParams]¶
Desired final state for the ingredients on this mixture. Each ingredient you specify will be matched with the existing ingredients on the mixture based on the component entity, and Benchling will create, update, or delete this mixture’s ingredients so that the final state of this mixture’s ingredients matches your request. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.
- property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶
- class MixtureWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_with_entity_type_entity_type.MixtureWithEntityTypeEntityType] = attr_dict['_entity_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, allow_measured_ingredients: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_allow_measured_ingredients'].default, amount: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amount'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_authors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_creator.MixtureCreator] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, ingredients: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.ingredient.Ingredient]] = attr_dict['_ingredients'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, units: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits] = attr_dict['_units'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class MixtureWithEntityType.
- property amount: str¶
The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property authors: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
- property creator: benchling_api_client.v2.stable.models.mixture_creator.MixtureCreator¶
- property custom_fields: CustomFields¶
- property entity_type: benchling_api_client.v2.stable.models.mixture_with_entity_type_entity_type.MixtureWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixture_with_entity_type.T ¶
- property ingredients: List[benchling_api_client.v2.stable.models.ingredient.Ingredient]¶
List of ingredients on this mixture.
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶
- property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶
- class MixturesArchivalChange¶
Bases:
object
IDs of all mixtures that were archived or unarchived.
- __init__(mixture_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_mixture_ids'].default) None ¶
Method generated by attrs for class MixturesArchivalChange.
- class MixturesArchive¶
Bases:
object
The request body for archiving mixtures.
- __init__(mixture_ids: List[str], reason: EntityArchiveReason) None ¶
Method generated by attrs for class MixturesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixtures_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class MixturesBulkCreateRequest¶
Bases:
object
- __init__(mixtures: List[MixtureCreate]) None ¶
Method generated by attrs for class MixturesBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixtures_bulk_create_request.T ¶
- property mixtures: List[MixtureCreate]¶
- class MixturesBulkUpdateRequest¶
Bases:
object
- __init__(mixtures: Union[benchling_api_client.v2.types.Unset, List[MixtureBulkUpdate]] = attr_dict['_mixtures'].default) None ¶
Method generated by attrs for class MixturesBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.mixtures_bulk_update_request.T ¶
- property mixtures: List[MixtureBulkUpdate]¶
- class MixturesPaginatedList¶
Bases:
object
- __init__(mixtures: Union[benchling_api_client.v2.types.Unset, List[Mixture]] = attr_dict['_mixtures'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class MixturesPaginatedList.
- class MixturesUnarchive¶
Bases:
object
The request body for unarchiving mixtures.
- class Molecule¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, canonicalized_smiles: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_canonicalized_smiles'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, original_smiles: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_original_smiles'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Molecule.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.molecule.T ¶
- property original_smiles: Optional[str]¶
The original chemical structure supplied by the user in SMILES format. Null if the user did not originally supply SMILES.
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class MoleculeBulkUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, chemical_structure: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure] = attr_dict['_chemical_structure'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class MoleculeBulkUpdate.
- property chemical_structure: benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure¶
- property custom_fields: CustomFields¶
- class MoleculeCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, chemical_structure: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure] = attr_dict['_chemical_structure'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class MoleculeCreate.
- property chemical_structure: benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure¶
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.molecule_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class MoleculeUpdate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, chemical_structure: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure] = attr_dict['_chemical_structure'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class MoleculeUpdate.
- property chemical_structure: benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure¶
- property custom_fields: CustomFields¶
- class MoleculeUpsertRequest¶
Bases:
object
- __init__(name: str, schema_id: str, registry_id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, chemical_structure: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure] = attr_dict['_chemical_structure'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet] = attr_dict['_archive_record'].default) None ¶
Method generated by attrs for class MoleculeUpsertRequest.
- property archive_record: benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet¶
Currently, we only support setting a null value for archiveRecord, which unarchives the item
- property chemical_structure: benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure¶
- property custom_fields: CustomFields¶
- property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶
- class MoleculesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of Molecules along with any IDs of batches that were archived / unarchived.
- __init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default, molecule_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_molecule_ids'].default) None ¶
Method generated by attrs for class MoleculesArchivalChange.
- class MoleculesArchive¶
Bases:
object
The request body for archiving Molecules.
- __init__(molecule_ids: List[str], reason: MoleculesArchiveReason) None ¶
Method generated by attrs for class MoleculesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.molecules_archive.T ¶
- property reason: MoleculesArchiveReason¶
The reason for archiving the provided Molecules. Accepted reasons may differ based on tenant configuration.
- class MoleculesArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) MoleculesArchiveReason ¶
- class MoleculesBulkCreateRequest¶
Bases:
object
- __init__(molecules: Union[benchling_api_client.v2.types.Unset, List[MoleculeCreate]] = attr_dict['_molecules'].default) None ¶
Method generated by attrs for class MoleculesBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.molecules_bulk_create_request.T ¶
- property molecules: List[MoleculeCreate]¶
- class MoleculesBulkUpdateRequest¶
Bases:
object
- __init__(molecules: Union[benchling_api_client.v2.types.Unset, List[MoleculeBulkUpdate]] = attr_dict['_molecules'].default) None ¶
Method generated by attrs for class MoleculesBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.molecules_bulk_update_request.T ¶
- property molecules: List[MoleculeBulkUpdate]¶
- class MoleculesBulkUpsertRequest¶
Bases:
object
- __init__(molecules: List[benchling_api_client.v2.stable.models.molecule_bulk_upsert_request.MoleculeBulkUpsertRequest]) None ¶
Method generated by attrs for class MoleculesBulkUpsertRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.molecules_bulk_upsert_request.T ¶
- property molecules: List[benchling_api_client.v2.stable.models.molecule_bulk_upsert_request.MoleculeBulkUpsertRequest]¶
- class MoleculesPaginatedList¶
Bases:
object
- __init__(molecules: Union[benchling_api_client.v2.types.Unset, List[Molecule]] = attr_dict['_molecules'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class MoleculesPaginatedList.
- class MoleculesUnarchive¶
Bases:
object
The request body for unarchiving Molecules.
- class MultipleContainersTransfer¶
Bases:
object
- __init__(destination_container_id: str, final_quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_final_quantity'].default, final_volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput] = attr_dict['_final_volume'].default, source_concentration: Union[benchling_api_client.v2.types.Unset, Measurement] = attr_dict['_source_concentration'].default, restricted_sample_party_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_restricted_sample_party_ids'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owner_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_owner_ids'].default, source_batch_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_source_batch_id'].default, source_container_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_source_container_id'].default, source_entity_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_source_entity_id'].default, transfer_quantity: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity] = attr_dict['_transfer_quantity'].default, transfer_volume: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput] = attr_dict['_transfer_volume'].default) None ¶
Method generated by attrs for class MultipleContainersTransfer.
- property final_quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property final_volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput¶
Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.multiple_containers_transfer.T ¶
- property restricted_sample_party_ids: List[str]¶
IDs of users or teams to be set as restricted sample parties for the destination container. If not specified, restricted sample parties from the source container, if present, will be added to those of the destination container. This only applies to stand-alone containers.
- property restriction_status: SampleRestrictionStatus¶
- property sample_owner_ids: List[str]¶
IDs of users or teams to be set as sample owners for the destination container. If not specified, restricted sample parties from the source container, if present, will be added to those of the destination container. This only applies to stand-alone containers.
- property source_batch_id: str¶
ID of the batch that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.
- property source_concentration: Measurement¶
- property source_container_id: str¶
ID of the container that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.
- property source_entity_id: str¶
ID of the entity that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.
- property transfer_quantity: benchling_api_client.v2.stable.models.container_quantity.ContainerQuantity¶
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
- property transfer_volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_input.DeprecatedContainerVolumeForInput¶
Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.
- class MultipleContainersTransfersList¶
Bases:
object
- __init__(transfers: List[MultipleContainersTransfer]) None ¶
Method generated by attrs for class MultipleContainersTransfersList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.multiple_containers_transfers_list.T ¶
- property transfers: List[MultipleContainersTransfer]¶
- class NamingStrategy¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- DELETE_NAMES = 'DELETE_NAMES'¶
- IDS_FROM_NAMES = 'IDS_FROM_NAMES'¶
- KEEP_NAMES = 'KEEP_NAMES'¶
- NEW_IDS = 'NEW_IDS'¶
- REPLACE_ID_AND_NAME_FROM_PARTS = 'REPLACE_ID_AND_NAME_FROM_PARTS'¶
- REPLACE_NAMES_FROM_PARTS = 'REPLACE_NAMES_FROM_PARTS'¶
- SET_FROM_NAME_PARTS = 'SET_FROM_NAME_PARTS'¶
- static of_unknown(val: str) NamingStrategy ¶
- class NotFoundError¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.not_found_error_error.NotFoundErrorError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class NotFoundError.
- property error: benchling_api_client.v2.stable.models.not_found_error_error.NotFoundErrorError¶
- class NucleotideAlignment¶
Bases:
object
- __init__(aligned_sequences: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.aligned_nucleotide_sequence.AlignedNucleotideSequence]] = attr_dict['_aligned_sequences'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, reference_sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_reference_sequence_id'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class NucleotideAlignment.
- property aligned_sequences: List[benchling_api_client.v2.stable.models.aligned_nucleotide_sequence.AlignedNucleotideSequence]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.nucleotide_alignment.T ¶
- class NucleotideAlignmentSummary¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, reference_sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_reference_sequence_id'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class NucleotideAlignmentSummary.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.nucleotide_alignment_summary.T ¶
- class NucleotideAlignmentsPaginatedList¶
Bases:
object
- __init__(alignments: Union[benchling_api_client.v2.types.Unset, List[NucleotideAlignmentSummary]] = attr_dict['_alignments'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class NucleotideAlignmentsPaginatedList.
- property alignments: List[NucleotideAlignmentSummary]¶
- class NucleotideConsensusAlignmentCreate¶
Bases:
object
- __init__(algorithm: benchling_api_client.v2.stable.models.nucleotide_alignment_base_algorithm.NucleotideAlignmentBaseAlgorithm, files: List[Union[benchling_api_client.v2.stable.models.nucleotide_alignment_base_files_item.NucleotideAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.nucleotide_alignment_file.NucleotideAlignmentFile, benchling_api_client.v2.extensions.UnknownType]], new_sequence: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.nucleotide_consensus_alignment_create_new_sequence.NucleotideConsensusAlignmentCreateNewSequence] = attr_dict['_new_sequence'].default, sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_sequence_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class NucleotideConsensusAlignmentCreate.
- property algorithm: benchling_api_client.v2.stable.models.nucleotide_alignment_base_algorithm.NucleotideAlignmentBaseAlgorithm¶
- property files: List[Union[benchling_api_client.v2.stable.models.nucleotide_alignment_base_files_item.NucleotideAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.nucleotide_alignment_file.NucleotideAlignmentFile, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.nucleotide_consensus_alignment_create.T ¶
- property new_sequence: benchling_api_client.v2.stable.models.nucleotide_consensus_alignment_create_new_sequence.NucleotideConsensusAlignmentCreateNewSequence¶
- class NucleotideTemplateAlignmentCreate¶
Bases:
object
- __init__(template_sequence_id: str, algorithm: benchling_api_client.v2.stable.models.nucleotide_alignment_base_algorithm.NucleotideAlignmentBaseAlgorithm, files: List[Union[benchling_api_client.v2.stable.models.nucleotide_alignment_base_files_item.NucleotideAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.nucleotide_alignment_file.NucleotideAlignmentFile, benchling_api_client.v2.extensions.UnknownType]], name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class NucleotideTemplateAlignmentCreate.
- property algorithm: benchling_api_client.v2.stable.models.nucleotide_alignment_base_algorithm.NucleotideAlignmentBaseAlgorithm¶
- property files: List[Union[benchling_api_client.v2.stable.models.nucleotide_alignment_base_files_item.NucleotideAlignmentBaseFilesItem, benchling_api_client.v2.stable.models.nucleotide_alignment_file.NucleotideAlignmentFile, benchling_api_client.v2.extensions.UnknownType]]¶
- class OligoCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class OligoCreate.
- property custom_fields: CustomFields¶
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.oligo_create.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class OligoUpdate¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class OligoUpdate.
- property custom_fields: CustomFields¶
- class OligoUpsertRequest¶
Bases:
object
- __init__(name: str, schema_id: str, registry_id: str, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet] = attr_dict['_archive_record'].default) None ¶
Method generated by attrs for class OligoUpsertRequest.
- property archive_record: benchling_api_client.v2.stable.models.archive_record_set.ArchiveRecordSet¶
Currently, we only support setting a null value for archiveRecord, which unarchives the item
- property custom_fields: CustomFields¶
- property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶
- class OligosArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of Oligos along with any IDs of batches that were archived / unarchived.
- __init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default, oligo_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_oligo_ids'].default) None ¶
Method generated by attrs for class OligosArchivalChange.
- class OligosArchive¶
Bases:
object
The request body for archiving Oligos.
- __init__(oligo_ids: List[str], reason: EntityArchiveReason) None ¶
Method generated by attrs for class OligosArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.oligos_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class OligosBulkCreateRequest¶
Bases:
object
- __init__(oligos: Union[benchling_api_client.v2.types.Unset, List[OligoCreate]] = attr_dict['_oligos'].default) None ¶
Method generated by attrs for class OligosBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.oligos_bulk_create_request.T ¶
- property oligos: List[OligoCreate]¶
- class OligosPaginatedList¶
Bases:
object
- __init__(oligos: Union[benchling_api_client.v2.types.Unset, List[Union[DnaOligo, RnaOligo, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_oligos'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class OligosPaginatedList.
- class OligosUnarchive¶
Bases:
object
The request body for unarchiving Oligos.
- class Organization¶
Bases:
object
- __init__(handle: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_handle'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class Organization.
- class OrganizationsPaginatedList¶
Bases:
object
- __init__(organizations: Union[benchling_api_client.v2.types.Unset, List[Organization]] = attr_dict['_organizations'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class OrganizationsPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.organizations_paginated_list.T ¶
- property organizations: List[Organization]¶
- class Plate¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, available_capacity: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_available_capacity'].default, barcode: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_barcode'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, occupied_capacity: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_occupied_capacity'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, total_capacity: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_total_capacity'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.plate_type.PlateType] = attr_dict['_type'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, wells: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.plate_wells.PlateWells] = attr_dict['_wells'].default) None ¶
Method generated by attrs for class Plate.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property available_capacity: Optional[int]¶
The number of available positions in a matrix plate. Null for well plates.
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.plate.T ¶
- property occupied_capacity: Optional[int]¶
The number of containers currently in a matrix plate. Null for well plates.
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property total_capacity: Optional[int]¶
The total capacity of a matrix plate (i.e. how many containers it can store). Null for well plates.
- property type: benchling_api_client.v2.stable.models.plate_type.PlateType¶
- property wells: benchling_api_client.v2.stable.models.plate_wells.PlateWells¶
Well contents of the plate, keyed by position string (eg. “A1”).
- class PlateCreate¶
Bases:
object
- __init__(schema_id: str, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, container_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_container_schema_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, wells: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.plate_create_wells.PlateCreateWells] = attr_dict['_wells'].default) None ¶
Method generated by attrs for class PlateCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.plate_create.T ¶
- property wells: benchling_api_client.v2.stable.models.plate_create_wells.PlateCreateWells¶
- class PlateSchema¶
Bases:
object
- __init__(container_schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.plate_schema_container_schema.PlateSchemaContainerSchema] = attr_dict['_container_schema'].default, height: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_height'].default, plate_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_plate_type'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.plate_schema_type.PlateSchemaType] = attr_dict['_type'].default, width: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_width'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class PlateSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property container_schema: Optional[benchling_api_client.v2.stable.models.plate_schema_container_schema.PlateSchemaContainerSchema]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.plate_schema.T ¶
- property type: benchling_api_client.v2.stable.models.plate_schema_type.PlateSchemaType¶
- class PlateSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, plate_schemas: Union[benchling_api_client.v2.types.Unset, List[PlateSchema]] = attr_dict['_plate_schemas'].default) None ¶
Method generated by attrs for class PlateSchemasPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.plate_schemas_paginated_list.T ¶
- property plate_schemas: List[PlateSchema]¶
- class PlateUpdate¶
Bases:
object
- __init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) None ¶
Method generated by attrs for class PlateUpdate.
- property barcode: str¶
Barcode of the plate. The barcode must be unique within the registry and cannot be empty.
- class PlatesArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of plates along with any IDs of containers that were archived / unarchived.
- __init__(container_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_container_ids'].default, plate_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_plate_ids'].default) None ¶
Method generated by attrs for class PlatesArchivalChange.
- class PlatesArchive¶
Bases:
object
- __init__(plate_ids: List[str], reason: PlatesArchiveReason, should_remove_barcodes: bool) None ¶
Method generated by attrs for class PlatesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.plates_archive.T ¶
- property reason: PlatesArchiveReason¶
Reason that plates are being archived.
- class PlatesArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) PlatesArchiveReason ¶
- class PlatesPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, plates: Union[benchling_api_client.v2.types.Unset, List[Plate]] = attr_dict['_plates'].default) None ¶
Method generated by attrs for class PlatesPaginatedList.
- class PlatesUnarchive¶
Bases:
object
- class PrintLabels¶
Bases:
object
- __init__(container_ids: List[str], label_template_id: str, printer_id: str) None ¶
Method generated by attrs for class PrintLabels.
- property container_ids: List[str]¶
List of IDs of containers that will have labels printed (one label will be printed per container).
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.print_labels.T ¶
- class Printer¶
Bases:
object
- __init__(address: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_address'].default, description: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_description'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, port: Union[benchling_api_client.v2.types.Unset, None, int] = attr_dict['_port'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default) None ¶
Method generated by attrs for class Printer.
- class Project¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, owner: Union[benchling_api_client.v2.types.Unset, Organization, benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_owner'].default) None ¶
Method generated by attrs for class Project.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.project.T ¶
- property owner: Union[Organization, benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.extensions.UnknownType]¶
- class ProjectsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of projects along with any IDs of project contents that were unarchived.
- __init__(aa_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aa_sequence_ids'].default, custom_entity_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_custom_entity_ids'].default, dna_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_dna_sequence_ids'].default, entry_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_entry_ids'].default, folder_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_folder_ids'].default, mixture_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_mixture_ids'].default, oligo_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_oligo_ids'].default, project_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_project_ids'].default, protocol_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_protocol_ids'].default) None ¶
Method generated by attrs for class ProjectsArchivalChange.
- class ProjectsArchive¶
Bases:
object
- __init__(project_ids: List[str], reason: ProjectsArchiveReason) None ¶
Method generated by attrs for class ProjectsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.projects_archive.T ¶
- property reason: ProjectsArchiveReason¶
The reason for archiving the provided projects. Accepted reasons may differ based on tenant configuration.
- class ProjectsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) ProjectsArchiveReason ¶
- class ProjectsPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, projects: Union[benchling_api_client.v2.types.Unset, List[Project]] = attr_dict['_projects'].default) None ¶
Method generated by attrs for class ProjectsPaginatedList.
- class ProjectsUnarchive¶
Bases:
object
- class RegisterEntities¶
Bases:
object
- __init__(entity_ids: List[str], naming_strategy: NamingStrategy) None ¶
Method generated by attrs for class RegisterEntities.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.register_entities.T ¶
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- class Registry¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, owner: Union[benchling_api_client.v2.types.Unset, Organization] = attr_dict['_owner'].default) None ¶
Method generated by attrs for class Registry.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.registry.T ¶
- property owner: Organization¶
- class Request¶
Bases:
object
- __init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, assignees: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.request_user_assignee.RequestUserAssignee, benchling_api_client.v2.stable.models.request_team_assignee.RequestTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_assignees'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_creator.RequestCreator] = attr_dict['_creator'].default, display_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_display_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, request_status: Union[benchling_api_client.v2.types.Unset, RequestStatus] = attr_dict['_request_status'].default, requestor: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_requestor.RequestRequestor] = attr_dict['_requestor'].default, sample_groups: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_sample_group.RequestSampleGroup]] = attr_dict['_sample_groups'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, None, date] = attr_dict['_scheduled_on'].default, schema: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_schema_property.RequestSchemaProperty] = attr_dict['_schema'].default, tasks: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_task.RequestTask]] = attr_dict['_tasks'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Request.
- property assignees: List[Union[benchling_api_client.v2.stable.models.request_user_assignee.RequestUserAssignee, benchling_api_client.v2.stable.models.request_team_assignee.RequestTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]¶
Array of assignees
- property creator: benchling_api_client.v2.stable.models.request_creator.RequestCreator¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request.T ¶
- property request_status: RequestStatus¶
- property requestor: benchling_api_client.v2.stable.models.request_requestor.RequestRequestor¶
- property sample_groups: List[benchling_api_client.v2.stable.models.request_sample_group.RequestSampleGroup]¶
- property scheduled_on: Optional[date]¶
Date the request is scheduled to be executed on, in YYYY-MM-DD format.
- property schema: benchling_api_client.v2.stable.models.request_schema_property.RequestSchemaProperty¶
- property tasks: List[benchling_api_client.v2.stable.models.request_task.RequestTask]¶
- class RequestCreate¶
Bases:
object
- __init__(schema_id: str, assignees: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.request_write_user_assignee.RequestWriteUserAssignee, benchling_api_client.v2.stable.models.request_write_team_assignee.RequestWriteTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_assignees'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, requestor_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_requestor_id'].default, sample_groups: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_sample_group_create.RequestSampleGroupCreate]] = attr_dict['_sample_groups'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, date] = attr_dict['_scheduled_on'].default) None ¶
Method generated by attrs for class RequestCreate.
- property assignees: List[Union[benchling_api_client.v2.stable.models.request_write_user_assignee.RequestWriteUserAssignee, benchling_api_client.v2.stable.models.request_write_team_assignee.RequestWriteTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]¶
Array of assignees
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_create.T ¶
- property requestor_id: Optional[str]¶
ID of the user making the request. If unspecified, the requestor is the request creator.
- property sample_groups: List[benchling_api_client.v2.stable.models.request_sample_group_create.RequestSampleGroupCreate]¶
- class RequestFulfillment¶
Bases:
object
A request fulfillment represents work that is done which changes the status of a request or a sample group within that request. Fulfillments are created when state changes between IN_PROGRESS, COMPLETED, or FAILED statuses. Fulfillments do not capture a PENDING state because all requests or request sample groups are considered PENDING until the first corresponding fulfillment is created.
- __init__(created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, entry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entry_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, request_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_request_id'].default, sample_group: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.sample_group.SampleGroup] = attr_dict['_sample_group'].default, status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.sample_group_status.SampleGroupStatus] = attr_dict['_status'].default) None ¶
Method generated by attrs for class RequestFulfillment.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_fulfillment.T ¶
- property sample_group: Optional[benchling_api_client.v2.stable.models.sample_group.SampleGroup]¶
Represents a sample group that is an input to a request. A sample group is a set of samples upon which work in the request should be done.
- property status: benchling_api_client.v2.stable.models.sample_group_status.SampleGroupStatus¶
Status of a sample group
- class RequestFulfillmentsPaginatedList¶
Bases:
object
An object containing an array of RequestFulfillments
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, request_fulfillments: Union[benchling_api_client.v2.types.Unset, List[RequestFulfillment]] = attr_dict['_request_fulfillments'].default) None ¶
Method generated by attrs for class RequestFulfillmentsPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_fulfillments_paginated_list.T ¶
- property request_fulfillments: List[RequestFulfillment]¶
- class RequestResponse¶
Bases:
object
- __init__(results: Union[benchling_api_client.v2.types.Unset, List[AssayResult]] = attr_dict['_results'].default, samples: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_response_samples_item.RequestResponseSamplesItem]] = attr_dict['_samples'].default) None ¶
Method generated by attrs for class RequestResponse.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_response.T ¶
- property results: List[AssayResult]¶
- property samples: List[benchling_api_client.v2.stable.models.request_response_samples_item.RequestResponseSamplesItem]¶
Array of samples produced by the request.
- class RequestSchema¶
Bases:
object
- __init__(modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, organization: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_schema_organization.RequestSchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_schema_type.RequestSchemaType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class RequestSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_schema.T ¶
- property organization: benchling_api_client.v2.stable.models.request_schema_organization.RequestSchemaOrganization¶
The organization that owns the schema.
- property type: benchling_api_client.v2.stable.models.request_schema_type.RequestSchemaType¶
- class RequestSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, request_schemas: Union[benchling_api_client.v2.types.Unset, List[RequestSchema]] = attr_dict['_request_schemas'].default) None ¶
Method generated by attrs for class RequestSchemasPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_schemas_paginated_list.T ¶
- property request_schemas: List[RequestSchema]¶
- class RequestStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CANCELLED = 'CANCELLED'¶
- COMPLETED = 'COMPLETED'¶
- IN_PROGRESS = 'IN_PROGRESS'¶
- REQUESTED = 'REQUESTED'¶
- SCHEDULED = 'SCHEDULED'¶
- static of_unknown(val: str) RequestStatus ¶
- class RequestTaskBase¶
Bases:
object
A request task.
- __init__(id: str, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, sample_group_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_group_ids'].default) None ¶
Method generated by attrs for class RequestTaskBase.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_task_base.T ¶
- class RequestTaskSchema¶
Bases:
object
- __init__(modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, organization: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_task_schema_organization.RequestTaskSchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.request_task_schema_type.RequestTaskSchemaType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class RequestTaskSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_task_schema.T ¶
- property organization: benchling_api_client.v2.stable.models.request_task_schema_organization.RequestTaskSchemaOrganization¶
The organization that owns the schema.
- property type: benchling_api_client.v2.stable.models.request_task_schema_type.RequestTaskSchemaType¶
- class RequestTaskSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, request_task_schemas: Union[benchling_api_client.v2.types.Unset, List[RequestTaskSchema]] = attr_dict['_request_task_schemas'].default) None ¶
Method generated by attrs for class RequestTaskSchemasPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_task_schemas_paginated_list.T ¶
- property request_task_schemas: List[RequestTaskSchema]¶
- class RequestTasksBulkCreate¶
Bases:
object
- __init__(schema_id: str, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, sample_group_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_sample_group_ids'].default) None ¶
Method generated by attrs for class RequestTasksBulkCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_tasks_bulk_create.T ¶
- class RequestTasksBulkCreateRequest¶
Bases:
object
- __init__(tasks: List[RequestTasksBulkCreate]) None ¶
Method generated by attrs for class RequestTasksBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_tasks_bulk_create_request.T ¶
- property tasks: List[RequestTasksBulkCreate]¶
The tasks to create
- class RequestTasksBulkCreateResponse¶
Bases:
object
- __init__(tasks: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_task.RequestTask]] = attr_dict['_tasks'].default) None ¶
Method generated by attrs for class RequestTasksBulkCreateResponse.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_tasks_bulk_create_response.T ¶
- property tasks: List[benchling_api_client.v2.stable.models.request_task.RequestTask]¶
The created tasks
- class RequestTasksBulkUpdateRequest¶
Bases:
object
A request body for bulk updating request tasks.
- __init__(tasks: List[RequestTaskBase]) None ¶
Method generated by attrs for class RequestTasksBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_tasks_bulk_update_request.T ¶
- property tasks: List[RequestTaskBase]¶
The tasks to update
- class RequestTasksBulkUpdateResponse¶
Bases:
object
- __init__(tasks: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_task.RequestTask]] = attr_dict['_tasks'].default) None ¶
Method generated by attrs for class RequestTasksBulkUpdateResponse.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_tasks_bulk_update_response.T ¶
- property tasks: List[benchling_api_client.v2.stable.models.request_task.RequestTask]¶
The tasks to update
- class RequestUpdate¶
Bases:
object
- __init__(request_status: Union[benchling_api_client.v2.types.Unset, RequestStatus] = attr_dict['_request_status'].default, assignees: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.request_write_user_assignee.RequestWriteUserAssignee, benchling_api_client.v2.stable.models.request_write_team_assignee.RequestWriteTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_assignees'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, requestor_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_requestor_id'].default, sample_groups: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.request_sample_group_create.RequestSampleGroupCreate]] = attr_dict['_sample_groups'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, date] = attr_dict['_scheduled_on'].default) None ¶
Method generated by attrs for class RequestUpdate.
- property assignees: List[Union[benchling_api_client.v2.stable.models.request_write_user_assignee.RequestWriteUserAssignee, benchling_api_client.v2.stable.models.request_write_team_assignee.RequestWriteTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]¶
Array of assignees
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.request_update.T ¶
- property request_status: RequestStatus¶
- property requestor_id: Optional[str]¶
ID of the user making the request. If unspecified, the requestor is the request creator.
- property sample_groups: List[benchling_api_client.v2.stable.models.request_sample_group_create.RequestSampleGroupCreate]¶
- class RequestsPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, requests: Union[benchling_api_client.v2.types.Unset, List[Request]] = attr_dict['_requests'].default) None ¶
Method generated by attrs for class RequestsPaginatedList.
- class RnaOligo¶
Bases:
object
- __init__(annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation'].default, custom_notation_name: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation_name'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, nucleotide_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_nucleotide_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class RnaOligo.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations on the Oligo.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property custom_notation: Optional[str]¶
Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.
- property custom_notation_name: Optional[str]¶
Name of the custom notation specified in the request. Null if no notation was specified.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligo.T ¶
- property helm: str¶
Representation of the oligo in HELM syntax, including any chemical modifications
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class RnaOligoBulkUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class RnaOligoBulkUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations on the Oligo.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligo_bulk_update.T ¶
- class RnaOligoCreate¶
Bases:
object
- __init__(annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class RnaOligoCreate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations on the Oligo.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligo_create.T ¶
- property helm: str¶
Representation of the oligo in HELM syntax, including any chemical modifications
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- class RnaOligoUpdate¶
Bases:
object
- __init__(annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) None ¶
Method generated by attrs for class RnaOligoUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations on the Oligo.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligo_update.T ¶
- class RnaOligoWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.rna_oligo_with_entity_type_entity_type.RnaOligoWithEntityTypeEntityType] = attr_dict['_entity_type'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation'].default, custom_notation_name: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation_name'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, nucleotide_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.oligo_nucleotide_type.OligoNucleotideType] = attr_dict['_nucleotide_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class RnaOligoWithEntityType.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations on the Oligo.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property custom_notation: Optional[str]¶
Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.
- property custom_notation_name: Optional[str]¶
Name of the custom notation specified in the request. Null if no notation was specified.
- property entity_type: benchling_api_client.v2.stable.models.rna_oligo_with_entity_type_entity_type.RnaOligoWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligo_with_entity_type.T ¶
- property helm: str¶
Representation of the oligo in HELM syntax, including any chemical modifications
- property nucleotide_type: benchling_api_client.v2.stable.models.oligo_nucleotide_type.OligoNucleotideType¶
Nucleotide type of the Oligo.
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class RnaOligosArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of RNA Oligos along with any IDs of batches that were archived / unarchived.
- __init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default, rna_oligo_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_rna_oligo_ids'].default) None ¶
Method generated by attrs for class RnaOligosArchivalChange.
- class RnaOligosArchive¶
Bases:
object
The request body for archiving RNA Oligos.
- __init__(reason: EntityArchiveReason, rna_oligo_ids: List[str]) None ¶
Method generated by attrs for class RnaOligosArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligos_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class RnaOligosBulkCreateRequest¶
Bases:
object
- __init__(rna_oligos: Union[benchling_api_client.v2.types.Unset, List[RnaOligoCreate]] = attr_dict['_rna_oligos'].default) None ¶
Method generated by attrs for class RnaOligosBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligos_bulk_create_request.T ¶
- property rna_oligos: List[RnaOligoCreate]¶
- class RnaOligosBulkUpdateRequest¶
Bases:
object
- __init__(rna_oligos: Union[benchling_api_client.v2.types.Unset, List[RnaOligoBulkUpdate]] = attr_dict['_rna_oligos'].default) None ¶
Method generated by attrs for class RnaOligosBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligos_bulk_update_request.T ¶
- property rna_oligos: List[RnaOligoBulkUpdate]¶
- class RnaOligosBulkUpsertRequest¶
Bases:
object
- __init__(rna_oligos: List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]) None ¶
Method generated by attrs for class RnaOligosBulkUpsertRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_oligos_bulk_upsert_request.T ¶
- property rna_oligos: List[benchling_api_client.v2.stable.models.oligo_bulk_upsert_request.OligoBulkUpsertRequest]¶
- class RnaOligosPaginatedList¶
Bases:
object
- __init__(rna_oligos: Union[benchling_api_client.v2.types.Unset, List[RnaOligo]] = attr_dict['_rna_oligos'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class RnaOligosPaginatedList.
- class RnaOligosUnarchive¶
Bases:
object
The request body for unarchiving RNA Oligos.
- class RnaSequence¶
Bases:
object
- __init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation'].default, custom_notation_name: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_custom_notation_name'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, helm: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_helm'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class RnaSequence.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property custom_notation: Optional[str]¶
Representation of the RNA Sequence in the custom notation specified in the request. Null if no notation was specified.
- property custom_notation_name: Optional[str]¶
Name of the custom notation specified in the request. Null if no notation was specified.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequence.T ¶
- property helm: Optional[str]¶
Representation of the RNA Sequence in HELM syntax, including any chemical modifications.
- property parts: List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
- class RnaSequenceBulkCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default) None ¶
Method generated by attrs for class RnaSequenceBulkCreate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations to create on the RNA sequence.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequence_bulk_create.T ¶
- property helm: str¶
Representation of the RNA sequence in HELM syntax, including any chemical modifications
- property is_circular: bool¶
Whether the RNA sequence is circular or linear. RNA sequences can only be linear
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property parts: List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the RNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class RnaSequenceBulkUpdate¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default) None ¶
Method generated by attrs for class RnaSequenceBulkUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations to create on the RNA sequence.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequence_bulk_update.T ¶
- property helm: str¶
Representation of the RNA sequence in HELM syntax, including any chemical modifications
- property is_circular: bool¶
Whether the RNA sequence is circular or linear. RNA sequences can only be linear
- property parts: List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the RNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class RnaSequenceCreate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default) None ¶
Method generated by attrs for class RnaSequenceCreate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations to create on the RNA sequence.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- property entity_registry_id: str¶
Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequence_create.T ¶
- property helm: str¶
Representation of the RNA sequence in HELM syntax, including any chemical modifications
- property is_circular: bool¶
Whether the RNA sequence is circular or linear. RNA sequences can only be linear
- property naming_strategy: NamingStrategy¶
Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
- property parts: List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property registry_id: str¶
Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)
Required in order for entities to be created directly in the registry.
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the RNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class RnaSequenceUpdate¶
Bases:
object
- __init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, helm: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_helm'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parts: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]] = attr_dict['_parts'].default, primers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.primer.Primer]] = attr_dict['_primers'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, translations: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.translation.Translation]] = attr_dict['_translations'].default, custom_notation: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation'].default, custom_notation_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_custom_notation_id'].default) None ¶
Method generated by attrs for class RnaSequenceUpdate.
- property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶
Annotations to create on the RNA sequence.
- property custom_fields: CustomFields¶
- property custom_notation: str¶
Representation of the sequence or oligo in the custom notation specified by customNotationId
- property custom_notation_id: str¶
ID of the notation used to interpret the string provided in the customNotation field
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequence_update.T ¶
- property helm: str¶
Representation of the RNA sequence in HELM syntax, including any chemical modifications
- property is_circular: bool¶
Whether the RNA sequence is circular or linear. RNA sequences can only be linear
- property parts: List[benchling_api_client.v2.stable.models.rna_sequence_part.RnaSequencePart]¶
- property primers: List[benchling_api_client.v2.stable.models.primer.Primer]¶
- property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶
Translations to create on the RNA sequence. Translations are specified by either a combination of ‘start’ and ‘end’ fields, or a list of regions. Both cannot be provided.
- class RnaSequencesArchivalChange¶
Bases:
object
IDs of all RNA Sequences that were archived or unarchived, grouped by resource type.
- __init__(rna_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_rna_sequence_ids'].default) None ¶
Method generated by attrs for class RnaSequencesArchivalChange.
- class RnaSequencesArchive¶
Bases:
object
The request body for archiving RNA sequences.
- __init__(reason: EntityArchiveReason, rna_sequence_ids: List[str]) None ¶
Method generated by attrs for class RnaSequencesArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequences_archive.T ¶
- property reason: EntityArchiveReason¶
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.
- class RnaSequencesBulkCreateRequest¶
Bases:
object
- __init__(rna_sequences: Union[benchling_api_client.v2.types.Unset, List[RnaSequenceBulkCreate]] = attr_dict['_rna_sequences'].default) None ¶
Method generated by attrs for class RnaSequencesBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequences_bulk_create_request.T ¶
- property rna_sequences: List[RnaSequenceBulkCreate]¶
- class RnaSequencesBulkUpdateRequest¶
Bases:
object
- __init__(rna_sequences: Union[benchling_api_client.v2.types.Unset, List[RnaSequenceBulkUpdate]] = attr_dict['_rna_sequences'].default) None ¶
Method generated by attrs for class RnaSequencesBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequences_bulk_update_request.T ¶
- property rna_sequences: List[RnaSequenceBulkUpdate]¶
- class RnaSequencesPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, rna_sequences: Union[benchling_api_client.v2.types.Unset, List[RnaSequence]] = attr_dict['_rna_sequences'].default) None ¶
Method generated by attrs for class RnaSequencesPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.rna_sequences_paginated_list.T ¶
- property rna_sequences: List[RnaSequence]¶
- class RnaSequencesUnarchive¶
Bases:
object
The request body for unarchiving RNA sequences.
- __init__(rna_sequence_ids: List[str]) None ¶
Method generated by attrs for class RnaSequencesUnarchive.
- class SampleGroupsStatusUpdate¶
Bases:
object
Specification to update status of sample groups on the request which were executed.
- __init__(sample_groups: List[benchling_api_client.v2.stable.models.sample_group_status_update.SampleGroupStatusUpdate]) None ¶
Method generated by attrs for class SampleGroupsStatusUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.sample_groups_status_update.T ¶
- property sample_groups: List[benchling_api_client.v2.stable.models.sample_group_status_update.SampleGroupStatusUpdate]¶
- class SampleRestrictionStatus¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- NOT_APPLICABLE = 'NOT_APPLICABLE'¶
- RESTRICTED = 'RESTRICTED'¶
- UNRESTRICTED = 'UNRESTRICTED'¶
- static of_unknown(val: str) SampleRestrictionStatus ¶
- class SchemaDependencySubtypes¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- AA_SEQUENCE = 'aa_sequence'¶
- CUSTOM_ENTITY = 'custom_entity'¶
- DNA_OLIGO = 'dna_oligo'¶
- DNA_SEQUENCE = 'dna_sequence'¶
- MIXTURE = 'mixture'¶
- MOLECULE = 'molecule'¶
- RNA_OLIGO = 'rna_oligo'¶
- RNA_SEQUENCE = 'rna_sequence'¶
- static of_unknown(val: str) SchemaDependencySubtypes ¶
- class SchemaFieldsQueryParam¶
Bases:
object
- class SearchBasesRequest¶
Bases:
object
- __init__(bases: str, archive_reason: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_bases_request_archive_reason.SearchBasesRequestArchiveReason] = attr_dict['_archive_reason'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, page_size: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_page_size'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default, sort: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_bases_request_sort.SearchBasesRequestSort] = attr_dict['_sort'].default) None ¶
Method generated by attrs for class SearchBasesRequest.
- property archive_reason: benchling_api_client.v2.stable.models.search_bases_request_archive_reason.SearchBasesRequestArchiveReason¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_bases_request.T ¶
- property registry_id: Optional[str]¶
ID of a registry. Restricts results to those registered in this registry. Specifying null returns unregistered items.
- property sort: benchling_api_client.v2.stable.models.search_bases_request_sort.SearchBasesRequestSort¶
- class SearchInputMultiValueUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType, id: str, item_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType] = attr_dict['_item_type'].default, schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SearchInputMultiValueUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_input_multi_value_ui_block.T ¶
- property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶
- property type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType¶
- class SearchInputMultiValueUiBlockCreate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType] = attr_dict['_type'].default, item_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType] = attr_dict['_item_type'].default, schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SearchInputMultiValueUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_create.T ¶
- property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶
- property type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType¶
- class SearchInputMultiValueUiBlockUpdate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType] = attr_dict['_type'].default, item_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType] = attr_dict['_item_type'].default, schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SearchInputMultiValueUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_update.T ¶
- property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶
- property type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType¶
- class SearchInputUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType, id: str, item_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType] = attr_dict['_item_type'].default, schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SearchInputUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_input_ui_block.T ¶
- property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶
- property type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType¶
- class SearchInputUiBlockCreate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType] = attr_dict['_type'].default, item_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType] = attr_dict['_item_type'].default, schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SearchInputUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_input_ui_block_create.T ¶
- property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶
- property type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType¶
- class SearchInputUiBlockUpdate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType] = attr_dict['_type'].default, item_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType] = attr_dict['_item_type'].default, schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SearchInputUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.search_input_ui_block_update.T ¶
- property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶
- property type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType¶
- class SectionUiBlock¶
Bases:
object
- __init__(children: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, benchling_api_client.v2.extensions.UnknownType]], id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.section_ui_block_type.SectionUiBlockType] = attr_dict['_type'].default) None ¶
Method generated by attrs for class SectionUiBlock.
- property children: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.section_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.section_ui_block_type.SectionUiBlockType¶
- class SectionUiBlockCreate¶
Bases:
object
- __init__(children: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, benchling_api_client.v2.extensions.UnknownType]], id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.section_ui_block_type.SectionUiBlockType] = attr_dict['_type'].default) None ¶
Method generated by attrs for class SectionUiBlockCreate.
- property children: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.section_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.section_ui_block_type.SectionUiBlockType¶
- class SectionUiBlockUpdate¶
Bases:
object
- __init__(children: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, benchling_api_client.v2.extensions.UnknownType]], id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.section_ui_block_type.SectionUiBlockType] = attr_dict['_type'].default) None ¶
Method generated by attrs for class SectionUiBlockUpdate.
- property children: List[Union[ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.section_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.section_ui_block_type.SectionUiBlockType¶
- class SecureTextAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, SecureTextAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class SecureTextAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.secure_text_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: SecureTextAppConfigItemType¶
- class SecureTextAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- SECURE_TEXT = 'secure_text'¶
- static of_unknown(val: str) SecureTextAppConfigItemType ¶
- class SelectorInputMultiValueUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType, id: str, options: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_options'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SelectorInputMultiValueUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType¶
- class SelectorInputMultiValueUiBlockCreate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType] = attr_dict['_type'].default, options: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_options'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SelectorInputMultiValueUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType¶
- class SelectorInputMultiValueUiBlockUpdate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType] = attr_dict['_type'].default, options: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_options'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, List[str]] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SelectorInputMultiValueUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType¶
- class SelectorInputUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType, id: str, options: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_options'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SelectorInputUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.selector_input_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType¶
- class SelectorInputUiBlockCreate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType] = attr_dict['_type'].default, options: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_options'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SelectorInputUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.selector_input_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType¶
- class SelectorInputUiBlockUpdate¶
Bases:
object
- __init__(id: str, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType] = attr_dict['_type'].default, options: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_options'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class SelectorInputUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.selector_input_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType¶
- class TableUiBlock¶
Bases:
object
- __init__(name: str, source: Union[benchling_api_client.v2.stable.models.table_ui_block_dataset_source.TableUiBlockDatasetSource, benchling_api_client.v2.stable.models.table_ui_block_data_frame_source.TableUiBlockDataFrameSource, benchling_api_client.v2.extensions.UnknownType], type: benchling_api_client.v2.stable.models.table_ui_block_type.TableUiBlockType, id: str, max_rows: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_max_rows'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class TableUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.table_ui_block.T ¶
- property source: Union[benchling_api_client.v2.stable.models.table_ui_block_dataset_source.TableUiBlockDatasetSource, benchling_api_client.v2.stable.models.table_ui_block_data_frame_source.TableUiBlockDataFrameSource, benchling_api_client.v2.extensions.UnknownType]¶
- property type: benchling_api_client.v2.stable.models.table_ui_block_type.TableUiBlockType¶
- class TableUiBlockCreate¶
Bases:
object
- __init__(id: str, max_rows: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_max_rows'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, source: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.table_ui_block_dataset_source.TableUiBlockDatasetSource, benchling_api_client.v2.stable.models.table_ui_block_data_frame_source.TableUiBlockDataFrameSource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_source'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.table_ui_block_type.TableUiBlockType] = attr_dict['_type'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class TableUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.table_ui_block_create.T ¶
- property source: Union[benchling_api_client.v2.stable.models.table_ui_block_dataset_source.TableUiBlockDatasetSource, benchling_api_client.v2.stable.models.table_ui_block_data_frame_source.TableUiBlockDataFrameSource, benchling_api_client.v2.extensions.UnknownType]¶
- property type: benchling_api_client.v2.stable.models.table_ui_block_type.TableUiBlockType¶
- class TableUiBlockUpdate¶
Bases:
object
- __init__(id: str, max_rows: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_max_rows'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, source: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.table_ui_block_dataset_source.TableUiBlockDatasetSource, benchling_api_client.v2.stable.models.table_ui_block_data_frame_source.TableUiBlockDataFrameSource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_source'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.table_ui_block_type.TableUiBlockType] = attr_dict['_type'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class TableUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.table_ui_block_update.T ¶
- property source: Union[benchling_api_client.v2.stable.models.table_ui_block_dataset_source.TableUiBlockDatasetSource, benchling_api_client.v2.stable.models.table_ui_block_data_frame_source.TableUiBlockDataFrameSource, benchling_api_client.v2.extensions.UnknownType]¶
- property type: benchling_api_client.v2.stable.models.table_ui_block_type.TableUiBlockType¶
- class Team¶
Bases:
object
- __init__(organization: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.organization_summary.OrganizationSummary] = attr_dict['_organization'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class Team.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.team.T ¶
- property organization: benchling_api_client.v2.stable.models.organization_summary.OrganizationSummary¶
- class TeamsPaginatedList¶
Bases:
object
- __init__(teams: Union[benchling_api_client.v2.types.Unset, List[Team]] = attr_dict['_teams'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class TeamsPaginatedList.
- class TextAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, TextAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class TextAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.text_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config item’s location in the tree in order from top to bottom.
- property type: TextAppConfigItemType¶
- class TextAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- TEXT = 'text'¶
- static of_unknown(val: str) TextAppConfigItemType ¶
- class TextInputUiBlock¶
Bases:
object
- __init__(type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType, id: str, placeholder: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_placeholder'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class TextInputUiBlock.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.text_input_ui_block.T ¶
- property type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType¶
- class TextInputUiBlockCreate¶
Bases:
object
- __init__(id: str, placeholder: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_placeholder'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType] = attr_dict['_type'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class TextInputUiBlockCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.text_input_ui_block_create.T ¶
- property type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType¶
- class TextInputUiBlockUpdate¶
Bases:
object
- __init__(id: str, placeholder: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_placeholder'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType] = attr_dict['_type'].default, label: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_label'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, enabled: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_enabled'].default) None ¶
Method generated by attrs for class TextInputUiBlockUpdate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.text_input_ui_block_update.T ¶
- property type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType¶
- class UnregisterEntities¶
Bases:
object
- __init__(entity_ids: List[str], folder_id: str) None ¶
Method generated by attrs for class UnregisterEntities.
- class User¶
Bases:
object
- __init__(api_key_last_changed_at: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_api_key_last_changed_at'].default, email: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_email'].default, is_suspended: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_suspended'].default, password_last_changed_at: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_password_last_changed_at'].default, handle: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_handle'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class User.
- class UserActivity¶
Bases:
object
- __init__(last_seen: Union[benchling_api_client.v2.types.Unset, None, datetime] = attr_dict['_last_seen'].default, user_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_id'].default) None ¶
Method generated by attrs for class UserActivity.
- class UserBulkCreateRequest¶
Bases:
object
- __init__(users: Union[benchling_api_client.v2.types.Unset, List[UserCreate]] = attr_dict['_users'].default) None ¶
Method generated by attrs for class UserBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.user_bulk_create_request.T ¶
- property users: List[UserCreate]¶
- class UserBulkUpdate¶
Bases:
object
- __init__(id: str, email: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_email'].default, handle: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_handle'].default, is_suspended: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_suspended'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class UserBulkUpdate.
- class UserBulkUpdateRequest¶
Bases:
object
- __init__(users: Union[benchling_api_client.v2.types.Unset, List[UserBulkUpdate]] = attr_dict['_users'].default) None ¶
Method generated by attrs for class UserBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.user_bulk_update_request.T ¶
- property users: List[UserBulkUpdate]¶
- class UserCreate¶
Bases:
object
- class UserUpdate¶
Bases:
object
- __init__(email: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_email'].default, handle: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_handle'].default, is_suspended: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_suspended'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class UserUpdate.
- class UsersPaginatedList¶
Bases:
object
- __init__(users: Union[benchling_api_client.v2.types.Unset, List[User]] = attr_dict['_users'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class UsersPaginatedList.
- class WarehouseCredentials¶
Bases:
object
- __init__(expires_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_expires_at'].default, password: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_password'].default, username: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_username'].default) None ¶
Method generated by attrs for class WarehouseCredentials.
- property expires_at: datetime¶
The time after which new connections using the username/password will not be permitted. Upon expiration, currently open connections are not terminated.
- class WarehouseCredentialsCreate¶
Bases:
object
- property expires_in: int¶
Duration, in seconds, that credentials should be active for. Must be greater than 0 and less than 3600.
- class WorkflowOutput¶
Bases:
object
- __init__(created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creation_origin: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.creation_origin.CreationOrigin] = attr_dict['_creation_origin'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, task: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary] = attr_dict['_task'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, workflow_task_group: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_group_summary.WorkflowTaskGroupSummary] = attr_dict['_workflow_task_group'].default, display_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_display_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class WorkflowOutput.
- property creation_origin: benchling_api_client.v2.stable.models.creation_origin.CreationOrigin¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_output.T ¶
- property task: benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary¶
- property workflow_task_group: benchling_api_client.v2.stable.models.workflow_task_group_summary.WorkflowTaskGroupSummary¶
- class WorkflowOutputArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) WorkflowOutputArchiveReason ¶
- class WorkflowOutputBulkCreate¶
Bases:
object
- __init__(workflow_task_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_workflow_task_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) None ¶
Method generated by attrs for class WorkflowOutputBulkCreate.
- class WorkflowOutputBulkUpdate¶
Bases:
object
- __init__(workflow_output_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_workflow_output_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) None ¶
Method generated by attrs for class WorkflowOutputBulkUpdate.
- class WorkflowOutputCreate¶
Bases:
object
- __init__(workflow_task_id: str, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) None ¶
Method generated by attrs for class WorkflowOutputCreate.
- class WorkflowOutputUpdate¶
Bases:
object
- __init__(fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) None ¶
Method generated by attrs for class WorkflowOutputUpdate.
- class WorkflowOutputsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type
- __init__(workflow_output_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_workflow_output_ids'].default) None ¶
Method generated by attrs for class WorkflowOutputsArchivalChange.
- class WorkflowOutputsArchive¶
Bases:
object
- __init__(reason: WorkflowOutputArchiveReason, workflow_output_ids: List[str]) None ¶
Method generated by attrs for class WorkflowOutputsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_outputs_archive.T ¶
- property reason: WorkflowOutputArchiveReason¶
The reason for archiving the provided workflow outputs. Accepted reasons may differ based on tenant configuration.
- class WorkflowOutputsBulkCreateRequest¶
Bases:
object
- __init__(workflow_outputs: Union[benchling_api_client.v2.types.Unset, List[WorkflowOutputBulkCreate]] = attr_dict['_workflow_outputs'].default) None ¶
Method generated by attrs for class WorkflowOutputsBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_outputs_bulk_create_request.T ¶
- property workflow_outputs: List[WorkflowOutputBulkCreate]¶
- class WorkflowOutputsBulkUpdateRequest¶
Bases:
object
- __init__(workflow_outputs: Union[benchling_api_client.v2.types.Unset, List[WorkflowOutputBulkUpdate]] = attr_dict['_workflow_outputs'].default) None ¶
Method generated by attrs for class WorkflowOutputsBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_outputs_bulk_update_request.T ¶
- property workflow_outputs: List[WorkflowOutputBulkUpdate]¶
- class WorkflowOutputsPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, workflow_outputs: Union[benchling_api_client.v2.types.Unset, List[WorkflowOutput]] = attr_dict['_workflow_outputs'].default) None ¶
Method generated by attrs for class WorkflowOutputsPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_outputs_paginated_list.T ¶
- property workflow_outputs: List[WorkflowOutput]¶
- class WorkflowOutputsUnarchive¶
Bases:
object
- __init__(workflow_output_ids: List[str]) None ¶
Method generated by attrs for class WorkflowOutputsUnarchive.
- class WorkflowTask¶
Bases:
object
- __init__(execution_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_execution_type.WorkflowTaskExecutionType] = attr_dict['_execution_type'].default, assignee: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_assignee'].default, cloned_from: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary] = attr_dict['_cloned_from'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creation_origin: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.creation_origin.CreationOrigin] = attr_dict['_creation_origin'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, execution_origin: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.workflow_task_execution_origin.WorkflowTaskExecutionOrigin] = attr_dict['_execution_origin'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, outputs: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.workflow_output_summary.WorkflowOutputSummary]] = attr_dict['_outputs'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, None, date] = attr_dict['_scheduled_on'].default, schema: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_schema_summary.WorkflowTaskSchemaSummary] = attr_dict['_schema'].default, status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_status.WorkflowTaskStatus] = attr_dict['_status'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, workflow_task_group: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_group_summary.WorkflowTaskGroupSummary] = attr_dict['_workflow_task_group'].default, display_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_display_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) None ¶
Method generated by attrs for class WorkflowTask.
- property assignee: Optional[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
- property cloned_from: Optional[benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary]¶
- property creation_origin: benchling_api_client.v2.stable.models.creation_origin.CreationOrigin¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property execution_origin: Optional[benchling_api_client.v2.stable.models.workflow_task_execution_origin.WorkflowTaskExecutionOrigin]¶
The context into which a task was executed
- property execution_type: benchling_api_client.v2.stable.models.workflow_task_execution_type.WorkflowTaskExecutionType¶
The method by which the task of the workflow is executed
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_task.T ¶
- property outputs: List[benchling_api_client.v2.stable.models.workflow_output_summary.WorkflowOutputSummary]¶
- property schema: benchling_api_client.v2.stable.models.workflow_task_schema_summary.WorkflowTaskSchemaSummary¶
- property status: benchling_api_client.v2.stable.models.workflow_task_status.WorkflowTaskStatus¶
- property workflow_task_group: benchling_api_client.v2.stable.models.workflow_task_group_summary.WorkflowTaskGroupSummary¶
- class WorkflowTaskArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) WorkflowTaskArchiveReason ¶
- class WorkflowTaskBulkCreate¶
Bases:
object
- __init__(workflow_task_group_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_workflow_task_group_id'].default, assignee_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assignee_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, date] = attr_dict['_scheduled_on'].default) None ¶
Method generated by attrs for class WorkflowTaskBulkCreate.
- class WorkflowTaskBulkUpdate¶
Bases:
object
- __init__(workflow_task_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_workflow_task_id'].default, status_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_status_id'].default, assignee_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assignee_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, date] = attr_dict['_scheduled_on'].default) None ¶
Method generated by attrs for class WorkflowTaskBulkUpdate.
- class WorkflowTaskCreate¶
Bases:
object
- __init__(workflow_task_group_id: str, assignee_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assignee_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, date] = attr_dict['_scheduled_on'].default) None ¶
Method generated by attrs for class WorkflowTaskCreate.
- class WorkflowTaskGroup¶
Bases:
object
- __init__(execution_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_group_execution_type.WorkflowTaskGroupExecutionType] = attr_dict['_execution_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creation_origin: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.creation_origin.CreationOrigin] = attr_dict['_creation_origin'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, folder: Union[benchling_api_client.v2.types.Unset, Folder] = attr_dict['_folder'].default, modified_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_modified_at'].default, outputs: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.workflow_output_summary.WorkflowOutputSummary]] = attr_dict['_outputs'].default, responsible_team: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.team_summary.TeamSummary] = attr_dict['_responsible_team'].default, watchers: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.user_summary.UserSummary]] = attr_dict['_watchers'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, workflow_task_schema: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_schema_summary.WorkflowTaskSchemaSummary] = attr_dict['_workflow_task_schema'].default, workflow_tasks: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary]] = attr_dict['_workflow_tasks'].default, display_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_display_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class WorkflowTaskGroup.
- property creation_origin: benchling_api_client.v2.stable.models.creation_origin.CreationOrigin¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property execution_type: benchling_api_client.v2.stable.models.workflow_task_group_execution_type.WorkflowTaskGroupExecutionType¶
The method by which the workflow is executed
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_task_group.T ¶
- property outputs: List[benchling_api_client.v2.stable.models.workflow_output_summary.WorkflowOutputSummary]¶
The outputs of the workflow task group
- property responsible_team: Optional[benchling_api_client.v2.stable.models.team_summary.TeamSummary]¶
- property watchers: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶
The users watching the workflow task group
- property workflow_task_schema: benchling_api_client.v2.stable.models.workflow_task_schema_summary.WorkflowTaskSchemaSummary¶
- property workflow_tasks: List[benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary]¶
The input tasks to the workflow task group
- class WorkflowTaskGroupArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) WorkflowTaskGroupArchiveReason ¶
- class WorkflowTaskGroupCreate¶
Bases:
object
- __init__(schema_id: str, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, watcher_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_watcher_ids'].default) None ¶
Method generated by attrs for class WorkflowTaskGroupCreate.
- class WorkflowTaskGroupUpdate¶
Bases:
object
- __init__(folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, watcher_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_watcher_ids'].default) None ¶
Method generated by attrs for class WorkflowTaskGroupUpdate.
- class WorkflowTaskGroupsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type
- __init__(workflow_task_group_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_workflow_task_group_ids'].default) None ¶
Method generated by attrs for class WorkflowTaskGroupsArchivalChange.
- class WorkflowTaskGroupsArchive¶
Bases:
object
- __init__(reason: WorkflowTaskGroupArchiveReason, workflow_task_group_ids: List[str]) None ¶
Method generated by attrs for class WorkflowTaskGroupsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_task_groups_archive.T ¶
- property reason: WorkflowTaskGroupArchiveReason¶
The reason for archiving the provided workflow task groups. Accepted reasons may differ based on tenant configuration.
- class WorkflowTaskGroupsPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, workflow_task_groups: Union[benchling_api_client.v2.types.Unset, List[WorkflowTaskGroup]] = attr_dict['_workflow_task_groups'].default) None ¶
Method generated by attrs for class WorkflowTaskGroupsPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_task_groups_paginated_list.T ¶
- property workflow_task_groups: List[WorkflowTaskGroup]¶
- class WorkflowTaskGroupsUnarchive¶
Bases:
object
- __init__(workflow_task_group_ids: List[str]) None ¶
Method generated by attrs for class WorkflowTaskGroupsUnarchive.
- class WorkflowTaskSchema¶
Bases:
object
- __init__(execution_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_schema_execution_type.WorkflowTaskSchemaExecutionType] = attr_dict['_execution_type'].default, can_set_assignee_on_task_creation: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_can_set_assignee_on_task_creation'].default, default_creation_folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_default_creation_folder_id'].default, default_entry_execution_folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_default_entry_execution_folder_id'].default, default_responsible_team: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.team_summary.TeamSummary] = attr_dict['_default_responsible_team'].default, entry_template_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_template_id'].default, is_propagate_watchers_enabled: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_propagate_watchers_enabled'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, status_lifecycle: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.workflow_task_status_lifecycle.WorkflowTaskStatusLifecycle] = attr_dict['_status_lifecycle'].default, task_group_prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_task_group_prefix'].default, workflow_output_schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.workflow_output_schema.WorkflowOutputSchema] = attr_dict['_workflow_output_schema'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) None ¶
Method generated by attrs for class WorkflowTaskSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property can_set_assignee_on_task_creation: bool¶
Whether or not tasks of this schema can be created with a non-null assignee.
- property default_creation_folder_id: Optional[str]¶
ID of the default folder for creating workflow task groups
- property default_entry_execution_folder_id: Optional[str]¶
ID of the default folder for workflow task execution entries
- property default_responsible_team: Optional[benchling_api_client.v2.stable.models.team_summary.TeamSummary]¶
- property entry_template_id: Optional[str]¶
The ID of the template of the entries tasks of this schema will be executed into.
- property execution_type: benchling_api_client.v2.stable.models.workflow_task_schema_execution_type.WorkflowTaskSchemaExecutionType¶
The method by which instances of this schema are executed
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_task_schema.T ¶
- property is_propagate_watchers_enabled: bool¶
Whether propagation of watchers has been enabled for this task schema.
- property status_lifecycle: benchling_api_client.v2.stable.models.workflow_task_status_lifecycle.WorkflowTaskStatusLifecycle¶
- property task_group_prefix: str¶
The prefix for the displayId of task groups containing tasks of this schema
- property workflow_output_schema: Optional[benchling_api_client.v2.stable.models.workflow_output_schema.WorkflowOutputSchema]¶
- class WorkflowTaskSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, workflow_task_schemas: Union[benchling_api_client.v2.types.Unset, List[WorkflowTaskSchema]] = attr_dict['_workflow_task_schemas'].default) None ¶
Method generated by attrs for class WorkflowTaskSchemasPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_task_schemas_paginated_list.T ¶
- property workflow_task_schemas: List[WorkflowTaskSchema]¶
- class WorkflowTaskUpdate¶
Bases:
object
- __init__(status_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_status_id'].default, assignee_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assignee_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, scheduled_on: Union[benchling_api_client.v2.types.Unset, date] = attr_dict['_scheduled_on'].default) None ¶
Method generated by attrs for class WorkflowTaskUpdate.
- class WorkflowTasksArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type
- __init__(workflow_task_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_workflow_task_ids'].default) None ¶
Method generated by attrs for class WorkflowTasksArchivalChange.
- class WorkflowTasksArchive¶
Bases:
object
- __init__(reason: WorkflowTaskArchiveReason, workflow_task_ids: List[str]) None ¶
Method generated by attrs for class WorkflowTasksArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_tasks_archive.T ¶
- property reason: WorkflowTaskArchiveReason¶
The reason for archiving the provided workflow tasks. Accepted reasons may differ based on tenant configuration.
- class WorkflowTasksBulkCopyRequest¶
Bases:
object
- __init__(workflow_task_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_workflow_task_ids'].default) None ¶
Method generated by attrs for class WorkflowTasksBulkCopyRequest.
- class WorkflowTasksBulkCreateRequest¶
Bases:
object
- __init__(workflow_tasks: Union[benchling_api_client.v2.types.Unset, List[WorkflowTaskBulkCreate]] = attr_dict['_workflow_tasks'].default) None ¶
Method generated by attrs for class WorkflowTasksBulkCreateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_tasks_bulk_create_request.T ¶
- property workflow_tasks: List[WorkflowTaskBulkCreate]¶
- class WorkflowTasksBulkUpdateRequest¶
Bases:
object
- __init__(workflow_tasks: Union[benchling_api_client.v2.types.Unset, List[WorkflowTaskBulkUpdate]] = attr_dict['_workflow_tasks'].default) None ¶
Method generated by attrs for class WorkflowTasksBulkUpdateRequest.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_tasks_bulk_update_request.T ¶
- property workflow_tasks: List[WorkflowTaskBulkUpdate]¶
- class WorkflowTasksPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, workflow_tasks: Union[benchling_api_client.v2.types.Unset, List[WorkflowTask]] = attr_dict['_workflow_tasks'].default) None ¶
Method generated by attrs for class WorkflowTasksPaginatedList.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.workflow_tasks_paginated_list.T ¶
- property workflow_tasks: List[WorkflowTask]¶
- class WorkflowTasksUnarchive¶
Bases:
object
- __init__(workflow_task_ids: List[str]) None ¶
Method generated by attrs for class WorkflowTasksUnarchive.