chore: update models and api types

Author: nfrasser

cryosparc/api.pyi

@@ -46,7 +46,6 @@ import httpx
 from .dataset import Dataset
 from .models.api_request import AppSession, SHA256Password
 from .models.api_response import (
-    BrowseFileResponse,
     GetFinalResultsResponse,
     Hello,
     WorkspaceAncestorUidsResponse,
@@ -60,6 +59,7 @@ from .models.diagnostics import RuntimeDiagnostics
 from .models.event import CheckpointEvent, Event, ImageEvent, InteractiveEvent, TextEvent
 from .models.exposure import Exposure
 from .models.external import ExternalOutputSpec
+from .models.file_browser import BrowseFileResponse, FileBrowserPrefixes
 from .models.job import Job, JobStatus
 from .models.job_register import JobRegister
 from .models.job_spec import Category, InputSpec, OutputResult, OutputSpec
@@ -102,8 +102,25 @@ class APINamespace:
 
 class ConfigAPI(APINamespace):
     """
-    Functions available in ``api.config``, e.g., ``api.config.set_instance_banner(...)``
+    Functions available in ``api.config``, e.g., ``api.config.get_file_browser_settings(...)``
     """
+    def get_file_browser_settings(self) -> FileBrowserPrefixes:
+        """
+        Returns:
+            FileBrowserPrefixes: Instance file browser settings
+
+        """
+        ...
+    def set_file_browser_settings(self, body: FileBrowserPrefixes) -> Any:
+        """
+        Args:
+            body (FileBrowserPrefixes):
+
+        Returns:
+            Any: Successful Response
+
+        """
+        ...
     def set_instance_banner(
         self, *, active: bool = False, title: Optional[str] = None, body: Optional[str] = None
     ) -> Any:
@@ -304,8 +321,13 @@ class InstanceAPI(APINamespace):
 
         """
         ...
-    def audit_dump(self) -> Optional[str]:
+    def audit_dump(self, *, timestamp: Union[float, str, None] = None) -> Optional[str]:
         """
+        Generate an audit dump file containing all audit logs since the given timestamp.
+
+        Args:
+            timestamp (float | str, optional): Leave unspecified to dump all audit logs, set to "auto" to dump new logs since the last dump, or set to a UNIX timestamp to dump every log that occurred after it.. Defaults to None
+
         Returns:
             str | None: Successful Response
 
@@ -544,22 +566,6 @@ class UsersAPI(APINamespace):
         Returns:
             Any: Successful Response
 
-        """
-        ...
-    def set_allowed_prefix_dir(self, user_id: str, /, allowed_prefix: str) -> User:
-        """
-        Sets directories that users are allowed to query from the file browser.
-        ``allowed_prefix`` is the path of the directory the user can query inside.
-        (must start with "/", and must be an absolute path)
-        Returns True if successful
-
-        Args:
-            user_id (str): User ID or Email Address
-            allowed_prefix (str):
-
-        Returns:
-            User: Successful Response
-
         """
         ...
     def get_state_var(self, user_id: str, key: str, /) -> Any:
@@ -629,6 +635,27 @@ class UsersAPI(APINamespace):
 
         """
         ...
+    def get_file_browser_settings(self, user_id: str, /) -> FileBrowserPrefixes:
+        """
+        Args:
+            user_id (str): User ID or Email Address
+
+        Returns:
+            FileBrowserPrefixes: User file browser settings
+
+        """
+        ...
+    def set_file_browser_settings(self, user_id: str, /, body: FileBrowserPrefixes) -> User:
+        """
+        Args:
+            user_id (str): User ID or Email Address
+            body (FileBrowserPrefixes):
+
+        Returns:
+            User: Successful Response
+
+        """
+        ...
 
 class ResourcesAPI(APINamespace):
     """
@@ -4971,7 +4998,7 @@ class DeveloperAPI(APINamespace):
 class APIClient:
     """
     Top-level API client class. e.g., ``api.read_root(...)``
-    or ``api.config.set_instance_banner(...)``
+    or ``api.config.get_file_browser_settings(...)``
     """
 
     config: ConfigAPI

cryosparc/controllers/job.py

@@ -70,7 +70,7 @@ class JobController(Controller[Job]):
             Job model, e.g. ``("P3", "J42")``
 
     Attributes:
-        model (Workspace): All job data from the CryoSPARC database.
+        model (Job): All job data from the CryoSPARC database.
             Contents may change over time, use :py:meth:`refresh` to update.
 
     Examples:

cryosparc/model_registry.py

@@ -11,6 +11,7 @@
     event,
     exposure,
     external,
+    file_browser,
     gpu,
     instance,
     job,
@@ -44,14 +45,15 @@
 register_model_module(api_request, include_literals=True)
 register_model_module(session, include_literals=True)
 register_model_module(user, include_literals=True)
-register_model_module(api_response, include_literals=True)
+register_model_module(file_browser, include_literals=True)
 register_model_module(job_spec, include_literals=True)
 register_model_module(exposure, include_literals=True)
 register_model_module(event, include_literals=True)
 register_model_module(preview, include_literals=True)
 register_model_module(session_params, include_literals=True)
 register_model_module(external, include_literals=True)
 register_model_module(project, include_literals=True)
+register_model_module(api_response, include_literals=True)
 register_model_module(asset, include_literals=True)
 register_model_module(signature, include_literals=True)
 register_model_module(instance, include_literals=True)

cryosparc/models/api_response.py

@@ -1,29 +1,10 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_models.py
-from typing import List, Literal, Optional
+from typing import List
 
 from pydantic import BaseModel
 
 
-class BrowseFile(BaseModel):
-    file_name: str
-    base_path: str
-    is_hidden: bool
-    path_abs: str
-    is_link: bool = False
-    mtime: Optional[float] = None
-    size: Optional[int] = None
-    type: Optional[Literal["dir", "file"]] = None
-    link_path: Optional[str] = None
-    errmesg: Optional[str] = None
-
-
-class BrowseFileResponse(BaseModel):
-    back_path: str
-    files: List[BrowseFile]
-    type: str
-
-
 class GetFinalResultsResponse(BaseModel):
     final_results: List[str]
     """

cryosparc/models/exposure.py

@@ -1,7 +1,7 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_models.py
 import datetime
-from typing import Any, Dict, List, Literal, Optional, Tuple, Union
+from typing import Any, Dict, List, Literal, Optional, Union
 
 from pydantic import BaseModel, Field
 
@@ -45,7 +45,7 @@ class StatBlob(BaseModel):
     idx: int
     path: str
     psize_A: float
-    shape: Tuple[int, int]
+    shape: List[int]
 
 
 class GainRefBlob(BaseModel):

cryosparc/models/file_browser.py

@@ -0,0 +1,30 @@
+# THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
+# SEE dev/api_generate_models.py
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel
+
+
+class BrowseFile(BaseModel):
+    file_name: str
+    base_path: str
+    is_hidden: bool
+    path_abs: str
+    is_link: bool = False
+    mtime: Optional[float] = None
+    size: Optional[int] = None
+    type: Optional[Literal["dir", "file"]] = None
+    link_path: Optional[str] = None
+    errmesg: Optional[str] = None
+
+
+class BrowseFileResponse(BaseModel):
+    back_path: str
+    files: List[BrowseFile]
+    type: str
+
+
+class FileBrowserPrefixes(BaseModel):
+    allowed_prefixes: Optional[List[str]] = None
+    import_dir_default: Optional[str] = None
+    project_dir_default: Optional[str] = None

cryosparc/models/user.py

@@ -5,6 +5,8 @@
 
 from pydantic import BaseModel, Field
 
+from .file_browser import FileBrowserPrefixes
+
 
 class Bookmark(BaseModel):
     id: str
@@ -105,5 +107,5 @@ class User(BaseModel):
     services: Services = Services()
     state: UserState = UserState()
     preferences: Dict[str, Any] = {}
-    allowed_prefix_dir: str = "/"
+    file_browser_settings: FileBrowserPrefixes = FileBrowserPrefixes()
     lanes: List[str] = []