synapseclient 4.1.1__tar.gz → 4.3.0__tar.gz

{synapseclient-4.1.1/synapseclient.egg-info → synapseclient-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapseclient
-Version: 4.1.1
+Version: 4.3.0
 Summary: A client for Synapse, a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate.
 Home-page: https://www.synapse.org
 Author: The Synapse Engineering Team
@@ -36,11 +36,17 @@ Requires-Dist: opentelemetry-api~=1.21.0
 Requires-Dist: opentelemetry-sdk~=1.21.0
 Requires-Dist: opentelemetry-exporter-otlp-proto-http~=1.21.0
 Requires-Dist: nest-asyncio~=1.6.0
+Requires-Dist: asyncio-atexit~=1.0.1
+Requires-Dist: httpx~=0.27.0
+Requires-Dist: tqdm<5.0,>=4.66.2
+Requires-Dist: loky~=3.0.0
+Requires-Dist: async-lru~=2.0.4
+Requires-Dist: psutil~=5.9.8
 Provides-Extra: dev
-Requires-Dist: pytest<7.0,>=6.0.0; extra == "dev"
+Requires-Dist: pytest<8.0,>=7.0.0; extra == "dev"
 Requires-Dist: pytest-mock<4.0,>=3.0; extra == "dev"
 Requires-Dist: pytest-socket~=0.6.0; extra == "dev"
-Requires-Dist: pytest-asyncio~=0.19; extra == "dev"
+Requires-Dist: pytest-asyncio<1.0,>=0.23.6; extra == "dev"
 Requires-Dist: flake8<4.0,>=3.7.0; extra == "dev"
 Requires-Dist: pytest-xdist[psutil]<3.0.0,>=2.2; extra == "dev"
 Requires-Dist: pytest-rerunfailures~=12.0; extra == "dev"
@@ -48,16 +54,18 @@ Requires-Dist: func-timeout~=4.3; extra == "dev"
 Requires-Dist: pytest-cov~=4.1.0; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pandas<3.0,>=1.5; extra == "dev"
 Provides-Extra: tests
-Requires-Dist: pytest<7.0,>=6.0.0; extra == "tests"
+Requires-Dist: pytest<8.0,>=7.0.0; extra == "tests"
 Requires-Dist: pytest-mock<4.0,>=3.0; extra == "tests"
 Requires-Dist: pytest-socket~=0.6.0; extra == "tests"
-Requires-Dist: pytest-asyncio~=0.19; extra == "tests"
+Requires-Dist: pytest-asyncio<1.0,>=0.23.6; extra == "tests"
 Requires-Dist: flake8<4.0,>=3.7.0; extra == "tests"
 Requires-Dist: pytest-xdist[psutil]<3.0.0,>=2.2; extra == "tests"
 Requires-Dist: pytest-rerunfailures~=12.0; extra == "tests"
 Requires-Dist: func-timeout~=4.3; extra == "tests"
 Requires-Dist: pytest-cov~=4.1.0; extra == "tests"
+Requires-Dist: pandas<3.0,>=1.5; extra == "tests"
 Provides-Extra: pandas
 Requires-Dist: pandas<3.0,>=1.5; extra == "pandas"
 Provides-Extra: pysftp
@@ -119,16 +127,24 @@ The Python Synapse client has been tested on 3.8, 3.9, 3.10 and 3.11 on Mac OS X
 
 The [Python Synapse Client is on PyPI](https://pypi.python.org/pypi/synapseclient) and can be installed with pip:
 
-    (sudo) pip install synapseclient[pandas,pysftp]
+    # Here are a few ways to install the client. Choose the one that fits your use-case
+    # sudo may optionally be needed depending on your setup
+
+    pip install --upgrade synapseclient
+    pip install --upgrade "synapseclient[pandas]"
+    pip install --upgrade "synapseclient[pandas, pysftp, boto3]"
 
 ...or to upgrade an existing installation of the Synapse client:
 
-    (sudo) pip install --upgrade synapseclient
+    # sudo may optionally be needed depending on your setup
+    pip install --upgrade synapseclient
 
-The dependencies on `pandas` and `pysftp` are optional. Synapse [Tables](https://python-docs.synapse.org/reference/tables/) integrate
+The dependencies on `pandas`, `pysftp`, and `boto3` are optional. Synapse
+[Tables](https://python-docs.synapse.org/reference/tables/) integrate
 with [Pandas](http://pandas.pydata.org/). The library `pysftp` is required for users of
-[SFTP](https://python-docs.synapse.org/guides/data_storage/#sftp) file storage. Both libraries require native code
-to be compiled or installed separately from prebuilt binaries.
+[SFTP](https://python-docs.synapse.org/guides/data_storage/#sftp) file storage. All
+libraries require native code to be compiled or installed separately from prebuilt
+binaries.
 
 ### Install from source
 
@@ -138,6 +154,13 @@ Clone the [source code repository](https://github.com/Sage-Bionetworks/synapsePy
     cd synapsePythonClient
     pip install .
 
+Alternatively, you can use pip to install a particular branch, commit, or other git reference:
+
+    pip install git+https://github.com/Sage-Bionetworks/synapsePythonClient@master
+
+or
+
+    pip install git+https://github.com/Sage-Bionetworks/synapsePythonClient@my-commit-hash
 
 Command line usage
 ------------------

{synapseclient-4.1.1 → synapseclient-4.3.0}/README.md

@@ -44,16 +44,24 @@ The Python Synapse client has been tested on 3.8, 3.9, 3.10 and 3.11 on Mac OS X
 
 The [Python Synapse Client is on PyPI](https://pypi.python.org/pypi/synapseclient) and can be installed with pip:
 
-    (sudo) pip install synapseclient[pandas,pysftp]
+    # Here are a few ways to install the client. Choose the one that fits your use-case
+    # sudo may optionally be needed depending on your setup
+
+    pip install --upgrade synapseclient
+    pip install --upgrade "synapseclient[pandas]"
+    pip install --upgrade "synapseclient[pandas, pysftp, boto3]"
 
 ...or to upgrade an existing installation of the Synapse client:
 
-    (sudo) pip install --upgrade synapseclient
+    # sudo may optionally be needed depending on your setup
+    pip install --upgrade synapseclient
 
-The dependencies on `pandas` and `pysftp` are optional. Synapse [Tables](https://python-docs.synapse.org/reference/tables/) integrate
+The dependencies on `pandas`, `pysftp`, and `boto3` are optional. Synapse
+[Tables](https://python-docs.synapse.org/reference/tables/) integrate
 with [Pandas](http://pandas.pydata.org/). The library `pysftp` is required for users of
-[SFTP](https://python-docs.synapse.org/guides/data_storage/#sftp) file storage. Both libraries require native code
-to be compiled or installed separately from prebuilt binaries.
+[SFTP](https://python-docs.synapse.org/guides/data_storage/#sftp) file storage. All
+libraries require native code to be compiled or installed separately from prebuilt
+binaries.
 
 ### Install from source
 
@@ -63,6 +71,13 @@ Clone the [source code repository](https://github.com/Sage-Bionetworks/synapsePy
     cd synapsePythonClient
     pip install .
 
+Alternatively, you can use pip to install a particular branch, commit, or other git reference:
+
+    pip install git+https://github.com/Sage-Bionetworks/synapsePythonClient@master
+
+or
+
+    pip install git+https://github.com/Sage-Bionetworks/synapsePythonClient@my-commit-hash
 
 Command line usage
 ------------------

{synapseclient-4.1.1 → synapseclient-4.3.0}/setup.cfg

@@ -45,23 +45,30 @@ install_requires =
 	opentelemetry-sdk~=1.21.0
 	opentelemetry-exporter-otlp-proto-http~=1.21.0
 	nest-asyncio~=1.6.0
+	asyncio-atexit~=1.0.1
+	httpx~=0.27.0
+	tqdm>=4.66.2,<5.0
+	loky~=3.0.0
+	async-lru~=2.0.4
+	psutil~=5.9.8
 tests_require = 
-	pytest>=6.0.0,<7.0
+	pytest>=7.0.0,<8.0
 	pytest-mock>=3.0,<4.0
 	pytest-socket~=0.6.0
-	pytest-asyncio~=0.19
+	pytest-asyncio>=0.23.6,<1.0
 	flake8>=3.7.0,<4.0
 	pytest-xdist[psutil]>=2.2,<3.0.0
 	pytest-rerunfailures~=12.0
 	func-timeout~=4.3
 	pytest-cov~=4.1.0
+	pandas>=1.5,<3.0
 
 [options.extras_require]
 dev = 
-	pytest>=6.0.0,<7.0
+	pytest>=7.0.0,<8.0
 	pytest-mock>=3.0,<4.0
 	pytest-socket~=0.6.0
-	pytest-asyncio~=0.19
+	pytest-asyncio>=0.23.6,<1.0
 	flake8>=3.7.0,<4.0
 	pytest-xdist[psutil]>=2.2,<3.0.0
 	pytest-rerunfailures~=12.0
@@ -69,16 +76,18 @@ dev =
 	pytest-cov~=4.1.0
 	black
 	pre-commit
+	pandas>=1.5,<3.0
 tests = 
-	pytest>=6.0.0,<7.0
+	pytest>=7.0.0,<8.0
 	pytest-mock>=3.0,<4.0
 	pytest-socket~=0.6.0
-	pytest-asyncio~=0.19
+	pytest-asyncio>=0.23.6,<1.0
 	flake8>=3.7.0,<4.0
 	pytest-xdist[psutil]>=2.2,<3.0.0
 	pytest-rerunfailures~=12.0
 	func-timeout~=4.3
 	pytest-cov~=4.1.0
+	pandas>=1.5,<3.0
 pandas = 
 	pandas>=1.5,<3.0
 pysftp = 

{synapseclient-4.1.1 → synapseclient-4.3.0}/synapseclient/__init__.py

@@ -88,6 +88,11 @@ USER_AGENT = {
     % (__version__, requests.utils.default_user_agent())
 }
 
+USER_AGENT_COMMAND_LINE = {
+    "User-Agent": "synapsecommandlineclient/%s %s"
+    % (__version__, requests.utils.default_user_agent())
+}
+
 # patch json
 from .core.models import custom_json  # noqa
 

{synapseclient-4.1.1 → synapseclient-4.3.0}/synapseclient/__main__.py

@@ -1871,9 +1871,7 @@ def _authenticate_login(
 
 def main():
     args = build_parser().parse_args()
-    synapseclient.USER_AGENT["User-Agent"] = (
-        "synapsecommandlineclient " + synapseclient.USER_AGENT["User-Agent"]
-    )
+    synapseclient.USER_AGENT = synapseclient.USER_AGENT_COMMAND_LINE
     if args.otel:
         trace.set_tracer_provider(
             TracerProvider(

synapseclient-4.3.0/synapseclient/api/__init__.py

@@ -0,0 +1,56 @@
+# These are all of the models that are used by the Synapse client.
+from .annotations import set_annotations
+from .entity_bundle_services_v2 import (
+    get_entity_id_bundle2,
+    get_entity_id_version_bundle2,
+    post_entity_bundle2_create,
+    put_entity_id_bundle2,
+)
+from .entity_services import (
+    get_entity,
+    get_upload_destination,
+    get_upload_destination_location,
+    post_entity,
+    put_entity,
+    create_access_requirements_if_none,
+    delete_entity_generated_by,
+)
+from .file_services import (
+    get_file_handle,
+    post_external_filehandle,
+    post_external_object_store_filehandle,
+    post_external_s3_file_handle,
+    post_file_multipart,
+    put_file_multipart_complete,
+    post_file_multipart_presigned_urls,
+    put_file_multipart_add,
+    AddPartResponse,
+)
+
+__all__ = [
+    # annotations
+    "set_annotations",
+    "get_entity_id_bundle2",
+    "get_entity_id_version_bundle2",
+    "post_entity_bundle2_create",
+    "put_entity_id_bundle2",
+    # file_services
+    "post_file_multipart",
+    "put_file_multipart_add",
+    "put_file_multipart_complete",
+    "post_external_object_store_filehandle",
+    "post_external_s3_file_handle",
+    "get_file_handle",
+    "post_external_filehandle",
+    "post_file_multipart_presigned_urls",
+    "put_file_multipart_add",
+    "AddPartResponse",
+    # entity_services
+    "get_entity",
+    "put_entity",
+    "post_entity",
+    "get_upload_destination",
+    "get_upload_destination_location",
+    "create_access_requirements_if_none",
+    "delete_entity_generated_by",
+]

{synapseclient-4.1.1 → synapseclient-4.3.0}/synapseclient/api/annotations.py

@@ -2,33 +2,40 @@
 The purpose of this module is to provide any functions that are needed to interact with
 annotations that are not cleanly provided by the synapseclient library.
 """
+
 import json
 
 from dataclasses import asdict
 
 from typing import TYPE_CHECKING, Optional
-from synapseclient import Synapse
+
 from synapseclient.annotations import _convert_to_annotations_list
 
 if TYPE_CHECKING:
     from synapseclient.models import Annotations
+    from synapseclient import Synapse
 
 
 def set_annotations(
     annotations: "Annotations",
-    synapse_client: Optional[Synapse] = None,
+    synapse_client: Optional["Synapse"] = None,
 ):
     """Call to synapse and set the annotations for the given input.
 
     Arguments:
-        annotations: The annotations to set. This is expected to have the id, etag, and annotations filled in.
-        synapse_client: If not passed in or None this will use the last client from the `.login()` method.
+        annotations: The annotations to set. This is expected to have the id, etag,
+            and annotations filled in.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
 
     Returns: The annotations set in Synapse.
     """
     annotations_dict = asdict(annotations)
 
-    synapse_annotations = _convert_to_annotations_list(annotations_dict["annotations"])
+    synapse_annotations = _convert_to_annotations_list(
+        annotations_dict["annotations"] or {}
+    )
+    from synapseclient import Synapse
 
     return Synapse.get_client(synapse_client=synapse_client).restPUT(
         f"/entity/{annotations.id}/annotations2",

synapseclient-4.3.0/synapseclient/api/entity_bundle_services_v2.py

@@ -0,0 +1,146 @@
+"""This module is responsible for exposing the services defined at:
+<https://rest-docs.synapse.org/rest/#org.sagebionetworks.repo.web.controller.EntityBundleV2Controller>
+"""
+
+import json
+from typing import Any, Dict, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from synapseclient import Synapse
+
+
+async def get_entity_id_bundle2(
+    entity_id: str,
+    request: Optional[Dict[str, bool]] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        entity_id: The ID of the entity to which the bundle belongs
+        request: The request for the bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundleRequest.html>.
+            If not passed in or None, the default request will be used:
+
+            - includeEntity: True
+            - includeAnnotations: True
+            - includeFileHandles: True
+            - includeRestrictionInformation: True
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundle.html>
+    """
+    from synapseclient import Synapse
+
+    if not request:
+        request = {
+            "includeEntity": True,
+            "includeAnnotations": True,
+            "includeFileHandles": True,
+            "includeRestrictionInformation": True,
+        }
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_post_async(
+        uri=f"/entity/{entity_id}/bundle2",
+        body=json.dumps(request),
+    )
+
+
+async def get_entity_id_version_bundle2(
+    entity_id: str,
+    version: int,
+    request: Optional[Dict[str, bool]] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        entity_id: The ID of the entity to which the bundle belongs
+        version: The version of the entity to which the bundle belongs
+        request: The request for the bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundleRequest.html>.
+            If not passed in or None, the default request will be used:
+
+            - includeEntity: True
+            - includeAnnotations: True
+            - includeFileHandles: True
+            - includeRestrictionInformation: True
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundle.html>
+    """
+    from synapseclient import Synapse
+
+    if not request:
+        request = {
+            "includeEntity": True,
+            "includeAnnotations": True,
+            "includeFileHandles": True,
+            "includeRestrictionInformation": True,
+        }
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_post_async(
+        uri=f"/entity/{entity_id}/version/{version}/bundle2",
+        body=json.dumps(request),
+    )
+
+
+async def post_entity_bundle2_create(
+    request: Dict[str, Any],
+    generated_by: Optional[str] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        request: The request for the bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundleCreate.html>
+        generated_by: The ID of the activity to associate with the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundle.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_post_async(
+        uri="/entity/bundle2/create"
+        + (f"?generatedBy={generated_by}" if generated_by else ""),
+        body=json.dumps(request),
+    )
+
+
+async def put_entity_id_bundle2(
+    entity_id: str,
+    request: Dict[str, Any],
+    generated_by: Optional[str] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        entity_id: The ID of the entity to which the bundle belongs.
+        request: The request for the bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundleCreate.html>
+        generated_by: The ID of the activity to associate with the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/entitybundle/v2/EntityBundle.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_put_async(
+        uri=f"/entity/{entity_id}/bundle2"
+        + (f"?generatedBy={generated_by}" if generated_by else ""),
+        body=json.dumps(request),
+    )

synapseclient-4.3.0/synapseclient/api/entity_services.py

@@ -0,0 +1,197 @@
+"""This module is responsible for exposing the services defined at:
+<https://rest-docs.synapse.org/rest/#org.sagebionetworks.repo.web.controller.EntityController>
+"""
+
+import json
+from typing import Any, Dict, Optional, Union, TYPE_CHECKING
+from async_lru import alru_cache
+
+if TYPE_CHECKING:
+    from synapseclient import Synapse
+
+
+async def post_entity(
+    request: Dict[str, Any],
+    generated_by: Optional[str] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        request: The request for the entity matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/Entity.html>
+        generated_by: The ID of the activity to associate with the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/Entity.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    params = {}
+    if generated_by:
+        params["generatedBy"] = generated_by
+    return await client.rest_post_async(
+        uri="/entity", body=json.dumps(request), params=params
+    )
+
+
+async def put_entity(
+    entity_id: str,
+    request: Dict[str, Any],
+    new_version: bool = False,
+    generated_by: Optional[str] = None,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        entity_id: The ID of the entity to update.
+        request: The request for the entity matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/Entity.html>
+        new_version: If true, a new version of the entity will be created.
+        generated_by: The ID of the activity to associate with the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/Entity.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    params = {}
+    if generated_by:
+        params["generatedBy"] = generated_by
+    if new_version:
+        params["newVersion"] = "true"
+    return await client.rest_put_async(
+        uri=f"/entity/{entity_id}", body=json.dumps(request), params=params
+    )
+
+
+async def get_entity(
+    entity_id: str,
+    synapse_client: Optional["Synapse"] = None,
+) -> Dict[str, Any]:
+    """
+    Arguments:
+        entity_id: The ID of the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The requested entity bundle matching
+            <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/Entity.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_get_async(
+        uri=f"/entity/{entity_id}",
+    )
+
+
+@alru_cache(ttl=60)
+async def get_upload_destination(
+    entity_id: str, synapse_client: Optional["Synapse"] = None
+) -> Dict[str, Union[str, int]]:
+    """
+    <https://rest-docs.synapse.org/rest/GET/entity/id/uploadDestination.html>
+
+    Arguments:
+        entity_id: The ID of the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The upload destination.
+        <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/file/UploadDestination.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_get_async(
+        uri=f"/entity/{entity_id}/uploadDestination",
+        endpoint=client.fileHandleEndpoint,
+    )
+
+
+async def get_upload_destination_location(
+    entity_id: str, location: str, synapse_client: Optional["Synapse"] = None
+) -> Dict[str, Union[str, int]]:
+    """
+    <https://rest-docs.synapse.org/rest/GET/entity/id/uploadDestination/storageLocationId.html>
+
+    Arguments:
+        entity_id: The ID of the entity.
+        location: A storage location ID of the upload destination.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns:
+        The upload destination.
+        <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/file/UploadDestination.html>
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_get_async(
+        uri=f"/entity/{entity_id}/uploadDestination/{location}",
+        endpoint=client.fileHandleEndpoint,
+    )
+
+
+async def create_access_requirements_if_none(
+    entity_id: str, synapse_client: Optional["Synapse"] = None
+) -> None:
+    """
+    Checks to see if the given entity has access requirements. If not, then one is added
+
+    Arguments:
+        entity_id: The ID of the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    existing_restrictions = await client.rest_get_async(
+        f"/entity/{entity_id}/accessRequirement?offset=0&limit=1"
+    )
+    if (
+        existing_restrictions is None
+        or not hasattr(existing_restrictions, "results")
+        or len(existing_restrictions["results"]) == 0
+    ):
+        access_requirements = await client.rest_post_async(
+            f"/entity/{entity_id}/lockAccessRequirement"
+        )
+        client.logger.info(
+            "Created an access requirements request for "
+            f"{entity_id}: {access_requirements['jiraKey']}. An email will be sent to "
+            "the Synapse access control team to start the process of adding "
+            "terms-of-use or review board approval for this entity."
+        )
+
+
+async def delete_entity_generated_by(
+    entity_id: str,
+    synapse_client: Optional["Synapse"] = None,
+) -> None:
+    """
+    Arguments:
+        entity_id: The ID of the entity.
+        synapse_client: If not passed in or None this will use the last client from
+            the `.login()` method.
+
+    Returns: None
+    """
+    from synapseclient import Synapse
+
+    client = Synapse.get_client(synapse_client=synapse_client)
+    return await client.rest_delete_async(
+        uri=f"/entity/{entity_id}/generatedBy",
+    )