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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Array of aliases

property amino_acids: str¶: Amino acids of the AA sequence.

property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶: Array of annotation objects on the AA sequence.

property api_url: str¶: The canonical url of the AA Sequence in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property created_at: datetime¶: DateTime the AA sequence was created.

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶: Registry ID of the AA sequence if registered.

property fields: Fields¶

property folder_id: Optional[str]¶: ID of the folder that contains the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the AA sequence.

property length: int¶: Number of amino acids in the AA sequence.

property modified_at: datetime¶: DateTime the AA sequence was last modified.

property name: str¶: Name of the AA sequence.

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶: Registry the AA sequence is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the protein.

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 aliases: List[str]¶: Aliases to add to the AA sequence

property amino_acids: str¶: Amino acids for the AA sequence.

property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶: Annotations to create on the AA sequence.

property author_ids: List[str]¶: IDs of users to set as the AA sequence’s authors.

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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_bulk_create.T¶

property name: str¶: Name of the AA sequence.

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 schema_id: str¶: ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the AA sequence

property amino_acids: str¶: Amino acids for the AA sequence.

property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶: Annotations to create on the AA sequence.

property author_ids: List[str]¶: IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_bulk_update.T¶

property id: str¶

property name: str¶: Name of the AA sequence.

property schema_id: str¶: ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the AA sequence

property amino_acids: str¶: Amino acids for the AA sequence.

property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶: Annotations to create on the AA sequence.

property author_ids: List[str]¶: IDs of users to set as the AA sequence’s authors.

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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_create.T¶

property name: str¶: Name of the AA sequence.

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 schema_id: str¶: ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the AA sequence

property amino_acids: str¶: Amino acids for the AA sequence.

property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶: Annotations to create on the AA sequence.

property author_ids: List[str]¶: IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_update.T¶

property name: str¶: Name of the AA sequence.

property schema_id: str¶: ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the AA sequence

property amino_acids: str¶: Amino acids for the AA sequence.

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 author_ids: List[str]¶: IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶

property entity_registry_id: str¶: Registry ID of the entity in Benchling.

property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶

property folder_id: str¶: ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_upsert.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶

property registry_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Array of aliases

property amino_acids: str¶: Amino acids of the AA sequence.

property annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶: Array of annotation objects on the AA sequence.

property api_url: str¶: The canonical url of the AA Sequence in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property created_at: datetime¶: DateTime the AA sequence was created.

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶: Registry ID of the AA sequence if registered.

property entity_type: benchling_api_client.v2.stable.models.aa_sequence_with_entity_type_entity_type.AaSequenceWithEntityTypeEntityType¶

property fields: Fields¶

property folder_id: Optional[str]¶: ID of the folder that contains the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_with_entity_type.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the AA sequence.

property length: int¶: Number of amino acids in the AA sequence.

property modified_at: datetime¶: DateTime the AA sequence was last modified.

property name: str¶: Name of the AA sequence.

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶: Registry the AA sequence is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the protein.

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.

property aa_sequence_ids: List[str]¶

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property aa_sequence_ids: List[str]¶

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.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_bulk_update_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_bulk_upsert_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property aa_sequence_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property resource_id: str¶: Identifier of the resource object to attach canvas to.

property session_id: Optional[str]¶: Identifier of a session. If specified, app status messages from the session will be reported in the canvas.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_canvas_app.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The id of the Benchling app.

to_dict() → Dict[str, Any]¶

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¶

property resource_id: str¶: Identifier of the resource object to attach canvas to.

property session_id: Optional[str]¶: Identifier of a session. If specified, app status messages from the session will be reported in the canvas.

to_dict() → Dict[str, Any]¶

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¶

property resource_id: str¶: Identifier of the resource object to attach canvas to.

property session_id: Optional[str]¶: Identifier of a session. If specified, app status messages from the session will be reported in the canvas.

to_dict() → Dict[str, Any]¶

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.

property canvas_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_canvases_archival_change.T¶

to_dict() → Dict[str, Any]¶

class AppCanvasesArchive¶

Bases: object

__init__(canvas_ids: List[str], reason: AppCanvasesArchiveReason) → None¶: Method generated by attrs for class AppCanvasesArchive.

property canvas_ids: List[str]¶: Array of canvas IDs

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.

to_dict() → Dict[str, Any]¶

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.

property app_canvases: List[AppCanvas]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_canvases_paginated_list.T¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class AppCanvasesUnarchive¶

Bases: object

__init__(canvas_ids: List[str]) → None¶: Method generated by attrs for class AppCanvasesUnarchive.

property canvas_ids: List[str]¶: Array of canvas IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_canvases_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_items_bulk_create_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_items_bulk_update_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_configuration_paginated_list.T¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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¶

property created_at: datetime¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_session.T¶

property id: str¶

property messages: Optional[List[benchling_api_client.v2.stable.models.app_session_message.AppSessionMessage]]¶: An array of SessionMessage describing the current session state.

property modified_at: datetime¶

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.

property timeout_seconds: int¶: Timeout in seconds, a value between 1 second and 30 days. Once set, it can only be increased, not decreased.

to_dict() → Dict[str, Any]¶

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.

property app_id: str¶

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.

property timeout_seconds: int¶: Timeout in seconds, a value between 1 second and 30 days. Once set, it can only be increased, not decreased.

to_dict() → Dict[str, Any]¶

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¶

to_dict() → Dict[str, Any]¶

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

property timeout_seconds: int¶: Timeout in seconds, a value between 1 second and 30 days. Once set, it can only be increased, not decreased.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property app_sessions: List[AppSession]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_sessions_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.array_element_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

to_dict() → Dict[str, Any]¶

property type: ArrayElementAppConfigItemType¶

property value: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property created_at: datetime¶: DateTime at which the the result was created

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property entry_id: Optional[str]¶: ID of the entry that this result is attached to

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.

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the result

property is_reviewed: bool¶: Whether or not this result is attached to an accepted entry

property modified_at: datetime¶: DateTime at which the the result was last modified

property project_id: Optional[str]¶: ID of the project to insert the result into

property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶

to_dict() → Dict[str, Any]¶

property validation_comment: str¶

property validation_status: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶: UUID

property project_id: Optional[str]¶: The project that the assay result should be uploaded to. Only users with read access to the project will be able to read the assay result. Leaving this empty will result in only the creator having read access.

property schema_id: str¶: ID of result schema under which to upload this result

to_dict() → Dict[str, Any]¶

class AssayResultIdsRequest¶

Bases: object

__init__(assay_result_ids: List[str]) → None¶: Method generated by attrs for class AssayResultIdsRequest.

property assay_result_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_ids_request.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_result_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_ids_response.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property derived_from: Optional[str]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Assay Result Schema was last modified

property name: str¶

property organization: benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization¶

property system_name: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_result_schemas: List[AssayResultSchema]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_transaction_create_response.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

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.

property assay_result_ids: List[str]¶

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

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_results: List[AssayResultCreate]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_bulk_create_in_table_request.T¶

get(key, default=None) → Optional[Any]¶

property table_id: str¶

to_dict() → Dict[str, Any]¶

class AssayResultsBulkCreateRequest¶

Bases: object

__init__(assay_results: List[AssayResultCreate]) → None¶: Method generated by attrs for class AssayResultsBulkCreateRequest.

property assay_results: List[AssayResultCreate]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_results: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_create_response.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_results: List[AssayResult]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the Run in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property created_at: str¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property entry_id: Optional[str]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property is_reviewed: bool¶

property project_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property validation_comment: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of assay run

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 schema_id: str¶: ID of assay schema that assay run conforms to

to_dict() → Dict[str, Any]¶

property validation_comment: str¶: Additional information about the validation status

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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 derived_from: Optional[str]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Assay Run Schema was last modified

property name: str¶

property organization: benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization¶

property system_name: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_run_schemas: List[AssayRunSchema]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run_update.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_run_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_runs_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property assay_run_ids: List[str]¶

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.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_runs_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_runs: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_runs_bulk_create_response.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assay_runs: List[AssayRun]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_runs_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class AssayRunsUnarchive¶

Bases: object

The request body for unarchiving Assay Runs.

__init__(assay_run_ids: List[str]) → None¶: Method generated by attrs for class AssayRunsUnarchive.

property assay_run_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_runs_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property message: str¶: Present only when status is FAILED. Contains information about the error.

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.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.async_task_link.T¶

get(key, default=None) → Optional[Any]¶

property task_id: str¶

to_dict() → Dict[str, Any]¶

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.

property aa_sequence_ids: List[str]¶: Array of AA sequence IDs.

property feature_library_ids: List[str]¶: Array of feature library IDs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.auto_annotate_aa_sequences.T¶

to_dict() → Dict[str, Any]¶

class AutoAnnotateDnaSequences¶

Bases: object

__init__(dna_sequence_ids: List[str], feature_library_ids: List[str]) → None¶: Method generated by attrs for class AutoAnnotateDnaSequences.

property dna_sequence_ids: List[str]¶: Array of DNA sequence IDs.

property feature_library_ids: List[str]¶: Array of feature library IDs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.auto_annotate_dna_sequences.T¶

