benchling-sdk 1.21.1__py3-none-any.whl → 1.22.0__py3-none-any.whl

benchling_sdk/services/v2/stable/team_service.py

@@ -139,7 +139,8 @@ class TeamService(BaseService):
 
     @api_method
     def create(self, team: TeamCreate) -> Team:
-        """Create team.
+        """
+        Create team.
 
         See https://benchling.com/api/reference#/Teams/createTeam
         """
@@ -148,7 +149,8 @@ class TeamService(BaseService):
 
     @api_method
     def update(self, team_id: str, team: TeamUpdate) -> Team:
-        """Update team.
+        """
+        Update team.
 
         See https://benchling.com/api/reference#/Teams/updateTeam
         """
@@ -179,7 +181,8 @@ class TeamService(BaseService):
         role: Optional[str] = None,
         page_size: Optional[int] = None,
     ) -> PageIterator[MembershipsPaginatedList]:
-        """Return all team memberships in the given team.
+        """
+        Return all team memberships in the given team.
 
         See https://benchling.com/api/reference#/Teams/listTeamMemberships
         """
@@ -191,7 +194,8 @@ class TeamService(BaseService):
 
     @api_method
     def get_membership(self, team_id: str, user_id: str) -> Membership:
-        """Get team membership.
+        """
+        Get team membership.
 
         See https://benchling.com/api/reference#/Teams/getTeamMembership
         """
@@ -200,7 +204,8 @@ class TeamService(BaseService):
 
     @api_method
     def create_membership(self, team_id: str, membership: MembershipCreate) -> Membership:
-        """Create team membership for the given user, role, and team.
+        """
+        Create team membership for the given user, role, and team.
 
         See https://benchling.com/api/reference#/Teams/createTeamMembership
         """
@@ -213,7 +218,8 @@ class TeamService(BaseService):
 
     @api_method
     def update_membership(self, team_id: str, user_id: str, membership: MembershipUpdate) -> Membership:
-        """Update a single team membership.
+        """
+        Update a single team membership.
 
         See https://benchling.com/api/reference#/Teams/updateTeamMembership
         """
@@ -227,7 +233,8 @@ class TeamService(BaseService):
 
     @api_method
     def delete_membership(self, team_id: str, user_id: str) -> None:
-        """Delete a single team membership.
+        """
+        Delete a single team membership.
 
         See https://benchling.com/api/reference#/Teams/deleteTeamMembership
         """

benchling_sdk/services/v2/stable/test_order_service.py

@@ -0,0 +1,145 @@
+from typing import Iterable, List, Optional
+
+from benchling_api_client.v2.stable.api.test_orders import (
+    bulk_update_test_orders,
+    list_test_orders,
+    update_test_order,
+)
+from benchling_api_client.v2.stable.models.async_task_link import AsyncTaskLink
+from benchling_api_client.v2.stable.models.list_test_orders_sort import ListTestOrdersSort
+from benchling_api_client.v2.stable.models.test_order import TestOrder
+from benchling_api_client.v2.stable.models.test_order_bulk_update import TestOrderBulkUpdate
+from benchling_api_client.v2.stable.models.test_order_status import TestOrderStatus
+from benchling_api_client.v2.stable.models.test_order_update import TestOrderUpdate
+from benchling_api_client.v2.stable.models.test_orders_bulk_update_request import TestOrdersBulkUpdateRequest
+from benchling_api_client.v2.stable.models.test_orders_paginated_list import TestOrdersPaginatedList
+from benchling_api_client.v2.types import Response
+
+from benchling_sdk.errors import raise_for_status
+from benchling_sdk.helpers.decorators import api_method
+from benchling_sdk.helpers.pagination_helpers import NextToken, PageIterator
+from benchling_sdk.helpers.response_helpers import model_from_detailed
+from benchling_sdk.helpers.serialization_helpers import none_as_unset
+from benchling_sdk.services.v2.base_service import BaseService
+
+
+class TestOrderService(BaseService):
+    """
+    Test Orders.
+
+    Test orders enable users to order tests for specific sample/container combinations that will be fulfilled in assays.
+
+    See https://benchling.com/api/reference?availability=la#/Test%20Orders/
+    """
+
+    @api_method
+    def bulk_update(self, test_orders: Iterable[TestOrderBulkUpdate]) -> AsyncTaskLink:
+        """
+        Bulk update Test Orders.
+
+        See https://benchling.com/api/reference?availability=la#/Test%20Orders/bulkUpdateTestOrders
+        """
+        body = TestOrdersBulkUpdateRequest(list(test_orders))
+        response = bulk_update_test_orders.sync_detailed(client=self.client, json_body=body)
+        return model_from_detailed(response)
+
+    @api_method
+    def _test_orders_page(
+        self,
+        page_size: Optional[int] = 50,
+        next_token: Optional[str] = None,
+        sort: Optional[ListTestOrdersSort] = ListTestOrdersSort.MODIFIEDATDESC,
+        created_atlt: Optional[str] = None,
+        created_atgt: Optional[str] = None,
+        created_atlte: Optional[str] = None,
+        created_atgte: Optional[str] = None,
+        modified_atlt: Optional[str] = None,
+        modified_atgt: Optional[str] = None,
+        modified_atlte: Optional[str] = None,
+        modified_atgte: Optional[str] = None,
+        ids: Optional[str] = None,
+        container_idsany_of: Optional[str] = None,
+        sample_idsany_of: Optional[str] = None,
+        status: Optional[TestOrderStatus] = None,
+    ) -> Response[TestOrdersPaginatedList]:
+        response = list_test_orders.sync_detailed(
+            client=self.client,
+            page_size=none_as_unset(page_size),
+            next_token=none_as_unset(next_token),
+            sort=none_as_unset(sort),
+            created_atlt=none_as_unset(created_atlt),
+            created_atgt=none_as_unset(created_atgt),
+            created_atlte=none_as_unset(created_atlte),
+            created_atgte=none_as_unset(created_atgte),
+            modified_atlt=none_as_unset(modified_atlt),
+            modified_atgt=none_as_unset(modified_atgt),
+            modified_atlte=none_as_unset(modified_atlte),
+            modified_atgte=none_as_unset(modified_atgte),
+            ids=none_as_unset(ids),
+            container_idsany_of=none_as_unset(container_idsany_of),
+            sample_idsany_of=none_as_unset(sample_idsany_of),
+            status=none_as_unset(status),
+        )
+        raise_for_status(response)
+        return response  # type: ignore
+
+    def list(
+        self,
+        *,
+        page_size: Optional[int] = 50,
+        next_token: Optional[str] = None,
+        sort: Optional[ListTestOrdersSort] = ListTestOrdersSort.MODIFIEDATDESC,
+        created_atlt: Optional[str] = None,
+        created_atgt: Optional[str] = None,
+        created_atlte: Optional[str] = None,
+        created_atgte: Optional[str] = None,
+        modified_atlt: Optional[str] = None,
+        modified_atgt: Optional[str] = None,
+        modified_atlte: Optional[str] = None,
+        modified_atgte: Optional[str] = None,
+        ids: Optional[str] = None,
+        container_idsany_of: Optional[str] = None,
+        sample_idsany_of: Optional[str] = None,
+        status: Optional[TestOrderStatus] = None,
+    ) -> PageIterator[TestOrder]:
+        """
+        List Test Orders.
+
+        See https://benchling.com/api/reference?availability=la#/Test%20Orders/listTestOrders
+        """
+
+        def api_call(next_token: NextToken) -> Response[TestOrdersPaginatedList]:
+            return self._test_orders_page(
+                page_size=page_size,
+                next_token=next_token,
+                sort=sort,
+                created_atlt=created_atlt,
+                created_atgt=created_atgt,
+                created_atlte=created_atlte,
+                created_atgte=created_atgte,
+                modified_atlt=modified_atlt,
+                modified_atgt=modified_atgt,
+                modified_atlte=modified_atlte,
+                modified_atgte=modified_atgte,
+                ids=ids,
+                container_idsany_of=container_idsany_of,
+                sample_idsany_of=sample_idsany_of,
+                status=status,
+            )
+
+        def results_extractor(body: TestOrdersPaginatedList) -> Optional[List[TestOrder]]:
+            return body.test_orders
+
+        return PageIterator(api_call, results_extractor)
+
+    @api_method
+    def update(self, test_order_id: str, test_order: TestOrderUpdate) -> TestOrder:
+        """
+        Update a TestOrder.
+
+        See https://benchling.com/api/reference?availability=la#/Test%20Orders/updateTestOrder
+        """
+        response = update_test_order.sync_detailed(
+            client=self.client, test_order_id=test_order_id, json_body=test_order
+        )
+        return model_from_detailed(response)

benchling_sdk/services/v2/v2_alpha_service.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, TYPE_CHECKING
 
 from benchling_api_client.v2.stable.client import Client
 
@@ -26,7 +26,7 @@ class V2AlphaService(BaseService):
 
     _alpha_client: Client
 
-    def __init__(self, client: Client, retry_strategy: RetryStrategy = RetryStrategy()):
+    def __init__(self, client: Client, retry_strategy: Optional[RetryStrategy] = None):
         """
         Initialize a v2-alpha service.
 

