Struct BenchlingClient

pub struct BenchlingClient { /* private fields */ }

Implementations

impl BenchlingClient

pub fn from_env() -> Self

impl BenchlingClient

pub fn new(url: &str, authentication: BenchlingAuthentication) -> Self

pub fn with_authentication( self, authentication: BenchlingAuthentication, ) -> Self

pub fn authenticate<'a>(&self, r: RequestBuilder<'a>) -> RequestBuilder<'a>

pub fn with_middleware<M: Middleware + 'static>(self, middleware: M) -> Self

pub fn list_aa_sequences(&self) -> ListAaSequencesRequest<'_>

List AA sequences

pub fn create_aa_sequence( &self, args: CreateAaSequenceRequired<'_>, ) -> CreateAaSequenceRequest<'_>

Create an AA sequence

pub fn get_aa_sequence(&self, aa_sequence_id: &str) -> GetAaSequenceRequest<'_>

Get an AA sequence

pub fn update_aa_sequence( &self, args: UpdateAaSequenceRequired<'_>, ) -> UpdateAaSequenceRequest<'_>

Update an AA sequence

pub fn archive_aa_sequences( &self, aa_sequence_ids: &[&str], reason: &str, ) -> ArchiveAaSequencesRequest<'_>

Archive AA sequences

pub fn auto_annotate_aa_sequences( &self, aa_sequence_ids: &[&str], feature_library_ids: &[&str], ) -> AutoAnnotateAaSequencesRequest<'_>

Auto-annotate AA sequences with matching features from specified Feature Libraries

pub fn bulk_create_aa_sequences(&self) -> BulkCreateAaSequencesRequest<'_>

Bulk Create AA sequences

Bulk Create AA sequences. Limit of 1000 AA Sequences per request.

pub fn bulk_get_aa_sequences( &self, aa_sequence_ids: &str, ) -> BulkGetAaSequencesRequest<'_>

Bulk get AA sequences by ID

pub fn bulk_update_aa_sequences(&self) -> BulkUpdateAaSequencesRequest<'_>

Bulk Update AA sequences

pub fn unarchive_aa_sequences( &self, aa_sequence_ids: &[&str], ) -> UnarchiveAaSequencesRequest<'_>

Unarchive AA sequences

pub fn list_app_configuration_items( &self, ) -> ListAppConfigurationItemsRequest<'_>

Get app configuration items

pub fn create_app_configuration_item( &self, ) -> CreateAppConfigurationItemRequest<'_>

Create app configuration item

pub fn get_app_configuration_item_by_id( &self, item_id: &str, ) -> GetAppConfigurationItemByIdRequest<'_>

Get app configuration item

pub fn update_app_configuration_item( &self, item_id: &str, ) -> UpdateAppConfigurationItemRequest<'_>

Update app configuration item

pub fn bulk_create_app_configuration_items( &self, app_configuration_items: Vec<AppConfigItemCreate>, ) -> BulkCreateAppConfigurationItemsRequest<'_>

Bulk Create app configuration items. Limit of 1000 App Config Items per request.

Bulk Create app configuration items

pub fn bulk_update_app_configuration_items( &self, app_configuration_items: Vec<AppConfigItemBulkUpdate>, ) -> BulkUpdateAppConfigurationItemsRequest<'_>

Bulk Update app configuration items. Limit of 1000 App Config Items per request.

Bulk Update app configuration items

pub fn list_benchling_apps(&self) -> ListBenchlingAppsRequest<'_>

List apps

pub fn create_benchling_app(&self, name: &str) -> CreateBenchlingAppRequest<'_>

Create an app

pub fn get_benchling_app_by_id( &self, app_id: &str, ) -> GetBenchlingAppByIdRequest<'_>

Get an app by ID

pub fn patch_benchling_app(&self, app_id: &str) -> PatchBenchlingAppRequest<'_>

Update an app

pub fn archive_benchling_apps( &self, app_ids: &[&str], reason: &str, ) -> ArchiveBenchlingAppsRequest<'_>

Archive apps

pub fn unarchive_benchling_apps( &self, app_ids: &[&str], ) -> UnarchiveBenchlingAppsRequest<'_>

Unarchive apps

pub fn list_assay_result_schemas(&self) -> ListAssayResultSchemasRequest<'_>

List assay result schemas

pub fn get_result_schema(&self, schema_id: &str) -> GetResultSchemaRequest<'_>

Get a Result schema by ID

pub fn list_assay_results(&self, schema_id: &str) -> ListAssayResultsRequest<'_>

List results

pub fn create_assay_results( &self, assay_results: Vec<AssayResultCreate>, ) -> CreateAssayResultsRequest<'_>

Create 1 or more results.

pub fn get_assay_result( &self, assay_result_id: &str, ) -> GetAssayResultRequest<'_>

Get a result

pub fn archive_assay_results( &self, assay_result_ids: &[&str], reason: &str, ) -> ArchiveAssayResultsRequest<'_>

Archive 1 or more results.

Only results that have not been added to a Notebook Entry can be Archived. Once results are attached to a notebook entry, they are tracked in the history of that notebook entry, and cannot be archived.

pub fn bulk_get_assay_results( &self, assay_result_ids: &str, ) -> BulkGetAssayResultsRequest<'_>

Gets multiple results specified by a list of IDs.

Up to 200 IDs can be specified at once.

pub fn unarchive_assay_results( &self, assay_result_ids: &[&str], ) -> UnarchiveAssayResultsRequest<'_>

Unarchive 1 or more results.

pub fn list_assay_run_schemas(&self) -> ListAssayRunSchemasRequest<'_>

List assay run schemas

pub fn get_run_schema(&self, schema_id: &str) -> GetRunSchemaRequest<'_>

Get a Run schema by ID

pub fn list_assay_runs(&self, schema_id: &str) -> ListAssayRunsRequest<'_>

List runs

pub fn create_assay_runs( &self, assay_runs: Vec<AssayRunCreate>, ) -> CreateAssayRunsRequest<'_>

Create 1 or more runs.

pub fn get_assay_run(&self, assay_run_id: &str) -> GetAssayRunRequest<'_>

Get a run

pub fn update_assay_run(&self, assay_run_id: &str) -> UpdateAssayRunRequest<'_>

Update a run

pub fn list_automation_input_generators( &self, assay_run_id: &str, ) -> ListAutomationInputGeneratorsRequest<'_>

list AutomationInputGenerators by Run

pub fn list_automation_output_processors_deprecated( &self, assay_run_id: &str, ) -> ListAutomationOutputProcessorsDeprecatedRequest<'_>

list AutomationOutputProcessors by Run

Deprecated in favor of ‘/automation-output-processors’. For each output config in the run config, will create an empty automationOutputProcessor for the run if one doesn’t exist.

pub fn archive_assay_runs( &self, assay_run_ids: &[&str], reason: &str, ) -> ArchiveAssayRunsRequest<'_>

Archive Assay Runs

Archive assay runs that are not embedded in a notebook entry

pub fn bulk_get_assay_runs( &self, assay_run_ids: &str, ) -> BulkGetAssayRunsRequest<'_>

Bulk get runs by ID

pub fn unarchive_assay_runs( &self, assay_run_ids: &[&str], ) -> UnarchiveAssayRunsRequest<'_>

Unarchive Assay Runs

Unarchive assay runs

pub fn get_lab_automation_transform( &self, transform_id: &str, ) -> GetLabAutomationTransformRequest<'_>

Get a Lab Automation Transform step

pub fn update_lab_automation_transform( &self, transform_id: &str, ) -> UpdateLabAutomationTransformRequest<'_>

Update a Lab Automation Transform step

pub fn get_automation_input_generator( &self, input_generator_id: &str, ) -> GetAutomationInputGeneratorRequest<'_>

Get an Automation Input Generator

pub fn update_automation_input_generator( &self, input_generator_id: &str, ) -> UpdateAutomationInputGeneratorRequest<'_>

Update an Automation Input Generator

pub fn generate_input_with_automation_input_generator( &self, input_generator_id: &str, ) -> GenerateInputWithAutomationInputGeneratorRequest<'_>

Generate Input with an Automation Input Generator

pub fn list_automation_output_processors( &self, ) -> ListAutomationOutputProcessorsRequest<'_>

List non-empty Automation Output Processors

List Automation Output Processors which have an attached file

pub fn create_automation_output_processor( &self, assay_run_id: &str, automation_file_config_name: &str, file_id: &str, ) -> CreateAutomationOutputProcessorRequest<'_>

Create Automation Output Processor

pub fn get_automation_output_processor( &self, output_processor_id: &str, ) -> GetAutomationOutputProcessorRequest<'_>

Get an Automation Output Processor

pub fn update_automation_output_processor( &self, output_processor_id: &str, file_id: &str, ) -> UpdateAutomationOutputProcessorRequest<'_>

Update an Automation Output Processor

pub fn process_output_with_automation_output_processor( &self, output_processor_id: &str, ) -> ProcessOutputWithAutomationOutputProcessorRequest<'_>

Process Output with an Automation Output Processor

pub fn archive_automation_output_processors( &self, automation_output_processor_ids: &[&str], ) -> ArchiveAutomationOutputProcessorsRequest<'_>

Archive Automation Output Processors and linked Results

pub fn unarchive_automation_output_processors( &self, automation_output_processor_ids: &[&str], ) -> UnarchiveAutomationOutputProcessorsRequest<'_>

Unarchive Automation Output Processors and linked Results

pub fn list_batch_schemas(&self) -> ListBatchSchemasRequest<'_>

List batch schemas

pub fn get_batch_schema(&self, schema_id: &str) -> GetBatchSchemaRequest<'_>

Get a batch schema by ID

pub fn list_batches(&self) -> ListBatchesRequest<'_>

List batches

pub fn create_batch(&self) -> CreateBatchRequest<'_>

Create a batch

pub fn get_batch(&self, batch_id: &str) -> GetBatchRequest<'_>

Get a batch

pub fn update_batch(&self, batch_id: &str) -> UpdateBatchRequest<'_>

Update a batch

pub fn archive_batches( &self, batch_ids: &[&str], reason: &str, ) -> ArchiveBatchesRequest<'_>

Archive Batches

pub fn bulk_get_batches(&self) -> BulkGetBatchesRequest<'_>

Bulk get batches

Batches can be queried by their IDs or their names. Querying by name requires specifying a registryId since batch names are not necessarily unique across registries. Batches must be registered to query by name.

pub fn unarchive_batches( &self, batch_ids: &[&str], ) -> UnarchiveBatchesRequest<'_>

Unarchive Batches

pub fn create_blob(&self, args: CreateBlobRequired<'_>) -> CreateBlobRequest<'_>

Upload single-part blob

This endpoint uploads a blob in a single API call.

Blobs larger than 10MB should be uploaded in multiple parts. The data64 parameter is the base64-encoded part contents, and the md5 parameter is the hex-encoded MD5 hash of the part contents. For example, given the string hello, data64 is aGVsbG8= and md5 is 5d41402abc4b2a76b9719d911017c592.

pub fn get_blob(&self, blob_id: &str) -> GetBlobRequest<'_>

Get a Blob

pub fn get_blob_url(&self, blob_id: &str) -> GetBlobUrlRequest<'_>

Get a Blob’s download url

pub fn create_blob_part( &self, args: CreateBlobPartRequired<'_>, ) -> CreateBlobPartRequest<'_>

Upload a part of a multi-part blob

Upload a part of the blob. This part must be at least 5MB, unless it’s the last or only part. It’s recommended to keep the part size around 10MB.

The data64 parameter is the base64-encoded part contents, and the md5 parameter is the hex-encoded MD5 hash of the part contents. For example, given the string hello, data64 is aGVsbG8= and md5 is 5d41402abc4b2a76b9719d911017c592.

Multipart Upload

If a blob is larger than 10MB, it should be uploaded in multiple parts using the following endpoints:

• Start a multi-part blob upload
• Upload a blob part
• Complete a blob upload

Each part has a partNumber and an eTag. The part number can be any number between 1 to 10,000, inclusive - this number should be unique and identifies the order of the part in the final blob. The eTag of a part is returned in the API response - this eTag must be specified when completing the upload in order to ensure the server has received all the expected parts.

pub fn abort_multipart_blob( &self, blob_id: &str, ) -> AbortMultipartBlobRequest<'_>

Abort multi-part blob upload

pub fn complete_multipart_blob( &self, blob_id: &str, ) -> CompleteMultipartBlobRequest<'_>

Complete multi-part blob upload

Combine blob parts into a single blob.

Multipart Upload

If a blob is larger than 10MB, it should be uploaded in multiple parts using the following endpoints:

• Start a multi-part blob upload
• Upload a blob part
• Complete a blob upload

Each part must be at least 5MB in size, except for the last part. We recommend keeping each part to under 10MB when uploading.

Each part has a partNumber and an eTag. The part number can be any number between 1 to 10,000, inclusive - this number should be unique and identifies the order of the part in the final blob. The eTag of a part is returned in the API response - this eTag must be specified when completing the upload in order to ensure the server has received all the expected parts.

pub fn bulk_get_blobs(&self) -> BulkGetBlobsRequest<'_>

Bulk get Blobs by UUID

pub fn create_multipart_blob( &self, name: &str, type_: &str, ) -> CreateMultipartBlobRequest<'_>

Initiate multi-part blob upload

Blobs may be uploaded using multi-part upload. This endpoint initiates the upload process - blob parts can then be uploaded in multiple blob parts.

Multipart Upload

If a blob is larger than 10MB, it should be uploaded in multiple parts using the following endpoints:

• Start a multi-part blob upload
• Upload a blob part
• Complete a blob upload

Each part must be at least 5MB in size, except for the last part. We recommend keeping each part to under 10MB when uploading.

Each part has a partNumber and an eTag. The part number can be any number between 1 to 10,000, inclusive - this number should be unique and identifies the order of the part in the final blob. The eTag of a part is returned in the API response - this eTag must be specified when completing the upload in order to ensure the server has received all the expected parts.

pub fn list_box_schemas(&self) -> ListBoxSchemasRequest<'_>

List box schemas

pub fn get_box_schema(&self, schema_id: &str) -> GetBoxSchemaRequest<'_>

Get a box schema by ID

pub fn list_boxes(&self) -> ListBoxesRequest<'_>

List boxes

pub fn create_box(&self, schema_id: &str) -> CreateBoxRequest<'_>

Create a box

pub fn get_box(&self, box_id: &str) -> GetBoxRequest<'_>

Get a box

pub fn update_box(&self, box_id: &str) -> UpdateBoxRequest<'_>

Update a box

pub fn list_box_contents(&self, box_id: &str) -> ListBoxContentsRequest<'_>

List a box’s contents

pub fn archive_boxes( &self, box_ids: &[&str], reason: &str, ) -> ArchiveBoxesRequest<'_>

Archive boxes

Archive boxes and any containers of the boxes

pub fn bulk_get_boxes(&self) -> BulkGetBoxesRequest<'_>

BulkGet boxes

pub fn unarchive_boxes(&self, box_ids: &[&str]) -> UnarchiveBoxesRequest<'_>

Unarchive boxes

Unarchive boxes and the containers that were archived along with them

pub fn list_container_schemas(&self) -> ListContainerSchemasRequest<'_>

List container schemas

pub fn get_container_schema( &self, schema_id: &str, ) -> GetContainerSchemaRequest<'_>

Get a container schema by ID

pub fn list_containers(&self) -> ListContainersRequest<'_>

List containers

pub fn create_container( &self, args: CreateContainerRequired<'_>, ) -> CreateContainerRequest<'_>

Create a new container

pub fn get_container(&self, container_id: &str) -> GetContainerRequest<'_>

get a container by id

pub fn update_container( &self, args: UpdateContainerRequired<'_>, ) -> UpdateContainerRequest<'_>

update a container

pub fn list_container_contents( &self, container_id: &str, ) -> ListContainerContentsRequest<'_>

List a container’s contents

pub fn get_container_content( &self, container_id: &str, containable_id: &str, ) -> GetContainerContentRequest<'_>

Get a container content

pub fn delete_container_content( &self, container_id: &str, containable_id: &str, ) -> DeleteContainerContentRequest<'_>

Delete a container content

pub fn update_container_content( &self, container_id: &str, containable_id: &str, concentration: Measurement, ) -> UpdateContainerContentRequest<'_>

Update a container content

pub fn transfer_into_container( &self, destination_container_id: &str, ) -> TransferIntoContainerRequest<'_>

Transfer into container

Transfers a volume of an entity, batch, or container into a destination container. Transfering a volume is cumulative with the existing destination container’s contents. To transfer an entire container’s contents, the sourceContainerId should be specified. To otherwise transfer multiple entities within a container, you can make multiple calls to this endpoint, specifying a single entity with each call.

pub fn archive_containers( &self, container_ids: &[&str], reason: &str, ) -> ArchiveContainersRequest<'_>

Archive containers

pub fn bulk_create_containers( &self, containers: Vec<ContainerCreate>, ) -> BulkCreateContainersRequest<'_>

Bulk create containers. Limit of 1000 containers per request.

Bulk create containers

pub fn bulk_get_containers(&self) -> BulkGetContainersRequest<'_>

Bulk get a set of containers

Bulk get a set of containers. Provide either containerIds or barcodes, not both.

pub fn bulk_update_containers( &self, containers: Vec<ContainerBulkUpdateItem>, ) -> BulkUpdateContainersRequest<'_>

Bulk update containers

pub fn checkin_containers( &self, container_ids: &[&str], ) -> CheckinContainersRequest<'_>

Check in containers

Check in containers to signify that they are available for use.

pub fn checkout_containers( &self, assignee_id: &str, container_ids: &[&str], ) -> CheckoutContainersRequest<'_>

Check out containers

Check out containers to signify that they are in use.

pub fn print_labels( &self, container_ids: &[&str], label_template_id: &str, printer_id: &str, ) -> PrintLabelsRequest<'_>

Print labels

pub fn reserve_containers( &self, assignee_id: &str, container_ids: &[&str], ) -> ReserveContainersRequest<'_>

Reserve containers

Reserve containers to signify that someone plans to use the containers.

pub fn unarchive_containers( &self, container_ids: &[&str], ) -> UnarchiveContainersRequest<'_>

Unarchive containers

pub fn list_custom_entities(&self) -> ListCustomEntitiesRequest<'_>

List custom entities

pub fn create_custom_entity( &self, args: CreateCustomEntityRequired<'_>, ) -> CreateCustomEntityRequest<'_>

Create a custom entity

pub fn get_custom_entity( &self, custom_entity_id: &str, ) -> GetCustomEntityRequest<'_>

Get a custom entity

pub fn update_custom_entity( &self, args: UpdateCustomEntityRequired<'_>, ) -> UpdateCustomEntityRequest<'_>

Update a custom entity

pub fn archive_custom_entities( &self, custom_entity_ids: &[&str], reason: &str, ) -> ArchiveCustomEntitiesRequest<'_>

Archive custom entities

pub fn bulk_create_custom_entities( &self, custom_entities: Vec<CustomEntityBulkCreate>, ) -> BulkCreateCustomEntitiesRequest<'_>

Bulk Create custom entities

Bulk Create custom entities. Limit of 2500 custom entities per request.

pub fn bulk_get_custom_entities( &self, custom_entity_ids: &str, ) -> BulkGetCustomEntitiesRequest<'_>

Bulk get custom entities by ID

pub fn bulk_update_custom_entities( &self, custom_entities: Vec<CustomEntityBulkUpdate>, ) -> BulkUpdateCustomEntitiesRequest<'_>

Bulk Update custom entities

pub fn unarchive_custom_entities( &self, custom_entity_ids: &[&str], ) -> UnarchiveCustomEntitiesRequest<'_>

Unarchive custom entities

pub fn list_dna_alignments(&self) -> ListDnaAlignmentsRequest<'_>

List DNA Alignments

pub fn get_dna_alignment( &self, dna_alignment_id: &str, ) -> GetDnaAlignmentRequest<'_>

Get a DNA Alignment

pub fn delete_dna_alignment( &self, dna_alignment_id: &str, ) -> DeleteDnaAlignmentRequest<'_>

Delete a DNA Alignment

pub fn create_dna_consensus_alignment( &self, args: CreateDnaConsensusAlignmentRequired<'_>, ) -> CreateDnaConsensusAlignmentRequest<'_>

Create a consensus DNA alignment

pub fn create_dna_template_alignment( &self, args: CreateDnaTemplateAlignmentRequired<'_>, ) -> CreateDnaTemplateAlignmentRequest<'_>

Create a template DNA alignment

pub fn list_dna_oligos(&self) -> ListDnaOligosRequest<'_>

List DNA Oligos

pub fn create_dna_oligo( &self, args: CreateDnaOligoRequired<'_>, ) -> CreateDnaOligoRequest<'_>

Create a DNA Oligo

pub fn get_dna_oligo(&self, oligo_id: &str) -> GetDnaOligoRequest<'_>

Get a DNA Oligo

pub fn update_dna_oligo( &self, args: UpdateDnaOligoRequired<'_>, ) -> UpdateDnaOligoRequest<'_>

Update a DNA Oligo

pub fn archive_dna_oligos( &self, dna_oligo_ids: &[&str], reason: &str, ) -> ArchiveDnaOligosRequest<'_>

Archive DNA Oligos

pub fn bulk_create_dna_oligos(&self) -> BulkCreateDnaOligosRequest<'_>

Bulk Create DNA Oligos

Bulk Create DNA Oligos. Limit of 1000 DNA Oligos per request.

pub fn bulk_update_dna_oligos(&self) -> BulkUpdateDnaOligosRequest<'_>

Bulk Update DNA Oligos

pub fn unarchive_dna_oligos( &self, dna_oligo_ids: &[&str], ) -> UnarchiveDnaOligosRequest<'_>

Unarchive DNA Oligos

pub fn list_dna_sequences(&self) -> ListDnaSequencesRequest<'_>

List DNA sequences

pub fn create_dna_sequence( &self, args: CreateDnaSequenceRequired<'_>, ) -> CreateDnaSequenceRequest<'_>

Create a DNA sequence

pub fn get_dna_sequence( &self, dna_sequence_id: &str, ) -> GetDnaSequenceRequest<'_>

Get a DNA sequence

pub fn update_dna_sequence( &self, args: UpdateDnaSequenceRequired<'_>, ) -> UpdateDnaSequenceRequest<'_>

Update a DNA sequence

pub fn archive_dna_sequences( &self, dna_sequence_ids: &[&str], reason: &str, ) -> ArchiveDnaSequencesRequest<'_>

Archive DNA sequences

pub fn auto_annotate_dna_sequences( &self, dna_sequence_ids: &[&str], feature_library_ids: &[&str], ) -> AutoAnnotateDnaSequencesRequest<'_>

Auto-annotate DNA sequences with matching features from specified Feature Libraries

pub fn autofill_dna_sequence_parts( &self, dna_sequence_ids: &[&str], ) -> AutofillDnaSequencePartsRequest<'_>

Autofill DNA sequence parts

pub fn autofill_dna_sequence_translations( &self, dna_sequence_ids: &[&str], ) -> AutofillDnaSequenceTranslationsRequest<'_>

Autofill DNA sequence translations

pub fn bulk_create_dna_sequences(&self) -> BulkCreateDnaSequencesRequest<'_>

Bulk Create DNA sequences

Bulk Create DNA sequences. Limit of 1000 DNA Sequences per request.

pub fn bulk_get_dna_sequences( &self, dna_sequence_ids: &str, ) -> BulkGetDnaSequencesRequest<'_>

Bulk get DNA sequences by ID

pub fn bulk_update_dna_sequences(&self) -> BulkUpdateDnaSequencesRequest<'_>

Bulk Update DNA sequences

pub fn unarchive_dna_sequences( &self, dna_sequence_ids: &[&str], ) -> UnarchiveDnaSequencesRequest<'_>

Unarchive DNA sequences

pub fn list_dropdowns(&self) -> ListDropdownsRequest<'_>

List dropdowns

pub fn create_dropdown( &self, name: &str, options: Vec<DropdownOptionCreate>, ) -> CreateDropdownRequest<'_>

Create a dropdown

pub fn get_dropdown(&self, dropdown_id: &str) -> GetDropdownRequest<'_>

Get a dropdown

pub fn update_dropdown( &self, dropdown_id: &str, options: Vec<DropdownOptionUpdate>, ) -> UpdateDropdownRequest<'_>

Update a dropdown

pub fn archive_dropdown_options( &self, dropdown_id: &str, ) -> ArchiveDropdownOptionsRequest<'_>

Archive dropdown options

Archive options belonging to a dropdown

pub fn unarchive_dropdown_options( &self, dropdown_id: &str, ) -> UnarchiveDropdownOptionsRequest<'_>

Unarchive dropdown options

Unarchive options belonging to a dropdown

pub fn get_enitity_batches( &self, entity_id: &str, ) -> GetEnitityBatchesRequest<'_>

Get an entity’s batches

pub fn list_entity_schemas(&self) -> ListEntitySchemasRequest<'_>

List entity schemas

pub fn get_entity_schema(&self, schema_id: &str) -> GetEntitySchemaRequest<'_>

Get an entity schema by ID

pub fn list_entries(&self) -> ListEntriesRequest<'_>

List entries

List notebook entries

pub fn create_entry( &self, folder_id: &str, name: &str, ) -> CreateEntryRequest<'_>

Create a notebook entry

pub fn get_entry(&self, entry_id: &str) -> GetEntryRequest<'_>

Get a notebook entry by ID

pub fn update_entry(&self, entry_id: &str) -> UpdateEntryRequest<'_>

Update a notebook entry’s metadata

pub fn get_external_file_metadata( &self, entry_id: &str, external_file_id: &str, ) -> GetExternalFileMetadataRequest<'_>

Retrieves the metadata for an external file. Use the ‘downloadURL’ to download the actual file.

Retrieves the metadata for an external file. Use the ‘downloadURL’ to download the actual file. (Expand the schema view for details)

pub fn archive_entries( &self, entry_ids: &[&str], reason: &str, ) -> ArchiveEntriesRequest<'_>

Archive notebook entries

pub fn bulk_get_entries(&self) -> BulkGetEntriesRequest<'_>

Get notebook entries using entry IDs or display IDs

pub fn unarchive_entries( &self, entry_ids: &[&str], ) -> UnarchiveEntriesRequest<'_>

Unarchive notebook entries

pub fn list_entry_schemas(&self) -> ListEntrySchemasRequest<'_>

List entry schemas

pub fn get_entry_schema(&self, schema_id: &str) -> GetEntrySchemaRequest<'_>

Get an Entry schema by ID

pub fn list_entry_templates(&self) -> ListEntryTemplatesRequest<'_>

List entry templates

pub fn get_entry_template( &self, entry_template_id: &str, ) -> GetEntryTemplateRequest<'_>

Get a notebook template entry by ID

pub fn list_events(&self) -> ListEventsRequest<'_>

List Events

List Events

Event Sort Order

Events in Benchling are assigned a stable sort order that reflects when the event was processed (not created). The createdAt time is not the stable sorted order of events. For this reason event createdAt time may appear out of order.

pub fn export_item(&self, id: &str) -> ExportItemRequest<'_>

Export Item

This endpoint launches a long-running task and returns the Task ID of the launched task. The task response contains a link to download the exported item from Amazon S3. The download is a ZIP file that contains the exported PDFs.

pub fn list_feature_libraries(&self) -> ListFeatureLibrariesRequest<'_>

List Feature Libraries

pub fn create_feature_library(&self) -> CreateFeatureLibraryRequest<'_>

Create a Feature Library

pub fn get_feature_library( &self, feature_library_id: &str, ) -> GetFeatureLibraryRequest<'_>

Get a feature library by ID

pub fn update_feature_library( &self, feature_library_id: &str, ) -> UpdateFeatureLibraryRequest<'_>

Update a feature library

Update a feature library. Note: Features cannot be updated from this endpoint. Use the /features* endpoints to add or modify features.

pub fn list_features(&self) -> ListFeaturesRequest<'_>

List Features

pub fn create_feature(&self) -> CreateFeatureRequest<'_>

Create a Feature

pub fn get_feature(&self, feature_id: &str) -> GetFeatureRequest<'_>

Get a feature by ID

pub fn update_feature(&self, feature_id: &str) -> UpdateFeatureRequest<'_>

Update a feature

pub fn bulk_create_features(&self) -> BulkCreateFeaturesRequest<'_>

Bulk create Features

pub fn list_folders(&self) -> ListFoldersRequest<'_>

List folders

pub fn create_folder( &self, name: &str, parent_folder_id: &str, ) -> CreateFolderRequest<'_>

Create folder

pub fn get_folder(&self, folder_id: &str) -> GetFolderRequest<'_>

Get a folder by ID

pub fn archive_folders( &self, folder_ids: &[&str], reason: &str, ) -> ArchiveFoldersRequest<'_>

Archive folders

Archives folders and their contents

pub fn unarchive_folders( &self, folder_ids: &[&str], ) -> UnarchiveFoldersRequest<'_>

Unarchive folders

Unarchives folders and the contents that were archived along with them

pub fn list_legacy_workflow_stage_run_input_samples( &self, stage_run_id: &str, ) -> ListLegacyWorkflowStageRunInputSamplesRequest<'_>

List legacy workflow stage run input samples

pub fn list_legacy_workflow_stage_run_output_samples( &self, stage_run_id: &str, ) -> ListLegacyWorkflowStageRunOutputSamplesRequest<'_>

List legacy workflow stage run output samples

pub fn list_legacy_workflow_stage_run_registered_samples( &self, stage_run_id: &str, ) -> ListLegacyWorkflowStageRunRegisteredSamplesRequest<'_>

List legacy workflow stage run registered samples

pub fn list_legacy_workflow_stage_runs( &self, stage_id: &str, ) -> ListLegacyWorkflowStageRunsRequest<'_>

List legacy workflow stage runs

pub fn list_legacy_workflows(&self) -> ListLegacyWorkflowsRequest<'_>

List legacy workflows

pub fn update_legacy_workflow_metadata( &self, legacy_workflow_id: &str, ) -> UpdateLegacyWorkflowMetadataRequest<'_>

Update legacy workflow

Update workflow metadata

pub fn list_legacy_workflow_stages( &self, legacy_workflow_id: &str, ) -> ListLegacyWorkflowStagesRequest<'_>

List legacy workflow stages

pub fn list_location_schemas(&self) -> ListLocationSchemasRequest<'_>

List location schemas

pub fn get_location_schema( &self, schema_id: &str, ) -> GetLocationSchemaRequest<'_>

Get a location schema by ID

pub fn list_locations(&self) -> ListLocationsRequest<'_>

List locations

pub fn create_location( &self, name: &str, schema_id: &str, ) -> CreateLocationRequest<'_>

Create a location

pub fn get_location(&self, location_id: &str) -> GetLocationRequest<'_>

Get a location by ID

pub fn update_location(&self, location_id: &str) -> UpdateLocationRequest<'_>

Update a location

pub fn archive_locations( &self, location_ids: &[&str], reason: &str, ) -> ArchiveLocationsRequest<'_>

Archive locations

pub fn bulk_get_locations(&self) -> BulkGetLocationsRequest<'_>

BulkGet locations

pub fn unarchive_locations( &self, location_ids: &[&str], ) -> UnarchiveLocationsRequest<'_>

Unarchive locations

pub fn list_mixtures(&self) -> ListMixturesRequest<'_>

List mixtures

pub fn create_mixture( &self, args: CreateMixtureRequired<'_>, ) -> CreateMixtureRequest<'_>

Create a mixture

Create a mixture. To create a new child mixture (eg. a prep) from a parent mixture (eg. a recipe), set the parent mixture field and specify the desired final state for your ingredients. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.

pub fn get_mixture(&self, mixture_id: &str) -> GetMixtureRequest<'_>

Get a mixture

pub fn update_mixture(&self, mixture_id: &str) -> UpdateMixtureRequest<'_>

Update a mixture

Update a mixture. To change the parent mixture, set the parent mixture field and specify the desired final state for your ingredients. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.

pub fn archive_mixtures( &self, mixture_ids: &[&str], reason: &str, ) -> ArchiveMixturesRequest<'_>

Archive mixtures

pub fn bulk_create_mixtures( &self, mixtures: Vec<MixtureCreate>, ) -> BulkCreateMixturesRequest<'_>

Bulk Create mixtures

Create multiple mixtures. Limit of 1000 mixtures per request. To create new child mixtures (eg. a prep) from parent mixtures (eg. a recipe), set the parent mixture field and specify the desired final state for your ingredients. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixtures (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.

pub fn bulk_update_mixtures(&self) -> BulkUpdateMixturesRequest<'_>

Bulk Update mixtures

Update multiple mixtures. To change the parent mixture on your specified mixtures, set the parent mixture field and specify the desired final state for your ingredients. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixtures (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.

pub fn unarchive_mixtures( &self, mixture_ids: &[&str], ) -> UnarchiveMixturesRequest<'_>

Unarchive mixtures

pub fn list_molecules(&self) -> ListMoleculesRequest<'_>

List Molecules

List molecules

pub fn create_molecule( &self, args: CreateMoleculeRequired<'_>, ) -> CreateMoleculeRequest<'_>

Create a Molecule

pub fn get_molecule(&self, molecule_id: &str) -> GetMoleculeRequest<'_>

Get a Molecule

pub fn update_molecule( &self, args: UpdateMoleculeRequired<'_>, ) -> UpdateMoleculeRequest<'_>

Update a Molecule

pub fn archive_molecules( &self, molecule_ids: &[&str], reason: &str, ) -> ArchiveMoleculesRequest<'_>

Archive Molecules

pub fn bulk_create_molecules(&self) -> BulkCreateMoleculesRequest<'_>

Bulk Create Molecules

pub fn bulk_update_molecules(&self) -> BulkUpdateMoleculesRequest<'_>

Bulk Update Molecules

pub fn unarchive_molecules( &self, molecule_ids: &[&str], ) -> UnarchiveMoleculesRequest<'_>

Unarchive Molecules

pub fn list_nucleotide_alignments(&self) -> ListNucleotideAlignmentsRequest<'_>

List Nucleotide Alignments

pub fn get_nucleotide_alignment( &self, alignment_id: &str, ) -> GetNucleotideAlignmentRequest<'_>

Get a Nucleotide Alignment

pub fn delete_nucleotide_alignment( &self, alignment_id: &str, ) -> DeleteNucleotideAlignmentRequest<'_>

Delete a Nucleotide Alignment

pub fn create_consensus_nucleotide_alignment( &self, args: CreateConsensusNucleotideAlignmentRequired<'_>, ) -> CreateConsensusNucleotideAlignmentRequest<'_>

Create a consensus Nucleotide Alignment

pub fn create_template_nucleotide_alignment( &self, args: CreateTemplateNucleotideAlignmentRequired<'_>, ) -> CreateTemplateNucleotideAlignmentRequest<'_>

Create a template Nucleotide Alignment

pub fn list_oligos(&self) -> ListOligosRequest<'_>

List Oligos

pub fn create_oligo( &self, args: CreateOligoRequired<'_>, ) -> CreateOligoRequest<'_>

Create an Oligo

pub fn get_oligo(&self, oligo_id: &str) -> GetOligoRequest<'_>

Get an Oligo

pub fn update_oligo( &self, args: UpdateOligoRequired<'_>, ) -> UpdateOligoRequest<'_>

Update an Oligo

pub fn archive_oligos( &self, oligo_ids: &[&str], reason: &str, ) -> ArchiveOligosRequest<'_>

Archive Oligos

pub fn bulk_create_oligos(&self) -> BulkCreateOligosRequest<'_>

Bulk Create DNA Oligos

Bulk Create DNA Oligos Please migrate to Bulk Create DNA Oligos so that we can support RNA Oligos.

pub fn bulk_get_oligos(&self, oligo_ids: &str) -> BulkGetOligosRequest<'_>

Bulk get Oligos by ID

pub fn unarchive_oligos(&self, oligo_ids: &[&str]) -> UnarchiveOligosRequest<'_>

Unarchive Oligos

pub fn list_organizations(&self) -> ListOrganizationsRequest<'_>

List organizations

Returns all organizations that the caller has permission to view. The following roles have view permission:

• tenant admins
• members of the organization

pub fn get_organization( &self, organization_id: &str, ) -> GetOrganizationRequest<'_>

Get an organization by ID

Returns an organization by ID if the caller has permission to view. The following roles have view permission:

• tenant admins
• members of the organization

pub fn list_plate_schemas(&self) -> ListPlateSchemasRequest<'_>

List plate schemas

pub fn get_plate_schema(&self, schema_id: &str) -> GetPlateSchemaRequest<'_>

Get a plate schema by ID

pub fn list_plates(&self) -> ListPlatesRequest<'_>

List plates

pub fn create_plate(&self, schema_id: &str) -> CreatePlateRequest<'_>

Create a plate

pub fn get_plate(&self, plate_id: &str) -> GetPlateRequest<'_>

Get a plate

pub fn update_plate(&self, plate_id: &str) -> UpdatePlateRequest<'_>

Update a plate

pub fn archive_plates( &self, plate_ids: &[&str], reason: &str, should_remove_barcodes: bool, ) -> ArchivePlatesRequest<'_>

Archive plates

Archive plates and any containers of the plates

pub fn bulk_get_plates(&self) -> BulkGetPlatesRequest<'_>

BulkGet plates

pub fn unarchive_plates(&self, plate_ids: &[&str]) -> UnarchivePlatesRequest<'_>

Unarchive plates

Unarchive plates and the containers that were archived along with them

pub fn list_projects(&self) -> ListProjectsRequest<'_>

List projects

pub fn get_project(&self, project_id: &str) -> GetProjectRequest<'_>

Get a project by ID

pub fn archive_projects( &self, project_ids: &[&str], reason: &str, ) -> ArchiveProjectsRequest<'_>

Archive projects

Archives projects and their contents

pub fn unarchive_projects( &self, project_ids: &[&str], ) -> UnarchiveProjectsRequest<'_>

Unarchive projects

Unarchives projects and the contents that were archived along with them

pub fn list_registries(&self) -> ListRegistriesRequest<'_>

List registries

pub fn get_registry(&self, registry_id: &str) -> GetRegistryRequest<'_>

Get registry

pub fn list_batch_schemas_by_registry( &self, registry_id: &str, ) -> ListBatchSchemasByRegistryRequest<'_>

List batch schemas by registry

List batch schemas by registry. Deprecated - use Schemas endpoints instead.

pub fn list_box_schemas_by_registry( &self, registry_id: &str, ) -> ListBoxSchemasByRegistryRequest<'_>

List box schemas by registry

List box schemas by registry. Deprecated - use Schemas endpoints instead.

pub fn list_container_schemas_by_registry( &self, registry_id: &str, ) -> ListContainerSchemasByRegistryRequest<'_>

List container schemas by registry

List container schemas by registry. Deprecated - use Schemas endpoints instead.

pub fn list_dropdowns_by_registry( &self, registry_id: &str, ) -> ListDropdownsByRegistryRequest<'_>

List dropdowns for a given registry

List dropdowns by registry

pub fn list_entity_schemas_by_registry( &self, registry_id: &str, ) -> ListEntitySchemasByRegistryRequest<'_>

List entity schemas by registry

List entity schemas by registry. Deprecated - use Schemas endpoints instead.

pub fn list_printers(&self, registry_id: &str) -> ListPrintersRequest<'_>

List printers

pub fn list_label_templates( &self, registry_id: &str, ) -> ListLabelTemplatesRequest<'_>

List label templates

pub fn list_location_schemas_by_registry( &self, registry_id: &str, ) -> ListLocationSchemasByRegistryRequest<'_>

List location schemas by registry

List location schemas by registry. Deprecated - use Schemas endpoints instead.

pub fn list_plate_schemas_by_registry( &self, registry_id: &str, ) -> ListPlateSchemasByRegistryRequest<'_>

List plate schemas by registry

List plate schemas by registry. Deprecated - use Schemas endpoints instead.

pub fn bulk_get_registered_entities( &self, registry_id: &str, entity_registry_ids: &str, ) -> BulkGetRegisteredEntitiesRequest<'_>

Bulk get registered entities

pub fn register_entities( &self, registry_id: &str, entity_ids: &[&str], naming_strategy: &str, ) -> RegisterEntitiesRequest<'_>

Register entities

Attempts to move entities into the registry. Limit of 2500 entities per request. This endpoint will first check that the entities are all valid to be moved into the registry, given the namingStrategy. If any entities fail validation, no files will be moved and errors describing invalid entities is returned. If all entities pass validation, the entities are moved into the registry.

pub fn unregister_entities( &self, registry_id: &str, entity_ids: &[&str], folder_id: &str, ) -> UnregisterEntitiesRequest<'_>

Unregister entities

Unregisters entities and moves them to a folder

pub fn validate_barcodes( &self, registry_id: &str, barcodes: &[&str], ) -> ValidateBarcodesRequest<'_>

Validate barcodes

Validate barcodes on storage objects.

pub fn list_request_fulfillments( &self, entry_id: &str, ) -> ListRequestFulfillmentsRequest<'_>

List Request Fulfillments

pub fn get_request_fulfillment( &self, request_fulfillment_id: &str, ) -> GetRequestFulfillmentRequest<'_>

Get a request’s fulfillment

pub fn list_request_schemas(&self) -> ListRequestSchemasRequest<'_>

List request schemas

pub fn get_request_schema(&self, schema_id: &str) -> GetRequestSchemaRequest<'_>

Get a Request schema by ID

pub fn list_request_task_schemas(&self) -> ListRequestTaskSchemasRequest<'_>

List request task schemas

pub fn get_request_task_schema( &self, schema_id: &str, ) -> GetRequestTaskSchemaRequest<'_>

Get a Request Task schema by ID

pub fn list_requests(&self, schema_id: &str) -> ListRequestsRequest<'_>

List requests

pub fn create_request( &self, args: CreateRequestRequired<'_>, ) -> CreateRequestRequest<'_>

Create a request

pub fn get_request(&self, request_id: &str) -> GetRequestRequest<'_>

Get a request by ID

pub fn patch_request( &self, args: PatchRequestRequired<'_>, ) -> PatchRequestRequest<'_>

Update a request

pub fn get_request_response( &self, request_id: &str, ) -> GetRequestResponseRequest<'_>

Get a request’s response

pub fn bulk_create_request_tasks( &self, request_id: &str, tasks: Vec<RequestTasksBulkCreate>, ) -> BulkCreateRequestTasksRequest<'_>

Create tasks for a request

pub fn bulk_update_request_tasks( &self, request_id: &str, tasks: Vec<RequestTaskBase>, ) -> BulkUpdateRequestTasksRequest<'_>

Bulk update tasks for a request

pub fn execute_requests_sample_groups( &self, request_id: &str, sample_groups: Vec<SampleGroupStatusUpdate>, ) -> ExecuteRequestsSampleGroupsRequest<'_>

Update the status of sample groups in a request

pub fn bulk_get_requests(&self) -> BulkGetRequestsRequest<'_>

Bulk get requests

Bulk get requests by API ID or display ID

pub fn create_assay_results_transaction( &self, ) -> CreateAssayResultsTransactionRequest<'_>

Create a transaction

Transactions allow results to be upload in multiple requests. This endpoint lets you create a transaction. You can then upload results to the transaction, abort the transaction, or commit the transaction.

pub fn create_assay_results_in_transaction( &self, transaction_id: &str, assay_results: Vec<AssayResultCreate>, ) -> CreateAssayResultsInTransactionRequest<'_>

Create results in a transaction

pub fn abort_assay_results_transaction( &self, transaction_id: &str, ) -> AbortAssayResultsTransactionRequest<'_>

Abort a transaction

Aborting a transaction will discard all uploaded results.

pub fn commit_assay_results_transaction( &self, transaction_id: &str, ) -> CommitAssayResultsTransactionRequest<'_>

Commit a transaction

Committing a transaction will cause all results that have been uploaded to be saved and visible to others.

pub fn list_rna_oligos(&self) -> ListRnaOligosRequest<'_>

List RNA Oligos

pub fn create_rna_oligo( &self, args: CreateRnaOligoRequired<'_>, ) -> CreateRnaOligoRequest<'_>

Create an RNA Oligo

pub fn get_rna_oligo(&self, oligo_id: &str) -> GetRnaOligoRequest<'_>

Get an RNA Oligo

pub fn update_rna_oligo( &self, args: UpdateRnaOligoRequired<'_>, ) -> UpdateRnaOligoRequest<'_>

Update an RNA Oligo

pub fn archive_rna_oligos( &self, reason: &str, rna_oligo_ids: &[&str], ) -> ArchiveRnaOligosRequest<'_>

Archive RNA Oligos

pub fn bulk_create_rna_oligos(&self) -> BulkCreateRnaOligosRequest<'_>

Bulk Create RNA Oligos

Bulk Create RNA Oligos. Limit of 1000 RNA Oligos per request.

pub fn bulk_update_rna_oligos(&self) -> BulkUpdateRnaOligosRequest<'_>

Bulk Update RNA Oligos

pub fn unarchive_rna_oligos( &self, rna_oligo_ids: &[&str], ) -> UnarchiveRnaOligosRequest<'_>

Unarchive RNA Oligos

pub fn list_rna_sequences(&self) -> ListRnaSequencesRequest<'_>

List RNA sequences

pub fn create_rna_sequence( &self, args: CreateRnaSequenceRequired<'_>, ) -> CreateRnaSequenceRequest<'_>

Create an RNA sequence

pub fn get_rna_sequence( &self, rna_sequence_id: &str, ) -> GetRnaSequenceRequest<'_>

Get an RNA sequence

pub fn update_rna_sequence( &self, args: UpdateRnaSequenceRequired<'_>, ) -> UpdateRnaSequenceRequest<'_>

Update an RNA sequence

pub fn archive_rna_sequences( &self, reason: &str, rna_sequence_ids: &[&str], ) -> ArchiveRnaSequencesRequest<'_>

Archive RNA Sequences

Archive RNA Sequences. RNA sequences that are already registered will not be removed from the registry.

pub fn auto_annotate_rna_sequences( &self, feature_library_ids: &[&str], rna_sequence_ids: &[&str], ) -> AutoAnnotateRnaSequencesRequest<'_>

Auto-annotate RNA sequences with matching features from specified Feature Libraries

Auto-annotate RNA sequences with matching features from specified Feature Libraries. U/T bases are treated as interchangeable in both features and sequences.

pub fn autofill_rna_sequence_parts( &self, rna_sequence_ids: &[&str], ) -> AutofillRnaSequencePartsRequest<'_>

Autofill RNA sequence parts

Autofill parts from matching RNA Sequences with linked schemas.

pub fn autofill_rna_sequence_translations( &self, rna_sequence_ids: &[&str], ) -> AutofillRnaSequenceTranslationsRequest<'_>

Autofill RNA sequence translations from Amino Acid sequences with matching schemas

Autofill RNA sequence translations

pub fn bulk_create_rna_sequences(&self) -> BulkCreateRnaSequencesRequest<'_>

Bulk Create RNA sequences

Bulk Create RNA sequences. Limit of 1000 RNA Sequences per request.

pub fn bulk_get_rna_sequences( &self, rna_sequence_ids: &str, ) -> BulkGetRnaSequencesRequest<'_>

Bulk get RNA sequences by ID

pub fn bulk_update_rna_sequences(&self) -> BulkUpdateRnaSequencesRequest<'_>

Bulk Update RNA sequences

pub fn unarchive_rna_sequences( &self, rna_sequence_ids: &[&str], ) -> UnarchiveRnaSequencesRequest<'_>

Unarchive RNA sequences

pub fn get_task(&self, task_id: &str) -> GetTaskRequest<'_>

Get a task by id

pub fn list_teams(&self) -> ListTeamsRequest<'_>

List teams

Returns all teams that the caller has permission to view. The following roles have view permission:

• tenant admins
• members of the team’s organization

pub fn get_team(&self, team_id: &str) -> GetTeamRequest<'_>

Get a team by ID

Returns a team by ID if the caller has permission to view. The following roles have view permission:

• tenant admins
• members of the team’s organization

pub fn generate_token(&self) -> GenerateTokenRequest<'_>

Generate a token for usage with authenticating via OAuth2 in subsequent API calls.

Generate a token

pub fn transfer_into_containers( &self, transfers: Vec<MultipleContainersTransfer>, ) -> TransferIntoContainersRequest<'_>

Transfers into containers

Transfers a volume of an entity, batch, or container into a destination container. Limit of 5000 transfers per request. Concentration of all contents in the destination container will be automatically updated based on the previous volume & concentrations of the contents in that container, the concentration of the contents being transferred in, the volume of the contents being transferred in, and the final volume of the container. If no concentration is specified, the concentration will not be tracked.

pub fn list_users(&self) -> ListUsersRequest<'_>

List users

Returns all users that the caller has permission to view. The following roles have view permission:

• tenant admins
• members of the user’s organizations

pub fn get_user(&self, user_id: &str) -> GetUserRequest<'_>

Get a user by ID

Returns a user by ID if the caller has permission to view. The following roles have view permission:

• tenant admins
• members of any of the user’s organizations

pub fn create_warehouse_credentials( &self, expires_in: i64, ) -> CreateWarehouseCredentialsRequest<'_>

Create Benchling Warehouse credentials

Allows for programmatically generating credentials to connect to the Benchling warehouse. You must have a warehouse configured to access this endpoint. The credentials will authenticate as the same user calling the API. Note that expiresIn is required - only temporary credentials are currently allowed.

pub fn list_workflow_outputs(&self) -> ListWorkflowOutputsRequest<'_>

List workflow outputs

pub fn create_workflow_output( &self, fields: Fields, workflow_task_id: &str, ) -> CreateWorkflowOutputRequest<'_>

Create a new workflow output

pub fn get_workflow_output( &self, workflow_output_id: &str, ) -> GetWorkflowOutputRequest<'_>

Get a workflow output

pub fn update_workflow_output( &self, workflow_output_id: &str, fields: Fields, ) -> UpdateWorkflowOutputRequest<'_>

Update a workflow output

pub fn archive_workflow_outputs( &self, reason: &str, workflow_output_ids: &[&str], ) -> ArchiveWorkflowOutputsRequest<'_>

Archive one or more workflow outputs

pub fn bulk_create_workflow_outputs( &self, ) -> BulkCreateWorkflowOutputsRequest<'_>

Bulk create new workflow outputs

pub fn bulk_update_workflow_outputs( &self, ) -> BulkUpdateWorkflowOutputsRequest<'_>

Bulk update workflow outputs

pub fn unarchive_workflow_outputs( &self, workflow_output_ids: &[&str], ) -> UnarchiveWorkflowOutputsRequest<'_>

Unarchive one or more workflow outputs

pub fn list_stage_run_input_samples( &self, stage_run_id: &str, ) -> ListStageRunInputSamplesRequest<'_>

List stage run input samples

pub fn list_stage_run_output_samples( &self, stage_run_id: &str, ) -> ListStageRunOutputSamplesRequest<'_>

List stage run output samples

pub fn list_stage_run_registered_samples( &self, stage_run_id: &str, ) -> ListStageRunRegisteredSamplesRequest<'_>

List stage run registered samples

pub fn list_workflow_stage_runs( &self, stage_id: &str, ) -> ListWorkflowStageRunsRequest<'_>

List workflow stage runs

pub fn list_workflow_task_groups(&self) -> ListWorkflowTaskGroupsRequest<'_>

List workflow task groups

pub fn create_workflow_task_group( &self, args: CreateWorkflowTaskGroupRequired<'_>, ) -> CreateWorkflowTaskGroupRequest<'_>

Create a new workflow task group

Create a new workflow task group. If no name is specified, uses the workflow schema name and a unique incrementor separated by a single whitespace.

pub fn get_workflow_task_group( &self, workflow_task_group_id: &str, ) -> GetWorkflowTaskGroupRequest<'_>

Get a workflow task group

pub fn update_workflow_task_group( &self, args: UpdateWorkflowTaskGroupRequired<'_>, ) -> UpdateWorkflowTaskGroupRequest<'_>

Update a workflow task group

pub fn archive_workflow_task_groups( &self, reason: &str, workflow_task_group_ids: &[&str], ) -> ArchiveWorkflowTaskGroupsRequest<'_>

Archive one or more workflows

pub fn unarchive_workflow_task_groups( &self, workflow_task_group_ids: &[&str], ) -> UnarchiveWorkflowTaskGroupsRequest<'_>

Unarchive one or more workflows

pub fn list_workflow_task_schemas(&self) -> ListWorkflowTaskSchemasRequest<'_>

List workflow task schemas

pub fn get_workflow_task_schema( &self, schema_id: &str, ) -> GetWorkflowTaskSchemaRequest<'_>

Get a workflow task schema

pub fn list_workflow_tasks(&self) -> ListWorkflowTasksRequest<'_>

List workflow tasks

pub fn create_workflow_task( &self, args: CreateWorkflowTaskRequired<'_>, ) -> CreateWorkflowTaskRequest<'_>

Create a new workflow task

pub fn get_workflow_task( &self, workflow_task_id: &str, ) -> GetWorkflowTaskRequest<'_>

Get a workflow task

pub fn update_workflow_task( &self, workflow_task_id: &str, ) -> UpdateWorkflowTaskRequest<'_>

Update a workflow task

pub fn copy_workflow_task( &self, workflow_task_id: &str, ) -> CopyWorkflowTaskRequest<'_>

Creates a new workflow task with the same fields and assignee as the provided task and creates a relationship between the two tasks

Creates a new workflow task based on the provided task

pub fn archive_workflow_tasks( &self, reason: &str, workflow_task_ids: &[&str], ) -> ArchiveWorkflowTasksRequest<'_>

Archive one or more workflow tasks

pub fn bulk_copy_workflow_tasks(&self) -> BulkCopyWorkflowTasksRequest<'_>

Bulk creates new workflow tasks where each new task has the same fields and assignee as one of the provided tasks and creates a relationship between the provided task and its copy

Bulk creates new workflow tasks based on the provided tasks

pub fn bulk_create_workflow_tasks(&self) -> BulkCreateWorkflowTasksRequest<'_>

Create one or more workflow tasks

pub fn bulk_update_workflow_tasks(&self) -> BulkUpdateWorkflowTasksRequest<'_>

Update one or more workflow task

Update one or more workflow tasks

pub fn unarchive_workflow_tasks( &self, workflow_task_ids: &[&str], ) -> UnarchiveWorkflowTasksRequest<'_>

Unarchive one or more workflow tasks

pub fn list_workflows(&self) -> ListWorkflowsRequest<'_>

List workflows

pub fn update_workflow_metadata( &self, workflow_id: &str, ) -> UpdateWorkflowMetadataRequest<'_>

Update workflow

Update workflow metadata

pub fn list_workflow_stages( &self, workflow_id: &str, ) -> ListWorkflowStagesRequest<'_>

List workflow stages