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, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default, 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

property created_at: datetime

DateTime the app config item was created

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.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[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_app_configuration_items'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AppConfigurationPaginatedList.

property app_configuration_items: List[Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]

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

property next_token: str

to_dict() → Dict[str, Any]

class 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 ArrayElementAppConfigItem

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, ArrayElementAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) → None

Method generated by attrs for class ArrayElementAppConfigItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

property created_at: datetime

DateTime the app config item was created

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

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

property id: str

property modified_at: datetime

DateTime the app config item was last modified

property path: List[str]

Array-based representation of config item’s location in the tree in order from top to bottom.

to_dict() → Dict[str, Any]

property type: ArrayElementAppConfigItemType

property value: Optional[str]

class ArrayElementAppConfigItemType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ARRAY_ELEMENT = 'array_element'

static of_unknown(val: str) → ArrayElementAppConfigItemType

class 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, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, 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 modified_at: datetime

DateTime at which the the result was last modified

property project_id: Optional[str]

ID of the project to insert the result into

property schema: 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[Optional[LabAutomationTransform]]] = attr_dict['_transforms'].default, assay_run_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_id'].default, automation_file_config: Union[benchling_api_client.v2.types.Unset, 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[Optional[LabAutomationTransform]]

class AutomationOutputProcessorArchivalChange

Bases: object

IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of any linked Results that were archived / unarchived.

__init__(automation_output_processor_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_automation_output_processor_ids'].default, result_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_result_ids'].default) → None

Method generated by attrs for class AutomationOutputProcessorArchivalChange.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_output_processor_ids: List[str]

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

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

property result_ids: List[str]

to_dict() → Dict[str, Any]

class 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, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default, 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 created_at: datetime

DateTime the app config item was created

property description: str

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.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, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) → None

Method generated by attrs for class BooleanAppConfigItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

property created_at: datetime

DateTime the app config item was created

property description: str

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

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

property id: str

property modified_at: datetime

DateTime the app config item was last modified

property path: List[str]

Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool

to_dict() → Dict[str, Any]

property type: BooleanAppConfigItemType

property value: Optional[bool]

class BooleanAppConfigItemType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOOLEAN = 'boolean'

static of_unknown(val: str) → BooleanAppConfigItemType

class Box

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, 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 inventory that contain items will also remove barcodes from the contained items.

to_dict() → Dict[str, Any]

class BoxesArchiveReason

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CONTAMINATED = 'Contaminated'

EXPENDED = 'Expended'

EXPIRED = 'Expired'

MADE_IN_ERROR = 'Made in error'

MISSING = 'Missing'

OTHER = 'Other'

RETIRED = 'Retired'

SHIPPED = 'Shipped'

static of_unknown(val: str) → BoxesArchiveReason

class 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, restricted_sample_parties: Union[benchling_api_client.v2.types.Unset, List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_restricted_sample_parties'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owners: Union[benchling_api_client.v2.types.Unset, List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_sample_owners'].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 restricted_sample_parties: List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]

property restriction_status: SampleRestrictionStatus

property sample_owners: List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]

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 inventory, 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 inventory, 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 inventory, 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, restricted_sample_parties: Union[benchling_api_client.v2.types.Unset, List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_restricted_sample_parties'].default, restriction_status: Union[benchling_api_client.v2.types.Unset, SampleRestrictionStatus] = attr_dict['_restriction_status'].default, sample_owners: Union[benchling_api_client.v2.types.Unset, List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_sample_owners'].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 restricted_sample_parties: List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]

property restriction_status: SampleRestrictionStatus

property sample_owners: List[Union[UserSummary, TeamSummary, benchling_api_client.v2.extensions.UnknownType]]

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 inventory, 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 inventory that contain items will also remove barcodes from the contained items.

to_dict() → Dict[str, Any]

class ContainersArchiveReason

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

CONTAMINATED = 'Contaminated'

EXPENDED = 'Expended'

EXPIRED = 'Expired'

MADE_IN_ERROR = 'Made in error'

MISSING = 'Missing'

OTHER = 'Other'

RETIRED = 'Retired'

SHIPPED = 'Shipped'

static of_unknown(val: str) → ContainersArchiveReason

class ContainersBulkCreateRequest

Bases: object

__init__(containers: List[ContainerCreate]) → None

Method generated by attrs for class ContainersBulkCreateRequest.

property containers: List[ContainerCreate]

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

to_dict() → Dict[str, Any]

class ContainersBulkUpdateRequest

Bases: object

__init__(containers: List[ContainerBulkUpdateItem]) → None

Method generated by attrs for class ContainersBulkUpdateRequest.

property containers: List[ContainerBulkUpdateItem]

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

to_dict() → Dict[str, Any]

class ContainersCheckin

Bases: object

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

Method generated by attrs for class ContainersCheckin.

property comments: str

property container_ids: List[str]

Array of container IDs.

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

to_dict() → Dict[str, Any]

class ContainersCheckout

Bases: object

__init__(assignee_id: str, container_ids: List[str], comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_comment'].default) → None

Method generated by attrs for class ContainersCheckout.

property assignee_id: str

User or Team API ID.

property comment: str

property container_ids: List[str]

Array of container IDs.

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

to_dict() → Dict[str, Any]

class 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, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) → None

Method generated by attrs for class DateAppConfigItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

property created_at: datetime

DateTime the app config item was created

property description: str

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

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

property id: str

property modified_at: datetime

DateTime the app config item was last modified

property path: List[str]

Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool

to_dict() → Dict[str, Any]

property type: DateAppConfigItemType

property value: Optional[str]

class DateAppConfigItemType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATE = 'date'

static of_unknown(val: str) → DateAppConfigItemType

class DatetimeAppConfigItem

Bases: object

__init__(type: Union[benchling_api_client.v2.types.Unset, DatetimeAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, AppConfigItemApiMixinApp] = attr_dict['_app'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) → None

Method generated by attrs for class DatetimeAppConfigItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

property created_at: datetime

DateTime the app config item was created

property description: str

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

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

property id: str

property modified_at: datetime

DateTime the app config item was last modified

property path: List[str]

Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool

to_dict() → Dict[str, Any]

property type: DatetimeAppConfigItemType

property value: Optional[str]

class DatetimeAppConfigItemType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATETIME = 'datetime'

static of_unknown(val: str) → DatetimeAppConfigItemType

class 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, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) → None

Method generated by attrs for class EntitySchemaAppConfigItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

property app: AppConfigItemApiMixinApp

property created_at: datetime

DateTime the app config item was created

property description: str

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

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

property id: str

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

property modified_at: datetime

DateTime the app config item was last modified

property path: List[str]

Array-based representation of config item’s location in the tree in order from top to bottom.

property required_config: bool

property subtype: SchemaDependencySubtypes

to_dict() → Dict[str, Any]

property type: EntitySchemaAppConfigItemType

property value: Optional[str]

class EntitySchemaAppConfigItemType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ENTITY_SCHEMA = 'entity_schema'

static of_unknown(val: str) → EntitySchemaAppConfigItemType

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