to_dict() → Dict[str, Any]¶

class AutoAnnotateRnaSequences¶

Bases: object

__init__(feature_library_ids: List[str], rna_sequence_ids: List[str]) → None¶: Method generated by attrs for class AutoAnnotateRnaSequences.

property feature_library_ids: List[str]¶: Array of feature library IDs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.auto_annotate_rna_sequences.T¶

property rna_sequence_ids: List[str]¶: Array of RNA sequence IDs.

to_dict() → Dict[str, Any]¶

class AutofillSequences¶

Bases: object

__init__(dna_sequence_ids: List[str]) → None¶: Method generated by attrs for class AutofillSequences.

property dna_sequence_ids: List[str]¶: Array of DNA sequence IDs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.autofill_sequences.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property automation_input_generators: List[AutomationInputGenerator]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_file_inputs_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the Automation Input Generator in the API.

property assay_run_id: str¶

property automation_file_config: benchling_api_client.v2.stable.models.automation_file_automation_file_config.AutomationFileAutomationFileConfig¶

property created_at: datetime¶: DateTime the Automation Input Generator was last modified

property file: Optional[Blob]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_input_generator.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Automation Input Generator was last modified

property status: benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus¶

to_dict() → Dict[str, Any]¶

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.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_input_generator_update.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the Automation Output Processor in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property assay_run_id: str¶

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.

property created_at: datetime¶: DateTime the Automation Output Processor was created

property error_file: Optional[Blob]¶

property file: Optional[Blob]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_output_processor.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Automation Output Processor was last modified

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¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property automation_output_processor_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_output_processor_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property result_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 assay_run_id: str¶

property automation_file_config_name: str¶

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.

property file_id: str¶: The ID of a blob link to process.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_output_processor_create.T¶

to_dict() → Dict[str, Any]¶

class AutomationOutputProcessorUpdate¶

Bases: object

__init__(file_id: str) → None¶: Method generated by attrs for class AutomationOutputProcessorUpdate.

property file_id: str¶: The ID of a blob link to process.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_output_processor_update.T¶

to_dict() → Dict[str, Any]¶

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.

property automation_output_processor_ids: List[str]¶: Array of automation output processor IDs

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.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property automation_output_processors: List[AutomationOutputProcessor]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_output_processors_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class AutomationOutputProcessorsUnarchive¶

Bases: object

__init__(automation_output_processor_ids: List[str]) → None¶: Method generated by attrs for class AutomationOutputProcessorsUnarchive.

property automation_output_processor_ids: List[str]¶: Array of automation output processor IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.automation_output_processors_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property error: benchling_api_client.v2.stable.models.bad_request_error_error.BadRequestErrorError¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.bad_request_error.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property error: BadRequestErrorBulkError¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.bad_request_error_bulk.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property errors: List[benchling_api_client.v2.stable.models.bad_request_error_bulk_error_errors_item.BadRequestErrorBulkErrorErrorsItem]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.bad_request_error_bulk_error.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property barcode: str¶: Barcode to validate.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.barcode_validation_result.T¶

get(key, default=None) → Optional[Any]¶

property is_valid: bool¶: Whether the barcode is valid.

property message: Optional[str]¶: If barcode is not valid, a message string explaining the error.

to_dict() → Dict[str, Any]¶

class BarcodesList¶

Bases: object

__init__(barcodes: List[str]) → None¶: Method generated by attrs for class BarcodesList.

property barcodes: List[str]¶: Array of barcodes to validate.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.barcodes_list.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property entity_schema_id: str¶

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.batch_schema.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Batch Schema was last modified

property name: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

property type: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_schemas: List[BatchSchema]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.batch_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 api_url: str¶

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 created_at: datetime¶: DateTime at which the the app was created

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.benchling_app.T¶

property id: str¶

property modified_at: datetime¶: DateTime at which the the app was last modified

property name: str¶

to_dict() → Dict[str, Any]¶

property web_url: str¶

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.

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.benchling_app_create.T¶

property name: str¶

to_dict() → Dict[str, Any]¶

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.

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.benchling_app_update.T¶

property name: str¶

to_dict() → Dict[str, Any]¶

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.

property app_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.benchling_apps_archival_change.T¶

to_dict() → Dict[str, Any]¶

class BenchlingAppsArchive¶

Bases: object

__init__(app_ids: List[str], reason: BenchlingAppsArchiveReason) → None¶: Method generated by attrs for class BenchlingAppsArchive.

property app_ids: List[str]¶: Array of app IDs

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.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.benchling_apps_paginated_list.T¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class BenchlingAppsUnarchive¶

Bases: object

__init__(app_ids: List[str]) → None¶: Method generated by attrs for class BenchlingAppsUnarchive.

property app_ids: List[str]¶: Array of app IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.benchling_apps_unarchive.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.blob.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The universally unique identifier (UUID) for the blob.

property mime_type: str¶: eg. application/jpeg

property name: str¶: Name of the blob

to_dict() → Dict[str, Any]¶

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.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.blob_complete.T¶

property parts: List[BlobPart]¶

to_dict() → Dict[str, Any]¶

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.

property data64: str¶: base64 encoded file contents

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 mime_type: str¶: eg. application/jpeg

property name: str¶: Name of the blob

to_dict() → Dict[str, Any]¶

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 mime_type: str¶: eg. application/jpeg

property name: str¶: Name of the blob

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property e_tag: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.blob_part.T¶

get(key, default=None) → Optional[Any]¶

property part_number: int¶

to_dict() → Dict[str, Any]¶

class BlobPartCreate¶

Bases: object

__init__(data64: str, md5: str, part_number: int) → None¶: Method generated by attrs for class BlobPartCreate.

property data64: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.blob_part_create.T¶

property md5: str¶

property part_number: int¶: An integer between 1 to 10,000, inclusive. The part number must be unique per part and indicates the ordering of the part inside the final blob. The part numbers do not need to be consecutive.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property download_url: str¶: a pre-signed download url.

property expires_at: int¶: The unix time that the download URL expires at.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.blob_url.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.boolean_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: BooleanAppConfigItemType¶

property value: Optional[bool]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property available_capacity: int¶: The number of available positions in the box.

property barcode: Optional[str]¶

property created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property empty_containers: int¶: The number of containers in the box that have no contents.

property empty_positions: int¶: The number of empty positions for adding additional containers in the box.

property fields: Fields¶

property filled_positions: int¶: The number of containers currently in the box.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.box.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶

property name: str¶

property occupied_capacity: int¶: The number of containers currently in the box.

property parent_storage_id: Optional[str]¶

property project_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

property size: int¶: The size of the box (i.e. how many containers it can store).

to_dict() → Dict[str, Any]¶

property total_capacity: int¶: The total capacity of the box (i.e. how many containers it can store).

property web_url: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property containers: List[ContainerWithCoordinates]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.box_contents_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property barcode: str¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.box_create.T¶

property name: str¶

property parent_storage_id: str¶

property project_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property height: float¶

property id: str¶

property name: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.box_schema_type.BoxSchemaType¶

property width: float¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property box_schemas: List[BoxSchema]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.box_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.box_update.T¶

property name: str¶

property parent_storage_id: str¶

property project_id: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property box_ids: List[str]¶

property container_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.boxes_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property box_ids: List[str]¶: Array of box IDs

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.

property should_remove_barcodes: bool¶: Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property boxes: List[Box]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.boxes_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class BoxesUnarchive¶

Bases: object

__init__(box_ids: List[str]) → None¶: Method generated by attrs for class BoxesUnarchive.

property box_ids: List[str]¶: Array of box IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.boxes_unarchive.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.button_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property text: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.button_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property text: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.button_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property text: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.chip_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType¶

property value: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.chip_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType¶

property value: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.chip_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.chip_ui_block_type.ChipUiBlockType¶

property value: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property error: benchling_api_client.v2.stable.models.conflict_error_error.ConflictErrorError¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.conflict_error.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property barcode: Optional[str]¶

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 created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶

property name: str¶

property parent_storage_id: Optional[str]¶

property parent_storage_schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

property project_id: Optional[str]¶

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]¶

to_dict() → Dict[str, Any]¶

property volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_response.DeprecatedContainerVolumeForResponse¶

property web_url: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property barcode: str¶: Barcode of the container. The barcode must be unique within the registry and cannot be empty.

property concentration: Measurement¶

property container_id: str¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_bulk_update_item.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶

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.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_content.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

class ContainerContentUpdate¶

Bases: object

__init__(concentration: Measurement) → None¶: Method generated by attrs for class ContainerContentUpdate.

property concentration: Measurement¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_content_update.T¶

to_dict() → Dict[str, Any]¶

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.

property barcode: str¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_create.T¶

property name: str¶

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 project_id: Optional[str]¶

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 schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Container Schema was last modified

property name: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property container_schemas: List[ContainerSchema]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

to_dict() → Dict[str, Any]¶

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.

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_update.T¶

property name: str¶

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 project_id: Optional[str]¶

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.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property barcode: Optional[str]¶

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 created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.container_with_coordinates.T¶