benchling_sdk/services/v2/v2_beta_service.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, TYPE_CHECKING
 
 from benchling_api_client.v2.stable.client import Client
 
@@ -14,7 +14,6 @@ if TYPE_CHECKING:
     from benchling_sdk.services.v2.beta.v2_beta_analysis_service import V2BetaAnalysisService
     from benchling_sdk.services.v2.beta.v2_beta_app_definition_service import V2BetaAppDefinitionService
     from benchling_sdk.services.v2.beta.v2_beta_app_service import V2BetaAppService
-    from benchling_sdk.services.v2.beta.v2_beta_audit_service import V2BetaAuditService
     from benchling_sdk.services.v2.beta.v2_beta_collaboration_service import V2BetaCollaborationService
     from benchling_sdk.services.v2.beta.v2_beta_entry_service import V2BetaEntryService
     from benchling_sdk.services.v2.beta.v2_beta_folder_service import V2BetaFolderService
@@ -33,7 +32,7 @@ class V2BetaService(BaseService):
 
     _beta_client: Client
 
-    def __init__(self, client: Client, retry_strategy: RetryStrategy = RetryStrategy()):
+    def __init__(self, client: Client, retry_strategy: Optional[RetryStrategy] = None):
         """
         Initialize a v2-beta service.
 
@@ -82,19 +81,6 @@ class V2BetaService(BaseService):
 
         return self._create_service(V2BetaAppDefinitionService)
 
-    @cached_property
-    def audit(self) -> V2BetaAuditService:
-        """
-        V2-Beta Audit.
-
-        Export audit log data for Benchling objects.
-
-        https://benchling.com/api/v2-beta/reference#/Audit
-        """
-        from .beta.v2_beta_audit_service import V2BetaAuditService
-
-        return self._create_service(V2BetaAuditService)
-
     @cached_property
     def collaborations(self) -> V2BetaCollaborationService:
         """

benchling_sdk/services/v2/v2_stable_service.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, TYPE_CHECKING
 
 from benchling_api_client.v2.stable.client import Client
 
@@ -14,12 +14,16 @@ if TYPE_CHECKING:
     from benchling_sdk.services.v2.stable.app_service import AppService
     from benchling_sdk.services.v2.stable.assay_result_service import AssayResultService
     from benchling_sdk.services.v2.stable.assay_run_service import AssayRunService
+    from benchling_sdk.services.v2.stable.audit_service import AuditService
     from benchling_sdk.services.v2.stable.blob_service import BlobService
     from benchling_sdk.services.v2.stable.box_service import BoxService
     from benchling_sdk.services.v2.stable.codon_usage_table_service import CodonUsageTableService
+    from benchling_sdk.services.v2.stable.connect_service import ConnectService
     from benchling_sdk.services.v2.stable.container_service import ContainerService
     from benchling_sdk.services.v2.stable.custom_entity_service import CustomEntityService
     from benchling_sdk.services.v2.stable.custom_notation_service import CustomNotationService
+    from benchling_sdk.services.v2.stable.data_frame_service import DataFrameService
+    from benchling_sdk.services.v2.stable.dataset_service import DatasetService
     from benchling_sdk.services.v2.stable.dna_alignments_service import DnaAlignmentsService
     from benchling_sdk.services.v2.stable.dna_oligo_service import DnaOligoService
     from benchling_sdk.services.v2.stable.dna_sequence_service import DnaSequenceService
