benchling_sdk.models package

class AIGGenerateInputAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, AutomationInputGenerator] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AIGGenerateInputAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.aig_generate_input_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: AutomationInputGenerator

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AOPProcessOutputAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessor] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AOPProcessOutputAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.aop_process_output_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: AutomationOutputProcessor

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AaAnnotation

Bases: object

__init__(color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].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, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class AaAnnotation.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property color: str

property end: int

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

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

property id: str

property name: str

property start: int

to_dict() → Dict[str, Any]

property type: str

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[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, 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, 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, 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, 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[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[ArchiveRecord]

property created_at: datetime

DateTime the AA sequence was created.

property creator: 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[RegistrationOrigin]

property registry_id: Optional[str]

Registry the AA sequence is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the protein.

class AaSequenceBaseRequest

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[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 AaSequenceBaseRequest.

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[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_base_request.T

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

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 AaSequenceBaseRequestForCreate

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[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 AaSequenceBaseRequestForCreate.

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[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_base_request_for_create.T

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

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 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[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[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[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[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[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[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 AaSequenceRequestRegistryFields

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default) → None

Method generated by attrs for class AaSequenceRequestRegistryFields.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: str

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

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

to_dict() → Dict[str, Any]

class AaSequenceSummary

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, AaSequenceSummaryEntityType] = attr_dict['_entity_type'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class AaSequenceSummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_type: AaSequenceSummaryEntityType

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

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

property id: str

to_dict() → Dict[str, Any]

property type: str

class AaSequenceSummaryEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'

static of_unknown(val: str) → AaSequenceSummaryEntityType

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[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[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 AaSequenceWithEntityType

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, 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[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, 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, 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, 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, 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[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[ArchiveRecord]

property created_at: datetime

DateTime the AA sequence was created.

property creator: UserSummary

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

Registry ID of the AA sequence if registered.

property 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[RegistrationOrigin]

property registry_id: Optional[str]

Registry the AA sequence is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the protein.

class AaSequenceWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'

static of_unknown(val: str) → AaSequenceWithEntityTypeEntityType

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 AaSequencesBulkGet

Bases: object

__init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequence]] = attr_dict['_aa_sequences'].default) → None

Method generated by attrs for class AaSequencesBulkGet.

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_bulk_get.T

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

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 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 AlignedNucleotideSequence

Bases: object

__init__(bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pairwise_identity: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_pairwise_identity'].default, sequence_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_sequence_id'].default, trim_end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_trim_end'].default, trim_start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_trim_start'].default) → None

Method generated by attrs for class AlignedNucleotideSequence.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property bases: str

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

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

property name: str

property pairwise_identity: float

Fraction of bases between trimStart and trimEnd that match the template bases. Only present for Template Alignments; Will be empty for Consensus Alignments.

property sequence_id: Optional[str]

to_dict() → Dict[str, Any]

property trim_end: int

property trim_start: int

class AlignedSequence

Bases: object

__init__(bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, dna_sequence_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_dna_sequence_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pairwise_identity: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_pairwise_identity'].default, trim_end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_trim_end'].default, trim_start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_trim_start'].default) → None

Method generated by attrs for class AlignedSequence.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property bases: str

property dna_sequence_id: Optional[str]

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

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

property name: str

property pairwise_identity: float

Fraction of bases between trimStart and trimEnd that match the template bases. Only present for Template Alignments; Will be empty for Consensus Alignments.

to_dict() → Dict[str, Any]

property trim_end: int

property trim_start: int

class AppConfigItemApiMixin

Bases: object

__init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, AppConfigItemApiMixinApp] = attr_dict['_app'].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, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class AppConfigItemApiMixin.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_api_mixin.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: str

Type of the app config item

class AppConfigItemApiMixinApp

Bases: object

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) → None

Method generated by attrs for class AppConfigItemApiMixinApp.

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_config_item_api_mixin_app.T

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

property id: str

The id of the Benchling app to which this configuration item belongs

to_dict() → Dict[str, Any]

class AppConfigItemBooleanBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemBooleanUpdateType, value: bool) → None

Method generated by attrs for class AppConfigItemBooleanBulkUpdate.

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_config_item_boolean_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemBooleanUpdateType

property value: bool

class AppConfigItemBooleanCreate

Bases: object

__init__(type: AppConfigItemBooleanCreateType, value: bool, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemBooleanCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemBooleanCreateType

property value: bool

class AppConfigItemBooleanCreateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOOLEAN = 'boolean'

static of_unknown(val: str) → AppConfigItemBooleanCreateType

class AppConfigItemBooleanUpdate

Bases: object

__init__(type: AppConfigItemBooleanUpdateType, value: bool) → None

Method generated by attrs for class AppConfigItemBooleanUpdate.

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_config_item_boolean_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemBooleanUpdateType

property value: bool

class AppConfigItemBooleanUpdateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOOLEAN = 'boolean'

static of_unknown(val: str) → AppConfigItemBooleanUpdateType

class AppConfigItemBulkUpdateMixin

Bases: object

__init__(id: str) → None

Method generated by attrs for class AppConfigItemBulkUpdateMixin.

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_config_item_bulk_update_mixin.T

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

property id: str

to_dict() → Dict[str, Any]

class AppConfigItemCreateMixin

Bases: object

__init__(app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemCreateMixin.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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]

class AppConfigItemDateBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemDateUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemDateBulkUpdate.

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_config_item_date_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemDateUpdateType

property value: str

class AppConfigItemDateCreate

Bases: object

__init__(type: AppConfigItemDateCreateType, value: date, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemDateCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemDateCreateType

property value: date

class AppConfigItemDateCreateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATE = 'date'

static of_unknown(val: str) → AppConfigItemDateCreateType

class AppConfigItemDateUpdate

Bases: object

__init__(type: AppConfigItemDateUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemDateUpdate.

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_config_item_date_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemDateUpdateType

property value: str

class AppConfigItemDateUpdateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATE = 'date'

static of_unknown(val: str) → AppConfigItemDateUpdateType

class AppConfigItemDatetimeBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemDatetimeUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemDatetimeBulkUpdate.

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_config_item_datetime_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemDatetimeUpdateType

property value: str

class AppConfigItemDatetimeCreate

Bases: object

__init__(type: AppConfigItemDatetimeCreateType, value: str, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemDatetimeCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemDatetimeCreateType

property value: str

class AppConfigItemDatetimeCreateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATETIME = 'datetime'

static of_unknown(val: str) → AppConfigItemDatetimeCreateType

class AppConfigItemDatetimeUpdate

Bases: object

__init__(type: AppConfigItemDatetimeUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemDatetimeUpdate.

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_config_item_datetime_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemDatetimeUpdateType

property value: str

class AppConfigItemDatetimeUpdateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATETIME = 'datetime'

static of_unknown(val: str) → AppConfigItemDatetimeUpdateType

class AppConfigItemFloatBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemFloatUpdateType, value: float) → None

Method generated by attrs for class AppConfigItemFloatBulkUpdate.

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_config_item_float_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemFloatUpdateType

property value: float

class AppConfigItemFloatCreate

Bases: object

__init__(type: AppConfigItemFloatCreateType, value: float, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemFloatCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemFloatCreateType

property value: float

class AppConfigItemFloatCreateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FLOAT = 'float'

static of_unknown(val: str) → AppConfigItemFloatCreateType

class AppConfigItemFloatUpdate

Bases: object

__init__(type: AppConfigItemFloatUpdateType, value: float) → None

Method generated by attrs for class AppConfigItemFloatUpdate.

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_config_item_float_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemFloatUpdateType

property value: float

class AppConfigItemFloatUpdateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FLOAT = 'float'

static of_unknown(val: str) → AppConfigItemFloatUpdateType

class AppConfigItemGenericBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemGenericUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemGenericBulkUpdate.

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_config_item_generic_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemGenericUpdateType

property value: str

class AppConfigItemGenericCreate

Bases: object

__init__(type: AppConfigItemGenericCreateType, value: str, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemGenericCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemGenericCreateType

property value: str

class AppConfigItemGenericCreateType

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'

DATE = 'date'

DATETIME = 'datetime'

DNA_OLIGO = 'dna_oligo'

DNA_SEQUENCE = 'dna_sequence'

DROPDOWN = 'dropdown'

DROPDOWN_OPTION = 'dropdown_option'

ENTITY_SCHEMA = 'entity_schema'

ENTRY = 'entry'

ENTRY_SCHEMA = 'entry_schema'

FIELD = 'field'

FOLDER = 'folder'

JSON = 'json'

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'

SECURE_TEXT = 'secure_text'

TEXT = 'text'

WORKFLOW_TASK_SCHEMA = 'workflow_task_schema'

WORKFLOW_TASK_STATUS = 'workflow_task_status'

WORKLIST = 'worklist'

static of_unknown(val: str) → AppConfigItemGenericCreateType

class AppConfigItemGenericUpdate

Bases: object

__init__(type: AppConfigItemGenericUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemGenericUpdate.

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_config_item_generic_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemGenericUpdateType

property value: str

class AppConfigItemGenericUpdateType

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'

DATE = 'date'

DATETIME = 'datetime'

DNA_OLIGO = 'dna_oligo'

DNA_SEQUENCE = 'dna_sequence'

DROPDOWN = 'dropdown'

DROPDOWN_OPTION = 'dropdown_option'

ENTITY_SCHEMA = 'entity_schema'

ENTRY = 'entry'

ENTRY_SCHEMA = 'entry_schema'

FIELD = 'field'

FOLDER = 'folder'

JSON = 'json'

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'

SECURE_TEXT = 'secure_text'

TEXT = 'text'

WORKFLOW_TASK_SCHEMA = 'workflow_task_schema'

WORKFLOW_TASK_STATUS = 'workflow_task_status'

WORKLIST = 'worklist'

static of_unknown(val: str) → AppConfigItemGenericUpdateType

class AppConfigItemIntegerBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemIntegerUpdateType, value: int) → None

Method generated by attrs for class AppConfigItemIntegerBulkUpdate.

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_config_item_integer_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemIntegerUpdateType

property value: int

class AppConfigItemIntegerCreate

Bases: object

__init__(type: AppConfigItemIntegerCreateType, value: int, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemIntegerCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemIntegerCreateType

property value: int

class AppConfigItemIntegerCreateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INTEGER = 'integer'

static of_unknown(val: str) → AppConfigItemIntegerCreateType

class AppConfigItemIntegerUpdate

Bases: object

__init__(type: AppConfigItemIntegerUpdateType, value: int) → None

Method generated by attrs for class AppConfigItemIntegerUpdate.

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_config_item_integer_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemIntegerUpdateType

property value: int

class AppConfigItemIntegerUpdateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INTEGER = 'integer'

static of_unknown(val: str) → AppConfigItemIntegerUpdateType

class AppConfigItemJsonBulkUpdate

Bases: object

__init__(id: str, type: AppConfigItemJsonUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemJsonBulkUpdate.

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_config_item_json_bulk_update.T

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

property id: str

to_dict() → Dict[str, Any]

property type: AppConfigItemJsonUpdateType

property value: str

class AppConfigItemJsonCreate

Bases: object

__init__(type: AppConfigItemJsonCreateType, value: str, app_id: str, path: List[str]) → None

Method generated by attrs for class AppConfigItemJsonCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property app_id: str

App id to which this config item belongs.

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

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

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: AppConfigItemJsonCreateType

property value: str

The value of a json create object should be json parseable.

class AppConfigItemJsonCreateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

JSON = 'json'

static of_unknown(val: str) → AppConfigItemJsonCreateType

class AppConfigItemJsonUpdate

Bases: object

__init__(type: AppConfigItemJsonUpdateType, value: str) → None

Method generated by attrs for class AppConfigItemJsonUpdate.

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_config_item_json_update.T

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

to_dict() → Dict[str, Any]

property type: AppConfigItemJsonUpdateType

property value: str

class AppConfigItemJsonUpdateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

JSON = 'json'

static of_unknown(val: str) → AppConfigItemJsonUpdateType

class AppConfigItemsBulkCreateRequest

Bases: object

__init__(app_configuration_items: List[Union[AppConfigItemGenericCreate, AppConfigItemBooleanCreate, AppConfigItemIntegerCreate, AppConfigItemFloatCreate, AppConfigItemDateCreate, AppConfigItemDatetimeCreate, 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[AppConfigItemGenericCreate, AppConfigItemBooleanCreate, AppConfigItemIntegerCreate, AppConfigItemFloatCreate, AppConfigItemDateCreate, AppConfigItemDatetimeCreate, 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[AppConfigItemGenericBulkUpdate, AppConfigItemBooleanBulkUpdate, AppConfigItemIntegerBulkUpdate, AppConfigItemFloatBulkUpdate, AppConfigItemDateBulkUpdate, AppConfigItemDatetimeBulkUpdate, 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[AppConfigItemGenericBulkUpdate, AppConfigItemBooleanBulkUpdate, AppConfigItemIntegerBulkUpdate, AppConfigItemFloatBulkUpdate, AppConfigItemDateBulkUpdate, AppConfigItemDatetimeBulkUpdate, 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[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[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 ArchiveRecord

Bases: object

__init__(reason: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_reason'].default) → None

Method generated by attrs for class ArchiveRecord.

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.archive_record.T

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

property reason: str

to_dict() → Dict[str, Any]

class AssayFieldsCreate

Bases: object

__init__() → None

Method generated by attrs for class AssayFieldsCreate.

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_fields_create.T

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

to_dict() → Dict[str, Any]

class AssayResult

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, 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, 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, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, 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[ArchiveRecord]

property created_at: datetime

DateTime at which the the result was created

property creator: UserSummary

property entry_id: Optional[str]

ID of the entry that this result is attached to

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

ID of the project to insert the result into

property schema: SchemaSummary

to_dict() → Dict[str, Any]

property validation_comment: str

property validation_status: str

class AssayResultCreate

Bases: object

__init__(fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, field_validation: Union[benchling_api_client.v2.types.Unset, 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: AssayResultCreateFieldValidation

Dictionary mapping field names to UserValidation Resources.

property fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]

Dictionary of result fields

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 AssayResultCreateFieldValidation

Bases: object

Dictionary mapping field names to UserValidation Resources.

__init__() → None

Method generated by attrs for class AssayResultCreateFieldValidation.

property additional_keys: List[str]

additional_properties: Dict[str, UserValidation]

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

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

to_dict() → Dict[str, Any]

class AssayResultFieldValidation

Bases: object

Object mapping field names to a UserValidation Resource object for that field. To set validation for a result, you must use this object.

__init__() → None

Method generated by attrs for class AssayResultFieldValidation.

property additional_keys: List[str]

additional_properties: Dict[str, UserValidation]

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

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

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, 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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property derived_from: Optional[str]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: BaseAssaySchemaOrganization

property system_name: str

to_dict() → Dict[str, Any]

property type: AssayResultSchemaType

class AssayResultSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RESULT = 'assay_result'

static of_unknown(val: str) → 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, 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: AssayResultsArchiveReason

The reason for archiving the provided results. Accepted reasons may differ based on tenant configuration

to_dict() → Dict[str, Any]

class AssayResultsArchiveReason

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) → AssayResultsArchiveReason

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 AssayResultsBulkGet

Bases: object

__init__(assay_results: Union[benchling_api_client.v2.types.Unset, List[AssayResult]] = attr_dict['_assay_results'].default) → None

Method generated by attrs for class AssayResultsBulkGet.

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_bulk_get.T

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

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, 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, 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, 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, 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[ArchiveRecord]

property created_at: str

property creator: 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[SchemaSummary]

to_dict() → Dict[str, Any]

property validation_comment: Optional[str]

property validation_status: AssayRunValidationStatus

Must be either VALID or INVALID

class AssayRunCreate

Bases: object

__init__(fields: Union[Fields, 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, 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, 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: AssayRunValidationStatus

Must be either VALID or INVALID

class AssayRunCreatedEvent

Bases: object

__init__(assay_run: Union[benchling_api_client.v2.types.Unset, AssayRun] = attr_dict['_assay_run'].default, event_type: Union[benchling_api_client.v2.types.Unset, AssayRunCreatedEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AssayRunCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run: AssayRun

property created_at: datetime

property deprecated: bool

property event_type: AssayRunCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AssayRunCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ASSAYRUNCREATED = 'v2.assayRun.created'

static of_unknown(val: str) → AssayRunCreatedEventEventType

class AssayRunNotePart

Bases: object

__init__(assay_run_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_assay_run_id'].default, assay_run_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, AssayRunNotePartType] = attr_dict['_type'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class AssayRunNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run_id: Optional[str]

property assay_run_schema_id: str

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

to_dict() → Dict[str, Any]

property type: AssayRunNotePartType

class AssayRunNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RUN = 'assay_run'

static of_unknown(val: str) → AssayRunNotePartType

class AssayRunSchema

Bases: object

__init__(automation_input_file_configs: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchemaAutomationInputFileConfigsItem]] = attr_dict['_automation_input_file_configs'].default, automation_output_file_configs: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property automation_input_file_configs: List[AssayRunSchemaAutomationInputFileConfigsItem]

property automation_output_file_configs: List[AssayRunSchemaAutomationOutputFileConfigsItem]

property derived_from: Optional[str]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: BaseAssaySchemaOrganization

property system_name: str

to_dict() → Dict[str, Any]

property type: AssayRunSchemaType

class AssayRunSchemaAutomationInputFileConfigsItem

Bases: object

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AssayRunSchemaAutomationInputFileConfigsItem.

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_run_schema_automation_input_file_configs_item.T

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

property name: str

to_dict() → Dict[str, Any]

class AssayRunSchemaAutomationOutputFileConfigsItem

Bases: object

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AssayRunSchemaAutomationOutputFileConfigsItem.

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_run_schema_automation_output_file_configs_item.T

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

property name: str

to_dict() → Dict[str, Any]

class AssayRunSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RUN = 'assay_run'

static of_unknown(val: str) → 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 AssayRunUpdatedFieldsEvent

Bases: object

__init__(assay_run: Union[benchling_api_client.v2.types.Unset, AssayRun] = attr_dict['_assay_run'].default, event_type: Union[benchling_api_client.v2.types.Unset, AssayRunUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AssayRunUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run: AssayRun

property created_at: datetime

property deprecated: bool

property event_type: AssayRunUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class AssayRunUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ASSAYRUNUPDATEDFIELDS = 'v2.assayRun.updated.fields'

static of_unknown(val: str) → AssayRunUpdatedFieldsEventEventType

class AssayRunValidationStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID = 'INVALID'

VALID = 'VALID'

static of_unknown(val: str) → AssayRunValidationStatus

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 AssayRunsBulkGet

Bases: object

__init__(assay_runs: Union[benchling_api_client.v2.types.Unset, List[AssayRun]] = attr_dict['_assay_runs'].default) → None

Method generated by attrs for class AssayRunsBulkGet.

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_bulk_get.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, 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, 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: 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: 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 AsyncTaskErrors

Bases: object

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

__init__() → None

Method generated by attrs for class AsyncTaskErrors.

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_errors.T

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

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 AsyncTaskResponse

Bases: object

Present only when status is SUCCEEDED. response can be empty if there is no data to be returned.

__init__() → None

Method generated by attrs for class AsyncTaskResponse.

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_response.T

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

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 AutofillPartsAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Optional[benchling_api_client.v2.types.Unset] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AutofillPartsAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.autofill_parts_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: None

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AutofillRnaSequences

Bases: object

__init__(rna_sequence_ids: List[str]) → None

Method generated by attrs for class AutofillRnaSequences.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.autofill_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 AutofillTranslationsAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Optional[benchling_api_client.v2.types.Unset] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AutofillTranslationsAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.autofill_translations_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: None

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AutomationFile

Bases: object

__init__(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, AutomationFileAutomationFileConfig] = attr_dict['_automation_file_config'].default, file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_file'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, status: Union[benchling_api_client.v2.types.Unset, AutomationFileStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class AutomationFile.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run_id: str

property automation_file_config: AutomationFileAutomationFileConfig

property file: Optional[Blob]

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

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

property id: str

property status: AutomationFileStatus

to_dict() → Dict[str, Any]

class AutomationFileAutomationFileConfig

Bases: object

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AutomationFileAutomationFileConfig.

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.automation_file_automation_file_config.T

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

property name: str

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 AutomationFileStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FAILED = 'FAILED'

NOT_STARTED = 'NOT_STARTED'

RUNNING = 'RUNNING'

SUCCEEDED = 'SUCCEEDED'

static of_unknown(val: str) → AutomationFileStatus

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, 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, 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, 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: 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: AutomationFileStatus

to_dict() → Dict[str, Any]

class AutomationInputGeneratorCompletedV2BetaEvent

Bases: object

__init__(automation_input_generator: Union[benchling_api_client.v2.types.Unset, AutomationFile] = attr_dict['_automation_input_generator'].default, event_type: Union[benchling_api_client.v2.types.Unset, AutomationInputGeneratorCompletedV2BetaEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AutomationInputGeneratorCompletedV2BetaEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_input_generator: AutomationFile

property created_at: datetime

property deprecated: bool

property event_type: AutomationInputGeneratorCompletedV2BetaEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AutomationInputGeneratorCompletedV2BetaEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_BETAAUTOMATIONINPUTGENERATORCOMPLETED = 'v2-beta.automationInputGenerator.completed'

static of_unknown(val: str) → AutomationInputGeneratorCompletedV2BetaEventEventType

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, 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, AutomationProgressStats] = attr_dict['_progress_stats'].default, transforms: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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: ArchiveRecord

property assay_run_id: str

property 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: AutomationProgressStats

Processing progress information.

property status: AutomationFileStatus

to_dict() → Dict[str, Any]

property transforms: List[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 AutomationOutputProcessorCompletedV2BetaEvent

Bases: object

__init__(automation_output_processor: Union[benchling_api_client.v2.types.Unset, AutomationFile] = attr_dict['_automation_output_processor'].default, event_type: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessorCompletedV2BetaEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AutomationOutputProcessorCompletedV2BetaEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_output_processor: AutomationFile

property created_at: datetime

property deprecated: bool

property event_type: AutomationOutputProcessorCompletedV2BetaEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AutomationOutputProcessorCompletedV2BetaEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_BETAAUTOMATIONOUTPUTPROCESSORCOMPLETED = 'v2-beta.automationOutputProcessor.completed'

static of_unknown(val: str) → AutomationOutputProcessorCompletedV2BetaEventEventType

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 AutomationOutputProcessorUploadedV2BetaEvent

Bases: object

__init__(automation_output_processor: Union[benchling_api_client.v2.types.Unset, AutomationFile] = attr_dict['_automation_output_processor'].default, event_type: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessorUploadedV2BetaEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AutomationOutputProcessorUploadedV2BetaEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_output_processor: AutomationFile

property created_at: datetime

property deprecated: bool

property event_type: AutomationOutputProcessorUploadedV2BetaEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AutomationOutputProcessorUploadedV2BetaEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_BETAAUTOMATIONOUTPUTPROCESSORUPLOADED = 'v2-beta.automationOutputProcessor.uploaded'

static of_unknown(val: str) → AutomationOutputProcessorUploadedV2BetaEventEventType

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 AutomationProgressStats

Bases: object

Processing progress information.

__init__(rows_failed: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_rows_failed'].default, rows_succeeded: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_rows_succeeded'].default, rows_unprocessed: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_rows_unprocessed'].default) → None

Method generated by attrs for class AutomationProgressStats.

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.automation_progress_stats.T

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

property rows_failed: int

property rows_succeeded: int

property rows_unprocessed: int

to_dict() → Dict[str, Any]

class BadRequestError

Bases: object

__init__(error: Union[benchling_api_client.v2.types.Unset, 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: 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[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[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 BadRequestErrorBulkErrorErrorsItem

Bases: object

__init__(index: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_index'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BadRequestErrorBulkErrorErrorsItem.

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.bad_request_error_bulk_error_errors_item.T

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

property index: float

property message: str

to_dict() → Dict[str, Any]

class BadRequestErrorError

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, BadRequestErrorErrorType] = attr_dict['_type'].default) → None

Method generated by attrs for class BadRequestErrorError.

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.bad_request_error_error.T

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

to_dict() → Dict[str, Any]

property type: BadRequestErrorErrorType

class BadRequestErrorErrorType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID_REQUEST_ERROR = 'invalid_request_error'

static of_unknown(val: str) → BadRequestErrorErrorType

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 BarcodeValidationResults

Bases: object

__init__(validation_results: Union[benchling_api_client.v2.types.Unset, List[BarcodeValidationResult]] = attr_dict['_validation_results'].default) → None

Method generated by attrs for class BarcodeValidationResults.

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.barcode_validation_results.T

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

to_dict() → Dict[str, Any]

property validation_results: List[BarcodeValidationResult]

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 BaseAppConfigItem

Bases: object

__init__(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, AppConfigItemApiMixinApp] = attr_dict['_app'].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, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class BaseAppConfigItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

property description: str

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.base_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: str

Type of the app config item

class BaseAssaySchema

Bases: object

__init__(derived_from: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_derived_from'].default, organization: Union[benchling_api_client.v2.types.Unset, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 BaseAssaySchema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property derived_from: Optional[str]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]

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

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

property id: str

property name: str

property organization: BaseAssaySchemaOrganization

property system_name: str

to_dict() → Dict[str, Any]

property type: str

class BaseAssaySchemaOrganization

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

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.base_assay_schema_organization.T

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

property handle: str

property id: str

property name: str

to_dict() → Dict[str, Any]

class BaseError

Bases: object

__init__(message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default, user_message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_message'].default) → None

Method generated by attrs for class BaseError.

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.base_error.T

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

property message: str

to_dict() → Dict[str, Any]

property type: str

property user_message: str

class BaseNotePart

Bases: object

__init__(indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class BaseNotePart.

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.base_note_part.T

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

to_dict() → Dict[str, Any]

property type: str

The type of the note. Type determines what other fields are present.

class Batch

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, UserSummary] = attr_dict['_creator'].default, default_concentration: Union[benchling_api_client.v2.types.Unset, Measurement] = attr_dict['_default_concentration'].default, entity: Union[benchling_api_client.v2.types.Unset, DnaSequenceSummary, AaSequenceSummary, CustomEntitySummary, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_entity'].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, schema: Union[benchling_api_client.v2.types.Unset, None, 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 Batch.

property archive_record: Optional[ArchiveRecord]

property created_at: datetime

DateTime at which the the result was created

property creator: UserSummary

property default_concentration: Measurement

property entity: Union[DnaSequenceSummary, AaSequenceSummary, CustomEntitySummary, benchling_api_client.v2.extensions.UnknownType]

property fields: Fields

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

property id: str

property modified_at: datetime

property name: str

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

class BatchCreate

Bases: object

__init__(default_concentration: Union[benchling_api_client.v2.types.Unset, DefaultConcentrationSummary] = attr_dict['_default_concentration'].default, entity_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) → None

Method generated by attrs for class BatchCreate.

property default_concentration: DefaultConcentrationSummary

property entity_id: str

API identifier for the entity that the batch will be added to.

property fields: Fields

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.batch_create.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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property entity_schema_id: str

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 BatchSchemasList

Bases: object

__init__(batch_schemas: Union[benchling_api_client.v2.types.Unset, List[BatchSchema]] = attr_dict['_batch_schemas'].default) → None

Method generated by attrs for class BatchSchemasList.

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_list.T

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

to_dict() → Dict[str, Any]

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 BatchUpdate

Bases: object

__init__(default_concentration: Union[benchling_api_client.v2.types.Unset, DefaultConcentrationSummary] = attr_dict['_default_concentration'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) → None

Method generated by attrs for class BatchUpdate.

property default_concentration: DefaultConcentrationSummary

property fields: Fields

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

to_dict() → Dict[str, Any]

class BatchesArchivalChange

Bases: object

IDs of all batches that were archived / unarchived, grouped by resource type.

__init__(batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default) → None

Method generated by attrs for class BatchesArchivalChange.

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.batches_archival_change.T

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

to_dict() → Dict[str, Any]

class BatchesArchive

Bases: object

The request body for archiving Batches.

__init__(batch_ids: List[str], reason: BatchesArchiveReason) → None

Method generated by attrs for class BatchesArchive.

property batch_ids: List[str]

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

property reason: BatchesArchiveReason

The reason for archiving the provided Batches. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]

class BatchesArchiveReason

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) → BatchesArchiveReason

class BatchesBulkGet

Bases: object

__init__(batches: Union[benchling_api_client.v2.types.Unset, List[Batch]] = attr_dict['_batches'].default) → None

Method generated by attrs for class BatchesBulkGet.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batches: List[Batch]

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

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

to_dict() → Dict[str, Any]

class BatchesPaginatedList

Bases: object

__init__(batches: Union[benchling_api_client.v2.types.Unset, List[Batch]] = attr_dict['_batches'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class BatchesPaginatedList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batches: List[Batch]

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

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

property next_token: str

to_dict() → Dict[str, Any]

class BatchesUnarchive

Bases: object

The request body for unarchiving Batches.

__init__(batch_ids: List[str]) → None

Method generated by attrs for class BatchesUnarchive.

property batch_ids: List[str]

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

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, archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, 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 archive_record: Optional[ArchiveRecord]

property created_at: datetime

DateTime at which the the app was created

property creator: 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, BlobType] = attr_dict['_type'].default, upload_status: Union[benchling_api_client.v2.types.Unset, 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: BlobType

One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.

property 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 BlobType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

RAW_FILE = 'RAW_FILE'

VISUALIZATION = 'VISUALIZATION'

static of_unknown(val: str) → BlobType

class BlobUploadStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ABORTED = 'ABORTED'

COMPLETE = 'COMPLETE'

IN_PROGRESS = 'IN_PROGRESS'

static of_unknown(val: str) → BlobUploadStatus

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 BlobsBulkGet

Bases: object

__init__(blobs: Union[benchling_api_client.v2.types.Unset, List[Blob]] = attr_dict['_blobs'].default) → None

Method generated by attrs for class BlobsBulkGet.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property blobs: List[Blob]

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.blobs_bulk_get.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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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, ArchiveRecord] = attr_dict['_archive_record'].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, 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, 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, SchemaSummary] = attr_dict['_schema'].default, size: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_size'].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[ArchiveRecord]

property barcode: Optional[str]

property created_at: datetime

property creator: 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 parent_storage_id: Optional[str]

property project_id: Optional[str]

property schema: Optional[SchemaSummary]

property size: int

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

to_dict() → Dict[str, Any]

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 BoxCreationTableNotePart

Bases: object

__init__(box_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_box_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, BoxCreationTableNotePartType] = attr_dict['_type'].default, api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class BoxCreationTableNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property box_schema_id: str

property columns: List[StructuredTableColumnInfo]

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

to_dict() → Dict[str, Any]

property type: BoxCreationTableNotePartType

class BoxCreationTableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOX_CREATION_TABLE = 'box_creation_table'

static of_unknown(val: str) → BoxCreationTableNotePartType

class BoxSchema

Bases: object

__init__(container_schema: Union[benchling_api_client.v2.types.Unset, None, 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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property container_schema: Optional[BoxSchemaContainerSchema]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: BoxSchemaType

property width: float

class BoxSchemaContainerSchema

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

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.box_schema_container_schema.T

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class BoxSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOX = 'box'

static of_unknown(val: str) → BoxSchemaType

class BoxSchemasList

Bases: object

__init__(box_schemas: Union[benchling_api_client.v2.types.Unset, List[BoxSchema]] = attr_dict['_box_schemas'].default) → None

Method generated by attrs for class BoxSchemasList.

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_list.T

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

to_dict() → Dict[str, Any]

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__(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 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 storage 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 BoxesBulkGet

Bases: object

__init__(boxes: Union[benchling_api_client.v2.types.Unset, List[Box]] = attr_dict['_boxes'].default) → None

Method generated by attrs for class BoxesBulkGet.

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_bulk_get.T

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

to_dict() → Dict[str, Any]

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 BulkCreateAaSequencesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateAaSequencesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateAaSequencesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_aa_sequences_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: BulkCreateAaSequencesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateAaSequencesAsyncTaskResponse

Bases: object

__init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequence]] = attr_dict['_aa_sequences'].default) → None

Method generated by attrs for class BulkCreateAaSequencesAsyncTaskResponse.

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.bulk_create_aa_sequences_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkCreateContainersAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateContainersAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateContainersAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_containers_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: BulkCreateContainersAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateContainersAsyncTaskResponse

Bases: object

__init__(containers: Union[benchling_api_client.v2.types.Unset, List[Container]] = attr_dict['_containers'].default) → None

Method generated by attrs for class BulkCreateContainersAsyncTaskResponse.

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.bulk_create_containers_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkCreateCustomEntitiesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateCustomEntitiesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateCustomEntitiesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_custom_entities_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: BulkCreateCustomEntitiesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateCustomEntitiesAsyncTaskResponse

Bases: object

__init__(custom_entities: Union[benchling_api_client.v2.types.Unset, List[CustomEntity]] = attr_dict['_custom_entities'].default) → None

Method generated by attrs for class BulkCreateCustomEntitiesAsyncTaskResponse.

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.bulk_create_custom_entities_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkCreateDnaOligosAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateDnaOligosAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateDnaOligosAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_dna_oligos_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: BulkCreateDnaOligosAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateDnaOligosAsyncTaskResponse

Bases: object

__init__(dna_oligos: Union[benchling_api_client.v2.types.Unset, List[DnaOligo]] = attr_dict['_dna_oligos'].default) → None

Method generated by attrs for class BulkCreateDnaOligosAsyncTaskResponse.

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.bulk_create_dna_oligos_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkCreateDnaSequencesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateDnaSequencesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateDnaSequencesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_dna_sequences_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: BulkCreateDnaSequencesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateDnaSequencesAsyncTaskResponse

Bases: object

__init__(dna_sequences: Union[benchling_api_client.v2.types.Unset, List[DnaSequence]] = attr_dict['_dna_sequences'].default) → None

Method generated by attrs for class BulkCreateDnaSequencesAsyncTaskResponse.

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.bulk_create_dna_sequences_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkCreateFeaturesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateFeaturesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateFeaturesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_features_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: BulkCreateFeaturesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateFeaturesAsyncTaskResponse

Bases: object

__init__(features: Union[benchling_api_client.v2.types.Unset, List[Feature]] = attr_dict['_features'].default) → None

Method generated by attrs for class BulkCreateFeaturesAsyncTaskResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property features: List[Feature]

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

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

to_dict() → Dict[str, Any]

class BulkCreateRnaOligosAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateRnaOligosAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateRnaOligosAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_rna_oligos_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: BulkCreateRnaOligosAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateRnaOligosAsyncTaskResponse

Bases: object

__init__(rna_oligos: Union[benchling_api_client.v2.types.Unset, List[RnaOligo]] = attr_dict['_rna_oligos'].default) → None

Method generated by attrs for class BulkCreateRnaOligosAsyncTaskResponse.

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.bulk_create_rna_oligos_async_task_response.T

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

property rna_oligos: List[RnaOligo]

to_dict() → Dict[str, Any]

class BulkCreateRnaSequencesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkCreateRnaSequencesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkCreateRnaSequencesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_create_rna_sequences_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: BulkCreateRnaSequencesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkCreateRnaSequencesAsyncTaskResponse

Bases: object

__init__(rna_sequences: Union[benchling_api_client.v2.types.Unset, List[RnaSequence]] = attr_dict['_rna_sequences'].default) → None

Method generated by attrs for class BulkCreateRnaSequencesAsyncTaskResponse.

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.bulk_create_rna_sequences_async_task_response.T

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

property rna_sequences: List[RnaSequence]

to_dict() → Dict[str, Any]

class BulkRegisterEntitiesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Optional[benchling_api_client.v2.types.Unset] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkRegisterEntitiesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_register_entities_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: None

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateAaSequencesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateAaSequencesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateAaSequencesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_aa_sequences_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: BulkUpdateAaSequencesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateAaSequencesAsyncTaskResponse

Bases: object

__init__(as_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequence]] = attr_dict['_as_sequences'].default) → None

Method generated by attrs for class BulkUpdateAaSequencesAsyncTaskResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property as_sequences: List[AaSequence]

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

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

to_dict() → Dict[str, Any]

class BulkUpdateContainersAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateContainersAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateContainersAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_containers_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: BulkUpdateContainersAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateContainersAsyncTaskResponse

Bases: object

__init__(containers: Union[benchling_api_client.v2.types.Unset, List[Container]] = attr_dict['_containers'].default) → None

Method generated by attrs for class BulkUpdateContainersAsyncTaskResponse.

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.bulk_update_containers_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkUpdateCustomEntitiesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateCustomEntitiesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateCustomEntitiesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_custom_entities_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: BulkUpdateCustomEntitiesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateCustomEntitiesAsyncTaskResponse

Bases: object

__init__(custom_entities: Union[benchling_api_client.v2.types.Unset, List[CustomEntity]] = attr_dict['_custom_entities'].default) → None

Method generated by attrs for class BulkUpdateCustomEntitiesAsyncTaskResponse.

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.bulk_update_custom_entities_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkUpdateDnaOligosAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateDnaOligosAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateDnaOligosAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_dna_oligos_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: BulkUpdateDnaOligosAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateDnaOligosAsyncTaskResponse

Bases: object

__init__(dna_oligos: Union[benchling_api_client.v2.types.Unset, List[DnaOligo]] = attr_dict['_dna_oligos'].default) → None

Method generated by attrs for class BulkUpdateDnaOligosAsyncTaskResponse.

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.bulk_update_dna_oligos_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkUpdateDnaSequencesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateDnaSequencesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateDnaSequencesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_dna_sequences_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: BulkUpdateDnaSequencesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateDnaSequencesAsyncTaskResponse

Bases: object

__init__(dna_sequences: Union[benchling_api_client.v2.types.Unset, List[DnaSequence]] = attr_dict['_dna_sequences'].default) → None

Method generated by attrs for class BulkUpdateDnaSequencesAsyncTaskResponse.

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.bulk_update_dna_sequences_async_task_response.T

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

to_dict() → Dict[str, Any]

class BulkUpdateRnaOligosAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateRnaOligosAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateRnaOligosAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_rna_oligos_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: BulkUpdateRnaOligosAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateRnaOligosAsyncTaskResponse

Bases: object

__init__(rna_oligos: Union[benchling_api_client.v2.types.Unset, List[RnaOligo]] = attr_dict['_rna_oligos'].default) → None

Method generated by attrs for class BulkUpdateRnaOligosAsyncTaskResponse.

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.bulk_update_rna_oligos_async_task_response.T

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

property rna_oligos: List[RnaOligo]

to_dict() → Dict[str, Any]

class BulkUpdateRnaSequencesAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, BulkUpdateRnaSequencesAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class BulkUpdateRnaSequencesAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.bulk_update_rna_sequences_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: BulkUpdateRnaSequencesAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class BulkUpdateRnaSequencesAsyncTaskResponse

Bases: object

__init__(rna_sequences: Union[benchling_api_client.v2.types.Unset, List[RnaSequence]] = attr_dict['_rna_sequences'].default) → None

Method generated by attrs for class BulkUpdateRnaSequencesAsyncTaskResponse.

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.bulk_update_rna_sequences_async_task_response.T

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

property rna_sequences: List[RnaSequence]

to_dict() → Dict[str, Any]

class CheckboxNotePart

Bases: object

One “line” of a checklist

__init__(checked: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_checked'].default, links: Union[benchling_api_client.v2.types.Unset, List[EntryLink]] = attr_dict['_links'].default, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default, type: Union[benchling_api_client.v2.types.Unset, CheckboxNotePartType] = attr_dict['_type'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class CheckboxNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property checked: bool

Indicates whether the checkbox is checked or not.

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

property links: List[EntryLink]

Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note.

property text: str

The textual contents of the note.

to_dict() → Dict[str, Any]

property type: CheckboxNotePartType

class CheckboxNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

LIST_CHECKBOX = 'list_checkbox'

static of_unknown(val: str) → CheckboxNotePartType

class CheckoutRecord

Bases: object

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

__init__(assignee: Union[benchling_api_client.v2.types.Unset, None, UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_assignee'].default, comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_comment'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, status: Union[benchling_api_client.v2.types.Unset, CheckoutRecordStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class CheckoutRecord.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assignee: Optional[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]

property comment: str

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

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

property modified_at: datetime

property status: CheckoutRecordStatus

to_dict() → Dict[str, Any]

class CheckoutRecordStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AVAILABLE = 'AVAILABLE'

CHECKED_OUT = 'CHECKED_OUT'

RESERVED = 'RESERVED'

static of_unknown(val: str) → CheckoutRecordStatus

class ConflictError

Bases: object

__init__(error: Union[benchling_api_client.v2.types.Unset, 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: 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 ConflictErrorError

Bases: object

__init__(conflicts: Union[benchling_api_client.v2.types.Unset, List[ConflictErrorErrorConflictsItem]] = attr_dict['_conflicts'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default, user_message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_message'].default) → None

Method generated by attrs for class ConflictErrorError.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property conflicts: List[ConflictErrorErrorConflictsItem]

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

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

property message: str

to_dict() → Dict[str, Any]

property type: str

property user_message: str

class ConflictErrorErrorConflictsItem

Bases: object

__init__() → None

Method generated by attrs for class ConflictErrorErrorConflictsItem.

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.conflict_error_error_conflicts_item.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, 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, 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, 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, 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, ContainerQuantity] = attr_dict['_quantity'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, volume: Union[benchling_api_client.v2.types.Unset, 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[ArchiveRecord]

property barcode: Optional[str]

property 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: 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[SchemaSummary]

property project_id: Optional[str]

property quantity: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property volume: DeprecatedContainerVolumeForResponse

property web_url: str

class ContainerBulkUpdateItem

Bases: object

__init__(container_id: str, quantity: Union[benchling_api_client.v2.types.Unset, ContainerQuantity] = attr_dict['_quantity'].default, volume: Union[benchling_api_client.v2.types.Unset, 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) → None

Method generated by attrs for class ContainerBulkUpdateItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

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 storage, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).

property quantity: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

to_dict() → Dict[str, Any]

property volume: 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, 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[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 ContainerContentsList

Bases: object

__init__(contents: Union[benchling_api_client.v2.types.Unset, List[ContainerContent]] = attr_dict['_contents'].default) → None

Method generated by attrs for class ContainerContentsList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property contents: List[ContainerContent]

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

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

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) → 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 storage, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).

property project_id: Optional[str]

property schema_id: str

to_dict() → Dict[str, Any]

class ContainerLabels

Bases: object

__init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].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 ContainerLabels.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property barcode: str

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

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class ContainerQuantity

Bases: object

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

__init__(units: Union[benchling_api_client.v2.types.Unset, None, ContainerQuantityUnits] = attr_dict['_units'].default, value: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_value'].default) → None

Method generated by attrs for class ContainerQuantity.

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.container_quantity.T

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

to_dict() → Dict[str, Any]

property units: Optional[ContainerQuantityUnits]

property value: Optional[float]

class ContainerQuantityUnits

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CELLS = 'cells'

G = 'g'

GAL_US = 'gal (US)'

ITEMS = 'items'

KG = 'kg'

L = 'L'

LB = 'lb'

MG = 'mg'

ML = 'mL'

MMOL = 'mmol'

MOL = 'mol'

NG = 'ng'

NL = 'nL'

NMOL = 'nmol'

OZ = 'oz'

PG = 'pg'

PL = 'pL'

PMOL = 'pmol'

PT_US = 'pt (US)'

QT_US = 'qt (US)'

UG = 'ug'

UL = 'uL'

UMOL = 'umol'

UNITS = 'units'

VALUE_22 = '(x10^3) cells'

VALUE_23 = '(x10^4) cells'

VALUE_24 = '(x10^5) cells'

VALUE_25 = '(x10^6) cells'

VALUE_26 = '(x10^7) cells'

VALUE_27 = '(x10^8) cells'

VALUE_28 = '(x10^9) cells'

static of_unknown(val: str) → ContainerQuantityUnits

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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: ContainerSchemaType

class ContainerSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CONTAINER = 'container'

static of_unknown(val: str) → ContainerSchemaType

class ContainerSchemasList

Bases: object

__init__(container_schemas: Union[benchling_api_client.v2.types.Unset, List[ContainerSchema]] = attr_dict['_container_schemas'].default) → None

Method generated by attrs for class ContainerSchemasList.

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_list.T

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

to_dict() → Dict[str, Any]

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[ContainerTransferDestinationContentsItem], destination_quantity: Union[benchling_api_client.v2.types.Unset, ContainerQuantity] = attr_dict['_destination_quantity'].default, destination_volume: Union[benchling_api_client.v2.types.Unset, DeprecatedContainerVolumeForInput] = attr_dict['_destination_volume'].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, ContainerQuantity] = attr_dict['_transfer_quantity'].default, transfer_volume: Union[benchling_api_client.v2.types.Unset, DeprecatedContainerVolumeForInput] = attr_dict['_transfer_volume'].default) → None

Method generated by attrs for class ContainerTransfer.

property destination_contents: List[ContainerTransferDestinationContentsItem]

This represents what the contents of the destination container should look like post-transfer.

property destination_quantity: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property destination_volume: 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 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: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property transfer_volume: 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 ContainerTransferBase

Bases: object

__init__(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, ContainerQuantity] = attr_dict['_transfer_quantity'].default, transfer_volume: Union[benchling_api_client.v2.types.Unset, DeprecatedContainerVolumeForInput] = attr_dict['_transfer_volume'].default) → None

Method generated by attrs for class ContainerTransferBase.

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.container_transfer_base.T

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

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: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property transfer_volume: 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 ContainerTransferDestinationContentsItem

Bases: object

__init__(entity_id: str, concentration: Union[benchling_api_client.v2.types.Unset, Measurement] = attr_dict['_concentration'].default) → None

Method generated by attrs for class ContainerTransferDestinationContentsItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property concentration: Measurement

property entity_id: str

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

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

to_dict() → Dict[str, Any]

class ContainerUpdate

Bases: object

__init__(project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, quantity: Union[benchling_api_client.v2.types.Unset, ContainerQuantity] = attr_dict['_quantity'].default, volume: Union[benchling_api_client.v2.types.Unset, 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) → None

Method generated by attrs for class ContainerUpdate.

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 storage, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).

property project_id: Optional[str]

property quantity: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

to_dict() → Dict[str, Any]

property volume: 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, 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, 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, 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, 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, ContainerQuantity] = attr_dict['_quantity'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, volume: Union[benchling_api_client.v2.types.Unset, 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[ArchiveRecord]

property barcode: Optional[str]

property 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: 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[SchemaSummary]

property project_id: Optional[str]

property quantity: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property volume: DeprecatedContainerVolumeForResponse

property web_url: str

class ContainerWriteBase

Bases: object

__init__(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 ContainerWriteBase.

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.container_write_base.T

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

property name: str

property parent_storage_id: str

ID of containing parent storage, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).

to_dict() → Dict[str, Any]

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 storage 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 ContainersList

Bases: object

__init__(containers: Union[benchling_api_client.v2.types.Unset, List[Container]] = attr_dict['_containers'].default) → None

Method generated by attrs for class ContainersList.

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_list.T

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

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 CreateConsensusAlignmentAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, DnaAlignment] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class CreateConsensusAlignmentAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.create_consensus_alignment_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: DnaAlignment

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class CreateEntityIntoRegistry

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) → None

Method generated by attrs for class CreateEntityIntoRegistry.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

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 folder_id: str

ID of the folder containing the entity. Can be left empty when registryId is present.

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

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

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.

to_dict() → Dict[str, Any]

class CreateNucleotideConsensusAlignmentAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, NucleotideAlignment] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class CreateNucleotideConsensusAlignmentAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.create_nucleotide_consensus_alignment_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: NucleotideAlignment

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class CreateNucleotideTemplateAlignmentAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, NucleotideAlignment] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class CreateNucleotideTemplateAlignmentAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.create_nucleotide_template_alignment_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: NucleotideAlignment

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class CreateTemplateAlignmentAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, DnaAlignment] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class CreateTemplateAlignmentAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.create_template_alignment_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: DnaAlignment

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class CreationOrigin

Bases: object

__init__(application: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_application'].default, origin_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_origin_id'].default, origin_modal_uuid: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_origin_modal_uuid'].default, origin_type: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_origin_type'].default) → None

Method generated by attrs for class CreationOrigin.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property application: Optional[str]

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

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

property origin_id: Optional[str]

property origin_modal_uuid: Optional[str]

property origin_type: Optional[str]

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 CustomEntitiesList

Bases: object

__init__(custom_entities: Union[benchling_api_client.v2.types.Unset, List[CustomEntity]] = attr_dict['_custom_entities'].default) → None

Method generated by attrs for class CustomEntitiesList.

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_list.T

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

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, ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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, 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[ArchiveRecord]

property authors: List[UserSummary]

property created_at: datetime

property 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[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

class CustomEntityBaseRequest

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, 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 CustomEntityBaseRequest.

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_base_request.T

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

property name: str

property schema_id: str

to_dict() → Dict[str, Any]

class CustomEntityBaseRequestForCreate

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, 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 CustomEntityBaseRequestForCreate.

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_base_request_for_create.T

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

property name: str

property schema_id: str

to_dict() → Dict[str, Any]

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 CustomEntityCreator

Bases: object

__init__() → None

Method generated by attrs for class CustomEntityCreator.

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_entity_creator.T

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

to_dict() → Dict[str, Any]

class CustomEntityRequestRegistryFields

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default) → None

Method generated by attrs for class CustomEntityRequestRegistryFields.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: str

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

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

to_dict() → Dict[str, Any]

class CustomEntitySummary

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, CustomEntitySummaryEntityType] = attr_dict['_entity_type'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class CustomEntitySummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_type: CustomEntitySummaryEntityType

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

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

property id: str

to_dict() → Dict[str, Any]

property type: str

class CustomEntitySummaryEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CUSTOM_ENTITY = 'custom_entity'

static of_unknown(val: str) → CustomEntitySummaryEntityType

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 CustomEntityWithEntityType

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, 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, ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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, 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[ArchiveRecord]

property authors: List[UserSummary]

property created_at: datetime

property creator: CustomEntityCreator

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

property 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[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

class CustomEntityWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CUSTOM_ENTITY = 'custom_entity'

static of_unknown(val: str) → CustomEntityWithEntityTypeEntityType

class CustomField

Bases: object

__init__(value: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_value'].default) → None

Method generated by attrs for class CustomField.

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_field.T

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

to_dict() → Dict[str, Any]

property value: str

class CustomFields

Bases: object

__init__() → None

Method generated by attrs for class CustomFields.

property additional_keys: List[str]

additional_properties: Dict[str, 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[CustomField]

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 DefaultConcentrationSummary

Bases: object

__init__(units: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_units'].default, value: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_value'].default) → None

Method generated by attrs for class DefaultConcentrationSummary.

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.default_concentration_summary.T

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

to_dict() → Dict[str, Any]

property units: str

Units of measurement.

property value: float

Amount of measurement.

class DeprecatedAutomationOutputProcessorsPaginatedList

Bases: object

Deprecated - A paginated list of automation output processors

__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 DeprecatedAutomationOutputProcessorsPaginatedList.

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.deprecated_automation_output_processors_paginated_list.T

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

property next_token: str

to_dict() → Dict[str, Any]

class DeprecatedContainerVolumeForInput

Bases: object

Desired volume for a container, well, or transfer. “volume” type keys are deprecated in API requests; use the more permissive “quantity” type key instead.

__init__(units: Union[benchling_api_client.v2.types.Unset, None, DeprecatedContainerVolumeForInputUnits] = attr_dict['_units'].default, value: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_value'].default) → None

Method generated by attrs for class DeprecatedContainerVolumeForInput.

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.deprecated_container_volume_for_input.T

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

to_dict() → Dict[str, Any]

property units: Optional[DeprecatedContainerVolumeForInputUnits]

property value: Optional[float]

class DeprecatedContainerVolumeForInputUnits

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

L = 'L'

ML = 'mL'

NL = 'nL'

PL = 'pL'

UL = 'uL'

static of_unknown(val: str) → DeprecatedContainerVolumeForInputUnits

class DeprecatedContainerVolumeForResponse

Bases: object

__init__(units: Union[benchling_api_client.v2.types.Unset, None, ContainerQuantityUnits] = attr_dict['_units'].default, value: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_value'].default) → None

Method generated by attrs for class DeprecatedContainerVolumeForResponse.

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.deprecated_container_volume_for_response.T

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

to_dict() → Dict[str, Any]

property units: Optional[ContainerQuantityUnits]

property value: Optional[float]

class DeprecatedEntitySchema

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, DeprecatedEntitySchemaType] = attr_dict['_type'].default, constraint: Union[benchling_api_client.v2.types.Unset, None, EntitySchemaConstraint] = attr_dict['_constraint'].default, containable_type: Union[benchling_api_client.v2.types.Unset, EntitySchemaContainableType] = attr_dict['_containable_type'].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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 DeprecatedEntitySchema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property constraint: Optional[EntitySchemaConstraint]

property containable_type: EntitySchemaContainableType

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.deprecated_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: DeprecatedEntitySchemaType

class DeprecatedEntitySchemaType

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'

ENTRY = 'entry'

MIXTURE = 'mixture'

MOLECULE = 'molecule'

RNA_OLIGO = 'rna_oligo'

static of_unknown(val: str) → DeprecatedEntitySchemaType

class DeprecatedEntitySchemasList

Bases: object

__init__(entity_schemas: Union[benchling_api_client.v2.types.Unset, List[DeprecatedEntitySchema]] = attr_dict['_entity_schemas'].default) → None

Method generated by attrs for class DeprecatedEntitySchemasList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_schemas: List[DeprecatedEntitySchema]

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

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

to_dict() → Dict[str, Any]

class DnaAlignment

Bases: object

__init__(aligned_sequences: Union[benchling_api_client.v2.types.Unset, List[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[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 DnaAlignmentBase

Bases: object

__init__(algorithm: DnaAlignmentBaseAlgorithm, files: List[Union[DnaAlignmentBaseFilesItem, 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 DnaAlignmentBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property algorithm: DnaAlignmentBaseAlgorithm

property files: List[Union[DnaAlignmentBaseFilesItem, 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_alignment_base.T

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

property name: str

to_dict() → Dict[str, Any]

class DnaAlignmentBaseAlgorithm

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CLUSTALO = 'clustalo'

MAFFT = 'mafft'

static of_unknown(val: str) → DnaAlignmentBaseAlgorithm

class DnaAlignmentBaseFilesItem

Bases: object

__init__(sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_sequence_id'].default) → None

Method generated by attrs for class DnaAlignmentBaseFilesItem.

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.dna_alignment_base_files_item.T

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

property sequence_id: str

to_dict() → Dict[str, Any]

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 DnaAnnotation

Bases: object

__init__(end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, strand: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_strand'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, List[SequenceFeatureCustomField]] = attr_dict['_custom_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, notes: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_notes'].default) → None

Method generated by attrs for class DnaAnnotation.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property color: str

Hex color code used when displaying this feature in the UI.

property custom_fields: List[SequenceFeatureCustomField]

property end: int

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

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

property name: str

property notes: str

property start: int

property strand: int

to_dict() → Dict[str, Any]

property type: str

class DnaConsensusAlignmentCreate

Bases: object

__init__(algorithm: DnaAlignmentBaseAlgorithm, files: List[Union[DnaAlignmentBaseFilesItem, DnaTemplateAlignmentFile, benchling_api_client.v2.extensions.UnknownType]], new_sequence: Union[benchling_api_client.v2.types.Unset, 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: DnaAlignmentBaseAlgorithm

property files: List[Union[DnaAlignmentBaseFilesItem, 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: DnaConsensusAlignmentCreateNewSequence

property sequence_id: str

to_dict() → Dict[str, Any]

class DnaConsensusAlignmentCreateNewSequence

Bases: object

__init__(folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default) → None

Method generated by attrs for class DnaConsensusAlignmentCreateNewSequence.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property folder_id: str

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

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

to_dict() → Dict[str, Any]

class DnaOligo

Bases: object

__init__(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, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, 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, OligoNucleotideType] = attr_dict['_nucleotide_type'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, 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 api_url: str

property archive_record: Optional[ArchiveRecord]

property bases: str

property created_at: datetime

DateTime the Oligo was created.

property creator: UserSummary

property custom_fields: CustomFields

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 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: OligoNucleotideType

Nucleotide type of the Oligo.

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

Registry the Oligo is registered in.

property schema: Optional[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, 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 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.dna_oligo_bulk_update.T

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__(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 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.dna_oligo_create.T

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

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__(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 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.dna_oligo_update.T

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

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, DnaOligoWithEntityTypeEntityType] = attr_dict['_entity_type'].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, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, 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, OligoNucleotideType] = attr_dict['_nucleotide_type'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, 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 api_url: str

The canonical url of the Oligo in the API.

property archive_record: Optional[ArchiveRecord]

property bases: str

Base pairs of the Oligo.

property created_at: datetime

DateTime the Oligo was created.

property creator: UserSummary

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

Registry ID of the Oligo if registered.

property 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 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: OligoNucleotideType

Nucleotide type of the Oligo.

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

Registry the Oligo is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the Oligo.

class DnaOligoWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DNA_OLIGO = 'dna_oligo'

static of_unknown(val: str) → DnaOligoWithEntityTypeEntityType

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 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[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, 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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[Primer]] = attr_dict['_primers'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, SchemaSummary] = attr_dict['_schema'].default, translations: Union[benchling_api_client.v2.types.Unset, List[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[DnaAnnotation]

property api_url: str

The canonical url of the DNA Sequence in the API.

property archive_record: Optional[ArchiveRecord]

property bases: str

property created_at: datetime

property creator: 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 primers: List[Primer]

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property translations: List[Translation]

property web_url: str

class DnaSequenceBaseRequest

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[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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class DnaSequenceBaseRequest.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property aliases: List[str]

Aliases to add to the DNA sequence

property annotations: List[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_base_request.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 primers: List[Primer]

property schema_id: str

ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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 DnaSequenceBaseRequestForCreate

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[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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class DnaSequenceBaseRequestForCreate.

property aliases: List[str]

Aliases to add to the DNA sequence

property annotations: List[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_base_request_for_create.T

property is_circular: bool

Whether the DNA sequence is circular or linear.

property name: str

Name of the DNA sequence.

property primers: List[Primer]

property schema_id: str

ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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 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[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, primers: Union[benchling_api_client.v2.types.Unset, List[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[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[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 primers: List[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[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[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, primers: Union[benchling_api_client.v2.types.Unset, List[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[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[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 primers: List[Primer]

property schema_id: str

ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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[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, primers: Union[benchling_api_client.v2.types.Unset, List[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[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[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 primers: List[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[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 DnaSequenceRequestRegistryFields

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default) → None

Method generated by attrs for class DnaSequenceRequestRegistryFields.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: str

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

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

to_dict() → Dict[str, Any]

class DnaSequenceSummary

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, DnaSequenceSummaryEntityType] = attr_dict['_entity_type'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class DnaSequenceSummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_type: DnaSequenceSummaryEntityType

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

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

property id: str

to_dict() → Dict[str, Any]

property type: str

class DnaSequenceSummaryEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DNA_SEQUENCE = 'dna_sequence'

static of_unknown(val: str) → DnaSequenceSummaryEntityType

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[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, primers: Union[benchling_api_client.v2.types.Unset, List[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[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[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 primers: List[Primer]

property schema_id: str

ID of the DNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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, 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[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, 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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[Primer]] = attr_dict['_primers'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, SchemaSummary] = attr_dict['_schema'].default, translations: Union[benchling_api_client.v2.types.Unset, List[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[DnaAnnotation]

property api_url: str

The canonical url of the DNA Sequence in the API.

property archive_record: Optional[ArchiveRecord]

property bases: str

property created_at: datetime

property creator: UserSummary

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

property 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 primers: List[Primer]

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property translations: List[Translation]

property web_url: str

class DnaSequenceWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DNA_SEQUENCE = 'dna_sequence'

static of_unknown(val: str) → DnaSequenceWithEntityTypeEntityType

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 DnaSequencesBulkGet

Bases: object

__init__(dna_sequences: Union[benchling_api_client.v2.types.Unset, List[DnaSequence]] = attr_dict['_dna_sequences'].default) → None

Method generated by attrs for class DnaSequencesBulkGet.

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_bulk_get.T

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

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 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: DnaAlignmentBaseAlgorithm, files: List[Union[DnaAlignmentBaseFilesItem, 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: DnaAlignmentBaseAlgorithm

property files: List[Union[DnaAlignmentBaseFilesItem, 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 DnaTemplateAlignmentFile

Bases: object

__init__(data: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_data'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class DnaTemplateAlignmentFile.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property data: str

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

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

property name: 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, ArchiveRecord] = attr_dict['_archive_record'].default, options: Union[benchling_api_client.v2.types.Unset, List[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[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[DropdownOption]

Array of dropdown options

to_dict() → Dict[str, Any]

class DropdownCreate

Bases: object

__init__(name: str, options: List[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[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 DropdownFieldDefinition

Bases: object

__init__(dropdown_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_dropdown_id'].default, type: Union[benchling_api_client.v2.types.Unset, DropdownFieldDefinitionType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, is_required: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_required'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class DropdownFieldDefinition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property dropdown_id: Optional[str]

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

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

property id: str

property is_multi: bool

property is_required: bool

property name: str

to_dict() → Dict[str, Any]

property type: DropdownFieldDefinitionType

class DropdownFieldDefinitionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DROPDOWN = 'dropdown'

static of_unknown(val: str) → DropdownFieldDefinitionType

class DropdownOption

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, 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) → None

Method generated by attrs for class DropdownOption.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

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

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class DropdownOptionCreate

Bases: object

__init__(name: str) → None

Method generated by attrs for class DropdownOptionCreate.

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_option_create.T

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

property name: str

to_dict() → Dict[str, Any]

class DropdownOptionUpdate

Bases: object

__init__(name: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) → None

Method generated by attrs for class DropdownOptionUpdate.

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_option_update.T

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

property id: str

ID of the dropdown option to update, omitted if creating a new option.

property name: str

Name of the dropdown option.

to_dict() → Dict[str, Any]

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 DropdownUpdate

Bases: object

__init__(options: List[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[DropdownOptionUpdate]

Options to set for the dropdown

to_dict() → Dict[str, Any]

class DropdownsRegistryList

Bases: object

__init__(dropdowns: Union[benchling_api_client.v2.types.Unset, List[DropdownSummary]] = attr_dict['_dropdowns'].default) → None

Method generated by attrs for class DropdownsRegistryList.

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.dropdowns_registry_list.T

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

to_dict() → Dict[str, Any]

class EmptyObject

Bases: object

__init__() → None

Method generated by attrs for class EmptyObject.

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.empty_object.T

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

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 EntityLabels

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_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 EntityLabels.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: Optional[str]

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

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class EntityRegisteredEvent

Bases: object

__init__(entity: Union[benchling_api_client.v2.types.Unset, GenericEntity] = attr_dict['_entity'].default, event_type: Union[benchling_api_client.v2.types.Unset, EntityRegisteredEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class EntityRegisteredEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property entity: GenericEntity

property event_type: EntityRegisteredEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class EntityRegisteredEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ENTITYREGISTERED = 'v2.entity.registered'

static of_unknown(val: str) → EntityRegisteredEventEventType

class EntitySchema

Bases: object

__init__(constraint: Union[benchling_api_client.v2.types.Unset, None, EntitySchemaConstraint] = attr_dict['_constraint'].default, containable_type: Union[benchling_api_client.v2.types.Unset, 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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property constraint: Optional[EntitySchemaConstraint]

property containable_type: EntitySchemaContainableType

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: 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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 EntitySchemaConstraint

Bases: object

__init__(field_definition_names: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_field_definition_names'].default, has_unique_residues: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_has_unique_residues'].default) → None

Method generated by attrs for class EntitySchemaConstraint.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property field_definition_names: List[str]

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

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

property has_unique_residues: bool

to_dict() → Dict[str, Any]

class EntitySchemaContainableType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BATCH = 'BATCH'

ENTITY = 'ENTITY'

NONE = 'NONE'

static of_unknown(val: str) → EntitySchemaContainableType

class EntitySchemaType

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'

static of_unknown(val: str) → EntitySchemaType

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 Entries

Bases: object

__init__(entries: Union[benchling_api_client.v2.types.Unset, List[Entry]] = attr_dict['_entries'].default) → None

Method generated by attrs for class Entries.

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

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

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, ArchiveRecord] = attr_dict['_archive_record'].default, assigned_reviewers: Union[benchling_api_client.v2.types.Unset, List[UserSummary]] = attr_dict['_assigned_reviewers'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, 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[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, EntryReviewRecord] = attr_dict['_review_record'].default, schema: Union[benchling_api_client.v2.types.Unset, None, 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[ArchiveRecord]

property assigned_reviewers: List[UserSummary]

Array of users assigned to review the entry, if any.

property authors: List[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: UserSummary

property custom_fields: CustomFields

property days: List[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[EntryReviewRecord]

Review record if set

property schema: Optional[EntrySchema]

Entry schema

to_dict() → Dict[str, Any]

property web_url: str

URL of the entry

class EntryById

Bases: object

__init__(entry: Union[benchling_api_client.v2.types.Unset, Entry] = attr_dict['_entry'].default) → None

Method generated by attrs for class EntryById.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entry: Entry

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.

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

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

to_dict() → Dict[str, Any]

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[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[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 EntryCreatedEvent

Bases: object

__init__(entry: Union[benchling_api_client.v2.types.Unset, Entry] = attr_dict['_entry'].default, event_type: Union[benchling_api_client.v2.types.Unset, EntryCreatedEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class EntryCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property entry: Entry

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.

property event_type: EntryCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class EntryCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ENTRYCREATED = 'v2.entry.created'

static of_unknown(val: str) → EntryCreatedEventEventType

class EntryDay

Bases: object

__init__(date: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_date'].default, notes: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleNotePart, TableNotePart, CheckboxNotePart, ExternalFileNotePart, AssayRunNotePart, ResultsTableNotePart, RegistrationTableNotePart, PlateCreationTableNotePart, BoxCreationTableNotePart, MixturePrepTableNotePart, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_notes'].default) → None

Method generated by attrs for class EntryDay.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property date: str

A Date string

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

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

property notes: List[Union[SimpleNotePart, TableNotePart, CheckboxNotePart, ExternalFileNotePart, AssayRunNotePart, ResultsTableNotePart, RegistrationTableNotePart, PlateCreationTableNotePart, BoxCreationTableNotePart, MixturePrepTableNotePart, benchling_api_client.v2.extensions.UnknownType]]

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 EntryExternalFileById

Bases: object

__init__(external_file: Union[benchling_api_client.v2.types.Unset, EntryExternalFile] = attr_dict['_external_file'].default) → None

Method generated by attrs for class EntryExternalFileById.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property external_file: EntryExternalFile

The ExternalFile resource stores metadata about the file. The actual original file can be downloaded by using the ‘downloadURL’ property.

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

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

to_dict() → Dict[str, Any]

class EntryLink

Bases: object

Links are contained within notes to reference resources that live outside of the entry. A link can target an external resource via an http(s):// hyperlink or a Benchling resource via @-mentions and drag-n-drop.

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, EntryLinkType] = attr_dict['_type'].default, web_url: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_web_url'].default) → None

Method generated by attrs for class EntryLink.

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.entry_link.T

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

property id: str

For linked Benchling resources, this will be the ID of that resource (e.g., ‘seq_RhYGVnHF’). Omitted for “link” types.

to_dict() → Dict[str, Any]

property type: EntryLinkType

The type of resource being linked. For hyperlinks: ‘link’. For linked Benchling resources, one of: ‘user’, ‘request’, ‘entry’, ‘stage_entry’, ‘protocol’, ‘workflow’, ‘custom_entity’, ‘aa_sequence’, ‘dna_sequence’, ‘batch’, ‘box’, ‘container’, ‘location’, ‘plate’.

property web_url: Optional[str]

Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for “link” types. Note: locations do not currently have a URL.

class EntryLinkType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'

BATCH = 'batch'

BOX = 'box'

CONTAINER = 'container'

CUSTOM_ENTITY = 'custom_entity'

DNA_SEQUENCE = 'dna_sequence'

ENTRY = 'entry'

LINK = 'link'

LOCATION = 'location'

PLATE = 'plate'

PROTOCOL = 'protocol'

REQUEST = 'request'

STAGE_ENTRY = 'stage_entry'

USER = 'user'

WORKFLOW = 'workflow'

static of_unknown(val: str) → EntryLinkType

class EntryReviewRecord

Bases: object

Review record if set

__init__() → None

Method generated by attrs for class EntryReviewRecord.

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.entry_review_record.T

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

to_dict() → Dict[str, Any]

class EntrySchema

Bases: object

Entry schema

__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) → None

Method generated by attrs for class EntrySchema.

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.entry_schema.T

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

property id: str

ID of the entry schema

property modified_at: datetime

DateTime the Entry Schema was last modified

property name: str

Name of the entry schema

to_dict() → Dict[str, Any]

class EntrySchemaDetailed

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: EntrySchemaDetailedType

class EntrySchemaDetailedType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ENTRY = 'entry'

static of_unknown(val: str) → 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 EntryTable

Bases: object

Actual tabular data with rows and columns of text on the note.

__init__(column_labels: Union[benchling_api_client.v2.types.Unset, List[Optional[str]]] = attr_dict['_column_labels'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, rows: Union[benchling_api_client.v2.types.Unset, List[EntryTableRow]] = attr_dict['_rows'].default) → None

Method generated by attrs for class EntryTable.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property column_labels: List[Optional[str]]

Array of strings, with one item per column. Defaults to null, if the user is using the default, but is set if the user has given a custom name to the column.

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

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

property name: str

Name of the table - defaults to e.g. Table1 but can be renamed.

property rows: List[EntryTableRow]

Array of row objects.

to_dict() → Dict[str, Any]

class EntryTableCell

Bases: object

__init__(link: Union[benchling_api_client.v2.types.Unset, EntryLink] = attr_dict['_link'].default, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default) → None

Method generated by attrs for class EntryTableCell.

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.entry_table_cell.T

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

property link: EntryLink

Links are contained within notes to reference resources that live outside of the entry. A link can target an external resource via an http(s):// hyperlink or a Benchling resource via @-mentions and drag-n-drop.

property text: str

The textual content of the cell. If the cell was originally a formula, this will be the evaluated version of the formula.

to_dict() → Dict[str, Any]

class EntryTableRow

Bases: object

Each has property ‘cells’ that is an array of cell objects

__init__(cells: Union[benchling_api_client.v2.types.Unset, List[EntryTableCell]] = attr_dict['_cells'].default) → None

Method generated by attrs for class EntryTableRow.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property cells: List[EntryTableCell]

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

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

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, 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[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, 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: UserSummary

property custom_fields: CustomFields

property days: List[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[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 EntryTemplateDay

Bases: object

__init__(day: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_day'].default, notes: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleNotePart, TableNotePart, CheckboxNotePart, ExternalFileNotePart, AssayRunNotePart, LookupTableNotePart, ResultsTableNotePart, RegistrationTableNotePart, PlateCreationTableNotePart, BoxCreationTableNotePart, MixturePrepTableNotePart, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_notes'].default) → None

Method generated by attrs for class EntryTemplateDay.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property day: int

1 indexed day signifier.

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

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

property notes: List[Union[SimpleNotePart, TableNotePart, CheckboxNotePart, ExternalFileNotePart, AssayRunNotePart, LookupTableNotePart, ResultsTableNotePart, RegistrationTableNotePart, PlateCreationTableNotePart, BoxCreationTableNotePart, MixturePrepTableNotePart, benchling_api_client.v2.extensions.UnknownType]]

to_dict() → Dict[str, Any]

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 EntryUpdatedFieldsEvent

Bases: object

__init__(entry: Union[benchling_api_client.v2.types.Unset, Entry] = attr_dict['_entry'].default, event_type: Union[benchling_api_client.v2.types.Unset, EntryUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class EntryUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property entry: Entry

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.

property event_type: EntryUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class EntryUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ENTRYUPDATEDFIELDS = 'v2.entry.updated.fields'

static of_unknown(val: str) → EntryUpdatedFieldsEventEventType

class EntryUpdatedReviewRecordEvent

Bases: object

__init__(entry: Union[benchling_api_client.v2.types.Unset, Entry] = attr_dict['_entry'].default, event_type: Union[benchling_api_client.v2.types.Unset, EntryUpdatedReviewRecordEventEventType] = attr_dict['_event_type'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class EntryUpdatedReviewRecordEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property entry: Entry

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.

property event_type: EntryUpdatedReviewRecordEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class EntryUpdatedReviewRecordEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ENTRYUPDATEDREVIEWRECORD = 'v2.entry.updated.reviewRecord'

static of_unknown(val: str) → EntryUpdatedReviewRecordEventEventType

class EventBase

Bases: object

__init__(created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class EventBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class EventBaseSchema

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

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.event_base_schema.T

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class EventsPaginatedList

Bases: object

__init__(events: Union[benchling_api_client.v2.types.Unset, List[Union[EntityRegisteredEvent, EntryCreatedEvent, EntryUpdatedFieldsEvent, EntryUpdatedReviewRecordEvent, StageEntryCreatedEvent, StageEntryUpdatedFieldsEvent, StageEntryUpdatedReviewRecordEvent, RequestCreatedEvent, RequestUpdatedFieldsEvent, AssayRunCreatedEvent, AssayRunUpdatedFieldsEvent, AutomationInputGeneratorCompletedV2BetaEvent, AutomationOutputProcessorCompletedV2BetaEvent, AutomationOutputProcessorUploadedV2BetaEvent, WorkflowTaskGroupCreatedEvent, WorkflowTaskCreatedEvent, WorkflowTaskUpdatedFieldsEvent, WorkflowTaskUpdatedStatusEvent, WorkflowTaskUpdatedAssigneeEvent, WorkflowTaskUpdatedScheduledOnEvent, WorkflowTaskGroupUpdatedWatchersEvent, WorkflowOutputCreatedEvent, 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[EntityRegisteredEvent, EntryCreatedEvent, EntryUpdatedFieldsEvent, EntryUpdatedReviewRecordEvent, StageEntryCreatedEvent, StageEntryUpdatedFieldsEvent, StageEntryUpdatedReviewRecordEvent, RequestCreatedEvent, RequestUpdatedFieldsEvent, AssayRunCreatedEvent, AssayRunUpdatedFieldsEvent, AutomationInputGeneratorCompletedV2BetaEvent, AutomationOutputProcessorCompletedV2BetaEvent, AutomationOutputProcessorUploadedV2BetaEvent, WorkflowTaskGroupCreatedEvent, WorkflowTaskCreatedEvent, WorkflowTaskUpdatedFieldsEvent, WorkflowTaskUpdatedStatusEvent, WorkflowTaskUpdatedAssigneeEvent, WorkflowTaskUpdatedScheduledOnEvent, WorkflowTaskGroupUpdatedWatchersEvent, WorkflowOutputCreatedEvent, 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 ExecuteSampleGroups

Bases: object

The response is intentionally empty.

__init__() → None

Method generated by attrs for class ExecuteSampleGroups.

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.execute_sample_groups.T

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

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 ExportsAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, ExportsAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class ExportsAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.exports_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: ExportsAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class ExportsAsyncTaskResponse

Bases: object

__init__(download_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_download_url'].default) → None

Method generated by attrs for class ExportsAsyncTaskResponse.

property download_url: str

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

to_dict() → Dict[str, Any]

class ExternalFileNotePart

Bases: object

An attached user-uploaded file

__init__(external_file_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_external_file_id'].default, links: Union[benchling_api_client.v2.types.Unset, List[EntryLink]] = attr_dict['_links'].default, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default, type: Union[benchling_api_client.v2.types.Unset, ExternalFileNotePartType] = attr_dict['_type'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class ExternalFileNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property external_file_id: str

The ID of the external file. Use the ‘Get an external file’ endpoint to retrieve metadata about it.

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

property links: List[EntryLink]

Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note.

property text: str

The caption of the file attachment.

to_dict() → Dict[str, Any]

property type: ExternalFileNotePartType

class ExternalFileNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

EXTERNAL_FILE = 'external_file'

static of_unknown(val: str) → ExternalFileNotePartType

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, 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: 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 FeatureBase

Bases: object

__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 FeatureBase.

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_base.T

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

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, 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: 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: 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: 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 FeatureCreateMatchType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

NUCLEOTIDE = 'nucleotide'

PROTEIN = 'protein'

static of_unknown(val: str) → FeatureCreateMatchType

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, 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, 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 FeatureLibraryBase

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

property additional_keys: List[str]

additional_properties: Dict[str, Any]

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_base.T

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

property name: str

The name of the feature library

to_dict() → Dict[str, Any]

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 FeatureMatchType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

NUCLEOTIDE = 'nucleotide'

PROTEIN = 'protein'

static of_unknown(val: str) → FeatureMatchType

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, 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, FieldType] = attr_dict['_type'].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: FieldType

property value: Optional[Union[str, bool, float, 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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 FieldDefinition

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, is_required: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_required'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, type: Union[benchling_api_client.v2.types.Unset, FieldType] = attr_dict['_type'].default) → None

Method generated by attrs for class FieldDefinition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

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

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

property id: str

property is_multi: bool

property is_required: bool

property name: str

to_dict() → Dict[str, Any]

property type: FieldType

class FieldType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE_LINK = 'aa_sequence_link'

ASSAY_REQUEST_LINK = 'assay_request_link'

ASSAY_RESULT_LINK = 'assay_result_link'

ASSAY_RUN_LINK = 'assay_run_link'

BATCH_LINK = 'batch_link'

BLOB_LINK = 'blob_link'

BOOLEAN = 'boolean'

CUSTOM_ENTITY_LINK = 'custom_entity_link'

DATE = 'date'

DATETIME = 'datetime'

DNA_SEQUENCE_LINK = 'dna_sequence_link'

DROPDOWN = 'dropdown'

ENTITY_LINK = 'entity_link'

ENTRY_LINK = 'entry_link'

FLOAT = 'float'

INTEGER = 'integer'

JSON = 'json'

LONG_TEXT = 'long_text'

MIXTURE_LINK = 'mixture_link'

PART_LINK = 'part_link'

STORAGE_LINK = 'storage_link'

TEXT = 'text'

TRANSLATION_LINK = 'translation_link'

static of_unknown(val: str) → FieldType

class FieldValue

Bases: object

__init__() → None

Method generated by attrs for class FieldValue.

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.field_value.T

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

to_dict() → Dict[str, Any]

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 FindMatchingRegionsAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, FindMatchingRegionsAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class FindMatchingRegionsAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.find_matching_regions_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: FindMatchingRegionsAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class FindMatchingRegionsAsyncTaskResponse

Bases: object

__init__(aa_sequence_matches: Union[benchling_api_client.v2.types.Unset, List[FindMatchingRegionsAsyncTaskResponseAaSequenceMatchesItem]] = attr_dict['_aa_sequence_matches'].default) → None

Method generated by attrs for class FindMatchingRegionsAsyncTaskResponse.

property aa_sequence_matches: List[FindMatchingRegionsAsyncTaskResponseAaSequenceMatchesItem]

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.find_matching_regions_async_task_response.T

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

to_dict() → Dict[str, Any]

class FindMatchingRegionsAsyncTaskResponseAaSequenceMatchesItem

Bases: object

__init__(matching_aa_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_matching_aa_sequence_ids'].default, target_aa_sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_target_aa_sequence_id'].default) → None

Method generated by attrs for class FindMatchingRegionsAsyncTaskResponseAaSequenceMatchesItem.

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.find_matching_regions_async_task_response_aa_sequence_matches_item.T

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

property matching_aa_sequence_ids: List[str]

property target_aa_sequence_id: str

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 FloatFieldDefinition

Bases: object

__init__(decimal_precision: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_decimal_precision'].default, legal_text_dropdown_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_legal_text_dropdown_id'].default, numeric_max: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_numeric_max'].default, numeric_min: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_numeric_min'].default, type: Union[benchling_api_client.v2.types.Unset, FloatFieldDefinitionType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, is_required: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_required'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class FloatFieldDefinition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property decimal_precision: Optional[float]

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

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

property id: str

property is_multi: bool

property is_required: bool

property legal_text_dropdown_id: Optional[str]

property name: str

property numeric_max: Optional[float]

property numeric_min: Optional[float]

to_dict() → Dict[str, Any]

property type: FloatFieldDefinitionType

class FloatFieldDefinitionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FLOAT = 'float'

static of_unknown(val: str) → FloatFieldDefinitionType

class Folder

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, 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[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, 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: 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 ForbiddenErrorError

Bases: object

__init__(invalid_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_invalid_id'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default, user_message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_message'].default) → None

Method generated by attrs for class ForbiddenErrorError.

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.forbidden_error_error.T

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

property invalid_id: str

property message: str

to_dict() → Dict[str, Any]

property type: str

property user_message: str

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 GenericEntity

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, ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, GenericEntityCreator] = 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, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, 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 GenericEntity.

property aliases: List[str]

property api_url: str

property archive_record: Optional[ArchiveRecord]

property authors: List[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

property creator: GenericEntityCreator

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

property fields: Fields

property folder_id: str

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

property id: str

property modified_at: datetime

property name: str

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

class GenericEntityCreator

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

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.generic_entity_creator.T

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

property handle: str

property id: str

property name: str

to_dict() → Dict[str, Any]

class InaccessibleResource

Bases: object

__init__(inaccessible_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_inaccessible_id'].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

to_dict() → Dict[str, Any]

property type: str

The type of this inaccessible item. Example values: “custom_entity”, “container”, “plate”, “dna_sequence”

class Ingredient

Bases: object

__init__(amount: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_amount'].default, catalog_identifier: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_catalog_identifier'].default, component_entity: Union[benchling_api_client.v2.types.Unset, IngredientComponentEntity] = attr_dict['_component_entity'].default, component_lot_container: Union[benchling_api_client.v2.types.Unset, None, ContainerLabels] = attr_dict['_component_lot_container'].default, component_lot_entity: Union[benchling_api_client.v2.types.Unset, None, EntityLabels] = attr_dict['_component_lot_entity'].default, component_lot_text: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_component_lot_text'].default, has_parent: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_has_parent'].default, notes: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_notes'].default, target_amount: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_target_amount'].default, units: Union[benchling_api_client.v2.types.Unset, IngredientMeasurementUnits] = attr_dict['_units'].default) → None

Method generated by attrs for class Ingredient.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property amount: Optional[str]

The amount value of this ingredient in its mixture, in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4). One ingredient on this mixture can have an amount value of “QS”.

property catalog_identifier: Optional[str]

property component_entity: IngredientComponentEntity

property component_lot_container: Optional[ContainerLabels]

property component_lot_entity: Optional[EntityLabels]

property component_lot_text: Optional[str]

Text representing the component lot for this ingredient. This is only present if the mixture schema supports component lots in “text” format.

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

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

property has_parent: bool

property notes: Optional[str]

property target_amount: Optional[str]

The target amount for this ingredient such that this ingredient’s proportion in its mixture would preserve the equivalent ingredient’s proportion in the parent mixture. Pair with units.

to_dict() → Dict[str, Any]

property units: IngredientMeasurementUnits

class IngredientComponentEntity

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_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 IngredientComponentEntity.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: Optional[str]

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

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class IngredientMeasurementUnits

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

G = 'g'

L = 'L'

MG = 'mg'

ML = 'mL'

NL = 'nL'

UL = 'uL'

UNITS = 'Units'

static of_unknown(val: str) → IngredientMeasurementUnits

class IngredientWriteParams

Bases: object

__init__(component_entity_id: str, units: IngredientMeasurementUnits, amount: Optional[str], catalog_identifier: Optional[str], component_lot_container_id: Optional[str], component_lot_entity_id: Optional[str], component_lot_text: Optional[str], notes: Optional[str]) → None

Method generated by attrs for class IngredientWriteParams.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property amount: Optional[str]

The amount value of this ingredient in its mixture, in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4). One ingredient on this mixture can have an amount value of “QS”.

property catalog_identifier: Optional[str]

property component_entity_id: str

The entity that uniquely identifies this component.

property component_lot_container_id: Optional[str]

The container representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in “storage” format.

property component_lot_entity_id: Optional[str]

The entity representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in “storage” format.

property component_lot_text: Optional[str]

Text representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in “text” format.

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

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

property notes: Optional[str]

to_dict() → Dict[str, Any]

property units: IngredientMeasurementUnits

class InitialTable

Bases: object

__init__(csv_data: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_csv_data'].default, template_table_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_template_table_id'].default) → None

Method generated by attrs for class InitialTable.

property csv_data: str

blobId of an uploaded csv blob. The CSV should be formatted with column headers of columnId which can be found in the [EntryTemplate](#/components/schemas/EntryTemplate). For more information on uploading a blob, [click here](https://docs.benchling.com/docs/uploading-a-blob-to-benchling).

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

property template_table_id: str

Template table API ID

to_dict() → Dict[str, Any]

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 IntegerFieldDefinition

Bases: object

__init__(numeric_max: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_numeric_max'].default, numeric_min: Union[benchling_api_client.v2.types.Unset, None, float] = attr_dict['_numeric_min'].default, type: Union[benchling_api_client.v2.types.Unset, IntegerFieldDefinitionType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, is_required: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_required'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class IntegerFieldDefinition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

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

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

property id: str

property is_multi: bool

property is_required: bool

property name: str

property numeric_max: Optional[float]

property numeric_min: Optional[float]

to_dict() → Dict[str, Any]

property type: IntegerFieldDefinitionType

class IntegerFieldDefinitionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INTEGER = 'integer'

static of_unknown(val: str) → IntegerFieldDefinitionType

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 LabAutomationBenchlingAppError

Bases: object

__init__(message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class LabAutomationBenchlingAppError.

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.lab_automation_benchling_app_error.T

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

property message: str

to_dict() → Dict[str, Any]

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, List[LabAutomationBenchlingAppError]] = attr_dict['_errors'].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, output_processor_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_output_processor_id'].default, status: Union[benchling_api_client.v2.types.Unset, 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: List[LabAutomationBenchlingAppError]

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 modified_at: datetime

DateTime the transform was last modified.

property output_processor_id: str

property status: LabAutomationTransformStatus

to_dict() → Dict[str, Any]

class LabAutomationTransformStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FAILED = 'FAILED'

NOT_STARTED = 'NOT_STARTED'

RUNNING = 'RUNNING'

SUCCEEDED = 'SUCCEEDED'

static of_unknown(val: str) → LabAutomationTransformStatus

class LabAutomationTransformUpdate

Bases: object

__init__(blob_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_blob_id'].default, errors: Union[benchling_api_client.v2.types.Unset, List[LabAutomationBenchlingAppError]] = attr_dict['_errors'].default) → None

Method generated by attrs for class LabAutomationTransformUpdate.

property blob_id: str

property errors: List[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 LabelTemplatesList

Bases: object

__init__(label_templates: Union[benchling_api_client.v2.types.Unset, List[LabelTemplate]] = attr_dict['_label_templates'].default) → None

Method generated by attrs for class LabelTemplatesList.

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_templates_list.T

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

property label_templates: List[LabelTemplate]

to_dict() → Dict[str, Any]

class LegacyWorkflow

Bases: object

__init__(created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, description: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_description'].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, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) → None

Method generated by attrs for class LegacyWorkflow.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

DateTime at which the the legacy workflow was created

property description: Optional[str]

Description of the legacy workflow

property display_id: str

User-friendly ID of the legacy workflow

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

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

property id: str

ID of the legacy workflow

property name: str

Name of the legacy workflow

property project_id: str

ID of the project that contains the legacy workflow

to_dict() → Dict[str, Any]

class LegacyWorkflowList

Bases: object

__init__(workflows: Union[benchling_api_client.v2.types.Unset, List[LegacyWorkflow]] = attr_dict['_workflows'].default) → None

Method generated by attrs for class LegacyWorkflowList.

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.legacy_workflow_list.T

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

to_dict() → Dict[str, Any]

property workflows: List[LegacyWorkflow]

class LegacyWorkflowPatch

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, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) → None

Method generated by attrs for class LegacyWorkflowPatch.

property description: str

Description of the legacy workflow

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

property name: str

Name of the legacy workflow

property project_id: str

ID of the project that contains the legacy workflow

to_dict() → Dict[str, Any]

class LegacyWorkflowSample

Bases: object

__init__(batch_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_batch_id'].default, container_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_container_ids'].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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class LegacyWorkflowSample.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batch_id: str

ID of the batch

property container_ids: List[str]

Array of IDs of containers

property created_at: datetime

DateTime at which the the sample was created

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

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

property id: str

ID of the sample

property name: str

Name of the sample

to_dict() → Dict[str, Any]

class LegacyWorkflowSampleList

Bases: object

__init__(samples: Union[benchling_api_client.v2.types.Unset, List[LegacyWorkflowSample]] = attr_dict['_samples'].default) → None

Method generated by attrs for class LegacyWorkflowSampleList.

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.legacy_workflow_sample_list.T

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

property samples: List[LegacyWorkflowSample]

to_dict() → Dict[str, Any]

class LegacyWorkflowStage

Bases: object

__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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class LegacyWorkflowStage.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

DateTime at which the the legacy workflow stage was created

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

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

property id: str

ID of the legacy workflow stage

property name: str

Name of the legacy workflow stage

to_dict() → Dict[str, Any]

class LegacyWorkflowStageList

Bases: object

__init__(workflow_stages: Union[benchling_api_client.v2.types.Unset, List[LegacyWorkflowStage]] = attr_dict['_workflow_stages'].default) → None

Method generated by attrs for class LegacyWorkflowStageList.

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.legacy_workflow_stage_list.T

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

to_dict() → Dict[str, Any]

property workflow_stages: List[LegacyWorkflowStage]

class LegacyWorkflowStageRun

Bases: object

__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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, status: Union[benchling_api_client.v2.types.Unset, LegacyWorkflowStageRunStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class LegacyWorkflowStageRun.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

DateTime at which the the legacy workflow stage run was created

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

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

property id: str

ID of the legacy workflow stage run

property name: str

Name of the legacy workflow stage run

property status: LegacyWorkflowStageRunStatus

Status of the legacy workflow stage run

to_dict() → Dict[str, Any]

class LegacyWorkflowStageRunList

Bases: object

__init__(workflow_stage_runs: Union[benchling_api_client.v2.types.Unset, List[LegacyWorkflowStageRun]] = attr_dict['_workflow_stage_runs'].default) → None

Method generated by attrs for class LegacyWorkflowStageRunList.

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.legacy_workflow_stage_run_list.T

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

to_dict() → Dict[str, Any]

property workflow_stage_runs: List[LegacyWorkflowStageRun]

class LegacyWorkflowStageRunStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

COMPLETED = 'COMPLETED'

DISCARDED = 'DISCARDED'

INITIALIZED = 'INITIALIZED'

static of_unknown(val: str) → LegacyWorkflowStageRunStatus

class LinkedAppConfigResourceMixin

Bases: object

__init__(linked_resource: Union[benchling_api_client.v2.types.Unset, None, LinkedAppConfigResourceSummary, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_linked_resource'].default) → None

Method generated by attrs for class LinkedAppConfigResourceMixin.

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.linked_app_config_resource_mixin.T

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

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

to_dict() → Dict[str, Any]

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.

MODIFIEDAT = 'modifiedAt'

MODIFIEDATASC = 'modifiedAt:asc'

MODIFIEDATDESC = 'modifiedAt:desc'

NAME = 'name'

NAMEASC = 'name:asc'

NAMEDESC = 'name:desc'

static of_unknown(val: str) → ListAASequencesSort

class ListAppConfigurationItemsSort

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

MODIFIEDAT = 'modifiedAt'

MODIFIEDATASC = 'modifiedAt:asc'

MODIFIEDATDESC = 'modifiedAt:desc'

static of_unknown(val: str) → ListAppConfigurationItemsSort

class ListAssayResultsSort

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CREATEDATASC = 'createdAt:asc'

CREATEDATDESC = 'createdAt:desc'

static of_unknown(val: str) → ListAssayResultsSort

class ListBatchesSort

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

MODIFIEDAT = 'modifiedAt'

MODIFIEDATASC = 'modifiedAt:asc'

MODIFIEDATDESC = 'modifiedAt:desc'

NAME = 'name'

NAMEASC = 'name:asc'

NAMEDESC = 'name:desc'

static of_unknown(val: str) → ListBatchesSort

class ListBenchlingAppsSort

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

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.

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'

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.

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.

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.

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.

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.

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.

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.

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'

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.

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.

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.

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.

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.

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'

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.

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.

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.

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.

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.

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, ArchiveRecord] = attr_dict['_archive_record'].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, 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, 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, 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 Location.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property barcode: str

property created_at: str

property creator: 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 parent_storage_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: LocationSchemaType

class LocationSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

LOCATION = 'location'

static of_unknown(val: str) → LocationSchemaType

class LocationSchemasList

Bases: object

__init__(location_schemas: Union[benchling_api_client.v2.types.Unset, List[LocationSchema]] = attr_dict['_location_schemas'].default) → None

Method generated by attrs for class LocationSchemasList.

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_list.T

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

property location_schemas: List[LocationSchema]

to_dict() → Dict[str, Any]

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__(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 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 storage 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 LocationsBulkGet

Bases: object

__init__(locations: Union[benchling_api_client.v2.types.Unset, List[Location]] = attr_dict['_locations'].default) → None

Method generated by attrs for class LocationsBulkGet.

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_bulk_get.T

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

property locations: List[Location]

to_dict() → Dict[str, Any]

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 LookupTableNotePart

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, LookupTableNotePartType] = attr_dict['_type'].default, api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default) → None

Method generated by attrs for class LookupTableNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property columns: List[StructuredTableColumnInfo]

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

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

to_dict() → Dict[str, Any]

property type: LookupTableNotePartType

class LookupTableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

LOOKUP_TABLE = 'lookup_table'

static of_unknown(val: str) → LookupTableNotePartType

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, ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, 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[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, 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, SchemaSummary] = attr_dict['_schema'].default, units: Union[benchling_api_client.v2.types.Unset, 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[ArchiveRecord]

property authors: List[UserSummary]

property created_at: datetime

property 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[Ingredient]

List of ingredients on this mixture.

property modified_at: datetime

property name: str

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: SchemaSummary

to_dict() → Dict[str, Any]

property 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[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, 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[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: 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[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, 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[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: MixtureMeasurementUnits

class MixtureCreator

Bases: object

__init__() → None

Method generated by attrs for class MixtureCreator.

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.mixture_creator.T

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

to_dict() → Dict[str, Any]

class MixtureMeasurementUnits

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

G = 'g'

KG = 'kg'

L = 'L'

ML = 'mL'

NL = 'nL'

UL = 'uL'

UNITS = 'Units'

static of_unknown(val: str) → MixtureMeasurementUnits

class MixturePrepTableNotePart

Bases: object

__init__(mixture_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mixture_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, MixturePrepTableNotePartType] = attr_dict['_type'].default, api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class MixturePrepTableNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property columns: List[StructuredTableColumnInfo]

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

property mixture_schema_id: str

to_dict() → Dict[str, Any]

property type: MixturePrepTableNotePartType

class MixturePrepTableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

MIXTURE_PREP_TABLE = 'mixture_prep_table'

static of_unknown(val: str) → MixturePrepTableNotePartType

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[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, 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[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: MixtureMeasurementUnits

class MixtureWithEntityType

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, 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, ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, 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[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, 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, SchemaSummary] = attr_dict['_schema'].default, units: Union[benchling_api_client.v2.types.Unset, 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[ArchiveRecord]

property authors: List[UserSummary]

property created_at: datetime

property creator: MixtureCreator

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

property 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[Ingredient]

List of ingredients on this mixture.

property modified_at: datetime

property name: str

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: SchemaSummary

to_dict() → Dict[str, Any]

property units: MixtureMeasurementUnits

property web_url: str

class MixtureWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

MIXTURE = 'mixture'

static of_unknown(val: str) → MixtureWithEntityTypeEntityType

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, 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, 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, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, 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[ArchiveRecord]

property canonicalized_smiles: str

The canonicalized chemical structure in SMILES format.

property created_at: datetime

DateTime the Molecule was created.

property creator: 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 registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

Registry the Molecule is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the Molecule.

class MoleculeBaseRequest

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, chemical_structure: Union[benchling_api_client.v2.types.Unset, 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 MoleculeBaseRequest.

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: MoleculeStructure

property custom_fields: CustomFields

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_base_request.T

property name: str

Name of the Molecule.

property schema_id: str

ID of the Molecule’s schema.

to_dict() → Dict[str, Any]

class MoleculeBaseRequestForCreate

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, chemical_structure: Union[benchling_api_client.v2.types.Unset, 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 MoleculeBaseRequestForCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

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: MoleculeStructure

property custom_fields: CustomFields

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_base_request_for_create.T

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

property name: str

Name of the Molecule.

property schema_id: str

ID of the Molecule’s schema.

to_dict() → Dict[str, Any]

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, 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: 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, 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: 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 MoleculeStructure

Bases: object

__init__(structure_format: Union[benchling_api_client.v2.types.Unset, MoleculeStructureStructureFormat] = attr_dict['_structure_format'].default, value: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_value'].default) → None

Method generated by attrs for class MoleculeStructure.

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

property structure_format: MoleculeStructureStructureFormat

to_dict() → Dict[str, Any]

property value: str

Chemical structure in SMILES or molfile format.

class MoleculeStructureStructureFormat

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

MOLFILE = 'molfile'

SMILES = 'smiles'

static of_unknown(val: str) → MoleculeStructureStructureFormat

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, 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: 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 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 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, ContainerQuantity] = attr_dict['_final_quantity'].default, final_volume: Union[benchling_api_client.v2.types.Unset, DeprecatedContainerVolumeForInput] = attr_dict['_final_volume'].default, source_concentration: Union[benchling_api_client.v2.types.Unset, MultipleContainersTransferSourceConcentration] = attr_dict['_source_concentration'].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, ContainerQuantity] = attr_dict['_transfer_quantity'].default, transfer_volume: Union[benchling_api_client.v2.types.Unset, 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: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property final_volume: 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 source_batch_id: str

ID of the batch that will be transferred in. Must specify one of sourceEntityId, sourceBatchId, or sourceContainerId.

property 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: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property transfer_volume: 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 MultipleContainersTransferSourceConcentration

Bases: object

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

__init__() → None

Method generated by attrs for class MultipleContainersTransferSourceConcentration.

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.multiple_containers_transfer_source_concentration.T

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

to_dict() → Dict[str, Any]

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, 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: 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 NotFoundErrorError

Bases: object

__init__(invalid_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_invalid_id'].default, type: Union[benchling_api_client.v2.types.Unset, NotFoundErrorErrorType] = attr_dict['_type'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, user_message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_message'].default) → None

Method generated by attrs for class NotFoundErrorError.

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.not_found_error_error.T

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

property invalid_id: str

property message: str

to_dict() → Dict[str, Any]

property type: NotFoundErrorErrorType

property user_message: str

class NotFoundErrorErrorType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID_REQUEST_ERROR = 'invalid_request_error'

static of_unknown(val: str) → NotFoundErrorErrorType

class NucleotideAlignment

Bases: object

__init__(aligned_sequences: Union[benchling_api_client.v2.types.Unset, List[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[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 NucleotideAlignmentBase

Bases: object

__init__(algorithm: NucleotideAlignmentBaseAlgorithm, files: List[Union[NucleotideAlignmentBaseFilesItem, 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 NucleotideAlignmentBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property algorithm: NucleotideAlignmentBaseAlgorithm

property files: List[Union[NucleotideAlignmentBaseFilesItem, 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_alignment_base.T

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

property name: str

to_dict() → Dict[str, Any]

class NucleotideAlignmentBaseAlgorithm

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CLUSTALO = 'clustalo'

MAFFT = 'mafft'

static of_unknown(val: str) → NucleotideAlignmentBaseAlgorithm

class NucleotideAlignmentBaseFilesItem

Bases: object

__init__(sequence_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_sequence_id'].default) → None

Method generated by attrs for class NucleotideAlignmentBaseFilesItem.

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.nucleotide_alignment_base_files_item.T

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

property sequence_id: str

to_dict() → Dict[str, Any]

class NucleotideAlignmentFile

Bases: object

__init__(data: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_data'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class NucleotideAlignmentFile.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property data: str

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

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

property name: str

to_dict() → Dict[str, Any]

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: NucleotideAlignmentBaseAlgorithm, files: List[Union[NucleotideAlignmentBaseFilesItem, NucleotideAlignmentFile, benchling_api_client.v2.extensions.UnknownType]], new_sequence: Union[benchling_api_client.v2.types.Unset, 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: NucleotideAlignmentBaseAlgorithm

property files: List[Union[NucleotideAlignmentBaseFilesItem, 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: NucleotideConsensusAlignmentCreateNewSequence

property sequence_id: str

to_dict() → Dict[str, Any]

class NucleotideConsensusAlignmentCreateNewSequence

Bases: object

__init__(folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default) → None

Method generated by attrs for class NucleotideConsensusAlignmentCreateNewSequence.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property folder_id: str

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

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

to_dict() → Dict[str, Any]

class NucleotideTemplateAlignmentCreate

Bases: object

__init__(template_sequence_id: str, algorithm: NucleotideAlignmentBaseAlgorithm, files: List[Union[NucleotideAlignmentBaseFilesItem, 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: NucleotideAlignmentBaseAlgorithm

property files: List[Union[NucleotideAlignmentBaseFilesItem, 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 OAuthBadRequestError

Bases: object

__init__(error: Union[benchling_api_client.v2.types.Unset, OAuthBadRequestErrorError] = attr_dict['_error'].default) → None

Method generated by attrs for class OAuthBadRequestError.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property error: OAuthBadRequestErrorError

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

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

to_dict() → Dict[str, Any]

class OAuthBadRequestErrorError

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, OAuthBadRequestErrorErrorType] = attr_dict['_type'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, user_message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_message'].default) → None

Method generated by attrs for class OAuthBadRequestErrorError.

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.o_auth_bad_request_error_error.T

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

property message: str

to_dict() → Dict[str, Any]

property type: OAuthBadRequestErrorErrorType

property user_message: str

class OAuthBadRequestErrorErrorType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID_GRANT = 'invalid_grant'

INVALID_REQUEST = 'invalid_request'

UNAUTHORIZED_CLIENT = 'unauthorized_client'

UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'

static of_unknown(val: str) → OAuthBadRequestErrorErrorType

class OAuthUnauthorizedError

Bases: object

__init__(error: Union[benchling_api_client.v2.types.Unset, OAuthUnauthorizedErrorError] = attr_dict['_error'].default) → None

Method generated by attrs for class OAuthUnauthorizedError.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property error: OAuthUnauthorizedErrorError

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

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

to_dict() → Dict[str, Any]

class OAuthUnauthorizedErrorError

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, OAuthUnauthorizedErrorErrorType] = attr_dict['_type'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, user_message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_user_message'].default) → None

Method generated by attrs for class OAuthUnauthorizedErrorError.

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.o_auth_unauthorized_error_error.T

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

property message: str

to_dict() → Dict[str, Any]

property type: OAuthUnauthorizedErrorErrorType

property user_message: str

class OAuthUnauthorizedErrorErrorType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID_CLIENT = 'invalid_client'

static of_unknown(val: str) → OAuthUnauthorizedErrorErrorType

class OligoBaseRequest

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

property additional_keys: List[str]

additional_properties: Dict[str, Any]

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_base_request.T

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

property name: str

Name of the Oligo.

property schema_id: str

ID of the oligo’s schema.

to_dict() → Dict[str, Any]

class OligoBaseRequestForCreate

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

property additional_keys: List[str]

additional_properties: Dict[str, Any]

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_base_request_for_create.T

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

property name: str

Name of the Oligo.

property schema_id: str

ID of the oligo’s schema.

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 OligoNucleotideType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DNA = 'DNA'

RNA = 'RNA'

static of_unknown(val: str) → OligoNucleotideType

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 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 OligosBulkGet

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) → None

Method generated by attrs for class OligosBulkGet.

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_bulk_get.T

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

property oligos: List[Union[DnaOligo, RnaOligo, benchling_api_client.v2.extensions.UnknownType]]

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 OrganizationSummary

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

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_summary.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 Pagination

Bases: object

__init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class Pagination.

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.pagination.T

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

property next_token: str

to_dict() → Dict[str, Any]

class PartySummary

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

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.party_summary.T

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

property handle: str

property id: str

property name: str

to_dict() → Dict[str, Any]

class Plate

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].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, 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, 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, SchemaSummary] = attr_dict['_schema'].default, type: Union[benchling_api_client.v2.types.Unset, 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, PlateWells] = attr_dict['_wells'].default) → None

Method generated by attrs for class Plate.

property archive_record: Optional[ArchiveRecord]

property barcode: Optional[str]

Barcode of the plate

property created_at: datetime

DateTime the container was created

property creator: 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 parent_storage_id: Optional[str]

ID of containing parent storage (e.g. loc_k2lNspzS).

property project_id: Optional[str]

ID of the project if set

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property type: PlateType

property web_url: str

property 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, 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: PlateCreateWells

class PlateCreateWells

Bases: object

__init__() → None

Method generated by attrs for class PlateCreateWells.

property additional_keys: List[str]

additional_properties: Dict[str, PlateCreateWellsAdditionalProperty]

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

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

to_dict() → Dict[str, Any]

class PlateCreateWellsAdditionalProperty

Bases: object

__init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default) → None

Method generated by attrs for class PlateCreateWellsAdditionalProperty.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property barcode: str

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

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

to_dict() → Dict[str, Any]

class PlateCreationTableNotePart

Bases: object

__init__(plate_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_plate_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, PlateCreationTableNotePartType] = attr_dict['_type'].default, api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class PlateCreationTableNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property columns: List[StructuredTableColumnInfo]

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

property plate_schema_id: str

to_dict() → Dict[str, Any]

property type: PlateCreationTableNotePartType

class PlateCreationTableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

PLATE_CREATION_TABLE = 'plate_creation_table'

static of_unknown(val: str) → PlateCreationTableNotePartType

class PlateSchema

Bases: object

__init__(container_schema: Union[benchling_api_client.v2.types.Unset, None, 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, 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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property container_schema: Optional[PlateSchemaContainerSchema]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: PlateSchemaType

property width: float

class PlateSchemaContainerSchema

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

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_schema_container_schema.T

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class PlateSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

PLATE = 'plate'

static of_unknown(val: str) → PlateSchemaType

class PlateSchemasList

Bases: object

__init__(plate_schemas: Union[benchling_api_client.v2.types.Unset, List[PlateSchema]] = attr_dict['_plate_schemas'].default) → None

Method generated by attrs for class PlateSchemasList.

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_list.T

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

property plate_schemas: List[PlateSchema]

to_dict() → Dict[str, Any]

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 PlateType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

MATRIX_PLATE = 'matrix_plate'

WELL_PLATE = 'well_plate'

static of_unknown(val: str) → PlateType

class PlateUpdate

Bases: object

__init__(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 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 PlateWells

Bases: object

Well contents of the plate, keyed by position string (eg. “A1”).

__init__() → None

Method generated by attrs for class PlateWells.

property additional_keys: List[str]

additional_properties: Dict[str, Union[Well, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]

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

get(key, default=None) → Optional[Union[Well, InaccessibleResource, benchling_api_client.v2.extensions.UnknownType]]

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 storage 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 PlatesBulkGet

Bases: object

__init__(plates: Union[benchling_api_client.v2.types.Unset, List[Plate]] = attr_dict['_plates'].default) → None

Method generated by attrs for class PlatesBulkGet.

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_bulk_get.T

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

property plates: List[Plate]

to_dict() → Dict[str, Any]

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 Primer

Bases: object

__init__(bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, bind_position: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_bind_position'].default, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, oligo_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_oligo_id'].default, overhang_length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_overhang_length'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, strand: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_strand'].default) → None

Method generated by attrs for class Primer.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property bases: str

property bind_position: int

property color: str

property end: int

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

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

property name: str

property oligo_id: str

property overhang_length: int

property start: int

property strand: int

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 PrintersList

Bases: object

__init__(label_printers: Union[benchling_api_client.v2.types.Unset, List[Printer]] = attr_dict['_label_printers'].default) → None

Method generated by attrs for class PrintersList.

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.printers_list.T

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

property label_printers: List[Printer]

to_dict() → Dict[str, Any]

class Project

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, 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[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, 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 RegisteredEntitiesList

Bases: object

__init__(entities: Union[benchling_api_client.v2.types.Unset, List[Union[DnaSequenceWithEntityType, CustomEntityWithEntityType, AaSequenceWithEntityType, MixtureWithEntityType, DnaOligoWithEntityType, RnaOligoWithEntityType, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_entities'].default) → None

Method generated by attrs for class RegisteredEntitiesList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entities: List[Union[DnaSequenceWithEntityType, CustomEntityWithEntityType, AaSequenceWithEntityType, MixtureWithEntityType, DnaOligoWithEntityType, RnaOligoWithEntityType, benchling_api_client.v2.extensions.UnknownType]]

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

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

to_dict() → Dict[str, Any]

class RegistrationOrigin

Bases: object

__init__(origin_entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_origin_entry_id'].default, registered_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_registered_at'].default) → None

Method generated by attrs for class RegistrationOrigin.

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.registration_origin.T

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

property origin_entry_id: Optional[str]

property registered_at: datetime

to_dict() → Dict[str, Any]

class RegistrationTableNotePart

Bases: object

__init__(entity_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, RegistrationTableNotePartType] = attr_dict['_type'].default, api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class RegistrationTableNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property columns: List[StructuredTableColumnInfo]

property entity_schema_id: str

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

to_dict() → Dict[str, Any]

property type: RegistrationTableNotePartType

class RegistrationTableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

REGISTRATION_TABLE = 'registration_table'

static of_unknown(val: str) → RegistrationTableNotePartType

class RegistriesList

Bases: object

__init__(registries: Union[benchling_api_client.v2.types.Unset, List[Registry]] = attr_dict['_registries'].default) → None

Method generated by attrs for class RegistriesList.

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.registries_list.T

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

property registries: List[Registry]

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 RegistrySchema

Bases: object

__init__(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, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 RegistrySchema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.registry_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: str

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[RequestUserAssignee, 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, 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, RequestRequestor] = attr_dict['_requestor'].default, sample_groups: Union[benchling_api_client.v2.types.Unset, List[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, RequestSchemaProperty] = attr_dict['_schema'].default, tasks: Union[benchling_api_client.v2.types.Unset, List[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[RequestUserAssignee, RequestTeamAssignee, benchling_api_client.v2.extensions.UnknownType]]

Array of assignees

property created_at: str

Date and time the request was created

property 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: RequestRequestor

property sample_groups: List[RequestSampleGroup]

property scheduled_on: Optional[date]

Date the request is scheduled to be executed on, in YYYY-MM-DD format.

property schema: RequestSchemaProperty

property tasks: List[RequestTask]

to_dict() → Dict[str, Any]

property web_url: str

URL of the request

class RequestBase

Bases: object

A request is an ask to perform a service, e.g. produce a sample or perform assays on a sample. Requests are usually placed to another team or individual who specializes in performing the service.

__init__() → None

Method generated by attrs for class RequestBase.

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_base.T

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

to_dict() → Dict[str, Any]

class RequestCreate

Bases: object

__init__(schema_id: str, assignees: Union[benchling_api_client.v2.types.Unset, List[Union[RequestWriteUserAssignee, 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[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[RequestWriteUserAssignee, 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[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 RequestCreatedEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, RequestCreatedEventEventType] = attr_dict['_event_type'].default, request: Union[benchling_api_client.v2.types.Unset, Request] = attr_dict['_request'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class RequestCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: RequestCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property request: Request

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class RequestCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_REQUESTCREATED = 'v2.request.created'

static of_unknown(val: str) → RequestCreatedEventEventType

class RequestCreator

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

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_creator.T

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

property handle: str

property id: str

property name: str

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, SampleGroup] = attr_dict['_sample_group'].default, status: Union[benchling_api_client.v2.types.Unset, 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[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: 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 RequestRequestor

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

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_requestor.T

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

property handle: str

property id: str

property name: str

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[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[RequestResponseSamplesItem]

Array of samples produced by the request.

to_dict() → Dict[str, Any]

class RequestResponseSamplesItem

Bases: object

__init__(batch: Union[benchling_api_client.v2.types.Unset, None, RequestResponseSamplesItemBatch] = attr_dict['_batch'].default, entity: Union[benchling_api_client.v2.types.Unset, None, RequestResponseSamplesItemEntity] = attr_dict['_entity'].default, status: Union[benchling_api_client.v2.types.Unset, RequestResponseSamplesItemStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class RequestResponseSamplesItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batch: Optional[RequestResponseSamplesItemBatch]

property entity: Optional[RequestResponseSamplesItemEntity]

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

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

property status: RequestResponseSamplesItemStatus

The status of the sample, based on the status of the stage run that generated it.

to_dict() → Dict[str, Any]

class RequestResponseSamplesItemBatch

Bases: object

__init__(inaccessible_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_inaccessible_id'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, 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, UserSummary] = attr_dict['_creator'].default, default_concentration: Union[benchling_api_client.v2.types.Unset, Measurement] = attr_dict['_default_concentration'].default, entity: Union[benchling_api_client.v2.types.Unset, DnaSequenceSummary, AaSequenceSummary, CustomEntitySummary, benchling_api_client.v2.extensions.UnknownType] = attr_dict['_entity'].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, schema: Union[benchling_api_client.v2.types.Unset, None, 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 RequestResponseSamplesItemBatch.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property created_at: datetime

DateTime at which the the result was created

property creator: UserSummary

property default_concentration: Measurement

property entity: Union[DnaSequenceSummary, AaSequenceSummary, CustomEntitySummary, benchling_api_client.v2.extensions.UnknownType]

property fields: Fields

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

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

property id: str

property inaccessible_id: str

property modified_at: datetime

property name: str

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property type: str

The type of this inaccessible item. Example values: “custom_entity”, “container”, “plate”, “dna_sequence”

property web_url: str

class RequestResponseSamplesItemEntity

Bases: object

__init__(inaccessible_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_inaccessible_id'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_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, ArchiveRecord] = attr_dict['_archive_record'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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, 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, SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, nucleotide_type: Union[benchling_api_client.v2.types.Unset, OligoNucleotideType] = attr_dict['_nucleotide_type'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].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, ingredients: Union[benchling_api_client.v2.types.Unset, List[Ingredient]] = attr_dict['_ingredients'].default, units: Union[benchling_api_client.v2.types.Unset, MixtureMeasurementUnits] = attr_dict['_units'].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[DnaAnnotation]] = attr_dict['_annotations'].default, is_circular: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_circular'].default, primers: Union[benchling_api_client.v2.types.Unset, List[Primer]] = attr_dict['_primers'].default, translations: Union[benchling_api_client.v2.types.Unset, List[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class RequestResponseSamplesItemEntity.

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 amino_acids: str

Amino acids of the AA sequence.

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 annotations: List[DnaAnnotation]

property api_url: str

The canonical url of the DNA Sequence in the API.

property archive_record: Optional[ArchiveRecord]

property authors: List[UserSummary]

property bases: str

property created_at: datetime

property creator: 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.request_response_samples_item_entity.T

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

property id: str

property inaccessible_id: str

property ingredients: List[Ingredient]

List of ingredients on this mixture.

property is_circular: bool

property length: int

property modified_at: datetime

property name: str

property nucleotide_type: OligoNucleotideType

Nucleotide type of the Oligo.

property primers: List[Primer]

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property translations: List[Translation]

property type: str

The type of this inaccessible item. Example values: “custom_entity”, “container”, “plate”, “dna_sequence”

property units: MixtureMeasurementUnits

property web_url: str

class RequestResponseSamplesItemStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

COMPLETED = 'COMPLETED'

DISCARDED = 'DISCARDED'

static of_unknown(val: str) → RequestResponseSamplesItemStatus

class RequestSampleGroup

Bases: object

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, samples: Union[benchling_api_client.v2.types.Unset, RequestSampleGroupSamples] = attr_dict['_samples'].default) → None

Method generated by attrs for class RequestSampleGroup.

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_sample_group.T

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

property id: str

property samples: RequestSampleGroupSamples

The key for each RequestSample should match one of the samplesSchema[n].name property in the request schema json.

to_dict() → Dict[str, Any]

class RequestSampleGroupCreate

Bases: object

__init__(samples: RequestSampleGroupSamples) → None

Method generated by attrs for class RequestSampleGroupCreate.

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_sample_group_create.T

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

property samples: RequestSampleGroupSamples

The key for each RequestSample should match one of the samplesSchema[n].name property in the request schema json.

to_dict() → Dict[str, Any]

class RequestSampleGroupSamples

Bases: object

The key for each RequestSample should match one of the samplesSchema[n].name property in the request schema json.

__init__() → None

Method generated by attrs for class RequestSampleGroupSamples.

property additional_keys: List[str]

additional_properties: Dict[str, Union[RequestSampleWithEntity, RequestSampleWithBatch, benchling_api_client.v2.extensions.UnknownType]]

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

get(key, default=None) → Optional[Union[RequestSampleWithEntity, RequestSampleWithBatch, benchling_api_client.v2.extensions.UnknownType]]

to_dict() → Dict[str, Any]

class RequestSampleWithBatch

Bases: object

__init__(batch_id: str, container_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_container_id'].default) → None

Method generated by attrs for class RequestSampleWithBatch.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batch_id: str

property container_id: str

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

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

to_dict() → Dict[str, Any]

class RequestSampleWithEntity

Bases: object

__init__(entity_id: str, container_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_container_id'].default) → None

Method generated by attrs for class RequestSampleWithEntity.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property container_id: str

property entity_id: str

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

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

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, 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, RequestSchemaType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: RequestSchemaOrganization

The organization that owns the schema.

property system_name: str

to_dict() → Dict[str, Any]

property type: RequestSchemaType

class RequestSchemaOrganization

Bases: object

The organization that owns the schema.

__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 RequestSchemaOrganization.

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_schema_organization.T

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

property handle: str

property id: str

property name: str

to_dict() → Dict[str, Any]

class RequestSchemaProperty

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

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_schema_property.T

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

property id: str

property name: str

to_dict() → Dict[str, Any]

class RequestSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

REQUEST = 'request'

static of_unknown(val: str) → 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 RequestTask

Bases: object

A request task.

__init__(id: str, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, 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 RequestTask.

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

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

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 RequestTaskBaseFields

Bases: object

Shared fields for request tasks and related endpoints.

__init__(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 RequestTaskBaseFields.

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_fields.T

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

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, 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, RequestTaskSchemaType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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: RequestTaskSchemaOrganization

The organization that owns the schema.

property system_name: str

to_dict() → Dict[str, Any]

property type: RequestTaskSchemaType

class RequestTaskSchemaOrganization

Bases: object

The organization that owns the schema.

__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 RequestTaskSchemaOrganization.

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_schema_organization.T

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

property handle: str

property id: str

property name: str

to_dict() → Dict[str, Any]

class RequestTaskSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

REQUEST_TASK = 'request_task'

static of_unknown(val: str) → 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[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[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[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[RequestTask]

The tasks to update

to_dict() → Dict[str, Any]

class RequestTeamAssignee

Bases: object

__init__(team: Union[benchling_api_client.v2.types.Unset, TeamSummary] = attr_dict['_team'].default) → None

Method generated by attrs for class RequestTeamAssignee.

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_team_assignee.T

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

property team: TeamSummary

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[RequestWriteUserAssignee, 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[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[RequestWriteUserAssignee, 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[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 RequestUpdatedFieldsEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, RequestUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, request: Union[benchling_api_client.v2.types.Unset, Request] = attr_dict['_request'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class RequestUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: RequestUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property request: Request

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class RequestUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_REQUESTUPDATEDFIELDS = 'v2.request.updated.fields'

static of_unknown(val: str) → RequestUpdatedFieldsEventEventType

class RequestUserAssignee

Bases: object

__init__(user: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_user'].default) → None

Method generated by attrs for class RequestUserAssignee.

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_user_assignee.T

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

to_dict() → Dict[str, Any]

property user: UserSummary

class RequestWriteBase

Bases: object

__init__(assignees: Union[benchling_api_client.v2.types.Unset, List[Union[RequestWriteUserAssignee, 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[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 RequestWriteBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assignees: List[Union[RequestWriteUserAssignee, 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_write_base.T

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

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[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 RequestWriteTeamAssignee

Bases: object

__init__(team_id: str) → None

Method generated by attrs for class RequestWriteTeamAssignee.

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_write_team_assignee.T

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

property team_id: str

to_dict() → Dict[str, Any]

class RequestWriteUserAssignee

Bases: object

__init__(user_id: str) → None

Method generated by attrs for class RequestWriteUserAssignee.

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_write_user_assignee.T

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

to_dict() → Dict[str, Any]

property user_id: str

class RequestsBulkGet

Bases: object

__init__(requests: Union[benchling_api_client.v2.types.Unset, List[Request]] = attr_dict['_requests'].default) → None

Method generated by attrs for class RequestsBulkGet.

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_bulk_get.T

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

property requests: List[Request]

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 ResultsTableNotePart

Bases: object

__init__(assay_result_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_result_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, ResultsTableNotePartType] = attr_dict['_type'].default, api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class ResultsTableNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property assay_result_schema_id: str

property columns: List[StructuredTableColumnInfo]

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

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

to_dict() → Dict[str, Any]

property type: ResultsTableNotePartType

class ResultsTableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

RESULTS_TABLE = 'results_table'

static of_unknown(val: str) → ResultsTableNotePartType

class RnaAnnotation

Bases: object

__init__(end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, strand: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_strand'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, List[SequenceFeatureCustomField]] = attr_dict['_custom_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, notes: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_notes'].default) → None

Method generated by attrs for class RnaAnnotation.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property color: str

Hex color code used when displaying this feature in the UI.

property custom_fields: List[SequenceFeatureCustomField]

property end: int

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

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

property name: str

property notes: str

property start: int

property strand: int

to_dict() → Dict[str, Any]

property type: str

class RnaOligo

Bases: object

__init__(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, 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, 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, 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, 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, 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 api_url: str

property archive_record: Optional[ArchiveRecord]

property bases: str

property created_at: datetime

DateTime the Oligo was created.

property creator: UserSummary

property custom_fields: CustomFields

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 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[RegistrationOrigin]

property registry_id: Optional[str]

Registry the Oligo is registered in.

property schema: Optional[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, 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 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.rna_oligo_bulk_update.T

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__(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 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.rna_oligo_create.T

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

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__(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 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.rna_oligo_update.T

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

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, RnaOligoWithEntityTypeEntityType] = attr_dict['_entity_type'].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, nucleotide_type: Union[benchling_api_client.v2.types.Unset, 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, 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, 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, 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, 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 api_url: str

The canonical url of the Oligo in the API.

property archive_record: Optional[ArchiveRecord]

property bases: str

Base pairs of the Oligo.

property created_at: datetime

DateTime the Oligo was created.

property creator: UserSummary

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

Registry ID of the Oligo if registered.

property 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 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: OligoNucleotideType

Nucleotide type of the Oligo.

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

Registry the Oligo is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the Oligo.

class RnaOligoWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

RNA_OLIGO = 'rna_oligo'

static of_unknown(val: str) → RnaOligoWithEntityTypeEntityType

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 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[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, 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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[Primer]] = attr_dict['_primers'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, 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, SchemaSummary] = attr_dict['_schema'].default, translations: Union[benchling_api_client.v2.types.Unset, List[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[RnaAnnotation]

property api_url: str

The canonical url of the RNA Sequence in the API.

property archive_record: Optional[ArchiveRecord]

property bases: str

property created_at: datetime

property creator: 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.rna_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 primers: List[Primer]

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property translations: List[Translation]

property web_url: str

class RnaSequenceBaseRequest

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[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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class RnaSequenceBaseRequest.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property aliases: List[str]

Aliases to add to the RNA sequence

property annotations: List[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 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_base_request.T

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

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 primers: List[Primer]

property schema_id: str

ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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 RnaSequenceBaseRequestForCreate

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[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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class RnaSequenceBaseRequestForCreate.

property aliases: List[str]

Aliases to add to the RNA sequence

property annotations: List[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 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_base_request_for_create.T

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 primers: List[Primer]

property schema_id: str

ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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 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[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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].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[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 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 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 primers: List[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[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[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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class RnaSequenceBulkUpdate.

property aliases: List[str]

Aliases to add to the RNA sequence

property annotations: List[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 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 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 primers: List[Primer]

property schema_id: str

ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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[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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class RnaSequenceCreate.

property aliases: List[str]

Aliases to add to the RNA sequence

property annotations: List[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 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 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 primers: List[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[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 RnaSequenceRequestRegistryFields

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default) → None

Method generated by attrs for class RnaSequenceRequestRegistryFields.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: str

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

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

to_dict() → Dict[str, Any]

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[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, 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, primers: Union[benchling_api_client.v2.types.Unset, List[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[Translation]] = attr_dict['_translations'].default) → None

Method generated by attrs for class RnaSequenceUpdate.

property aliases: List[str]

Aliases to add to the RNA sequence

property annotations: List[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 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 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 primers: List[Primer]

property schema_id: str

ID of the RNA sequence’s schema.

to_dict() → Dict[str, Any]

property translations: List[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 RnaSequencesBulkGet

Bases: object

__init__(rna_sequences: Union[benchling_api_client.v2.types.Unset, List[RnaSequence]] = attr_dict['_rna_sequences'].default) → None

Method generated by attrs for class RnaSequencesBulkGet.

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_bulk_get.T

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

property rna_sequences: List[RnaSequence]

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 SampleGroup

Bases: object

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.

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, samples: Union[benchling_api_client.v2.types.Unset, SampleGroupSamples] = attr_dict['_samples'].default) → None

Method generated by attrs for class SampleGroup.

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.sample_group.T

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

property id: str

property samples: SampleGroupSamples

to_dict() → Dict[str, Any]

class SampleGroupSamples

Bases: object

__init__() → None

Method generated by attrs for class SampleGroupSamples.

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.sample_group_samples.T

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

to_dict() → Dict[str, Any]

class SampleGroupStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

COMPLETED = 'COMPLETED'

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

static of_unknown(val: str) → SampleGroupStatus

class SampleGroupStatusUpdate

Bases: object

__init__(sample_group_id: str, status: SampleGroupStatus) → None

Method generated by attrs for class SampleGroupStatusUpdate.

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.sample_group_status_update.T

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

property sample_group_id: str

The string id of the sample group

property status: SampleGroupStatus

Status of a sample group

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[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[SampleGroupStatusUpdate]

to_dict() → Dict[str, Any]

class Schema

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 Schema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]

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

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

property id: str

property name: str

to_dict() → Dict[str, Any]

property type: str

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 SchemaLinkFieldDefinition

Bases: object

__init__(schema_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, SchemaLinkFieldDefinitionType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, is_required: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_required'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class SchemaLinkFieldDefinition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

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

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

property id: str

property is_multi: bool

property is_required: bool

property name: str

property schema_id: Optional[str]

to_dict() → Dict[str, Any]

property type: SchemaLinkFieldDefinitionType

class SchemaLinkFieldDefinitionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_REQUEST_LINK = 'assay_request_link'

ASSAY_RESULT_LINK = 'assay_result_link'

ASSAY_RUN_LINK = 'assay_run_link'

BATCH_LINK = 'batch_link'

ENTITY_LINK = 'entity_link'

ENTRY_LINK = 'entry_link'

PART_LINK = 'part_link'

STORAGE_LINK = 'storage_link'

TRANSLATION_LINK = 'translation_link'

static of_unknown(val: str) → SchemaLinkFieldDefinitionType

class SchemaSummary

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

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_summary.T

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

property id: str

property name: str

to_dict() → Dict[str, Any]

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 SequenceFeatureBase

Bases: object

__init__(color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, List[SequenceFeatureCustomField]] = attr_dict['_custom_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, notes: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_notes'].default) → None

Method generated by attrs for class SequenceFeatureBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property color: str

Hex color code used when displaying this feature in the UI.

property custom_fields: List[SequenceFeatureCustomField]

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

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

property name: str

property notes: str

to_dict() → Dict[str, Any]

class SequenceFeatureCustomField

Bases: object

A name and value pair associated with a sequence feature (annotation or translation). For genbank imports, these are the qualifiers associated with each feature.

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, value: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_value'].default) → None

Method generated by attrs for class SequenceFeatureCustomField.

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.sequence_feature_custom_field.T

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

property name: str

Name of the custom field

to_dict() → Dict[str, Any]

property value: str

Value of the custom field

class SimpleFieldDefinition

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, SimpleFieldDefinitionType] = attr_dict['_type'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_multi: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_multi'].default, is_required: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_required'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class SimpleFieldDefinition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

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

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

property id: str

property is_multi: bool

property is_required: bool

property name: str

to_dict() → Dict[str, Any]

property type: SimpleFieldDefinitionType

class SimpleFieldDefinitionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE_LINK = 'aa_sequence_link'

BLOB_LINK = 'blob_link'

BOOLEAN = 'boolean'

CUSTOM_ENTITY_LINK = 'custom_entity_link'

DATE = 'date'

DATETIME = 'datetime'

DNA_SEQUENCE_LINK = 'dna_sequence_link'

JSON = 'json'

LONG_TEXT = 'long_text'

MIXTURE_LINK = 'mixture_link'

TEXT = 'text'

static of_unknown(val: str) → SimpleFieldDefinitionType

class SimpleNotePart

Bases: object

Simple note parts include the following types: - ‘text’: plain text - ‘code’: preformatted code block - ‘list_bullet’: one “line” of a bulleted list - ‘list_number’: one “line” of a numbered list

__init__(links: Union[benchling_api_client.v2.types.Unset, List[EntryLink]] = attr_dict['_links'].default, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default, type: Union[benchling_api_client.v2.types.Unset, SimpleNotePartType] = attr_dict['_type'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class SimpleNotePart.

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.simple_note_part.T

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

property links: List[EntryLink]

Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note.

property text: str

The textual contents of the note.

to_dict() → Dict[str, Any]

property type: SimpleNotePartType

class SimpleNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CODE = 'code'

LIST_BULLET = 'list_bullet'

LIST_NUMBER = 'list_number'

TEXT = 'text'

static of_unknown(val: str) → SimpleNotePartType

class StageEntry

Bases: object

A notebook entry used for execution of one or more stage runs in a legacy workflow.

__init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, authors: Union[benchling_api_client.v2.types.Unset, List[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, UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].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, 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, StageEntryReviewRecord] = attr_dict['_review_record'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EntrySchema] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, workflow_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_workflow_id'].default, workflow_stage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_workflow_stage_id'].default) → None

Method generated by attrs for class StageEntry.

property api_url: str

The canonical url of the Stage Entry in the API.

property authors: List[UserSummary]

Array of UserSummary Resources of the authors of the stage entry. This defaults to the creator but can be manually changed.

property created_at: datetime

DateTime the stage entry was created at

property creator: UserSummary

property custom_fields: CustomFields

property display_id: str

User-friendly ID of the stage entry

property fields: Fields

property folder_id: str

ID of the folder that contains the stage entry

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

property id: str

ID of the stage entry

property modified_at: str

DateTime the stage entry was last modified

property name: str

Title of the stage entry

property review_record: Optional[StageEntryReviewRecord]

Review record if set

property schema: Optional[EntrySchema]

Entry schema

to_dict() → Dict[str, Any]

property web_url: str

URL of the stage entry

property workflow_id: str

ID of the parent workflow

property workflow_stage_id: str

ID of the associated workflow stage

class StageEntryCreatedEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, StageEntryCreatedEventEventType] = attr_dict['_event_type'].default, stage_entry: Union[benchling_api_client.v2.types.Unset, StageEntry] = attr_dict['_stage_entry'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class StageEntryCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: StageEntryCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

property stage_entry: StageEntry

A notebook entry used for execution of one or more stage runs in a legacy workflow.

to_dict() → Dict[str, Any]

class StageEntryCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ALPHASTAGEENTRYCREATED = 'v2-alpha.stageEntry.created'

static of_unknown(val: str) → StageEntryCreatedEventEventType

class StageEntryReviewRecord

Bases: object

Review record if set

__init__() → None

Method generated by attrs for class StageEntryReviewRecord.

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.stage_entry_review_record.T

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

to_dict() → Dict[str, Any]

class StageEntryUpdatedFieldsEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, StageEntryUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, stage_entry: Union[benchling_api_client.v2.types.Unset, StageEntry] = attr_dict['_stage_entry'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class StageEntryUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: StageEntryUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

property stage_entry: StageEntry

A notebook entry used for execution of one or more stage runs in a legacy workflow.

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class StageEntryUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ALPHASTAGEENTRYUPDATEDFIELDS = 'v2-alpha.stageEntry.updated.fields'

static of_unknown(val: str) → StageEntryUpdatedFieldsEventEventType

class StageEntryUpdatedReviewRecordEvent

Bases: object

__init__(entry: Union[benchling_api_client.v2.types.Unset, StageEntry] = attr_dict['_entry'].default, event_type: Union[benchling_api_client.v2.types.Unset, StageEntryUpdatedReviewRecordEventEventType] = attr_dict['_event_type'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class StageEntryUpdatedReviewRecordEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property entry: StageEntry

A notebook entry used for execution of one or more stage runs in a legacy workflow.

property event_type: StageEntryUpdatedReviewRecordEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class StageEntryUpdatedReviewRecordEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ALPHASTAGEENTRYUPDATEDREVIEWRECORD = 'v2-alpha.stageEntry.updated.reviewRecord'

static of_unknown(val: str) → StageEntryUpdatedReviewRecordEventEventType

class StructuredTableApiIdentifiers

Bases: object

__init__(api_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_id'].default, columns: Union[benchling_api_client.v2.types.Unset, List[StructuredTableColumnInfo]] = attr_dict['_columns'].default) → None

Method generated by attrs for class StructuredTableApiIdentifiers.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_id: str

property columns: List[StructuredTableColumnInfo]

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

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

to_dict() → Dict[str, Any]

class StructuredTableColumnInfo

Bases: object

__init__(column_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_column_id'].default, is_read_only: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_read_only'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class StructuredTableColumnInfo.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property column_id: str

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

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

property is_read_only: bool

property name: str

to_dict() → Dict[str, Any]

class TableNotePart

Bases: object

A table with rows and columns of text

__init__(links: Union[benchling_api_client.v2.types.Unset, List[EntryLink]] = attr_dict['_links'].default, table: Union[benchling_api_client.v2.types.Unset, EntryTable] = attr_dict['_table'].default, text: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_text'].default, type: Union[benchling_api_client.v2.types.Unset, TableNotePartType] = attr_dict['_type'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class TableNotePart.

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.table_note_part.T

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

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

property links: List[EntryLink]

Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note.

property table: EntryTable

Actual tabular data with rows and columns of text on the note.

property text: str

The caption of the table.

to_dict() → Dict[str, Any]

property type: TableNotePartType

class TableNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

TABLE = 'table'

static of_unknown(val: str) → TableNotePartType

class Team

Bases: object

__init__(organization: Union[benchling_api_client.v2.types.Unset, 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: OrganizationSummary

to_dict() → Dict[str, Any]

class TeamSummary

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

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_summary.T

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

property handle: str

property id: str

property name: str

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, AppConfigItemApiMixinApp] = attr_dict['_app'].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: AppConfigItemApiMixinApp

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 TokenCreate

Bases: object

__init__(grant_type: TokenCreateGrantType, client_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_client_id'].default, client_secret: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_client_secret'].default) → None

Method generated by attrs for class TokenCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property client_id: str

ID of client to request token for. Leave off if client ID and secret are being supplied through Authorization header.

property client_secret: str

Leave off if client ID and secret are being supplied through Authorization header.

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

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

property grant_type: TokenCreateGrantType

to_dict() → Dict[str, Any]

class TokenCreateGrantType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CLIENT_CREDENTIALS = 'client_credentials'

static of_unknown(val: str) → TokenCreateGrantType

class TokenResponse

Bases: object

__init__(access_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_access_token'].default, expires_in: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_expires_in'].default, token_type: Union[benchling_api_client.v2.types.Unset, TokenResponseTokenType] = attr_dict['_token_type'].default) → None

Method generated by attrs for class TokenResponse.

property access_token: str

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property expires_in: int

Number of seconds that token is valid for

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

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

to_dict() → Dict[str, Any]

property token_type: TokenResponseTokenType

class TokenResponseTokenType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BEARER = 'Bearer'

static of_unknown(val: str) → TokenResponseTokenType

class TransfersAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, TransfersAsyncTaskResponse] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class TransfersAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property 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.transfers_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: TransfersAsyncTaskResponse

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class TransfersAsyncTaskResponse

Bases: object

__init__(destination_containers: Union[benchling_api_client.v2.types.Unset, List[Container]] = attr_dict['_destination_containers'].default) → None

Method generated by attrs for class TransfersAsyncTaskResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property destination_containers: List[Container]

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

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

to_dict() → Dict[str, Any]

class Translation

Bases: object

__init__(amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, genetic_code: Union[benchling_api_client.v2.types.Unset, TranslationGeneticCode] = attr_dict['_genetic_code'].default, regions: Union[benchling_api_client.v2.types.Unset, List[TranslationRegionsItem]] = attr_dict['_regions'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, strand: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_strand'].default, color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, List[SequenceFeatureCustomField]] = attr_dict['_custom_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, notes: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_notes'].default) → None

Method generated by attrs for class Translation.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property amino_acids: str

property color: str

Hex color code used when displaying this feature in the UI.

property custom_fields: List[SequenceFeatureCustomField]

property end: int

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

property genetic_code: TranslationGeneticCode

The genetic code to use when translating the nucleotide sequence into amino acids.

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

property name: str

property notes: str

property regions: List[TranslationRegionsItem]

property start: int

property strand: int

to_dict() → Dict[str, Any]

class TranslationGeneticCode

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ALTERNATIVE_FLATWORM_MITOCHONDRIAL = 'ALTERNATIVE_FLATWORM_MITOCHONDRIAL'

ALTERNATIVE_YEAST_NUCLEAR = 'ALTERNATIVE_YEAST_NUCLEAR'

ASCIDIAN_MITOCHONDRIAL = 'ASCIDIAN_MITOCHONDRIAL'

BACTERIAL_ARCHAEAL_PLANT_PLASTID = 'BACTERIAL_ARCHAEAL_PLANT_PLASTID'

CANDIDATE_DIVISION_S_R1_GRACILIBACTERIA = 'CANDIDATE_DIVISION_SR1_GRACILIBACTERIA'

CEPHALODISCIDAE_MITOCHONDRIAL_UAA_TYR = 'CEPHALODISCIDAE_MITOCHONDRIAL_UAA_TYR'

CHLOROPHYCEAN_MITOCHONDRIAL = 'CHLOROPHYCEAN_MITOCHONDRIAL'

CILIATE_DASYCLADACEAN_HEXAMITA_NUCLEAR = 'CILIATE_DASYCLADACEAN_HEXAMITA_NUCLEAR'

ECHINODERM_FLATWORM_MITOCHONDRIAL = 'ECHINODERM_FLATWORM_MITOCHONDRIAL'

EUPLOTID_NUCLEAR = 'EUPLOTID_NUCLEAR'

INVERTEBRATE_MITOCHONDRIAL = 'INVERTEBRATE_MITOCHONDRIAL'

MESODINIUM_NUCLEAR = 'MESODINIUM_NUCLEAR'

MOLD_PROTOZOAN_COELENTERATE_MITOCHONDRIAL_MYCOPLASMA_SPIROPLASMA = 'MOLD_PROTOZOAN_COELENTERATE_MITOCHONDRIAL_MYCOPLASMA_SPIROPLASMA'

PACHYSOLEN_TANNOPHILUS_NUCLEAR = 'PACHYSOLEN_TANNOPHILUS_NUCLEAR'

PERITRICH_NUCLEAR = 'PERITRICH_NUCLEAR'

RHABDOPLEURIDAE_MITOCHONDRIAL = 'RHABDOPLEURIDAE_MITOCHONDRIAL'

SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL = 'SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL'

STANDARD = 'STANDARD'

THRAUSTOCHYTRIUM_MITOCHONDRIAL = 'THRAUSTOCHYTRIUM_MITOCHONDRIAL'

TREMATODE_MITOCHONDRIAL = 'TREMATODE_MITOCHONDRIAL'

VERTEBRATE_MITOCHONDRIAL = 'VERTEBRATE_MITOCHONDRIAL'

YEAST_MITOCHONDRIAL = 'YEAST_MITOCHONDRIAL'

static of_unknown(val: str) → TranslationGeneticCode

class TranslationRegionsItem

Bases: object

__init__(end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default) → None

Method generated by attrs for class TranslationRegionsItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property end: int

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

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

property start: int

to_dict() → Dict[str, Any]

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 UpdateEventMixin

Bases: object

__init__(updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default) → None

Method generated by attrs for class UpdateEventMixin.

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.update_event_mixin.T

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

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class User

Bases: object

__init__(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 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 UserSummary

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

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_summary.T

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

property handle: str

property id: str

property name: str

to_dict() → Dict[str, Any]

class UserValidation

Bases: object

__init__(validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, UserValidationValidationStatus] = attr_dict['_validation_status'].default) → None

Method generated by attrs for class UserValidation.

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_validation.T

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

to_dict() → Dict[str, Any]

property validation_comment: str

A string explaining the reason for the provided validation status.

property validation_status: UserValidationValidationStatus

Valid values for this enum depend on whether it is used to set a value (e.g., in a POST request), or is a return value for an existing result. Acceptable values for setting a status are ‘VALID’ or ‘INVALID’. Possible return values are ‘VALID’, ‘INVALID’, or ‘PARTIALLY_VALID’ (a result will be partially valid if it has some valid fields and some invalid fields).

class UserValidationValidationStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID = 'INVALID'

PARTIALLY_VALID = 'PARTIALLY_VALID'

VALID = 'VALID'

static of_unknown(val: str) → UserValidationValidationStatus

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 Well

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, checkout_record: Union[benchling_api_client.v2.types.Unset, 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, 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, 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, ContainerQuantity] = attr_dict['_quantity'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, volume: Union[benchling_api_client.v2.types.Unset, 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 Well.

property archive_record: Optional[ArchiveRecord]

property barcode: str

Barcode of the well

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

Array of well contents, each with a batch and concentration

property created_at: datetime

DateTime the well was created

property creator: UserSummary

property fields: Fields

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

property id: str

ID of the well

property modified_at: datetime

DateTime the well was last modified

property name: str

Name of the well, defaults to barcode if name is not provided.

property parent_storage_id: Optional[str]

ID of containing parent storage, a plate well with a coordinate (e.g. plt_2bAks9dx:a2).

property parent_storage_schema: SchemaSummary

property project_id: Optional[str]

ID of the project if set

property quantity: ContainerQuantity

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property volume: DeprecatedContainerVolumeForResponse

property web_url: str

class WorkflowList

Bases: object

__init__(workflows: Union[benchling_api_client.v2.types.Unset, List[LegacyWorkflow]] = attr_dict['_workflows'].default) → None

Method generated by attrs for class WorkflowList.

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_list.T

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

to_dict() → Dict[str, Any]

property workflows: List[LegacyWorkflow]

class WorkflowOutput

Bases: object

__init__(creation_origin: Union[benchling_api_client.v2.types.Unset, CreationOrigin] = attr_dict['_creation_origin'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, task: Union[benchling_api_client.v2.types.Unset, 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, 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 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 task: WorkflowTaskSummary

to_dict() → Dict[str, Any]

property web_url: str

URL of the workflow output

property workflow_task_group: 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 WorkflowOutputCreatedEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowOutputCreatedEventEventType] = attr_dict['_event_type'].default, workflow_output: Union[benchling_api_client.v2.types.Unset, WorkflowOutput] = attr_dict['_workflow_output'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowOutputCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowOutputCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_output: WorkflowOutput

class WorkflowOutputCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWOUTPUTCREATED = 'v2.workflowOutput.created'

static of_unknown(val: str) → WorkflowOutputCreatedEventEventType

class WorkflowOutputSchema

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class WorkflowOutputSchema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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_output_schema.T

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

property name: str

property prefix: str

to_dict() → Dict[str, Any]

property type: str

class WorkflowOutputSummary

Bases: object

__init__(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 WorkflowOutputSummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property display_id: str

User-friendly ID of the workflow task group

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

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

property id: str

The ID of the workflow output

to_dict() → Dict[str, Any]

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 WorkflowOutputUpdatedFieldsEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowOutputUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, workflow_output: Union[benchling_api_client.v2.types.Unset, WorkflowOutput] = attr_dict['_workflow_output'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowOutputUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowOutputUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_output: WorkflowOutput

class WorkflowOutputUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWOUTPUTUPDATEDFIELDS = 'v2.workflowOutput.updated.fields'

static of_unknown(val: str) → WorkflowOutputUpdatedFieldsEventEventType

class WorkflowOutputWriteBase

Bases: object

__init__(fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) → None

Method generated by attrs for class WorkflowOutputWriteBase.

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_write_base.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 WorkflowPatch

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, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) → None

Method generated by attrs for class WorkflowPatch.

property description: str

Description of the workflow

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

property name: str

Name of the workflow

property project_id: str

ID of the project that contains the workflow

to_dict() → Dict[str, Any]

class WorkflowSample

Bases: object

__init__(batch_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_batch_id'].default, container_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_container_ids'].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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class WorkflowSample.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batch_id: str

ID of the batch

property container_ids: List[str]

Array of IDs of containers

property created_at: datetime

DateTime at which the the sample was created

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

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

property id: str

ID of the sample

property name: str

Name of the sample

to_dict() → Dict[str, Any]

class WorkflowSampleList

Bases: object

__init__(samples: Union[benchling_api_client.v2.types.Unset, List[WorkflowSample]] = attr_dict['_samples'].default) → None

Method generated by attrs for class WorkflowSampleList.

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_sample_list.T

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

property samples: List[WorkflowSample]

to_dict() → Dict[str, Any]

class WorkflowStage

Bases: object

__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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class WorkflowStage.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

DateTime at which the the workflow stage was created

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

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

property id: str

ID of the workflow stage

property name: str

Name of the workflow stage

to_dict() → Dict[str, Any]

class WorkflowStageList

Bases: object

__init__(workflow_stages: Union[benchling_api_client.v2.types.Unset, List[WorkflowStage]] = attr_dict['_workflow_stages'].default) → None

Method generated by attrs for class WorkflowStageList.

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_stage_list.T

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

to_dict() → Dict[str, Any]

property workflow_stages: List[WorkflowStage]

class WorkflowStageRun

Bases: object

__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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, status: Union[benchling_api_client.v2.types.Unset, WorkflowStageRunStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class WorkflowStageRun.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

DateTime at which the the stage run was created

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

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

property id: str

ID of the stage run

property name: str

Name of the stage run

property status: WorkflowStageRunStatus

Status of the stage run

to_dict() → Dict[str, Any]

class WorkflowStageRunList

Bases: object

__init__(workflow_stage_runs: Union[benchling_api_client.v2.types.Unset, List[WorkflowStageRun]] = attr_dict['_workflow_stage_runs'].default) → None

Method generated by attrs for class WorkflowStageRunList.

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_stage_run_list.T

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

to_dict() → Dict[str, Any]

property workflow_stage_runs: List[WorkflowStageRun]

class WorkflowStageRunStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

COMPLETED = 'COMPLETED'

DISCARDED = 'DISCARDED'

INITIALIZED = 'INITIALIZED'

static of_unknown(val: str) → WorkflowStageRunStatus

class WorkflowTask

Bases: object

__init__(execution_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskExecutionType] = attr_dict['_execution_type'].default, assignee: Union[benchling_api_client.v2.types.Unset, None, UserSummary] = attr_dict['_assignee'].default, cloned_from: Union[benchling_api_client.v2.types.Unset, None, WorkflowTaskSummary] = attr_dict['_cloned_from'].default, creation_origin: Union[benchling_api_client.v2.types.Unset, CreationOrigin] = attr_dict['_creation_origin'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, execution_origin: Union[benchling_api_client.v2.types.Unset, None, WorkflowTaskExecutionOrigin] = attr_dict['_execution_origin'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, outputs: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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[UserSummary]

property cloned_from: Optional[WorkflowTaskSummary]

property creation_origin: CreationOrigin

property creator: UserSummary

property display_id: str

User-friendly ID of the workflow task

property execution_origin: Optional[WorkflowTaskExecutionOrigin]

The context into which a task was executed

property 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 outputs: List[WorkflowOutputSummary]

property scheduled_on: Optional[date]

The date on which the task is scheduled to be executed

property status: WorkflowTaskStatus

to_dict() → Dict[str, Any]

property web_url: str

URL of the workflow task

property workflow_task_group: 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 WorkflowTaskBase

Bases: object

__init__(assignee: Union[benchling_api_client.v2.types.Unset, None, UserSummary] = attr_dict['_assignee'].default, cloned_from: Union[benchling_api_client.v2.types.Unset, None, WorkflowTaskSummary] = attr_dict['_cloned_from'].default, creation_origin: Union[benchling_api_client.v2.types.Unset, CreationOrigin] = attr_dict['_creation_origin'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, execution_origin: Union[benchling_api_client.v2.types.Unset, None, WorkflowTaskExecutionOrigin] = attr_dict['_execution_origin'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, outputs: Union[benchling_api_client.v2.types.Unset, List[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, 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, 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 WorkflowTaskBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assignee: Optional[UserSummary]

property cloned_from: Optional[WorkflowTaskSummary]

property creation_origin: CreationOrigin

property creator: UserSummary

property display_id: str

User-friendly ID of the workflow task

property execution_origin: Optional[WorkflowTaskExecutionOrigin]

The context into which a task was executed

property fields: Fields

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

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

property id: str

The ID of the workflow task

property outputs: List[WorkflowOutputSummary]

property scheduled_on: Optional[date]

The date on which the task is scheduled to be executed

property status: WorkflowTaskStatus

to_dict() → Dict[str, Any]

property web_url: str

URL of the workflow task

property workflow_task_group: WorkflowTaskGroupSummary

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 WorkflowTaskCreatedEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskCreatedEventEventType] = attr_dict['_event_type'].default, workflow_task: Union[benchling_api_client.v2.types.Unset, WorkflowTask] = attr_dict['_workflow_task'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task: WorkflowTask

class WorkflowTaskCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKCREATED = 'v2.workflowTask.created'

static of_unknown(val: str) → WorkflowTaskCreatedEventEventType

class WorkflowTaskExecutionOrigin

Bases: object

The context into which a task was executed

__init__(entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, origin_modal_uuid: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_origin_modal_uuid'].default, type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskExecutionOriginType] = attr_dict['_type'].default) → None

Method generated by attrs for class WorkflowTaskExecutionOrigin.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entry_id: Optional[str]

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

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

property origin_modal_uuid: Optional[str]

to_dict() → Dict[str, Any]

property type: WorkflowTaskExecutionOriginType

class WorkflowTaskExecutionOriginType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

API = 'API'

ENTRY = 'ENTRY'

MODAL = 'MODAL'

static of_unknown(val: str) → WorkflowTaskExecutionOriginType

class WorkflowTaskExecutionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DIRECT = 'DIRECT'

ENTRY = 'ENTRY'

static of_unknown(val: str) → WorkflowTaskExecutionType

class WorkflowTaskGroup

Bases: object

__init__(execution_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskGroupExecutionType] = attr_dict['_execution_type'].default, creation_origin: Union[benchling_api_client.v2.types.Unset, CreationOrigin] = attr_dict['_creation_origin'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, folder: Union[benchling_api_client.v2.types.Unset, Folder] = attr_dict['_folder'].default, outputs: Union[benchling_api_client.v2.types.Unset, List[WorkflowOutputSummary]] = attr_dict['_outputs'].default, responsible_team: Union[benchling_api_client.v2.types.Unset, None, TeamSummary] = attr_dict['_responsible_team'].default, watchers: Union[benchling_api_client.v2.types.Unset, List[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, WorkflowTaskSchemaSummary] = attr_dict['_workflow_task_schema'].default, workflow_tasks: Union[benchling_api_client.v2.types.Unset, List[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 creation_origin: CreationOrigin

property creator: UserSummary

property display_id: str

User-friendly ID of the workflow task group

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

The name of the workflow task group

property outputs: List[WorkflowOutputSummary]

The outputs of the workflow task group

property responsible_team: Optional[TeamSummary]

to_dict() → Dict[str, Any]

property watchers: List[UserSummary]

The users watching the workflow task group

property web_url: str

URL of the workflow task group

property workflow_task_schema: WorkflowTaskSchemaSummary

property workflow_tasks: List[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 WorkflowTaskGroupBase

Bases: object

__init__(creation_origin: Union[benchling_api_client.v2.types.Unset, CreationOrigin] = attr_dict['_creation_origin'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, folder: Union[benchling_api_client.v2.types.Unset, Folder] = attr_dict['_folder'].default, outputs: Union[benchling_api_client.v2.types.Unset, List[WorkflowOutputSummary]] = attr_dict['_outputs'].default, responsible_team: Union[benchling_api_client.v2.types.Unset, None, TeamSummary] = attr_dict['_responsible_team'].default, watchers: Union[benchling_api_client.v2.types.Unset, List[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, WorkflowTaskSchemaSummary] = attr_dict['_workflow_task_schema'].default, workflow_tasks: Union[benchling_api_client.v2.types.Unset, List[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 WorkflowTaskGroupBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property creation_origin: CreationOrigin

property creator: UserSummary

property display_id: str

User-friendly ID of the workflow task group

property folder: Folder

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

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

property id: str

The ID of the workflow task group

property name: str

The name of the workflow task group

property outputs: List[WorkflowOutputSummary]

The outputs of the workflow task group

property responsible_team: Optional[TeamSummary]

to_dict() → Dict[str, Any]

property watchers: List[UserSummary]

The users watching the workflow task group

property web_url: str

URL of the workflow task group

property workflow_task_schema: WorkflowTaskSchemaSummary

property workflow_tasks: List[WorkflowTaskSummary]

The input tasks to the workflow task group

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 WorkflowTaskGroupCreatedEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskGroupCreatedEventEventType] = attr_dict['_event_type'].default, workflow_task_group: Union[benchling_api_client.v2.types.Unset, WorkflowTaskGroup] = attr_dict['_workflow_task_group'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskGroupCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskGroupCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task_group: WorkflowTaskGroup

class WorkflowTaskGroupCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKGROUPCREATED = 'v2.workflowTaskGroup.created'

static of_unknown(val: str) → WorkflowTaskGroupCreatedEventEventType

class WorkflowTaskGroupExecutionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DIRECT = 'DIRECT'

ENTRY = 'ENTRY'

static of_unknown(val: str) → WorkflowTaskGroupExecutionType

class WorkflowTaskGroupSummary

Bases: object

__init__(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 WorkflowTaskGroupSummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property display_id: str

User-friendly ID of the workflow task group

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

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

property id: str

The ID of the workflow task group

property name: str

The name of the workflow task group

to_dict() → Dict[str, Any]

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 WorkflowTaskGroupUpdatedWatchersEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskGroupUpdatedWatchersEventEventType] = attr_dict['_event_type'].default, workflow_task_group: Union[benchling_api_client.v2.types.Unset, WorkflowTaskGroup] = attr_dict['_workflow_task_group'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskGroupUpdatedWatchersEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskGroupUpdatedWatchersEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task_group: WorkflowTaskGroup

class WorkflowTaskGroupUpdatedWatchersEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKGROUPUPDATEDWATCHERS = 'v2.workflowTaskGroup.updated.watchers'

static of_unknown(val: str) → WorkflowTaskGroupUpdatedWatchersEventEventType

class WorkflowTaskGroupWriteBase

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

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_write_base.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, 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, 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, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, status_lifecycle: Union[benchling_api_client.v2.types.Unset, 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, WorkflowOutputSchema] = attr_dict['_workflow_output_schema'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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[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[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: WorkflowTaskSchemaExecutionType

The method by which instances of this schema are executed

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 name: str

property prefix: str

The prefix for the displayId of tasks of this schema.

property 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[WorkflowOutputSchema]

class WorkflowTaskSchemaBase

Bases: object

__init__(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, 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, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, status_lifecycle: Union[benchling_api_client.v2.types.Unset, 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, WorkflowOutputSchema] = attr_dict['_workflow_output_schema'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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 WorkflowTaskSchemaBase.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[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[TeamSummary]

property entry_template_id: Optional[str]

The ID of the template of the entries tasks of this schema will be executed into.

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, 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_base.T

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

property id: str

property name: str

property prefix: str

The prefix for the displayId of tasks of this schema.

property 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[WorkflowOutputSchema]

class WorkflowTaskSchemaExecutionType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DIRECT = 'DIRECT'

ENTRY = 'ENTRY'

static of_unknown(val: str) → WorkflowTaskSchemaExecutionType

class WorkflowTaskSchemaSummary

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

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_schema_summary.T

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

property id: str

The ID of the workflow task schema

property name: str

The name of the workflow task schema

to_dict() → Dict[str, Any]

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 WorkflowTaskStatus

Bases: object

__init__(display_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_display_name'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, status_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskStatusStatusType] = attr_dict['_status_type'].default) → None

Method generated by attrs for class WorkflowTaskStatus.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property display_name: str

The status label

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

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

property id: str

The ID of the workflow task status

property status_type: WorkflowTaskStatusStatusType

The status type

to_dict() → Dict[str, Any]

class WorkflowTaskStatusLifecycle

Bases: object

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, initial_status: Union[benchling_api_client.v2.types.Unset, WorkflowTaskStatus] = attr_dict['_initial_status'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, statuses: Union[benchling_api_client.v2.types.Unset, List[WorkflowTaskStatus]] = attr_dict['_statuses'].default, transitions: Union[benchling_api_client.v2.types.Unset, List[WorkflowTaskStatusLifecycleTransition]] = attr_dict['_transitions'].default) → None

Method generated by attrs for class WorkflowTaskStatusLifecycle.

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_status_lifecycle.T

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

property id: str

property initial_status: WorkflowTaskStatus

property name: str

property statuses: List[WorkflowTaskStatus]

to_dict() → Dict[str, Any]

property transitions: List[WorkflowTaskStatusLifecycleTransition]

class WorkflowTaskStatusLifecycleTransition

Bases: object

__init__(from_: Union[benchling_api_client.v2.types.Unset, WorkflowTaskStatus] = attr_dict['_from_'].default, to: Union[benchling_api_client.v2.types.Unset, WorkflowTaskStatus] = attr_dict['_to'].default) → None

Method generated by attrs for class WorkflowTaskStatusLifecycleTransition.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property from_: WorkflowTaskStatus

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

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

property to: WorkflowTaskStatus

to_dict() → Dict[str, Any]

class WorkflowTaskStatusStatusType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CANCELLED = 'CANCELLED'

COMPLETED = 'COMPLETED'

FAILED = 'FAILED'

INVALID = 'INVALID'

IN_PROGRESS = 'IN_PROGRESS'

PENDING = 'PENDING'

static of_unknown(val: str) → WorkflowTaskStatusStatusType

class WorkflowTaskSummary

Bases: object

__init__(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 WorkflowTaskSummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property display_id: str

User-friendly ID of the workflow task

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

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

property id: str

The ID of the workflow task

to_dict() → Dict[str, Any]

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 WorkflowTaskUpdatedAssigneeEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskUpdatedAssigneeEventEventType] = attr_dict['_event_type'].default, workflow_task: Union[benchling_api_client.v2.types.Unset, WorkflowTask] = attr_dict['_workflow_task'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskUpdatedAssigneeEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskUpdatedAssigneeEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task: WorkflowTask

class WorkflowTaskUpdatedAssigneeEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKUPDATEDASSIGNEE = 'v2.workflowTask.updated.assignee'

static of_unknown(val: str) → WorkflowTaskUpdatedAssigneeEventEventType

class WorkflowTaskUpdatedFieldsEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, workflow_task: Union[benchling_api_client.v2.types.Unset, WorkflowTask] = attr_dict['_workflow_task'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task: WorkflowTask

class WorkflowTaskUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKUPDATEDFIELDS = 'v2.workflowTask.updated.fields'

static of_unknown(val: str) → WorkflowTaskUpdatedFieldsEventEventType

class WorkflowTaskUpdatedScheduledOnEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskUpdatedScheduledOnEventEventType] = attr_dict['_event_type'].default, workflow_task: Union[benchling_api_client.v2.types.Unset, WorkflowTask] = attr_dict['_workflow_task'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskUpdatedScheduledOnEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskUpdatedScheduledOnEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task: WorkflowTask

class WorkflowTaskUpdatedScheduledOnEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKUPDATEDSCHEDULEDON = 'v2.workflowTask.updated.scheduledOn'

static of_unknown(val: str) → WorkflowTaskUpdatedScheduledOnEventEventType

class WorkflowTaskUpdatedStatusEvent

Bases: object

__init__(event_type: Union[benchling_api_client.v2.types.Unset, WorkflowTaskUpdatedStatusEventEventType] = attr_dict['_event_type'].default, workflow_task: Union[benchling_api_client.v2.types.Unset, WorkflowTask] = attr_dict['_workflow_task'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class WorkflowTaskUpdatedStatusEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property created_at: datetime

property deprecated: bool

property event_type: WorkflowTaskUpdatedStatusEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

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

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

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property workflow_task: WorkflowTask

class WorkflowTaskUpdatedStatusEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_WORKFLOWTASKUPDATEDSTATUS = 'v2.workflowTask.updated.status'

static of_unknown(val: str) → WorkflowTaskUpdatedStatusEventEventType

class WorkflowTaskWriteBase

Bases: object

__init__(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 WorkflowTaskWriteBase.

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

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]