get(key, default=None) → Optional[Any]¶

property grid_number: float¶

property grid_position: str¶

property id: str¶

property modified_at: datetime¶

property name: str¶

property parent_storage_id: Optional[str]¶

property parent_storage_schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

property project_id: Optional[str]¶

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]¶

to_dict() → Dict[str, Any]¶

property volume: benchling_api_client.v2.stable.models.deprecated_container_volume_for_response.DeprecatedContainerVolumeForResponse¶

property web_url: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property container_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property container_ids: List[str]¶: Array of container IDs

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.

property should_remove_barcodes: bool¶: Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

class ContainersBulkUpdateRequest¶

Bases: object

__init__(containers: List[ContainerBulkUpdateItem]) → None¶: Method generated by attrs for class ContainersBulkUpdateRequest.

property containers: List[ContainerBulkUpdateItem]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_bulk_update_request.T¶

to_dict() → Dict[str, Any]¶

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.

property comments: str¶

property container_ids: List[str]¶: Array of container IDs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_checkin.T¶

to_dict() → Dict[str, Any]¶

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.

property assignee_id: str¶: User or Team API ID.

property comment: str¶

property container_ids: List[str]¶: Array of container IDs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_checkout.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property containers: List[Container]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class ContainersUnarchive¶

Bases: object

__init__(container_ids: List[str]) → None¶: Method generated by attrs for class ContainersUnarchive.

property container_ids: List[str]¶: Array of container IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.containers_unarchive.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_ids: List[str]¶

property custom_entity_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entities_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property custom_entity_ids: List[str]¶

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.

to_dict() → Dict[str, Any]¶

class CustomEntitiesBulkCreateRequest¶

Bases: object

__init__(custom_entities: List[CustomEntityBulkCreate]) → None¶: Method generated by attrs for class CustomEntitiesBulkCreateRequest.

property custom_entities: List[CustomEntityBulkCreate]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entities_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

class CustomEntitiesBulkUpdateRequest¶

Bases: object

__init__(custom_entities: List[CustomEntityBulkUpdate]) → None¶: Method generated by attrs for class CustomEntitiesBulkUpdateRequest.

property custom_entities: List[CustomEntityBulkUpdate]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entities_bulk_update_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entities_bulk_upsert_request.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property custom_entities: List[CustomEntity]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entities_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property custom_entity_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entities_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property api_url: str¶: The canonical url of the Custom Entity in the API.

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 created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.custom_entity_creator.CustomEntityCreator¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶

property name: str¶

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶

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 aliases: List[str]¶: Aliases to add to the custom entity

property author_ids: List[str]¶: IDs of users to set as the custom entity’s authors.

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.

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity_bulk_create.T¶

property name: str¶

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 schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the custom entity

property author_ids: List[str]¶: IDs of users to set as the custom entity’s authors.

property custom_fields: CustomFields¶

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity_bulk_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property name: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the custom entity

property author_ids: List[str]¶: IDs of users to set as the custom entity’s authors.

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.

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity_create.T¶

property name: str¶

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 schema_id: str¶

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the custom entity

property author_ids: List[str]¶: IDs of users to set as the custom entity’s authors.

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity_update.T¶

property name: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the custom entity

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 author_ids: List[str]¶: IDs of users to set as the custom entity’s authors.

property custom_fields: CustomFields¶

property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶

property folder_id: str¶: ID of the folder that the entity is moved into

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity_upsert_request.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶

property registry_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property api_url: str¶: The canonical url of the Custom Entity in the API.

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 created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.custom_entity_creator.CustomEntityCreator¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶

property entity_type: benchling_api_client.v2.stable.models.custom_entity_with_entity_type_entity_type.CustomEntityWithEntityTypeEntityType¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_entity_with_entity_type.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶

property name: str¶

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶

class CustomFields¶

Bases: object

__init__() → None¶: Method generated by attrs for class CustomFields.

property additional_keys: List[str]¶

additional_properties: Dict[str, benchling_api_client.v2.stable.models.custom_field.CustomField]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_fields.T¶

get(key, default=None) → Optional[benchling_api_client.v2.stable.models.custom_field.CustomField]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_notation.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property name: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property custom_notations: List[CustomNotation]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.custom_notations_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.date_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: DateAppConfigItemType¶

property value: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.datetime_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: DatetimeAppConfigItemType¶

property value: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aligned_sequences: List[benchling_api_client.v2.stable.models.aligned_sequence.AlignedSequence]¶

property api_url: str¶: The canonical url of the DNA Alignment in the API.

property created_at: datetime¶: DateTime the DNA Alignment was created

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_alignment.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the DNA Alignment was last modified

property name: str¶

property reference_sequence_id: str¶: The ID of the template or consensus DNA Sequence associated with the DNA Alignment

to_dict() → Dict[str, Any]¶

property web_url: str¶: The Benchling web UI url to view the DNA Alignment

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the DNA Alignment in the API.

property created_at: datetime¶: DateTime the DNA Alignment was created

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_alignment_summary.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the DNA Alignment was last modified

property name: str¶

property reference_sequence_id: str¶: The ID of the template or consensus DNA Sequence associated with the DNA Alignment

to_dict() → Dict[str, Any]¶

property web_url: str¶: The Benchling web UI url to view the DNA Alignment

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dna_alignments: List[DnaAlignmentSummary]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_alignments_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 name: str¶

property new_sequence: benchling_api_client.v2.stable.models.dna_consensus_alignment_create_new_sequence.DnaConsensusAlignmentCreateNewSequence¶

property sequence_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Array of aliases

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations on the Oligo.

property api_url: str¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶

property created_at: datetime¶: DateTime the Oligo was created.

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_registry_id: Optional[str]¶: Registry ID of the Oligo if registered.

property fields: Fields¶

property folder_id: Optional[str]¶: ID of the folder that contains the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligo.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property id: str¶: ID of the Oligo.

property length: int¶: Number of bases in the Oligo.

property modified_at: datetime¶: DateTime the Oligo was last modified.

property name: str¶: Name of the Oligo.

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 registry_id: Optional[str]¶: Registry the Oligo is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the Oligo.

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 aliases: List[str]¶: Aliases to add to the Oligo

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations on the Oligo.

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of 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 fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligo_bulk_update.T¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property id: str¶

property name: str¶: Name of the Oligo.

property schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the Oligo

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations on the Oligo.

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of 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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligo_create.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property name: str¶: Name of the Oligo.

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 schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the Oligo

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations on the Oligo.

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of 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 fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligo_update.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property name: str¶: Name of the Oligo.

property schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Array of aliases

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations on the Oligo.

property api_url: str¶: The canonical url of the Oligo in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶: Base pairs of the Oligo.

property created_at: datetime¶: DateTime the Oligo was created.

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_registry_id: Optional[str]¶: Registry ID of the Oligo if registered.

property entity_type: benchling_api_client.v2.stable.models.dna_oligo_with_entity_type_entity_type.DnaOligoWithEntityTypeEntityType¶

property fields: Fields¶

property folder_id: Optional[str]¶: ID of the folder that contains the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligo_with_entity_type.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property id: str¶: ID of the Oligo.

property length: int¶: Number of bases in the Oligo.

property modified_at: datetime¶: DateTime the Oligo was last modified.

property name: str¶: Name of the Oligo.

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 registry_id: Optional[str]¶: Registry the Oligo is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the Oligo.

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_ids: List[str]¶

property dna_oligo_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligos_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property dna_oligo_ids: List[str]¶

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.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligos_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligos_bulk_update_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligos_bulk_upsert_request.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dna_oligos: List[DnaOligo]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligos_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class DnaOligosUnarchive¶

Bases: object

The request body for unarchiving DNA Oligos.

__init__(dna_oligo_ids: List[str]) → None¶: Method generated by attrs for class DnaOligosUnarchive.

property dna_oligo_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_oligos_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶

property api_url: str¶: The canonical url of the DNA Sequence in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶

property created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property is_circular: bool¶

property length: int¶

property modified_at: datetime¶

property name: str¶

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 registry_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶

property web_url: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the DNA sequence

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations to create on the DNA sequence.

property author_ids: List[str]¶: IDs of users to set as the DNA sequence’s authors.

property bases: str¶: Base pairs for 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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the DNA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence_bulk_create.T¶

get(key, default=None) → Optional[Any]¶

property is_circular: bool¶: Whether the DNA sequence is circular or linear.

property name: str¶: Name of the DNA sequence.

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 schema_id: str¶: ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the DNA sequence

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations to create on the DNA sequence.

property author_ids: List[str]¶: IDs of users to set as the DNA sequence’s authors.

property bases: str¶: Base pairs for the DNA sequence.

property custom_fields: CustomFields¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the DNA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence_bulk_update.T¶

property id: str¶

property is_circular: bool¶: Whether the DNA sequence is circular or linear.

property name: str¶: Name of the DNA sequence.

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 schema_id: str¶: ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the DNA sequence

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations to create on the DNA sequence.

property author_ids: List[str]¶: IDs of users to set as the DNA sequence’s authors.

