benchling-sdk 1.21.2__py3-none-any.whl → 1.22.0a1__py3-none-any.whl

benchling_sdk/models/webhooks/v0/__init__.py

@@ -19,8 +19,10 @@ __all__ = [
     "AssayRunCreatedWebhookV2Type",
     "AssayRunUpdatedFieldsWebhookV2",
     "AssayRunUpdatedFieldsWebhookV2Type",
+    "CanvasCreatedWebhookV2",
     "CanvasCreatedWebhookV2Beta",
     "CanvasCreatedWebhookV2BetaType",
+    "CanvasCreatedWebhookV2Type",
     "CanvasInitializeWebhookV2",
     "CanvasInitializeWebhookV2Type",
     "CanvasInteractionWebhookV2",
@@ -132,8 +134,10 @@ if TYPE_CHECKING:
     import benchling_api_client.webhooks.v0.stable.models.assay_run_created_webhook_v2_type
     import benchling_api_client.webhooks.v0.stable.models.assay_run_updated_fields_webhook_v2
     import benchling_api_client.webhooks.v0.stable.models.assay_run_updated_fields_webhook_v2_type
+    import benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2
     import benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_beta
     import benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_beta_type
+    import benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_type
     import benchling_api_client.webhooks.v0.stable.models.canvas_initialize_webhook_v2
     import benchling_api_client.webhooks.v0.stable.models.canvas_initialize_webhook_v2_type
     import benchling_api_client.webhooks.v0.stable.models.canvas_interaction_webhook_v2
@@ -263,12 +267,18 @@ if TYPE_CHECKING:
     AssayRunUpdatedFieldsWebhookV2Type = (
         benchling_api_client.webhooks.v0.stable.models.assay_run_updated_fields_webhook_v2_type.AssayRunUpdatedFieldsWebhookV2Type
     )
+    CanvasCreatedWebhookV2 = (
+        benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2.CanvasCreatedWebhookV2
+    )
     CanvasCreatedWebhookV2Beta = (
         benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_beta.CanvasCreatedWebhookV2Beta
     )
     CanvasCreatedWebhookV2BetaType = (
         benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_beta_type.CanvasCreatedWebhookV2BetaType
     )
+    CanvasCreatedWebhookV2Type = (
+        benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_type.CanvasCreatedWebhookV2Type
+    )
     CanvasInitializeWebhookV2 = (
         benchling_api_client.webhooks.v0.stable.models.canvas_initialize_webhook_v2.CanvasInitializeWebhookV2
     )
@@ -350,8 +360,12 @@ if TYPE_CHECKING:
     LifecycleDeactivateWebhookV0Type = (
         benchling_api_client.webhooks.v0.stable.models.lifecycle_deactivate_webhook_v0_type.LifecycleDeactivateWebhookV0Type
     )
-    MessageBase = benchling_api_client.webhooks.v0.stable.models.message_base.MessageBase
-    MessageBaseV0 = benchling_api_client.webhooks.v0.stable.models.message_base_v0.MessageBaseV0
+    MessageBase = (
+        benchling_api_client.webhooks.v0.stable.models.message_base.MessageBase
+    )
+    MessageBaseV0 = (
+        benchling_api_client.webhooks.v0.stable.models.message_base_v0.MessageBaseV0
+    )
     RequestCreatedWebhookV2 = (
         benchling_api_client.webhooks.v0.stable.models.request_created_webhook_v2.RequestCreatedWebhookV2
     )
@@ -484,7 +498,9 @@ if TYPE_CHECKING:
     V2WorkflowTaskUpdatedStatusEventEventType = (
         benchling_api_client.webhooks.v0.stable.models.v2_workflow_task_updated_status_event_event_type.V2WorkflowTaskUpdatedStatusEventEventType
     )
-    WebhookEnvelopeV0 = benchling_api_client.webhooks.v0.stable.models.webhook_envelope_v0.WebhookEnvelopeV0
+    WebhookEnvelopeV0 = (
+        benchling_api_client.webhooks.v0.stable.models.webhook_envelope_v0.WebhookEnvelopeV0
+    )
     WebhookEnvelopeV0App = (
         benchling_api_client.webhooks.v0.stable.models.webhook_envelope_v0_app.WebhookEnvelopeV0App
     )
@@ -494,7 +510,9 @@ if TYPE_CHECKING:
     WebhookEnvelopeV0Version = (
         benchling_api_client.webhooks.v0.stable.models.webhook_envelope_v0_version.WebhookEnvelopeV0Version
     )
-    WebhookMessageV0 = benchling_api_client.webhooks.v0.stable.models.webhook_message_v0.WebhookMessageV0
+    WebhookMessageV0 = (
+        benchling_api_client.webhooks.v0.stable.models.webhook_message_v0.WebhookMessageV0
+    )
     WorkflowOutputCreatedWebhookV2 = (
         benchling_api_client.webhooks.v0.stable.models.workflow_output_created_webhook_v2.WorkflowOutputCreatedWebhookV2
     )
@@ -568,8 +586,10 @@ else:
         "AssayRunCreatedWebhookV2Type": "benchling_api_client.webhooks.v0.stable.models.assay_run_created_webhook_v2_type",
         "AssayRunUpdatedFieldsWebhookV2": "benchling_api_client.webhooks.v0.stable.models.assay_run_updated_fields_webhook_v2",
         "AssayRunUpdatedFieldsWebhookV2Type": "benchling_api_client.webhooks.v0.stable.models.assay_run_updated_fields_webhook_v2_type",
+        "CanvasCreatedWebhookV2": "benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2",
         "CanvasCreatedWebhookV2Beta": "benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_beta",
         "CanvasCreatedWebhookV2BetaType": "benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_beta_type",
+        "CanvasCreatedWebhookV2Type": "benchling_api_client.webhooks.v0.stable.models.canvas_created_webhook_v2_type",
         "CanvasInitializeWebhookV2": "benchling_api_client.webhooks.v0.stable.models.canvas_initialize_webhook_v2",
         "CanvasInitializeWebhookV2Type": "benchling_api_client.webhooks.v0.stable.models.canvas_initialize_webhook_v2_type",
         "CanvasInteractionWebhookV2": "benchling_api_client.webhooks.v0.stable.models.canvas_interaction_webhook_v2",

benchling_sdk/services/v2/stable/aa_sequence_service.py

@@ -93,6 +93,7 @@ class AaSequenceService(BaseService):
     def _aa_sequences_page(
         self,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         amino_acids: Optional[str] = None,
         folder_id: Optional[str] = None,
@@ -118,6 +119,7 @@ class AaSequenceService(BaseService):
         response = list_aa_sequences.sync_detailed(
             client=self.client,
             modified_at=none_as_unset(modified_at),
+            created_at=none_as_unset(created_at),
             name=none_as_unset(name),
             amino_acids=none_as_unset(amino_acids),
             folder_id=none_as_unset(folder_id),
@@ -145,6 +147,7 @@ class AaSequenceService(BaseService):
     def list(
         self,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         amino_acids: Optional[str] = None,
         folder_id: Optional[str] = None,
@@ -177,6 +180,7 @@ class AaSequenceService(BaseService):
         def api_call(next_token: NextToken) -> Response[AaSequencesPaginatedList]:
             return self._aa_sequences_page(
                 modified_at=modified_at,
+                created_at=created_at,
                 name=name,
                 amino_acids=amino_acids,
                 folder_id=folder_id,

benchling_sdk/services/v2/{beta/v2_beta_audit_service.py → stable/audit_service.py}

@@ -1,5 +1,5 @@
-from benchling_api_client.v2.beta.api.audit import audit_log
-from benchling_api_client.v2.beta.models.audit_log_export import AuditLogExport
+from benchling_api_client.v2.stable.api.audit import audit_log
+from benchling_api_client.v2.stable.models.audit_log_export import AuditLogExport
 
 from benchling_sdk.helpers.decorators import api_method
 from benchling_sdk.helpers.task_helpers import TaskHelper
@@ -7,13 +7,13 @@ from benchling_sdk.models import ExportAuditLogAsyncTaskResponse
 from benchling_sdk.services.v2.base_service import BaseService
 
 
-class V2BetaAuditService(BaseService):
+class AuditService(BaseService):
     """
-    V2-Beta Audit Service.
+    Audit Service.
 
     Export audit log data for Benchling objects.
 
-    https://benchling.com/api/v2-beta/reference#/Audit
+    https://benchling.com/api/reference#/Audit
     """
 
     @api_method
@@ -36,7 +36,7 @@ class V2BetaAuditService(BaseService):
         Example of submitting an export request and then getting the download URL from
         the completed task:
 
-            task = benchling.v2.beta.audit.get_audit_log(object_id, export)
+            task = benchling.v2.stable.audit.get_audit_log(object_id, export)
             task_result = task.wait_for_response()
             url = task_result.download_url
 

benchling_sdk/services/v2/stable/box_service.py

@@ -71,6 +71,7 @@ class BoxService(BaseService):
         sort: Optional[ListBoxesSort] = None,
         schema_id: Optional[str] = None,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         name_includes: Optional[str] = None,
         ancestor_storage_id: Optional[str] = None,
@@ -99,6 +100,7 @@ class BoxService(BaseService):
             sort=none_as_unset(sort),
             schema_id=none_as_unset(schema_id),
             modified_at=none_as_unset(modified_at),
+            created_at=none_as_unset(created_at),
             name=none_as_unset(name),
             name_includes=none_as_unset(name_includes),
             ancestor_storage_id=none_as_unset(ancestor_storage_id),
@@ -133,6 +135,7 @@ class BoxService(BaseService):
         sort: Optional[Union[str, ListBoxesSort]] = None,
         schema_id: Optional[str] = None,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         name_includes: Optional[str] = None,
         ancestor_storage_id: Optional[str] = None,
@@ -169,6 +172,7 @@ class BoxService(BaseService):
                 sort=_translate_to_string_enum(ListBoxesSort, sort),
                 schema_id=schema_id,
                 modified_at=modified_at,
+                created_at=created_at,
                 name=name,
                 name_includes=name_includes,
                 ancestor_storage_id=ancestor_storage_id,

benchling_sdk/services/v2/stable/connect_service.py

@@ -0,0 +1,79 @@
+from typing import List
+
+from benchling_api_client.v2.stable.api.connect import (
+    convert_to_asm as api_client_convert_to_asm,
+    convert_to_csv as api_client_convert_to_csv,
+    list_allotropy_vendors as api_client_list_allotropy_vendors,
+)
+from benchling_api_client.v2.stable.models.convert_to_asm import ConvertToASM
+from benchling_api_client.v2.stable.models.convert_to_asm_response_200 import ConvertToASMResponse_200
+from benchling_api_client.v2.stable.models.convert_to_csv import ConvertToCSV
+from benchling_api_client.v2.stable.models.convert_to_csv_response_200_item import (
+    ConvertToCSVResponse_200Item,
+)
+
+from benchling_sdk.errors import raise_for_status
+from benchling_sdk.helpers.decorators import api_method
+from benchling_sdk.helpers.response_helpers import model_from_detailed
+from benchling_sdk.services.v2.base_service import BaseService
+
+
+class ConnectService(BaseService):
+    """
+    Connect.
+
+    Connect endpoints support Benchling Connect actions, like instrument data conversion.
+
+    See https://benchling.com/api/reference#/Connect
+    """
+
+    @api_method
+    def convert_to_asm(self, file_info: ConvertToASM) -> ConvertToASMResponse_200:
+        """
+        Convert an input blob or file containing instrument data to ASM (Allotrope Simple Model) JSON.
+
+        May provide the name of the instrument vendor (see /connect/list-allotropy-vendors) or the ID of a
+        connection associated with an instrument vendor.
+
+        See https://benchling.com/api/reference#/Connect/convertToASM
+        """
+        response = api_client_convert_to_asm.sync_detailed(client=self.client, json_body=file_info)
+        response = raise_for_status(response)
+        return model_from_detailed(response)
+
+    @api_method
+    def convert_to_csv(self, file_info: ConvertToCSV) -> List[ConvertToCSVResponse_200Item]:
+        """
+        Convert a blob or file containing ASM, JSON, or instrument data to CSV.
+
+        If the file is ASM JSON, specify either no transform type (in which case all transform types will be
+        returned), a matching transform type for the ASM schema, or a custom JSON mapper config.
+
+        If the file non-ASM JSON, must provide a JSON mapper config argument, which specifies how to map the
+        JSON to CSV. Reach out to Benchling Support for more information about how to create a JSON mapper
+        config.
+
+        If the file is an instrument file, must also specify an instrument vendor. The file will be converted
+        first to ASM JSON and then to CSV. Only the CSV output will be returned.
+
+        May provide an AutomationOutputFile with CSV transform arguments configured to read the transform type
+        or mapper config from.
+
+        May provide a connection ID associated with an instrument to read the vendor from.
+
+        See https://benchling.com/api/reference#/Connect/convertToCSV
+        """
+        response = api_client_convert_to_csv.sync_detailed(client=self.client, json_body=file_info)
+        response = raise_for_status(response)
+        return model_from_detailed(response)
+
+    @api_method
+    def list_allotropy_vendors(self) -> List[None]:
+        """
+        Return the list of available allotropy instrument vendor types.
+
+        See https://benchling.com/api/reference#/Connect/listAllotropyVendors
+        """
+        response = api_client_list_allotropy_vendors.sync_detailed(client=self.client)
+        response = raise_for_status(response)
+        return model_from_detailed(response)

benchling_sdk/services/v2/stable/container_service.py

@@ -104,6 +104,7 @@ class ContainerService(BaseService):
         sort: Optional[ListContainersSort] = None,
         schema_id: Optional[str] = None,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         name_includes: Optional[str] = None,
         ancestor_storage_id: Optional[str] = None,
@@ -132,6 +133,7 @@ class ContainerService(BaseService):
             sort=none_as_unset(sort),
             schema_id=none_as_unset(schema_id),
             modified_at=none_as_unset(modified_at),
+            created_at=none_as_unset(created_at),
             name=none_as_unset(name),
             name_includes=none_as_unset(name_includes),
             ancestor_storage_id=none_as_unset(ancestor_storage_id),
@@ -174,6 +176,7 @@ class ContainerService(BaseService):
         sort: Optional[Union[str, ListContainersSort]] = None,
         schema_id: Optional[str] = None,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         name_includes: Optional[str] = None,
         ancestor_storage_id: Optional[str] = None,
@@ -210,6 +213,7 @@ class ContainerService(BaseService):
                 sort=_translate_to_string_enum(ListContainersSort, sort),
                 schema_id=schema_id,
                 modified_at=modified_at,
+                created_at=created_at,
                 name=name,
                 name_includes=name_includes,
                 ancestor_storage_id=ancestor_storage_id,

benchling_sdk/services/v2/stable/custom_entity_service.py

@@ -77,6 +77,7 @@ class CustomEntityService(BaseService):
         self,
         schema_id: Optional[str] = None,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         name_includes: Optional[str] = None,
         folder_id: Optional[str] = None,
@@ -101,6 +102,7 @@ class CustomEntityService(BaseService):
             client=self.client,
             schema_id=none_as_unset(schema_id),
             modified_at=none_as_unset(modified_at),
+            created_at=none_as_unset(created_at),
             name=none_as_unset(name),
             name_includes=none_as_unset(name_includes),
             folder_id=none_as_unset(folder_id),
@@ -128,6 +130,7 @@ class CustomEntityService(BaseService):
         self,
         schema_id: Optional[str] = None,
         modified_at: Optional[str] = None,
+        created_at: Optional[str] = None,
         name: Optional[str] = None,
         name_includes: Optional[str] = None,
         folder_id: Optional[str] = None,
@@ -162,6 +165,7 @@ class CustomEntityService(BaseService):
             return self._custom_entities_page(
                 schema_id=schema_id,
                 modified_at=modified_at,
+                created_at=created_at,
                 name=name,
                 name_includes=name_includes,
                 folder_id=folder_id,

benchling_sdk/services/v2/stable/data_frame_service.py

@@ -0,0 +1,323 @@
+from datetime import datetime
+from io import BytesIO
+from pathlib import Path
+import tempfile
+from typing import Dict, List, Optional, Union
+
+from benchling_api_client.v2.stable.api.data_frames import create_data_frame, get_data_frame, patch_data_frame
+from benchling_api_client.v2.stable.models.data_frame import DataFrame
+from benchling_api_client.v2.stable.models.data_frame_create import DataFrameCreate
+from benchling_api_client.v2.stable.models.data_frame_create_manifest_manifest_item import (
+    DataFrameCreateManifestManifestItem,
+)
+from benchling_api_client.v2.stable.models.data_frame_update import DataFrameUpdate
+from benchling_api_client.v2.stable.models.data_frame_update_upload_status import DataFrameUpdateUploadStatus
+from benchling_api_client.v2.stable.models.file_status_upload_status import FileStatusUploadStatus
+from benchling_api_client.v2.types import Response
+import httpx
+
+from benchling_sdk.errors import DataFrameInProgressError, InvalidDataFrameError, raise_for_status
+from benchling_sdk.helpers.decorators import api_method
+from benchling_sdk.helpers.response_helpers import model_from_detailed
+from benchling_sdk.helpers.serialization_helpers import none_as_unset
+from benchling_sdk.helpers.task_helpers import TaskHelper
+from benchling_sdk.models import GetDataFrameRowDataFormat
+from benchling_sdk.services.v2.base_service import BaseService
+
+_DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME: float = 60.0
+
+
+class DataFrameService(BaseService):
+    """
+    Data Frames.
+
+    Data Frames are Benchling objects that represent tabular data with typed columns and rows of data.
+
+    See https://benchling.com/api/v2/reference#/Data%20Frames
+    """
+
+    @api_method
+    def get_by_id(
+        self,
+        data_frame_id: str,
+        row_data_format: Optional[GetDataFrameRowDataFormat] = None,
+        returning: Optional[str] = None,
+    ) -> DataFrame:
+        """
+        Get a data frame and URLs to download its data.
+
+        See https://benchling.com/api/v2/reference#/Data%20Frames/getDataFrame
+        """
+        response = get_data_frame.sync_detailed(
+            client=self.client,
+            data_frame_id=data_frame_id,
+            returning=none_as_unset(returning),
+            row_data_format=none_as_unset(row_data_format),
+        )
+        return model_from_detailed(response)
+
+    @api_method
+    def create(self, data_frame: DataFrameCreate) -> DataFrame:
+        """
+        Create a data frame.
+
+        See https://benchling.com/api/v2/reference#/Data%20Frames/createDataFrame
+        """
+        response = create_data_frame.sync_detailed(client=self.client, json_body=data_frame)
+        return model_from_detailed(response)
+
+    @api_method
+    def update(self, data_frame_id: str, data_frame: DataFrameUpdate) -> TaskHelper[DataFrame]:
+        """
+        Update a data frame.
+
+        See https://benchling.com/api/v2/reference#/Data%20Frames/patchDataFrame
+        """
+        response = patch_data_frame.sync_detailed(
+            client=self.client, data_frame_id=data_frame_id, json_body=data_frame
+        )
+        return self._task_helper_from_response(response, DataFrame)
+
+    def upload_bytes(
+        self,
+        url: str,
+        input_bytes: Union[BytesIO, bytes],
+        timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME,
+    ) -> None:
+        """
+        Upload bytes to an existing data frame.
+
+        :param url: The url provided by Benchling for uploading to the data frame
+        :param input_bytes: Data to upload as bytes or BytesIO
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        """
+        # Use a completely different client instead of our configured self.client.httpx_client
+        # Amazon will reject clients sending other headers besides the ones it expects
+        httpx_response = httpx.put(
+            url, headers=_aws_url_headers(), content=input_bytes, timeout=timeout_seconds
+        )
+        response = _response_from_httpx(httpx_response)
+        raise_for_status(response)
+
+    def upload_file(
+        self, url: str, file: Path, timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME
+    ) -> None:
+        """
+        Upload a file to an existing data frame.
+
+        :param url: The url provided by Benchling for uploading to the data frame
+        :param file: A valid Path to an existing file containing the data to upload
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        """
+        if file.is_dir():
+            raise IsADirectoryError(
+                f"Cannot write data frame from directory '{file}', specify a file instead"
+            )
+        # Use a completely different client instead of our configured self.client.httpx_client
+        # Amazon will reject clients sending other headers besides the ones it expects
+        files = {"file": open(file, "rb")}
+        httpx_response = httpx.put(url, headers=_aws_url_headers(), files=files, timeout=timeout_seconds)
+        response = _response_from_httpx(httpx_response)
+        raise_for_status(response)
+
+    @api_method
+    def create_from_bytes(
+        self,
+        data_frame: DataFrameCreate,
+        input_bytes: Union[BytesIO, bytes],
+        timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME,
+    ) -> TaskHelper[DataFrame]:
+        """
+        Create a data frame from bytes or BytesIO data.
+
+        :param data_frame: The DataFrameCreate specification for the data. This must be provided, as it cannot be inferred from file names.
+        :param input_bytes: Data to upload as bytes or BytesIO
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        :return: A TaskHelper that can be polled to know when the data frame has completed processing
+        :rtype: TaskHelper[DataFrame]
+        """
+        # This is a current limit of the DataFrame API. We may need additional methods in the future
+        # to allow multi upload
+        if not data_frame.manifest:
+            raise InvalidDataFrameError("The data frame manifest must contain exactly 1 item")
+        elif len(data_frame.manifest) != 1:
+            raise InvalidDataFrameError(
+                f"The data frame manifest contains {len(data_frame.manifest)} items. It must contain exactly 1"
+            )
+        created_data_frame = self.create(data_frame)
+        manifest_item = created_data_frame.manifest[0]
+
+        # This would be unexpected and probably an error from the API return. Likely not a user error. This check appeases MyPy.
+        if manifest_item.url is None:
+            raise InvalidDataFrameError(
+                f"The data frame manifest URL is None. The data frame {created_data_frame.id} is not available for data upload."
+            )
+        self.upload_bytes(url=manifest_item.url, input_bytes=input_bytes, timeout_seconds=timeout_seconds)
+        data_frame_update = DataFrameUpdate(upload_status=DataFrameUpdateUploadStatus.IN_PROGRESS)
+        return self.update(data_frame_id=created_data_frame.id, data_frame=data_frame_update)
+
+    @api_method
+    def create_from_file(
+        self,
+        file: Path,
+        data_frame: Optional[DataFrameCreate] = None,
+        timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME,
+    ) -> TaskHelper[DataFrame]:
+        """
+        Create a data frame from file data.
+
+        :param file: A valid Path to an existing file containing the data to upload
+        :param data_frame: The DataFrameCreate specification for the data. If not provided, it will be inferred from the file name
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        :return: A TaskHelper that can be polled to know when the data frame has completed processing
+        :rtype: TaskHelper[DataFrame]
+        """
+        if file.is_dir():
+            raise IsADirectoryError(
+                f"Cannot write data frame from directory '{file}', specify a file instead"
+            )
+        with open(file, "rb") as file_handle:
+            input_bytes = file_handle.read()
+        if not data_frame:
+            data_frame = DataFrameCreate(
+                name=f"{datetime.now()} {file.name}",
+                manifest=[DataFrameCreateManifestManifestItem(file_name=file.name)],
+            )
+        return self.create_from_bytes(
+            data_frame=data_frame, input_bytes=input_bytes, timeout_seconds=timeout_seconds
+        )
+
+    def download_data_frame_bytes(
+        self, data_frame: DataFrame, timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME
+    ) -> List[BytesIO]:
+        """
+        Download data frame data to bytes.
+
+        :param data_frame: The data frame to download
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        :return: An ordered list of BytesIO streams corresponding to a manifest item in the data frame
+        :rtype: List[BytesIO]
+        """
+        if data_frame.upload_status != FileStatusUploadStatus.SUCCEEDED:
+            raise DataFrameInProgressError(
+                f"The data frame data cannot be downloaded until the status is {FileStatusUploadStatus.SUCCEEDED}. "
+                f"The status of data frame {data_frame.id} is {data_frame.upload_status}"
+            )
+        data_frame_bytes = []
+        for manifest_item in data_frame.manifest:
+            # This should be present based on the status check above. Assertion satisfies MyPy
+            assert (
+                manifest_item.url is not None
+            ), f"Unable to download data frame {data_frame.id}, URL was empty"
+            with httpx.stream("GET", manifest_item.url, timeout=timeout_seconds) as download_stream:
+                target_bytes = BytesIO()
+                for chunk in download_stream.iter_bytes():
+                    target_bytes.write(chunk)
+                target_bytes.seek(0)
+                data_frame_bytes.append(target_bytes)
+        return data_frame_bytes
+
+    def download_data_frame_files(
+        self,
+        data_frame: DataFrame,
+        destination_path: Optional[Path] = None,
+        timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME,
+    ) -> List[Path]:
+        """
+        Download data frame data to files.
+
+        :param data_frame: The data frame to download
+        :param destination_path: A target directory to place the files. File names will be created based on the manifest item file names.
+            If not specified, a temp directory will be created. The caller is responsible for deleting this directory.
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        :return: An ordered list of downloaded file paths corresponding to a manifest item in the data frame
+        :rtype: List[Path]
+        """
+        data_frame_files = []
+        if not destination_path:
+            destination_path = Path(tempfile.mkdtemp())
+        elif destination_path.is_file():
+            raise NotADirectoryError(
+                f"The destination path '{destination_path}' is a file, specify a directory instead"
+            )
+        elif not destination_path.exists():
+            raise NotADirectoryError(f"The destination path '{destination_path}' does not exist")
+        if data_frame.upload_status != FileStatusUploadStatus.SUCCEEDED:
+            raise DataFrameInProgressError(
+                f"The data frame data cannot be downloaded until the status is {FileStatusUploadStatus.SUCCEEDED}. "
+                f"The status of data frame {data_frame.id} is {data_frame.upload_status}"
+            )
+        for manifest_item in data_frame.manifest:
+            target_path = destination_path / manifest_item.file_name
+            data_frame_files.append(target_path)
+            # This should be present based on the status check above. Assertion satisfies MyPy
+            assert (
+                manifest_item.url is not None
+            ), f"Unable to download data frame {data_frame.id}, URL was empty"
+            with open(target_path, "wb") as data_frame_handle:
+                with httpx.stream("GET", manifest_item.url, timeout=timeout_seconds) as download_stream:
+                    for chunk in download_stream.iter_bytes():
+                        data_frame_handle.write(chunk)
+        return data_frame_files
+
+    @api_method
+    def download_data_frame_bytes_by_id(
+        self, data_frame_id: str, timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME
+    ) -> List[BytesIO]:
+        """
+        Download data frame data to files by data_frame_id.
+
+        Fetches the data frame first, then downloads the files.
+
+        :param data_frame_id: The id of the data frame to download
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        :return: An ordered list of BytesIO streams corresponding to a manifest item in the data frame
+        :rtype: List[BytesIO]
+        """
+        data_frame = self.get_by_id(data_frame_id=data_frame_id)
+        return self.download_data_frame_bytes(data_frame=data_frame, timeout_seconds=timeout_seconds)
+
+    @api_method
+    def download_data_frame_files_by_id(
+        self,
+        data_frame_id: str,
+        destination_path: Optional[Path] = None,
+        timeout_seconds: float = _DEFAULT_HTTP_TIMEOUT_UPLOAD_DATA_FRAME,
+    ) -> List[Path]:
+        """
+        Download data frame data to files by data_frame_id.
+
+        Fetches the data frame first, then downloads the files.
+
+        :param data_frame_id: The id of the data frame to download
+        :param destination_path: A target directory to place the files. File names will be created based on the manifest item file names.
+            If not specified, a temp directory will be created. The caller is responsible for deleting this directory.
+        :param timeout_seconds: Extends the normal HTTP timeout settings since DataFrame uploads can be large
+            Use this to extend even further if streams are very large
+        :return: An ordered list of downloaded file paths corresponding to a manifest item in the data frame
+        :rtype: List[Path]
+        """
+        data_frame = self.get_by_id(data_frame_id=data_frame_id)
+        return self.download_data_frame_files(
+            data_frame=data_frame, destination_path=destination_path, timeout_seconds=timeout_seconds
+        )
+
+
+def _aws_url_headers() -> Dict[str, str]:
+    return {"x-amz-server-side-encryption": "AES256"}
+
+
+def _response_from_httpx(httpx_response: httpx.Response) -> Response:
+    return Response(
+        status_code=httpx_response.status_code,
+        content=httpx_response.content,
+        headers=httpx_response.headers,
+        parsed=None,
+    )