benchling_sdk.models package¶

class AIGGenerateInputAsyncTask¶

Bases: object

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

Method generated by attrs for class AIGGenerateInputAsyncTask.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property errors: AsyncTaskErrors¶

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

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aig_generate_input_async_task.T¶
get(key, default=None) → Optional[Any]¶
property message: str¶

Present only when status is FAILED. Contains information about the error.

property response: AutomationInputGenerator¶
property status: AsyncTaskStatus¶

The current state of the task.

to_dict() → Dict[str, Any]¶
class AOPProcessOutputAsyncTask¶

Bases: object

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

Method generated by attrs for class AOPProcessOutputAsyncTask.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property errors: AsyncTaskErrors¶

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

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aop_process_output_async_task.T¶
get(key, default=None) → Optional[Any]¶
property message: str¶

Present only when status is FAILED. Contains information about the error.

property response: AutomationOutputProcessor¶
property status: AsyncTaskStatus¶

The current state of the task.

to_dict() → Dict[str, Any]¶
class AaAnnotation¶

Bases: object

__init__(color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None¶

Method generated by attrs for class AaAnnotation.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property color: str¶
property end: int¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_annotation.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
property name: str¶
property start: int¶
to_dict() → Dict[str, Any]¶
property type: str¶
class AaSequence¶

Bases: object

__init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) → None¶

Method generated by attrs for class AaSequence.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property aliases: List[str]¶

Array of aliases

property amino_acids: str¶

Amino acids of the AA sequence.

property annotations: List[AaAnnotation]¶

Array of annotation objects on the AA sequence.

property api_url: str¶

The canonical url of the AA Sequence in the API.

property archive_record: Optional[ArchiveRecord]¶
property created_at: datetime¶

DateTime the AA sequence was created.

property creator: UserSummary¶
property custom_fields: CustomFields¶
property entity_registry_id: Optional[str]¶

Registry ID of the AA sequence if registered.

property fields: Fields¶
property folder_id: Optional[str]¶

ID of the folder that contains the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶

ID of the AA sequence.

property length: int¶

Number of amino acids in the AA sequence.

property modified_at: datetime¶

DateTime the AA sequence was last modified.

property name: str¶

Name of the AA sequence.

property registration_origin: Optional[RegistrationOrigin]¶
property registry_id: Optional[str]¶

Registry the AA sequence is registered in.

property schema: Optional[SchemaSummary]¶
to_dict() → Dict[str, Any]¶
property web_url: str¶

URL of the protein.

class AaSequenceBaseRequest¶

Bases: object

__init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None¶

Method generated by attrs for class AaSequenceBaseRequest.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property aliases: List[str]¶

Aliases to add to the AA sequence

property amino_acids: str¶

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]¶

Annotations to create on the AA sequence.

property author_ids: List[str]¶

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶
property fields: Fields¶
property folder_id: str¶

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_base_request.T¶
get(key, default=None) → Optional[Any]¶
property name: str¶

Name of the AA sequence.

property schema_id: str¶

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶
class AaSequenceBaseRequestForCreate¶

Bases: object

__init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None¶

Method generated by attrs for class AaSequenceBaseRequestForCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property aliases: List[str]¶

Aliases to add to the AA sequence

property amino_acids: str¶

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]¶

Annotations to create on the AA sequence.

property author_ids: List[str]¶

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶
property fields: Fields¶
property folder_id: str¶

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_base_request_for_create.T¶
get(key, default=None) → Optional[Any]¶
property name: str¶

Name of the AA sequence.

property schema_id: str¶

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶
class AaSequenceBulkCreate¶

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None¶

Method generated by attrs for class AaSequenceBulkCreate.

property aliases: List[str]¶

Aliases to add to the AA sequence

property amino_acids: str¶

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]¶

Annotations to create on the AA sequence.

property author_ids: List[str]¶

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶
property entity_registry_id: str¶

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

property fields: Fields¶
property folder_id: str¶

ID of the folder containing the AA sequence.

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

Name of the AA sequence.

property naming_strategy: NamingStrategy¶

Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template

property registry_id: str¶

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)

Required in order for entities to be created directly in the registry.

property schema_id: str¶

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶
class AaSequenceBulkUpdate¶

Bases: object

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None¶

Method generated by attrs for class AaSequenceBulkUpdate.

property aliases: List[str]¶

Aliases to add to the AA sequence

property amino_acids: str¶

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]¶