property bases: str¶: Base pairs for 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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the DNA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence_create.T¶

property is_circular: bool¶: Whether the DNA sequence is circular or linear.

property name: str¶: Name of the DNA sequence.

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 schema_id: str¶: ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the DNA sequence

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶: Annotations to create on the DNA sequence.

property author_ids: List[str]¶: IDs of users to set as the DNA sequence’s authors.

property bases: str¶: Base pairs for the DNA sequence.

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the DNA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence_update.T¶

property is_circular: bool¶: Whether the DNA sequence is circular or linear.

property name: str¶: Name of the DNA sequence.

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 schema_id: str¶: ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the DNA sequence

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 author_ids: List[str]¶: IDs of users to set as the DNA sequence’s authors.

property bases: str¶: Base pairs for the DNA sequence.

property custom_fields: CustomFields¶

property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶

property folder_id: str¶: ID of the folder containing the DNA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence_upsert_request.T¶

get(key, default=None) → Optional[Any]¶

property is_circular: bool¶: Whether the DNA sequence is circular or linear.

property name: str¶

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¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property annotations: List[benchling_api_client.v2.stable.models.dna_annotation.DnaAnnotation]¶

property api_url: str¶: The canonical url of the DNA Sequence in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶

property created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶

property entity_type: benchling_api_client.v2.stable.models.dna_sequence_with_entity_type_entity_type.DnaSequenceWithEntityTypeEntityType¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequence_with_entity_type.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property is_circular: bool¶

property length: int¶

property modified_at: datetime¶

property name: str¶

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 registry_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶

property web_url: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_ids: List[str]¶

property dna_sequence_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequences_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property dna_sequence_ids: List[str]¶

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.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequences_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequences_bulk_update_request.T¶

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequences_bulk_upsert_request.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dna_sequences: List[DnaSequence]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequences_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property dna_sequence_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_sequences_unarchive.T¶

to_dict() → Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dna_template_alignment_create.T¶

property name: str¶

property template_sequence_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the dropdown

property name: str¶: Name of the dropdown

property options: List[benchling_api_client.v2.stable.models.dropdown_option.DropdownOption]¶: Array of dropdown options

to_dict() → Dict[str, Any]¶

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 name: str¶: Name of the dropdown

property options: List[benchling_api_client.v2.stable.models.dropdown_option_create.DropdownOptionCreate]¶: Options to set for the dropdown

property registry_id: Optional[str]¶: ID of registry in which to create the dropdown. Required if multiple registries exist.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_id: str¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_id: str¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_id: str¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.dropdown_multi_value_ui_block_type.DropdownMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_option_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_options_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property dropdown_option_ids: List[str]¶: Array of dropdown option IDs

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.

to_dict() → Dict[str, Any]¶

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.

property dropdown_option_ids: List[str]¶: Array of dropdown option IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_options_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdowns: List[DropdownSummary]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_summaries_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_summary.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the dropdown

property name: str¶: Name of the dropdown

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_id: str¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_id: str¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property dropdown_id: str¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.dropdown_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.dropdown_ui_block_type.DropdownUiBlockType¶

property value: Optional[str]¶

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

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Entity Schema was last modified

property name: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entity_schema_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property linked_resource: Optional[Union[LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

property subtype: SchemaDependencySubtypes¶

to_dict() → Dict[str, Any]¶

property type: EntitySchemaAppConfigItemType¶

property value: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property entity_schemas: List[EntitySchema]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entity_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property entry_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entries_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

class EntriesArchive¶

Bases: object

__init__(entry_ids: List[str], reason: EntriesArchiveReason) → None¶: Method generated by attrs for class EntriesArchive.

property entry_ids: List[str]¶: Array of entry IDs

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”].

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property entries: List[Entry]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entries_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class EntriesUnarchive¶

Bases: object

__init__(entry_ids: List[str]) → None¶: Method generated by attrs for class EntriesUnarchive.

property entry_ids: List[str]¶: Array of entry IDs

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entries_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the Entry in the API.

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 created_at: datetime¶: DateTime the entry was created at

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).

property display_id: str¶: User-friendly ID of the entry

property entry_template_id: Optional[str]¶: ID of the Entry Template this Entry was created from

property fields: Fields¶

property folder_id: str¶: ID of the folder that contains the entry

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entry.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the entry

property modified_at: str¶: DateTime the entry was last modified

property name: str¶: Title of the entry

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

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the entry

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 author_ids: Union[str, List[str], benchling_api_client.v2.extensions.UnknownType]¶

property custom_fields: CustomFields¶

property entry_template_id: str¶: ID of the template to clone the entry from

property fields: Fields¶

property folder_id: str¶: ID of the folder that will contain the entry

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.

property name: str¶: Name of the entry

property schema_id: str¶: ID of the entry’s schema

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property download_url: str¶: A short-lived URL that can be used to download the original file.

property expires_at: int¶: UNIX timestamp when downloadURL expires.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entry_external_file.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the external file

property size: int¶: Size, in bytes, of the external file

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property name: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property entry_schemas: List[EntrySchemaDetailed]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entry_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 api_url: str¶: The canonical url of the Entry Template in the API.

property created_at: datetime¶: DateTime the template was created at

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).

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entry_template.T¶

property id: str¶: ID of the entry template

property modified_at: str¶: DateTime the template was last modified

property name: str¶: Title of the template

property schema: Optional[benchling_api_client.v2.stable.models.entry_schema.EntrySchema]¶: Entry schema

property template_collection_id: str¶: ID of the collection that contains the template

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the template

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entry_templates_paginated_list.T¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property author_ids: str¶: IDs of users to set as the entry’s authors.

property fields: Fields¶

property folder_id: str¶: ID of the folder that will contain the entry

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.entry_update.T¶

property name: str¶: New name of the entry

property schema_id: str¶: ID of the schema for the entry

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.events_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class ExportItemRequest¶

Bases: object

__init__(id: str) → None¶: Method generated by attrs for class ExportItemRequest.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.export_item_request.T¶

property id: str¶: ID of the item to export

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property color: str¶: The color of the annotations generated by the feature. Must be a valid hex string

property feature_library_id: str¶: The id of the feature library the feature belongs to

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The id of the feature

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.

property name: str¶: The name of the feature

property pattern: str¶: The pattern used for matching during auto-annotation.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property color: str¶: The color of the annotations generated by the feature. Must be a valid hex string

property feature_library_id: str¶: The id of the feature library the feature belongs to

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¶

get(key, default=None) → Optional[Any]¶

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.

property name: str¶: The name of the feature

property pattern: str¶: The pattern used for matching during auto-annotation.

to_dict() → Dict[str, Any]¶

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_library_id: str¶: The id of the feature library the feature belongs to

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.

property name: str¶: The name of the feature

property pattern: str¶: The pattern used for matching during auto-annotation.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property feature_libraries: List[FeatureLibrary]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.feature_libraries_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property created_at: datetime¶: DateTime the Feature Library was created

property description: str¶: The description for the feature library

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.feature_library.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The id of the feature library

property modified_at: datetime¶: DateTime the Feature Library was last modified

property name: str¶: The name of the feature library

property owner: Union[Organization, benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.extensions.UnknownType]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: The Benchling web UI url to view the Feature Library

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.

property description: str¶: The description for the feature library

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.feature_library_create.T¶

property name: str¶: The name of the feature library

property organization_id: str¶: The organization that will own the feature library. The requesting user must be an administrator of the organization. If unspecified and the organization allows personal ownables, then the requesting user will own the feature library

to_dict() → Dict[str, Any]¶

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.

property description: str¶: The description for the feature library

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.feature_library_update.T¶

property name: str¶: The name of the feature library

to_dict() → Dict[str, Any]¶

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_library_id: str¶: The id of the feature library the feature belongs to

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_update.T¶

property name: str¶: The name of the feature

property pattern: str¶: The pattern used for matching during auto-annotation.

to_dict() → Dict[str, Any]¶

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]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.features_bulk_create_request.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property features: List[Feature]¶: List of features for the page

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.features_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property display_value: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.field.T¶

get(key, default=None) → Optional[Any]¶

property is_multi: bool¶