@@ -30,11 +34,13 @@ if TYPE_CHECKING:
     from benchling_sdk.services.v2.stable.event_service import EventService
     from benchling_sdk.services.v2.stable.export_service import ExportService
     from benchling_sdk.services.v2.stable.feature_library_service import FeatureLibraryService
+    from benchling_sdk.services.v2.stable.file_service import FileService
     from benchling_sdk.services.v2.stable.folder_service import FolderService
     from benchling_sdk.services.v2.stable.instrument_query_service import InstrumentQueryService
     from benchling_sdk.services.v2.stable.inventory_service import InventoryService
     from benchling_sdk.services.v2.stable.lab_automation_service import LabAutomationService
     from benchling_sdk.services.v2.stable.label_template_service import LabelTemplateService
+    from benchling_sdk.services.v2.stable.legacy_request_service import LegacyRequestService
     from benchling_sdk.services.v2.stable.location_service import LocationService
     from benchling_sdk.services.v2.stable.mixture_service import MixtureService
     from benchling_sdk.services.v2.stable.molecule_service import MoleculeService
@@ -46,12 +52,12 @@ if TYPE_CHECKING:
     from benchling_sdk.services.v2.stable.printer_service import PrinterService
     from benchling_sdk.services.v2.stable.project_service import ProjectService
     from benchling_sdk.services.v2.stable.registry_service import RegistryService
-    from benchling_sdk.services.v2.stable.request_service import RequestService
     from benchling_sdk.services.v2.stable.rna_oligo_service import RnaOligoService
     from benchling_sdk.services.v2.stable.rna_sequence_service import RnaSequenceService
     from benchling_sdk.services.v2.stable.schema_service import SchemaService
     from benchling_sdk.services.v2.stable.task_service import TaskService
     from benchling_sdk.services.v2.stable.team_service import TeamService