Annotations to create on the AA sequence.

property author_ids: List[str]¶

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶
property fields: Fields¶
property folder_id: str¶

ID of the folder containing the AA sequence.

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

Name of the AA sequence.

property schema_id: str¶

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶
class AaSequenceCreate¶

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None¶

Method generated by attrs for class AaSequenceCreate.

property aliases: List[str]¶

Aliases to add to the AA sequence

property amino_acids: str¶

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]¶

Annotations to create on the AA sequence.

property author_ids: List[str]¶

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶
property entity_registry_id: str¶

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

property fields: Fields¶
property folder_id: str¶

ID of the folder containing the AA sequence.

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

Name of the AA sequence.

property naming_strategy: NamingStrategy¶

Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template

property registry_id: str¶

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)

Required in order for entities to be created directly in the registry.

property schema_id: str¶

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶
class AaSequenceRequestRegistryFields¶

Bases: object

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

Method generated by attrs for class AaSequenceRequestRegistryFields.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property entity_registry_id: str¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_request_registry_fields.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AaSequenceSummary¶

Bases: object

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

Method generated by attrs for class AaSequenceSummary.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property entity_type: AaSequenceSummaryEntityType¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_summary.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: str¶
class AaSequenceSummaryEntityType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'¶
static of_unknown(val: str) → AaSequenceSummaryEntityType¶
class AaSequenceUpdate¶

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None¶

Method generated by attrs for class AaSequenceUpdate.

property aliases: List[str]¶

Aliases to add to the AA sequence

property amino_acids: str¶

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]¶

Annotations to create on the AA sequence.

property author_ids: List[str]¶

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields¶
property entity_registry_id: str¶
property fields: Fields¶
property folder_id: str¶

ID of the folder containing the AA sequence.

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

Name of the AA sequence.