property text_value: Optional[str]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.field_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property linked_resource: Optional[Union[LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: FieldAppConfigItemType¶

property value: Optional[str]¶

class FieldAppConfigItemType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FIELD = 'field'¶

static of_unknown(val: str) → FieldAppConfigItemType¶

class Fields¶

Bases: object

__init__() → None¶: Method generated by attrs for class Fields.

property additional_keys: List[str]¶

additional_properties: Dict[str, Field]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.fields.T¶

get(key, default=None) → Optional[Field]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.float_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: FloatAppConfigItemType¶

property value: Optional[float]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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.folder.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property name: str¶

property parent_folder_id: Optional[str]¶: ID of the parent folder, if it exists

property project_id: str¶: ID of the containing project

to_dict() → Dict[str, Any]¶

class FolderCreate¶

Bases: object

__init__(name: str, parent_folder_id: str) → None¶: Method generated by attrs for class FolderCreate.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.folder_create.T¶

property name: str¶: The name of the new folder.

property parent_folder_id: str¶: The ID of the parent folder.

to_dict() → Dict[str, Any]¶

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.

property aa_sequence_ids: List[str]¶

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property custom_entity_ids: List[str]¶

property dna_sequence_ids: List[str]¶

property entry_ids: List[str]¶

property folder_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.folders_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property mixture_ids: List[str]¶

property oligo_ids: List[str]¶

property protocol_ids: List[str]¶

to_dict() → Dict[str, Any]¶

class FoldersArchive¶

Bases: object

__init__(folder_ids: List[str], reason: FoldersArchiveReason) → None¶: Method generated by attrs for class FoldersArchive.

property folder_ids: List[str]¶: A list of folder IDs to archive.

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.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property folders: List[Folder]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.folders_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class FoldersUnarchive¶

Bases: object

__init__(folder_ids: List[str]) → None¶: Method generated by attrs for class FoldersUnarchive.

property folder_ids: List[str]¶: A list of folder IDs to unarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.folders_unarchive.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property error: benchling_api_client.v2.stable.models.forbidden_error_error.ForbiddenErrorError¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.forbidden_error.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.generic_api_identified_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property linked_resource: Optional[Union[LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: GenericApiIdentifiedAppConfigItemType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.get_user_warehouse_logins_response_200.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 inaccessible_id: str¶

property resource_type: benchling_api_client.v2.stable.models.inaccessible_resource_resource_type.InaccessibleResourceResourceType¶

to_dict() → Dict[str, Any]¶

property type: str¶: The type of this inaccessible item. Example values: “custom_entity”, “container”, “plate”, “dna_sequence”

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.integer_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: IntegerAppConfigItemType¶

property value: Optional[int]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.json_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: JsonAppConfigItemType¶

property value: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the transform in the API.

property blob_id: Optional[str]¶

property custom_transform_id: Optional[str]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property input_generator_id: Optional[str]¶

property modified_at: datetime¶: DateTime the transform was last modified.

property output_processor_id: Optional[str]¶

property status: benchling_api_client.v2.stable.models.lab_automation_transform_status.LabAutomationTransformStatus¶

to_dict() → Dict[str, Any]¶

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 blob_id: str¶

property errors: List[benchling_api_client.v2.stable.models.lab_automation_benchling_app_error.LabAutomationBenchlingAppError]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.lab_automation_transform_update.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.label_template.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the label template.

property name: str¶: Name of the label template.

to_dict() → Dict[str, Any]¶

property zpl_template: str¶: The ZPL template that will be filled in and sent to a printer.

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.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.linked_app_config_resource_summary.T¶

property id: str¶: The API ID of the linked resource

property name: str¶: The name of the resource in Benchling

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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 barcode: str¶

property created_at: str¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.location.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: str¶

property name: str¶

property occupied_capacity: Optional[int]¶: The number of plates, boxes, and containers currently in this location. Null if totalCapacity is not set.

property parent_storage_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property total_capacity: Optional[int]¶: The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.

property web_url: str¶

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.

property barcode: str¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.location_create.T¶

property name: str¶

property parent_storage_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property name: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.location_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property location_schemas: List[LocationSchema]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.location_update.T¶

property name: str¶

property parent_storage_id: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property box_ids: List[str]¶

property container_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.locations_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property location_ids: List[str]¶

property plate_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 location_ids: List[str]¶: Array of location IDs

property reason: LocationsArchiveReason¶: Reason that locations are being archived.

property should_remove_barcodes: bool¶: Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.locations_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property locations: List[Location]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class LocationsUnarchive¶

Bases: object

__init__(location_ids: List[str]) → None¶: Method generated by attrs for class LocationsUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.locations_unarchive.T¶

property location_ids: List[str]¶: Array of location IDs

to_dict() → Dict[str, Any]¶

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 id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType¶

property value: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.markdown_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType¶

property value: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.markdown_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.markdown_ui_block_type.MarkdownUiBlockType¶

property value: str¶

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¶

property bases: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.match_bases_request.T¶

property next_token: str¶

property page_size: int¶

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¶

to_dict() → Dict[str, Any]¶

class Measurement¶

Bases: object

__init__(units: Optional[str], value: Optional[float]) → None¶: Method generated by attrs for class Measurement.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.measurement.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property units: Optional[str]¶: Can only be null if value is also null

property value: Optional[float]¶: Can only be null if units is also null

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property allow_measured_ingredients: bool¶: Derived from the mixture’s schema.

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 api_url: str¶: The canonical url of the Mixture in the API.

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 created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.mixture_creator.MixtureCreator¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.mixture.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property ingredients: List[benchling_api_client.v2.stable.models.ingredient.Ingredient]¶: List of ingredients on this mixture.

property modified_at: datetime¶

property name: str¶

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶

property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶

to_dict() → Dict[str, Any]¶

property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶

property web_url: str¶

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 aliases: List[str]¶: Aliases to add to the 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 author_ids: List[str]¶: IDs of users to set as the mixture’s authors.

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.mixture_bulk_update.T¶

property id: str¶

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 name: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the 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 author_ids: List[str]¶: IDs of users to set as the mixture’s authors.

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

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 name: str¶

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 schema_id: str¶

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the 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 author_ids: List[str]¶: IDs of users to set as the mixture’s authors.

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder that the entity is moved into

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 name: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property allow_measured_ingredients: bool¶: Derived from the mixture’s schema.

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 api_url: str¶: The canonical url of the Mixture in the API.

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 created_at: datetime¶

property creator: benchling_api_client.v2.stable.models.mixture_creator.MixtureCreator¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶

property entity_type: benchling_api_client.v2.stable.models.mixture_with_entity_type_entity_type.MixtureWithEntityTypeEntityType¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.mixture_with_entity_type.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property ingredients: List[benchling_api_client.v2.stable.models.ingredient.Ingredient]¶: List of ingredients on this mixture.

property modified_at: datetime¶

property name: str¶

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶

property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶

to_dict() → Dict[str, Any]¶

property units: benchling_api_client.v2.stable.models.mixture_measurement_units.MixtureMeasurementUnits¶

property web_url: str¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.mixtures_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property mixture_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 mixture_ids: List[str]¶

property reason: EntityArchiveReason¶: The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.mixtures_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property mixtures: List[Mixture]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class MixturesUnarchive¶

Bases: object

The request body for unarchiving mixtures.

__init__(mixture_ids: List[str]) → None¶: Method generated by attrs for class MixturesUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.mixtures_unarchive.T¶

property mixture_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Array of aliases.

property api_url: str¶: The canonical url of the Molecule in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property canonicalized_smiles: str¶: The canonicalized chemical structure in SMILES format.

property created_at: datetime¶: DateTime the Molecule was created.

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property custom_fields: CustomFields¶

property entity_registry_id: Optional[str]¶: Registry ID of the Molecule if registered.

property fields: Fields¶

property folder_id: str¶: ID of the folder that contains the Molecule.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecule.T¶

property id: str¶: ID of the Molecule.

property modified_at: datetime¶: DateTime the Molecule was last modified.

property name: str¶: Name of the Molecule.

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 registry_id: Optional[str]¶: Registry the Molecule is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the Molecule.

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 aliases: List[str]¶: Aliases to add to the Molecule.

property author_ids: List[str]¶: IDs of users to set as the Molecule’s authors.

property chemical_structure: benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure¶

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Molecule.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecule_bulk_update.T¶

property id: str¶

property name: str¶: Name of the Molecule.

property schema_id: str¶: ID of the Molecule’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the Molecule.

property author_ids: List[str]¶: IDs of users to set as the Molecule’s authors.

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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Molecule.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecule_create.T¶

property name: str¶: Name of the Molecule.

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 schema_id: str¶: ID of the Molecule’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the Molecule.

property author_ids: List[str]¶: IDs of users to set as the Molecule’s authors.

property chemical_structure: benchling_api_client.v2.stable.models.molecule_structure.MoleculeStructure¶

property custom_fields: CustomFields¶

property entity_registry_id: str¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Molecule.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecule_update.T¶

property name: str¶: Name of the Molecule.

property schema_id: str¶: ID of the Molecule’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the Molecule.

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 author_ids: List[str]¶: IDs of users to set as the Molecule’s authors.

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¶

property folder_id: str¶: ID of the folder containing the Molecule.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecule_upsert_request.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶

property registry_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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.

property batch_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecules_archival_change.T¶

property molecule_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 molecule_ids: List[str]¶

property reason: MoleculesArchiveReason¶: The reason for archiving the provided Molecules. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecules_paginated_list.T¶

property molecules: List[Molecule]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

class MoleculesUnarchive¶

Bases: object

The request body for unarchiving Molecules.

__init__(molecule_ids: List[str]) → None¶: Method generated by attrs for class MoleculesUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.molecules_unarchive.T¶

property molecule_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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, benchling_api_client.v2.stable.models.multiple_containers_transfer_source_concentration.MultipleContainersTransferSourceConcentration] = 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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property destination_container_id: str¶: ID of container that will be transferred into.

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¶

get(key, default=None) → Optional[Any]¶

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: benchling_api_client.v2.stable.models.multiple_containers_transfer_source_concentration.MultipleContainersTransferSourceConcentration¶: Concentration at which to transfer entities or batches. Not applicable for container-to-container transfers (the concentration of the source container’s contents will be used).

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.

to_dict() → Dict[str, Any]¶

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¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property error: benchling_api_client.v2.stable.models.not_found_error_error.NotFoundErrorError¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.not_found_error.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aligned_sequences: List[benchling_api_client.v2.stable.models.aligned_nucleotide_sequence.AlignedNucleotideSequence]¶

property api_url: str¶: The canonical url of the Alignment in the API.

property created_at: datetime¶: DateTime the Alignment was created

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.nucleotide_alignment.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Alignment was last modified

property name: str¶

property reference_sequence_id: str¶: The ID of the template or consensus Sequence associated with the Alignment

to_dict() → Dict[str, Any]¶

property web_url: str¶: The Benchling web UI url to view the Alignment

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the Alignment in the API.

property created_at: datetime¶: DateTime the Alignment was created

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.nucleotide_alignment_summary.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Alignment was last modified

property name: str¶

property reference_sequence_id: str¶: The ID of the template or consensus Sequence associated with the Alignment

to_dict() → Dict[str, Any]¶

property web_url: str¶: The Benchling web UI url to view the Alignment

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property alignments: List[NucleotideAlignmentSummary]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.nucleotide_alignments_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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 name: str¶

property new_sequence: benchling_api_client.v2.stable.models.nucleotide_consensus_alignment_create_new_sequence.NucleotideConsensusAlignmentCreateNewSequence¶

property sequence_id: str¶

to_dict() → Dict[str, Any]¶

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]]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.nucleotide_template_alignment_create.T¶

property name: str¶

property template_sequence_id: str¶

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the Oligo

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of the oligo.

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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.oligo_create.T¶

property name: str¶: Name of the Oligo.

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 schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the Oligo

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of the oligo.

property custom_fields: CustomFields¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.oligo_update.T¶

property name: str¶: Name of the Oligo.

property schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the Oligo

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 author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of the oligo.

property custom_fields: CustomFields¶

property fields: benchling_api_client.v2.stable.models.fields_with_resolution.FieldsWithResolution¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.oligo_upsert_request.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶

property registry_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.oligos_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property oligo_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 oligo_ids: List[str]¶

property reason: EntityArchiveReason¶: The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.oligos_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property oligos: List[Union[DnaOligo, RnaOligo, benchling_api_client.v2.extensions.UnknownType]]¶

to_dict() → Dict[str, Any]¶

class OligosUnarchive¶

Bases: object

The request body for unarchiving Oligos.

__init__(oligo_ids: List[str]) → None¶: Method generated by attrs for class OligosUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.oligos_unarchive.T¶

property oligo_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.organization.T¶

get(key, default=None) → Optional[Any]¶

property handle: str¶

property id: str¶

property name: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.organizations_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property organizations: List[Organization]¶

to_dict() → Dict[str, Any]¶

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 barcode: Optional[str]¶: Barcode of the plate

property created_at: datetime¶: DateTime the container was created

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plate.T¶

property id: str¶: ID of the plate

property modified_at: datetime¶: DateTime the plate was last modified

property name: str¶: Name of the plate, defaults to barcode if name is not provided.

property occupied_capacity: Optional[int]¶: The number of containers currently in a matrix plate. Null for well plates.

property parent_storage_id: Optional[str]¶: ID of containing parent inventory (e.g. loc_k2lNspzS).

property project_id: Optional[str]¶: ID of the project if set

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

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 web_url: str¶

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.

property barcode: str¶

property container_schema_id: str¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plate_create.T¶

property name: str¶

property parent_storage_id: str¶

property project_id: str¶

property schema_id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property height: float¶

property id: str¶

property name: str¶

property plate_type: str¶

property prefix: str¶

property registry_id: str¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.plate_schema_type.PlateSchemaType¶

property width: float¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plate_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property plate_schemas: List[PlateSchema]¶

to_dict() → Dict[str, Any]¶

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.

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plate_update.T¶

property name: str¶

property parent_storage_id: str¶

property project_id: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property container_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plates_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property plate_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 plate_ids: List[str]¶: Array of plate IDs

property reason: PlatesArchiveReason¶: Reason that plates are being archived.

property should_remove_barcodes: bool¶: Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plates_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property plates: List[Plate]¶

to_dict() → Dict[str, Any]¶

class PlatesUnarchive¶

Bases: object

__init__(plate_ids: List[str]) → None¶: Method generated by attrs for class PlatesUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.plates_unarchive.T¶

property plate_ids: List[str]¶: Array of plate IDs

to_dict() → Dict[str, Any]¶

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¶

property label_template_id: str¶: ID of label template to use (same template will be used for all labels printed).

property printer_id: str¶: ID of printer to use (same printer will be used for all labels printed).

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property address: str¶: Web address of the printer (either IP address or URL).

property description: Optional[str]¶: Short description of the printer.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.printer.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the printer.

property name: str¶: Name of the printer.

property port: Optional[int]¶: Port to reach the printer at.

property registry_id: str¶: ID of the registry associated with this printer.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property name: str¶

property owner: Union[Organization, benchling_api_client.v2.stable.models.user_summary.UserSummary, benchling_api_client.v2.extensions.UnknownType]¶

to_dict() → Dict[str, Any]¶

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.

property aa_sequence_ids: List[str]¶

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property custom_entity_ids: List[str]¶

property dna_sequence_ids: List[str]¶

property entry_ids: List[str]¶

property folder_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.projects_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property mixture_ids: List[str]¶

property oligo_ids: List[str]¶

property project_ids: List[str]¶

property protocol_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 project_ids: List[str]¶: A list of project IDs to archive.

property reason: ProjectsArchiveReason¶: The reason for archiving the provided projects. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.projects_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property projects: List[Project]¶

to_dict() → Dict[str, Any]¶

class ProjectsUnarchive¶

Bases: object

__init__(project_ids: List[str]) → None¶: Method generated by attrs for class ProjectsUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.projects_unarchive.T¶

property project_ids: List[str]¶: A list of project IDs to unarchive.

to_dict() → Dict[str, Any]¶

class RegisterEntities¶

Bases: object

__init__(entity_ids: List[str], naming_strategy: NamingStrategy) → None¶: Method generated by attrs for class RegisterEntities.

property entity_ids: List[str]¶: Array of entity IDs

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

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.registry.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Registry was last modified

property name: str¶

property owner: Organization¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶: The canonical url of the Request in the API.

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 created_at: str¶: Date and time the request was created

property creator: benchling_api_client.v2.stable.models.request_creator.RequestCreator¶

property display_id: str¶: User-friendly ID of the request

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: Unique ID for the request

property project_id: str¶: The ID of the project to which the request belongs.

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]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the request

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

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_create.T¶