+    from benchling_sdk.services.v2.stable.test_order_service import TestOrderService
     from benchling_sdk.services.v2.stable.user_service import UserService
     from benchling_sdk.services.v2.stable.warehouse_service import WarehouseService
     from benchling_sdk.services.v2.stable.workflow_flowchart_config_version_service import (
@@ -70,7 +76,7 @@ class V2StableService(BaseService):
     Namespace containing support for the V2 stable endpoints of the Benchling API.
     """
 
-    def __init__(self, client: Client, retry_strategy: RetryStrategy = RetryStrategy()):
+    def __init__(self, client: Client, retry_strategy: Optional[RetryStrategy] = None):
         """
         Initialize a service.
 
@@ -117,7 +123,7 @@ class V2StableService(BaseService):
 
         See https://benchling.com/api/reference#/Apps
         and https://docs.benchling.com/docs/getting-started-benchling-apps
-        """
+        """  # noqa:RUF002  # Ruff gets confused by a trailing apostrophe with a plural noun
         from .stable.app_service import AppService
 
         return self._create_service(AppService)
@@ -149,6 +155,19 @@ class V2StableService(BaseService):
 
         return self._create_service(AssayRunService)
 
+    @cached_property
+    def audit(self) -> AuditService:
+        """
+        Audits.
+
+        Export audit log data for Benchling objects.
+
+        https://benchling.com/api/reference#/Audit
+        """
+        from .stable.audit_service import AuditService
+
+        return self._create_service(AuditService)
+
     @cached_property
     def blobs(self) -> BlobService:
         """
@@ -197,6 +216,19 @@ class V2StableService(BaseService):
 
         return self._create_service(CodonUsageTableService)
 
+    @cached_property
+    def connect(self) -> ConnectService:
+        """
+        Connect.
+
+        Connect endpoints support Benchling Connect actions, like instrument data conversion.
+
+        See https://benchling.com/api/reference#/Connect
+        """
+        from .stable.connect_service import ConnectService
+
+        return self._create_service(ConnectService)
+
     @cached_property
     def containers(self) -> ContainerService:
         """
@@ -245,6 +277,33 @@ class V2StableService(BaseService):
 
         return self._create_service(CustomNotationService)
 
+    @cached_property
+    def data_frames(self) -> DataFrameService:
+        """
+        DataFrames.
+
+        DataFrames are Benchling objects that represent tabular data with typed columns and rows of data.
+
+        See https://benchling.com/api/v2/reference#/Data%20Frames
+        """
+        from .stable.data_frame_service import DataFrameService
+
+        return self._create_service(DataFrameService)
+
+    @cached_property
+    def datasets(self) -> DatasetService:
+        """
+        Datasets.
+
+        Datasets are Benchling objects that represent tabular data with typed columns and rows of data. Unlike
+        Data Frames, Datasets are located in folders and can be searched in the UI.
+
+        See https://benchling.com/api/v2/reference#/Datasets
+        """
+        from .stable.dataset_service import DatasetService
+
+        return self._create_service(DatasetService)
+
     @cached_property
     def dna_alignments(self) -> DnaAlignmentsService:
         """
@@ -395,6 +454,21 @@ class V2StableService(BaseService):
 
         return self._create_service(FeatureLibraryService)
 
+    @cached_property
+    def files(self) -> FileService:
+        """
+        Files.
+
+        Files are Benchling objects that represent files and their metadata. Compared to Blobs, which are used
+        by most Benchling products for attachments, Files are primarily used in the Analysis and Connect
+        product.
+
+        See https://benchling.com/api/v2/reference#/Files
+        """
+        from .stable.file_service import FileService
+
+        return self._create_service(FileService)
+
     @cached_property
     def folders(self) -> FolderService:
         """
@@ -461,6 +535,19 @@ class V2StableService(BaseService):
 
         return self._create_service(LabelTemplateService)
 
+    @cached_property
+    def legacy_requests(self) -> LegacyRequestService:
+        """
+        Legacy Requests.
+
+        Legacy Requests allow scientists and teams to collaborate around experimental assays and workflows.
+
+        See https://benchling.com/api/reference#/Legacy%20Requests
+        """
+        from .stable.legacy_request_service import LegacyRequestService
+
+        return self._create_service(LegacyRequestService)
+
     @cached_property
     def locations(self) -> LocationService:
         """
@@ -618,19 +705,6 @@ class V2StableService(BaseService):
 
         return self._create_service(RegistryService)
 
-    @cached_property
-    def requests(self) -> RequestService:
-        """
-        Requests.
-
-        Requests allow scientists and teams to collaborate around experimental assays and workflows.
-
-        See https://benchling.com/api/reference#/Requests
-        """
-        from .stable.request_service import RequestService
-
-        return self._create_service(RequestService)
-
     @cached_property
     def rna_oligos(self) -> RnaOligoService:
         """
@@ -692,6 +766,19 @@ class V2StableService(BaseService):
 
         return self._create_service(TeamService)
 
+    @cached_property
+    def test_orders(self) -> TestOrderService:
+        """
+        Test Orders.
+
+        Test orders enable users to order tests for specific sample/container combinations that will be fulfilled in assays.
+
+        See https://benchling.com/api/reference?availability=la#/Test%20Orders/
+        """
+        from .stable.test_order_service import TestOrderService
+
+        return self._create_service(TestOrderService)
+
     @cached_property
     def users(self) -> UserService:
         """

benchling_sdk/services/v2_service.py

@@ -25,7 +25,7 @@ class V2Service(BaseService):
     _v2_alpha_service: Optional[V2AlphaService]
     _v2_beta_service: Optional[V2BetaService]
 
-    def __init__(self, client: Client, retry_strategy: RetryStrategy = RetryStrategy()):
+    def __init__(self, client: Client, retry_strategy: Optional[RetryStrategy] = None):
         """
         Initialize a service.
 

{benchling_sdk-1.21.1.dist-info → benchling_sdk-1.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: benchling-sdk
-Version: 1.21.1
+Version: 1.22.0
 Summary: SDK for interacting with the Benchling Platform.
 License: Apache-2.0
 Author: Benchling Support
@@ -16,7 +16,7 @@ Provides-Extra: python-jose
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: attrs (>=20.1.0)
 Requires-Dist: backoff (>=1.10.0,<3)
-Requires-Dist: benchling-api-client (==2.0.342)
+Requires-Dist: benchling-api-client (==2.0.390)
 Requires-Dist: certifi (>=2022.12.7)
 Requires-Dist: cryptography (>=42.0.0) ; extra == "cryptography"
 Requires-Dist: dataclasses-json (>=0.5.2,<0.6.0)