feat: add rename method to v2 assets (#1333)

* feat: add rename method to v2 assets (Folder, Project, SurfaceMesh, VolumeMesh, Case, etc)

* fix: raise rename method to AssetBase class

* fix: remove self return after renaming asset

* fix: remove return docstring + missed self returns

Author: dawoodhq

flow360/cloud/flow360_requests.py

@@ -235,8 +235,17 @@ def _validate_force_creation_config(self):
 
 
 class MoveToFolderRequestV2(Flow360RequestsV2):
-    """v2 request implementation for moving folder"""
+    """Data model for moving folder using v2 endpoint"""
 
     name: Optional[str] = pd_v2.Field(default=None, description="folder to move name")
     tags: List[str] = pd_v2.Field(default=[], description="folder tags")
     parent_folder_id: str = pd_v2.Field(alias="parentFolderId", default="ROOT.FLOW360")
+
+
+class RenameAssetRequestV2(Flow360RequestsV2):
+    """
+    Data model for renaming an asset (folder, project, surface mesh, volume mesh,
+    or case (other request fields, like folder to move to, already have implementations)
+    """
+
+    name: str = pd_v2.Field(description="case to rename")

flow360/component/case.py

@@ -14,7 +14,11 @@
 import pydantic.v1 as pd_v1
 
 from .. import error_messages
-from ..cloud.flow360_requests import MoveCaseItem, MoveToFolderRequest
+from ..cloud.flow360_requests import (
+    MoveCaseItem,
+    MoveToFolderRequest,
+    RenameAssetRequestV2,
+)
 from ..cloud.rest_api import RestApi
 from ..cloud.s3_utils import CloudFileNotFoundError
 from ..exceptions import Flow360RuntimeError, Flow360ValidationError, Flow360ValueError
@@ -668,6 +672,19 @@ def move_to_folder(self, folder: Folder):
         )
         return self
 
+    def rename(self, new_name: str):
+        """
+        Rename the current case.
+
+        Parameters
+        ----------
+        new_name : str
+            The new name for the case.
+        """
+        RestApi(CaseInterfaceV2.endpoint).patch(
+            RenameAssetRequestV2(name=new_name).dict(), method=self.id
+        )
+
     @classmethod
     def _interface(cls):
         return CaseInterface

flow360/component/project.py

@@ -14,7 +14,7 @@
 from PrettyPrint import PrettyPrintTree
 from pydantic import PositiveInt
 
-from flow360.cloud.flow360_requests import LengthUnitType
+from flow360.cloud.flow360_requests import LengthUnitType, RenameAssetRequestV2
 from flow360.cloud.rest_api import RestApi
 from flow360.component.case import Case
 from flow360.component.geometry import Geometry
@@ -1211,6 +1211,19 @@ def refresh_project_tree(self):
         """Refresh the local project tree by fetching the latest project tree from cloud."""
         return self._get_tree_from_cloud()
 
+    def rename(self, new_name: str):
+        """
+        Rename the current project.
+
+        Parameters
+        ----------
+        new_name : str
+            The new name for the project.
+        """
+        RestApi(ProjectInterface.endpoint).patch(
+            RenameAssetRequestV2(name=new_name).dict(), method=self.id
+        )
+
     def print_project_tree(self, line_width: int = 30, is_horizontal: bool = True):
         """Print the project tree to the terminal.
 

flow360/component/simulation/folder.py

@@ -10,7 +10,11 @@
 
 import pydantic as pd
 
-from ...cloud.flow360_requests import MoveToFolderRequestV2, NewFolderRequest
+from ...cloud.flow360_requests import (
+    MoveToFolderRequestV2,
+    NewFolderRequest,
+    RenameAssetRequestV2,
+)
 from ...cloud.rest_api import RestApi
 from ...exceptions import Flow360ValueError
 from ...log import log
@@ -133,6 +137,19 @@ def move_to_folder(self, folder: Folder):
         )
         return self
 
+    def rename(self, new_name: str):
+        """
+        Rename the current folder.
+
+        Parameters
+        ----------
+        new_name : str
+            The new name for the folder.
+        """
+        RestApi(FolderInterfaceV2.endpoint).patch(
+            RenameAssetRequestV2(name=new_name).dict(), method=self.id
+        )
+
     @classmethod
     def _interface(cls):
         return FolderInterface

flow360/component/simulation/web/asset_base.py

@@ -11,7 +11,7 @@
 from pydantic import ValidationError
 from requests.exceptions import HTTPError
 
-from flow360.cloud.flow360_requests import LengthUnitType
+from flow360.cloud.flow360_requests import LengthUnitType, RenameAssetRequestV2
 from flow360.cloud.rest_api import RestApi
 from flow360.component.interfaces import BaseInterface, ProjectInterface
 from flow360.component.resource_base import (
@@ -83,6 +83,19 @@ def solver_version(self):
         """
         return self.info.solver_version
 
+    def rename(self, new_name: str):
+        """
+        Rename the current asset.
+
+        Parameters
+        ----------
+        new_name : str
+            The new name for the asset.
+        """
+        RestApi(self._interface_class.endpoint).patch(
+            RenameAssetRequestV2(name=new_name).dict(), method=self.id
+        )
+
     @classmethod
     # pylint: disable=protected-access
     def _from_meta(cls, meta: AssetMetaBaseModelV2):