property project_id: str¶: The ID of the project to which the request belongs.

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]¶

property scheduled_on: date¶: Date the request is scheduled to be executed on, in YYYY-MM-DD format.

property schema_id: str¶: ID of the request’s schema.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property created_at: datetime¶: Date and time the fulfillment was created

property entry_id: str¶: ID of the entry this fulfillment was executed in, if any

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_fulfillment.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the request fulfillment

property modified_at: datetime¶: DateTime the Request Fulfillment was last modified

property request_id: str¶: ID of the request this fulfillment fulfills

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

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_fulfillments_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property request_fulfillments: List[RequestFulfillment]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_response.T¶

get(key, default=None) → Optional[Any]¶

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.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Request Schema was last modified

property name: str¶

property organization: benchling_api_client.v2.stable.models.request_schema_organization.RequestSchemaOrganization¶: The organization that owns the schema.

property system_name: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property request_schemas: List[RequestSchema]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_task_base.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: ID of the request task

property sample_group_ids: List[str]¶: IDs of all request sample groups now associated with this task.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the Request Task Schema was last modified

property name: str¶

property organization: benchling_api_client.v2.stable.models.request_task_schema_organization.RequestTaskSchemaOrganization¶: The organization that owns the schema.

property system_name: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_task_schemas_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property request_task_schemas: List[RequestTaskSchema]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_tasks_bulk_create.T¶

get(key, default=None) → Optional[Any]¶

property sample_group_ids: List[str]¶: IDs of all request sample groups now associated with this task.

property schema_id: str¶: The schema id of the task to create

to_dict() → Dict[str, Any]¶

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

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_tasks_bulk_create_response.T¶

get(key, default=None) → Optional[Any]¶

property tasks: List[benchling_api_client.v2.stable.models.request_task.RequestTask]¶: The created tasks

to_dict() → Dict[str, Any]¶

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

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_tasks_bulk_update_response.T¶

get(key, default=None) → Optional[Any]¶

property tasks: List[benchling_api_client.v2.stable.models.request_task.RequestTask]¶: The tasks to update

to_dict() → Dict[str, Any]¶

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

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.request_update.T¶

property project_id: str¶: The ID of the project to which the request belongs.

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]¶

property scheduled_on: date¶: Date the request is scheduled to be executed on, in YYYY-MM-DD format.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.requests_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property requests: List[Request]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Array of aliases

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations on the Oligo.

property api_url: str¶

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶

property created_at: datetime¶: DateTime the Oligo was created.

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_registry_id: Optional[str]¶: Registry ID of the Oligo if registered.

property fields: Fields¶

property folder_id: Optional[str]¶: ID of the folder that contains the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligo.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property id: str¶: ID of the Oligo.

property length: int¶: Number of bases in the Oligo.

property modified_at: datetime¶: DateTime the Oligo was last modified.

property name: str¶: Name of the Oligo.

property nucleotide_type: str¶

property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶

property registry_id: Optional[str]¶: Registry the Oligo is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the Oligo.

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 aliases: List[str]¶: Aliases to add to the Oligo

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations on the Oligo.

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of 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 fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligo_bulk_update.T¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property id: str¶

property name: str¶: Name of the Oligo.

property schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the Oligo

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations on the Oligo.

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of 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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligo_create.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property name: str¶: Name of the Oligo.

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 schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the Oligo

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations on the Oligo.

property author_ids: List[str]¶: IDs of users to set as the Oligo’s authors.

property bases: str¶: Base pairs of 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 fields: Fields¶

property folder_id: str¶: ID of the folder containing the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligo_update.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property name: str¶: Name of the Oligo.

property schema_id: str¶: ID of the oligo’s schema.

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Array of aliases

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations on the Oligo.

property api_url: str¶: The canonical url of the Oligo in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶: Base pairs of the Oligo.

property created_at: datetime¶: DateTime the Oligo was created.

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_registry_id: Optional[str]¶: Registry ID of the Oligo if registered.

property entity_type: benchling_api_client.v2.stable.models.rna_oligo_with_entity_type_entity_type.RnaOligoWithEntityTypeEntityType¶

property fields: Fields¶

property folder_id: Optional[str]¶: ID of the folder that contains the Oligo.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligo_with_entity_type.T¶

get(key, default=None) → Optional[Any]¶

property helm: str¶: Representation of the oligo in HELM syntax, including any chemical modifications

property id: str¶: ID of the Oligo.

property length: int¶: Number of bases in the Oligo.

property modified_at: datetime¶: DateTime the Oligo was last modified.

property name: str¶: Name of the Oligo.

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 registry_id: Optional[str]¶: Registry the Oligo is registered in.

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the Oligo.

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property batch_ids: List[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligos_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property rna_oligo_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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.

property rna_oligo_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligos_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property rna_oligos: List[RnaOligo]¶

to_dict() → Dict[str, Any]¶

class RnaOligosUnarchive¶

Bases: object

The request body for unarchiving RNA Oligos.

__init__(rna_oligo_ids: List[str]) → None¶: Method generated by attrs for class RnaOligosUnarchive.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_oligos_unarchive.T¶

property rna_oligo_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶

property api_url: str¶: The canonical url of the RNA Sequence in the API.

property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶

property bases: str¶

property created_at: datetime¶

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.

property entity_registry_id: Optional[str]¶

property fields: Fields¶

property folder_id: Optional[str]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_sequence.T¶

get(key, default=None) → Optional[Any]¶

property helm: Optional[str]¶: Representation of the RNA Sequence in HELM syntax, including any chemical modifications.

property id: str¶

property is_circular: bool¶

property length: int¶

property modified_at: datetime¶

property name: str¶

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 registry_id: Optional[str]¶

property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶

to_dict() → Dict[str, Any]¶

property translations: List[benchling_api_client.v2.stable.models.translation.Translation]¶

property web_url: str¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property aliases: List[str]¶: Aliases to add to the RNA sequence

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations to create on the RNA sequence.

property author_ids: List[str]¶: IDs of users to set as the RNA sequence’s authors.

property bases: str¶: Base pairs for 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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the RNA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_sequence_bulk_create.T¶

get(key, default=None) → Optional[Any]¶

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 name: str¶: Name of the RNA sequence.

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 schema_id: str¶: ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the RNA sequence

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations to create on the RNA sequence.

property author_ids: List[str]¶: IDs of users to set as the RNA sequence’s authors.

property bases: str¶: Base pairs for 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 fields: Fields¶

property folder_id: str¶: ID of the folder containing the RNA sequence.

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 id: str¶

property is_circular: bool¶: Whether the RNA sequence is circular or linear. RNA sequences can only be linear

property name: str¶: Name of the RNA sequence.

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 schema_id: str¶: ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the RNA sequence

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations to create on the RNA sequence.

property author_ids: List[str]¶: IDs of users to set as the RNA sequence’s authors.

property bases: str¶: Base pairs for 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.

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the RNA sequence.

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 name: str¶: Name of the RNA sequence.

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 schema_id: str¶: ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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 aliases: List[str]¶: Aliases to add to the RNA sequence

property annotations: List[benchling_api_client.v2.stable.models.rna_annotation.RnaAnnotation]¶: Annotations to create on the RNA sequence.

property author_ids: List[str]¶: IDs of users to set as the RNA sequence’s authors.

property bases: str¶: Base pairs for 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¶

property fields: Fields¶

property folder_id: str¶: ID of the folder containing the RNA sequence.

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 name: str¶: Name of the RNA sequence.

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 schema_id: str¶: ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_sequences_archival_change.T¶

get(key, default=None) → Optional[Any]¶

property rna_sequence_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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.

property rna_sequence_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_sequences_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property rna_sequences: List[RnaSequence]¶

to_dict() → Dict[str, Any]¶

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.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.rna_sequences_unarchive.T¶

property rna_sequence_ids: List[str]¶

to_dict() → Dict[str, Any]¶

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]¶

to_dict() → Dict[str, Any]¶

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

__init__() → None¶: Method generated by attrs for class SchemaFieldsQueryParam.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.schema_fields_query_param.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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¶

property bases: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.search_bases_request.T¶

property next_token: str¶

property page_size: int¶

property registry_id: Optional[str]¶: ID of a registry. Restricts results to those registered in this registry. Specifying null returns unregistered items.

property schema_id: str¶: ID of the nucleotide sequence’s schema.

property sort: benchling_api_client.v2.stable.models.search_bases_request_sort.SearchBasesRequestSort¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.search_input_multi_value_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶

property label: Optional[str]¶

property schema_id: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶

property label: Optional[str]¶

property schema_id: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶

property label: Optional[str]¶

property schema_id: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.search_input_multi_value_ui_block_type.SearchInputMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.search_input_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶

property label: Optional[str]¶

property schema_id: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.search_input_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶

property label: Optional[str]¶

property schema_id: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.search_input_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property item_type: benchling_api_client.v2.stable.models.search_input_ui_block_item_type.SearchInputUiBlockItemType¶

property label: Optional[str]¶

property schema_id: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.search_input_ui_block_type.SearchInputUiBlockType¶

property value: Optional[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.secure_text_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: SecureTextAppConfigItemType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property options: List[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property options: List[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property options: List[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.selector_input_multi_value_ui_block_type.SelectorInputMultiValueUiBlockType¶

property value: Optional[List[str]]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.selector_input_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property options: List[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.selector_input_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property options: List[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.selector_input_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property options: List[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.selector_input_ui_block_type.SelectorInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.table_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property max_rows: int¶

property name: str¶: Display name for the table block, to be shown in the UI

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]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.table_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property max_rows: int¶

property name: str¶: Display name for the table block, to be shown in the UI

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]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.table_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property max_rows: int¶

property name: str¶: Display name for the table block, to be shown in the UI

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]¶

to_dict() → Dict[str, Any]¶

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, 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 Team.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.team.T¶

get(key, default=None) → Optional[Any]¶

property handle: str¶

property id: str¶

property name: str¶

property organization: benchling_api_client.v2.stable.models.organization_summary.OrganizationSummary¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.teams_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

property teams: List[Team]¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_url: str¶

property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶

property created_at: datetime¶: DateTime the app config item was created

property description: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.text_app_config_item.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property modified_at: datetime¶: DateTime the app config item was last modified

property path: List[str]¶: Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool¶

to_dict() → Dict[str, Any]¶

property type: TextAppConfigItemType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.text_input_ui_block.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property placeholder: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.text_input_ui_block_create.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property placeholder: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType¶

property value: Optional[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property enabled: Optional[bool]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.text_input_ui_block_update.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property label: Optional[str]¶

property placeholder: Optional[str]¶

to_dict() → Dict[str, Any]¶

property type: benchling_api_client.v2.stable.models.text_input_ui_block_type.TextInputUiBlockType¶

property value: Optional[str]¶

class UnregisterEntities¶

Bases: object

__init__(entity_ids: List[str], folder_id: str) → None¶: Method generated by attrs for class UnregisterEntities.

property entity_ids: List[str]¶: Array of entity IDs

property folder_id: str¶: ID of the folder that the entities should be moved to

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.unregister_entities.T¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property api_key_last_changed_at: Optional[str]¶

property email: str¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.user.T¶

get(key, default=None) → Optional[Any]¶

property handle: str¶

property id: str¶

property is_suspended: bool¶

property name: str¶

property password_last_changed_at: Optional[str]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.user_activity.T¶

get(key, default=None) → Optional[Any]¶

property last_seen: Optional[datetime]¶

to_dict() → Dict[str, Any]¶

property user_id: str¶

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¶

to_dict() → Dict[str, Any]¶

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.

property email: str¶: Email of the User

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.user_bulk_update.T¶

property handle: str¶: Handle of the User

property id: str¶

property is_suspended: bool¶: Suspended status of the User

property name: str¶: Name of the User

to_dict() → Dict[str, Any]¶

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¶

to_dict() → Dict[str, Any]¶

property users: List[UserBulkUpdate]¶

class UserCreate¶

Bases: object

__init__(email: str, handle: str, name: str) → None¶: Method generated by attrs for class UserCreate.

property email: str¶: Email of the User

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.user_create.T¶

property handle: str¶: Handle of the User

property name: str¶: Name of the User

to_dict() → Dict[str, Any]¶

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.

property email: str¶: Email of the User

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.user_update.T¶

property handle: str¶: Handle of the User

property is_suspended: bool¶: Suspended status of the User

property name: str¶: Name of the User

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.users_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

property users: List[User]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.warehouse_credentials.T¶

get(key, default=None) → Optional[Any]¶

property password: str¶: The password to connect to the warehouse.

to_dict() → Dict[str, Any]¶

property username: str¶: The username to connect to the warehouse.

class WarehouseCredentialsCreate¶

Bases: object

__init__(expires_in: int) → None¶: Method generated by attrs for class WarehouseCredentialsCreate.

property expires_in: int¶: Duration, in seconds, that credentials should be active for. Must be greater than 0 and less than 3600.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.warehouse_credentials_create.T¶

to_dict() → Dict[str, Any]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property created_at: str¶: The ISO formatted date and time that the output was created

property creation_origin: benchling_api_client.v2.stable.models.creation_origin.CreationOrigin¶

property display_id: str¶: User-friendly ID of the workflow task group

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_output.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The ID of the workflow output

property modified_at: str¶: The ISO formatted date and time that the output was last modified

property task: benchling_api_client.v2.stable.models.workflow_task_summary.WorkflowTaskSummary¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the workflow output

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_output_bulk_create.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_id: str¶: The ID of the workflow task this output belogns to

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_output_bulk_update.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_output_id: str¶: The ID of the workflow output

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_output_create.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_id: str¶: The ID of the workflow task this output belogns to

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_output_update.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_outputs_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_output_ids: List[str]¶

class WorkflowOutputsArchive¶

Bases: object

__init__(reason: WorkflowOutputArchiveReason, workflow_output_ids: List[str]) → None¶: Method generated by attrs for class WorkflowOutputsArchive.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_outputs_archive.T¶

get(key, default=None) → Optional[Any]¶

property reason: WorkflowOutputArchiveReason¶: The reason for archiving the provided workflow outputs. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

property workflow_output_ids: List[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_outputs_bulk_create_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_outputs_bulk_update_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_outputs_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

property workflow_outputs: List[WorkflowOutput]¶

class WorkflowOutputsUnarchive¶

Bases: object

__init__(workflow_output_ids: List[str]) → None¶: Method generated by attrs for class WorkflowOutputsUnarchive.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_outputs_unarchive.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_output_ids: List[str]¶

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, 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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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 created_at: str¶: The ISO formatted date and time that the task was created

property creation_origin: benchling_api_client.v2.stable.models.creation_origin.CreationOrigin¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property display_id: str¶: User-friendly ID of the workflow task

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

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The ID of the workflow task

property modified_at: str¶: The ISO formatted date and time that the task was last modified

property outputs: List[benchling_api_client.v2.stable.models.workflow_output_summary.WorkflowOutputSummary]¶

property scheduled_on: Optional[date]¶: The date on which the task is scheduled to be executed

property status: benchling_api_client.v2.stable.models.workflow_task_status.WorkflowTaskStatus¶

to_dict() → Dict[str, Any]¶

property web_url: str¶: URL of the workflow task

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assignee_id: str¶: The id of the user assigned to the task

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_bulk_create.T¶

get(key, default=None) → Optional[Any]¶

property scheduled_on: date¶: The date on which the task is scheduled to be executed

to_dict() → Dict[str, Any]¶

property workflow_task_group_id: str¶: The workflow ID

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assignee_id: str¶: The id of the user assigned to the task

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_bulk_update.T¶

get(key, default=None) → Optional[Any]¶

property scheduled_on: date¶: The date on which the task is scheduled to be executed

property status_id: str¶

to_dict() → Dict[str, Any]¶

property workflow_task_id: str¶: The workflow task ID

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assignee_id: str¶: The id of the user assigned to the task

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_create.T¶

get(key, default=None) → Optional[Any]¶

property scheduled_on: date¶: The date on which the task is scheduled to be executed

to_dict() → Dict[str, Any]¶

property workflow_task_group_id: str¶: The workflow ID

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property created_at: str¶: The ISO formatted date and time that the task group was created

property creation_origin: benchling_api_client.v2.stable.models.creation_origin.CreationOrigin¶

property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶

property display_id: str¶: User-friendly ID of the workflow task group

property execution_type: benchling_api_client.v2.stable.models.workflow_task_group_execution_type.WorkflowTaskGroupExecutionType¶: The method by which the workflow is executed

property folder: Folder¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_group.T¶

get(key, default=None) → Optional[Any]¶

property id: str¶: The ID of the workflow task group

property modified_at: str¶: The ISO formatted date and time that the task group was last modified

property name: str¶: The name of the workflow task group

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]¶

to_dict() → Dict[str, Any]¶

property watchers: List[benchling_api_client.v2.stable.models.user_summary.UserSummary]¶: The users watching the workflow task group

property web_url: str¶: URL of 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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property folder_id: str¶: ID of the folder that contains the workflow task group

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_group_create.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶: The name of the workflow task group

property schema_id: str¶: The workflow task schema of tasks in this task group

to_dict() → Dict[str, Any]¶

property watcher_ids: List[str]¶: IDs of the users watching the workflow task group

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property folder_id: str¶: ID of the folder that contains the workflow task group

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_group_update.T¶

get(key, default=None) → Optional[Any]¶

property name: str¶: The name of the workflow task group

to_dict() → Dict[str, Any]¶

property watcher_ids: List[str]¶: IDs of the users watching the workflow task group

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_groups_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_group_ids: List[str]¶

class WorkflowTaskGroupsArchive¶

Bases: object

__init__(reason: WorkflowTaskGroupArchiveReason, workflow_task_group_ids: List[str]) → None¶: Method generated by attrs for class WorkflowTaskGroupsArchive.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_groups_archive.T¶

get(key, default=None) → Optional[Any]¶

property reason: WorkflowTaskGroupArchiveReason¶: The reason for archiving the provided workflow task groups. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

property workflow_task_group_ids: List[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_groups_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_groups_unarchive.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_group_ids: List[str]¶

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 additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

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¶

get(key, default=None) → Optional[Any]¶

property id: str¶

property is_propagate_watchers_enabled: bool¶: Whether propagation of watchers has been enabled for this task schema.

property name: str¶

property prefix: str¶: The prefix for the displayId of tasks of this 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

to_dict() → Dict[str, Any]¶

property type: str¶

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 next_token: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

property assignee_id: str¶: The id of the user assigned to the task

property fields: Fields¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_task_update.T¶

get(key, default=None) → Optional[Any]¶

property scheduled_on: date¶: The date on which the task is scheduled to be executed

property status_id: str¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_archival_change.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_ids: List[str]¶

class WorkflowTasksArchive¶

Bases: object

__init__(reason: WorkflowTaskArchiveReason, workflow_task_ids: List[str]) → None¶: Method generated by attrs for class WorkflowTasksArchive.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_archive.T¶

get(key, default=None) → Optional[Any]¶

property reason: WorkflowTaskArchiveReason¶: The reason for archiving the provided workflow tasks. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]¶

property workflow_task_ids: List[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_bulk_copy_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_ids: List[str]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_bulk_create_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_bulk_update_request.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

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.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_paginated_list.T¶

get(key, default=None) → Optional[Any]¶

property next_token: str¶

to_dict() → Dict[str, Any]¶

property workflow_tasks: List[WorkflowTask]¶

class WorkflowTasksUnarchive¶

Bases: object

__init__(workflow_task_ids: List[str]) → None¶: Method generated by attrs for class WorkflowTasksUnarchive.

property additional_keys: List[str]¶

additional_properties: Dict[str, Any]¶

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.workflow_tasks_unarchive.T¶

get(key, default=None) → Optional[Any]¶

to_dict() → Dict[str, Any]¶

property workflow_task_ids: List[str]¶

Subpackages¶

benchling_sdk.models.webhooks package
- Subpackages
  - benchling_sdk.models.webhooks.v0 package

benchling_sdk.models package¶

Subpackages¶

Table of Contents

Versions