property schema_id: str¶

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]¶
class AaSequenceWithEntityType¶

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, AaSequenceWithEntityTypeEntityType] = attr_dict['_entity_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) → None¶

Method generated by attrs for class AaSequenceWithEntityType.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property aliases: List[str]¶

Array of aliases

property amino_acids: str¶

Amino acids of the AA sequence.

property annotations: List[AaAnnotation]¶

Array of annotation objects on the AA sequence.

property api_url: str¶

The canonical url of the AA Sequence in the API.

property archive_record: Optional[ArchiveRecord]¶
property created_at: datetime¶

DateTime the AA sequence was created.

property creator: UserSummary¶
property custom_fields: CustomFields¶
property entity_registry_id: Optional[str]¶

Registry ID of the AA sequence if registered.

property entity_type: AaSequenceWithEntityTypeEntityType¶
property fields: Fields¶
property folder_id: Optional[str]¶

ID of the folder that contains the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequence_with_entity_type.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶

ID of the AA sequence.

property length: int¶

Number of amino acids in the AA sequence.

property modified_at: datetime¶

DateTime the AA sequence was last modified.

property name: str¶

Name of the AA sequence.

property registration_origin: Optional[RegistrationOrigin]¶
property registry_id: Optional[str]¶

Registry the AA sequence is registered in.

property schema: Optional[SchemaSummary]¶
to_dict() → Dict[str, Any]¶
property web_url: str¶

URL of the protein.

class AaSequenceWithEntityTypeEntityType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'¶
static of_unknown(val: str) → AaSequenceWithEntityTypeEntityType¶
class AaSequencesArchivalChange¶

Bases: object

IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of AA sequences along with any IDs of batches that were archived / unarchived.

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

Method generated by attrs for class AaSequencesArchivalChange.

property aa_sequence_ids: List[str]¶
property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property batch_ids: List[str]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_archival_change.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AaSequencesArchive¶

Bases: object

The request body for archiving AA sequences.

__init__(aa_sequence_ids: List[str], reason: EntityArchiveReason) → None¶

Method generated by attrs for class AaSequencesArchive.

property aa_sequence_ids: List[str]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_archive.T¶
property reason: EntityArchiveReason¶

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

to_dict() → Dict[str, Any]¶
class AaSequencesBulkCreateRequest¶

Bases: object

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

Method generated by attrs for class AaSequencesBulkCreateRequest.

property aa_sequences: List[AaSequenceBulkCreate]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_bulk_create_request.T¶
to_dict() → Dict[str, Any]¶
class AaSequencesBulkGet¶

Bases: object

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

Method generated by attrs for class AaSequencesBulkGet.

property aa_sequences: List[AaSequence]¶
property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_bulk_get.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AaSequencesBulkUpdateRequest¶

Bases: object

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

Method generated by attrs for class AaSequencesBulkUpdateRequest.

property aa_sequences: List[AaSequenceBulkUpdate]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_bulk_update_request.T¶
to_dict() → Dict[str, Any]¶
class AaSequencesPaginatedList¶

Bases: object

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

Method generated by attrs for class AaSequencesPaginatedList.

property aa_sequences: List[AaSequence]¶
property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aa_sequences_paginated_list.T¶
get(key, default=None) → Optional[Any]¶
property next_token: str¶
to_dict() → Dict[str, Any]¶
class AaSequencesUnarchive¶

Bases: object

The request body for unarchiving AA sequences.

__init__(aa_sequence_ids: List[str]) → None¶

Method generated by attrs for class AaSequencesUnarchive.

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

Bases: object

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

Method generated by attrs for class AlignedNucleotideSequence.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property bases: str¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aligned_nucleotide_sequence.T¶
get(key, default=None) → Optional[Any]¶
property name: str¶
property pairwise_identity: float¶

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

property sequence_id: Optional[str]¶
to_dict() → Dict[str, Any]¶
property trim_end: int¶
property trim_start: int¶
class AlignedSequence¶

Bases: object

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

Method generated by attrs for class AlignedSequence.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property bases: str¶
property dna_sequence_id: Optional[str]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.aligned_sequence.T¶
get(key, default=None) → Optional[Any]¶
property name: str¶
property pairwise_identity: float¶

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

to_dict() → Dict[str, Any]¶
property trim_end: int¶
property trim_start: int¶
class AppConfigItemApiMixin¶

Bases: object

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

Method generated by attrs for class AppConfigItemApiMixin.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property api_url: str¶
property app: AppConfigItemApiMixinApp¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_api_mixin.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
property modified_at: datetime¶

DateTime the app config item was last modified

property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: str¶

Type of the app config item

class AppConfigItemApiMixinApp¶

Bases: object

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

Method generated by attrs for class AppConfigItemApiMixinApp.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶

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

to_dict() → Dict[str, Any]¶
class AppConfigItemBooleanBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemBooleanBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_boolean_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemBooleanUpdateType¶
property value: bool¶
class AppConfigItemBooleanCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemBooleanCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_boolean_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemBooleanCreateType¶
property value: bool¶
class AppConfigItemBooleanCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOOLEAN = 'boolean'¶
static of_unknown(val: str) → AppConfigItemBooleanCreateType¶
class AppConfigItemBooleanUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemBooleanUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_boolean_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemBooleanUpdateType¶
property value: bool¶
class AppConfigItemBooleanUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

BOOLEAN = 'boolean'¶
static of_unknown(val: str) → AppConfigItemBooleanUpdateType¶
class AppConfigItemBulkUpdateMixin¶

Bases: object

__init__(id: str) → None¶

Method generated by attrs for class AppConfigItemBulkUpdateMixin.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_bulk_update_mixin.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
class AppConfigItemCreateMixin¶

Bases: object

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

Method generated by attrs for class AppConfigItemCreateMixin.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_create_mixin.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
class AppConfigItemDateBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemDateBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_date_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemDateUpdateType¶
property value: str¶
class AppConfigItemDateCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemDateCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_date_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemDateCreateType¶
property value: date¶
class AppConfigItemDateCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATE = 'date'¶
static of_unknown(val: str) → AppConfigItemDateCreateType¶
class AppConfigItemDateUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemDateUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_date_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemDateUpdateType¶
property value: str¶
class AppConfigItemDateUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATE = 'date'¶
static of_unknown(val: str) → AppConfigItemDateUpdateType¶
class AppConfigItemDatetimeBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemDatetimeBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_datetime_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemDatetimeUpdateType¶
property value: str¶
class AppConfigItemDatetimeCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemDatetimeCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_datetime_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemDatetimeCreateType¶
property value: str¶
class AppConfigItemDatetimeCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATETIME = 'datetime'¶
static of_unknown(val: str) → AppConfigItemDatetimeCreateType¶
class AppConfigItemDatetimeUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemDatetimeUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_datetime_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemDatetimeUpdateType¶
property value: str¶
class AppConfigItemDatetimeUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

DATETIME = 'datetime'¶
static of_unknown(val: str) → AppConfigItemDatetimeUpdateType¶
class AppConfigItemFloatBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemFloatBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_float_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemFloatUpdateType¶
property value: float¶
class AppConfigItemFloatCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemFloatCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_float_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemFloatCreateType¶
property value: float¶
class AppConfigItemFloatCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FLOAT = 'float'¶
static of_unknown(val: str) → AppConfigItemFloatCreateType¶
class AppConfigItemFloatUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemFloatUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_float_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemFloatUpdateType¶
property value: float¶
class AppConfigItemFloatUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FLOAT = 'float'¶
static of_unknown(val: str) → AppConfigItemFloatUpdateType¶
class AppConfigItemGenericBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemGenericBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_generic_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemGenericUpdateType¶
property value: str¶
class AppConfigItemGenericCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemGenericCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_generic_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemGenericCreateType¶
property value: str¶
class AppConfigItemGenericCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'¶
BOX = 'box'¶
BOX_SCHEMA = 'box_schema'¶
CONTAINER = 'container'¶
CONTAINER_SCHEMA = 'container_schema'¶
CUSTOM_ENTITY = 'custom_entity'¶
DATE = 'date'¶
DATETIME = 'datetime'¶
DNA_OLIGO = 'dna_oligo'¶
DNA_SEQUENCE = 'dna_sequence'¶
DROPDOWN = 'dropdown'¶
DROPDOWN_OPTION = 'dropdown_option'¶
ENTITY_SCHEMA = 'entity_schema'¶
ENTRY = 'entry'¶
ENTRY_SCHEMA = 'entry_schema'¶
FIELD = 'field'¶
FOLDER = 'folder'¶
JSON = 'json'¶
LOCATION = 'location'¶
LOCATION_SCHEMA = 'location_schema'¶
MIXTURE = 'mixture'¶
MOLECULE = 'molecule'¶
PLATE = 'plate'¶
PLATE_SCHEMA = 'plate_schema'¶
PROJECT = 'project'¶
REGISTRY = 'registry'¶
REQUEST_SCHEMA = 'request_schema'¶
RESULT_SCHEMA = 'result_schema'¶
RNA_OLIGO = 'rna_oligo'¶
RNA_SEQUENCE = 'rna_sequence'¶
RUN_SCHEMA = 'run_schema'¶
SECURE_TEXT = 'secure_text'¶
TEXT = 'text'¶
WORKFLOW_TASK_SCHEMA = 'workflow_task_schema'¶
WORKFLOW_TASK_STATUS = 'workflow_task_status'¶
WORKLIST = 'worklist'¶
static of_unknown(val: str) → AppConfigItemGenericCreateType¶
class AppConfigItemGenericUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemGenericUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_generic_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemGenericUpdateType¶
property value: str¶
class AppConfigItemGenericUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'¶
BOX = 'box'¶
BOX_SCHEMA = 'box_schema'¶
CONTAINER = 'container'¶
CONTAINER_SCHEMA = 'container_schema'¶
CUSTOM_ENTITY = 'custom_entity'¶
DATE = 'date'¶
DATETIME = 'datetime'¶
DNA_OLIGO = 'dna_oligo'¶
DNA_SEQUENCE = 'dna_sequence'¶
DROPDOWN = 'dropdown'¶
DROPDOWN_OPTION = 'dropdown_option'¶
ENTITY_SCHEMA = 'entity_schema'¶
ENTRY = 'entry'¶
ENTRY_SCHEMA = 'entry_schema'¶
FIELD = 'field'¶
FOLDER = 'folder'¶
JSON = 'json'¶
LOCATION = 'location'¶
LOCATION_SCHEMA = 'location_schema'¶
MIXTURE = 'mixture'¶
MOLECULE = 'molecule'¶
PLATE = 'plate'¶
PLATE_SCHEMA = 'plate_schema'¶
PROJECT = 'project'¶
REGISTRY = 'registry'¶
REQUEST_SCHEMA = 'request_schema'¶
RESULT_SCHEMA = 'result_schema'¶
RNA_OLIGO = 'rna_oligo'¶
RNA_SEQUENCE = 'rna_sequence'¶
RUN_SCHEMA = 'run_schema'¶
SECURE_TEXT = 'secure_text'¶
TEXT = 'text'¶
WORKFLOW_TASK_SCHEMA = 'workflow_task_schema'¶
WORKFLOW_TASK_STATUS = 'workflow_task_status'¶
WORKLIST = 'worklist'¶
static of_unknown(val: str) → AppConfigItemGenericUpdateType¶
class AppConfigItemIntegerBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemIntegerBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_integer_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemIntegerUpdateType¶
property value: int¶
class AppConfigItemIntegerCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemIntegerCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_integer_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemIntegerCreateType¶
property value: int¶
class AppConfigItemIntegerCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INTEGER = 'integer'¶
static of_unknown(val: str) → AppConfigItemIntegerCreateType¶
class AppConfigItemIntegerUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemIntegerUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_integer_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemIntegerUpdateType¶
property value: int¶
class AppConfigItemIntegerUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INTEGER = 'integer'¶
static of_unknown(val: str) → AppConfigItemIntegerUpdateType¶
class AppConfigItemJsonBulkUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemJsonBulkUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_json_bulk_update.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemJsonUpdateType¶
property value: str¶
class AppConfigItemJsonCreate¶

Bases: object

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

Method generated by attrs for class AppConfigItemJsonCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_id: str¶

App id to which this config item belongs.

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_json_create.T¶
get(key, default=None) → Optional[Any]¶
property path: List[str]¶

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

to_dict() → Dict[str, Any]¶
property type: AppConfigItemJsonCreateType¶
property value: str¶

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

class AppConfigItemJsonCreateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

JSON = 'json'¶
static of_unknown(val: str) → AppConfigItemJsonCreateType¶
class AppConfigItemJsonUpdate¶

Bases: object

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

Method generated by attrs for class AppConfigItemJsonUpdate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_item_json_update.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
property type: AppConfigItemJsonUpdateType¶
property value: str¶
class AppConfigItemJsonUpdateType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

JSON = 'json'¶
static of_unknown(val: str) → AppConfigItemJsonUpdateType¶
class AppConfigItemsBulkCreateRequest¶

Bases: object

__init__(app_configuration_items: List[Union[AppConfigItemGenericCreate, AppConfigItemBooleanCreate, AppConfigItemIntegerCreate, AppConfigItemFloatCreate, AppConfigItemDateCreate, AppConfigItemDatetimeCreate, AppConfigItemJsonCreate, benchling_api_client.v2.extensions.UnknownType]]) → None¶

Method generated by attrs for class AppConfigItemsBulkCreateRequest.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_configuration_items: List[Union[AppConfigItemGenericCreate, AppConfigItemBooleanCreate, AppConfigItemIntegerCreate, AppConfigItemFloatCreate, AppConfigItemDateCreate, AppConfigItemDatetimeCreate, AppConfigItemJsonCreate, benchling_api_client.v2.extensions.UnknownType]]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_items_bulk_create_request.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AppConfigItemsBulkUpdateRequest¶

Bases: object

__init__(app_configuration_items: List[Union[AppConfigItemGenericBulkUpdate, AppConfigItemBooleanBulkUpdate, AppConfigItemIntegerBulkUpdate, AppConfigItemFloatBulkUpdate, AppConfigItemDateBulkUpdate, AppConfigItemDatetimeBulkUpdate, AppConfigItemJsonBulkUpdate, benchling_api_client.v2.extensions.UnknownType]]) → None¶

Method generated by attrs for class AppConfigItemsBulkUpdateRequest.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property app_configuration_items: List[Union[AppConfigItemGenericBulkUpdate, AppConfigItemBooleanBulkUpdate, AppConfigItemIntegerBulkUpdate, AppConfigItemFloatBulkUpdate, AppConfigItemDateBulkUpdate, AppConfigItemDatetimeBulkUpdate, AppConfigItemJsonBulkUpdate, benchling_api_client.v2.extensions.UnknownType]]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_config_items_bulk_update_request.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AppConfigurationPaginatedList¶

Bases: object

__init__(app_configuration_items: Union[benchling_api_client.v2.types.Unset, List[Union[DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_app_configuration_items'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None¶

Method generated by attrs for class AppConfigurationPaginatedList.

property app_configuration_items: List[Union[DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.app_configuration_paginated_list.T¶
property next_token: str¶
to_dict() → Dict[str, Any]¶
class ArchiveRecord¶

Bases: object

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

Method generated by attrs for class ArchiveRecord.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.archive_record.T¶
get(key, default=None) → Optional[Any]¶
property reason: str¶
to_dict() → Dict[str, Any]¶
class AssayFieldsCreate¶

Bases: object

__init__() → None¶

Method generated by attrs for class AssayFieldsCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_fields_create.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AssayResult¶

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, field_validation: Union[benchling_api_client.v2.types.Unset, AssayResultFieldValidation] = attr_dict['_field_validation'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_reviewed: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_reviewed'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, SchemaSummary] = attr_dict['_schema'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_status'].default) → None¶

Method generated by attrs for class AssayResult.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property archive_record: Optional[ArchiveRecord]¶
property created_at: datetime¶

DateTime at which the the result was created

property creator: UserSummary¶
property entry_id: Optional[str]¶

ID of the entry that this result is attached to

property field_validation: AssayResultFieldValidation¶

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

property fields: Fields¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶

ID of the result

property is_reviewed: bool¶

Whether or not this result is attached to an accepted entry

property project_id: Optional[str]¶

ID of the project to insert the result into

property schema: SchemaSummary¶
to_dict() → Dict[str, Any]¶
property validation_comment: str¶
property validation_status: str¶
class AssayResultCreate¶

Bases: object

__init__(fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, field_validation: Union[benchling_api_client.v2.types.Unset, AssayResultCreateFieldValidation] = attr_dict['_field_validation'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default) → None¶

Method generated by attrs for class AssayResultCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property field_validation: AssayResultCreateFieldValidation¶

Dictionary mapping field names to UserValidation Resources.

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

Dictionary of result fields

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_create.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶

UUID

property project_id: Optional[str]¶

The project that the assay result should be uploaded to. Only users with read access to the project will be able to read the assay result. Leaving this empty will result in only the creator having read access.

property schema_id: str¶

ID of result schema under which to upload this result

to_dict() → Dict[str, Any]¶
class AssayResultCreateFieldValidation¶

Bases: object

Dictionary mapping field names to UserValidation Resources.

__init__() → None¶

Method generated by attrs for class AssayResultCreateFieldValidation.

property additional_keys: List[str]¶
additional_properties: Dict[str, UserValidation]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_create_field_validation.T¶
get(key, default=None) → Optional[UserValidation]¶
to_dict() → Dict[str, Any]¶
class AssayResultFieldValidation¶

Bases: object

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

__init__() → None¶

Method generated by attrs for class AssayResultFieldValidation.

property additional_keys: List[str]¶
additional_properties: Dict[str, UserValidation]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_field_validation.T¶
get(key, default=None) → Optional[UserValidation]¶
to_dict() → Dict[str, Any]¶
class AssayResultIdsRequest¶

Bases: object

__init__(assay_result_ids: List[str]) → None¶

Method generated by attrs for class AssayResultIdsRequest.

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

Bases: object

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

Method generated by attrs for class AssayResultIdsResponse.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_result_ids: List[str]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_ids_response.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AssayResultSchema¶

Bases: object

__init__(modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, AssayResultSchemaType] = attr_dict['_type'].default, derived_from: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_derived_from'].default, organization: Union[benchling_api_client.v2.types.Unset, BaseAssaySchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None¶

Method generated by attrs for class AssayResultSchema.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property archive_record: Optional[ArchiveRecord]¶
property derived_from: Optional[str]¶
property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_schema.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
property modified_at: datetime¶

DateTime the Assay Result Schema was last modified

property name: str¶
property organization: BaseAssaySchemaOrganization¶
property system_name: str¶
to_dict() → Dict[str, Any]¶
property type: AssayResultSchemaType¶
class AssayResultSchemaType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RESULT = 'assay_result'¶
static of_unknown(val: str) → AssayResultSchemaType¶
class AssayResultSchemasPaginatedList¶

Bases: object

__init__(assay_result_schemas: Union[benchling_api_client.v2.types.Unset, List[AssayResultSchema]] = attr_dict['_assay_result_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None¶

Method generated by attrs for class AssayResultSchemasPaginatedList.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_result_schemas: List[AssayResultSchema]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_schemas_paginated_list.T¶
get(key, default=None) → Optional[Any]¶
property next_token: str¶
to_dict() → Dict[str, Any]¶
class AssayResultTransactionCreateResponse¶

Bases: object

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

Method generated by attrs for class AssayResultTransactionCreateResponse.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_result_transaction_create_response.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
to_dict() → Dict[str, Any]¶
class AssayResultsArchive¶

Bases: object

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

Method generated by attrs for class AssayResultsArchive.

property assay_result_ids: List[str]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_archive.T¶
property reason: AssayResultsArchiveReason¶

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

to_dict() → Dict[str, Any]¶
class AssayResultsArchiveReason¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ARCHIVED = 'Archived'¶
MADE_IN_ERROR = 'Made in error'¶
OTHER = 'Other'¶
static of_unknown(val: str) → AssayResultsArchiveReason¶
class AssayResultsBulkCreateRequest¶

Bases: object

__init__(assay_results: List[AssayResultCreate]) → None¶

Method generated by attrs for class AssayResultsBulkCreateRequest.

property assay_results: List[AssayResultCreate]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_bulk_create_request.T¶
to_dict() → Dict[str, Any]¶
class AssayResultsBulkGet¶

Bases: object

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

Method generated by attrs for class AssayResultsBulkGet.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_results: List[AssayResult]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_bulk_get.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AssayResultsCreateResponse¶

Bases: object

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

Method generated by attrs for class AssayResultsCreateResponse.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_results: List[str]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_create_response.T¶
get(key, default=None) → Optional[Any]¶
to_dict() → Dict[str, Any]¶
class AssayResultsPaginatedList¶

Bases: object

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

Method generated by attrs for class AssayResultsPaginatedList.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_results: List[AssayResult]¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_results_paginated_list.T¶
get(key, default=None) → Optional[Any]¶
property next_token: str¶
to_dict() → Dict[str, Any]¶
class AssayRun¶

Bases: object

__init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_reviewed: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_reviewed'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, AssayRunValidationStatus] = attr_dict['_validation_status'].default) → None¶

Method generated by attrs for class AssayRun.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property api_url: str¶

The canonical url of the Run in the API.

property archive_record: Optional[ArchiveRecord]¶
property created_at: str¶
property creator: UserSummary¶
property entry_id: Optional[str]¶
property fields: Fields¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
property is_reviewed: bool¶
property project_id: Optional[str]¶
property schema: Optional[SchemaSummary]¶
to_dict() → Dict[str, Any]¶
property validation_comment: Optional[str]¶
property validation_status: AssayRunValidationStatus¶

Must be either VALID or INVALID

class AssayRunCreate¶

Bases: object

__init__(fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, AssayRunValidationStatus] = attr_dict['_validation_status'].default) → None¶

Method generated by attrs for class AssayRunCreate.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]¶

Object of assay run fields

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run_create.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶

ID of assay run

property project_id: str¶

The project that the assay run should be uploaded to. Only users with read access to the project will be able to read the assay run. Leaving this empty will result in only the creator having read access.

property schema_id: str¶

ID of assay schema that assay run conforms to

to_dict() → Dict[str, Any]¶
property validation_comment: str¶

Additional information about the validation status

property validation_status: AssayRunValidationStatus¶

Must be either VALID or INVALID

class AssayRunCreatedEvent¶

Bases: object

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

Method generated by attrs for class AssayRunCreatedEvent.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_run: AssayRun¶
property created_at: datetime¶
property deprecated: bool¶
property event_type: AssayRunCreatedEventEventType¶
property excluded_properties: List[str]¶

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

classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run_created_event.T¶
get(key, default=None) → Optional[Any]¶
property id: str¶
property schema: Optional[EventBaseSchema]¶
to_dict() → Dict[str, Any]¶
class AssayRunCreatedEventEventType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ASSAYRUNCREATED = 'v2.assayRun.created'¶
static of_unknown(val: str) → AssayRunCreatedEventEventType¶
class AssayRunNotePart¶

Bases: object

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

Method generated by attrs for class AssayRunNotePart.

property additional_keys: List[str]¶
additional_properties: Dict[str, Any]¶
property assay_run_id: Optional[str]¶
property assay_run_schema_id: str¶
classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) → benchling_api_client.v2.stable.models.assay_run_note_part.T¶
get(key, default=None) → Optional[Any]¶
property indentation: int¶

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

to_dict() → Dict[str, Any]¶
property type: AssayRunNotePartType¶
class AssayRunNotePartType¶

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RUN = 'assay_run'¶
static of_unknown(val: str) → AssayRunNotePartType¶
class AssayRunSchema¶

Bases: object

__init__(automation_input_file_configs: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchemaAutomationInputFileConfigsItem]] = attr_dict['_automation_input_file_configs'].default, automation_output_file_configs: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchemaAutomationOutputFileConfigsItem]] = attr_dict['_automation_output_file_configs'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset,