chore: update to latest API models

Author: nfrasser

cryosparc/api.pyi

@@ -586,7 +586,7 @@ class JobsNamespace(APINamespace):
         Finds the job.
         """
         ...
-    def delete(self, project_uid: str, job_uid: str, /, *, force: bool = False) -> None:
+    def delete(self, project_uid: str, job_uid: str, /, *, force: bool = False) -> Any:
         """
         Deletes a job. Will kill (if running) and clearing the job before deleting.
         """
@@ -1073,7 +1073,7 @@ class WorkspacesNamespace(APINamespace):
         Find a specific workspace in a project
         """
         ...
-    def delete(self, project_uid: str, workspace_uid: str, /) -> None:
+    def delete(self, project_uid: str, workspace_uid: str, /) -> Any:
         """
         Marks the workspace as "deleted". Deletes jobs that are only linked to this workspace
         and no other workspace.
@@ -1107,12 +1107,6 @@ class WorkspacesNamespace(APINamespace):
         Adds a workspace uid to a user's recently viewed workspaces list.
         """
         ...
-    def delete_async(self, project_uid: str, workspace_uid: str, /) -> Any:
-        """
-        Starts the workspace deletion task.  Deletes jobs that are only linked to this workspace
-        and no other workspace.
-        """
-        ...
     def add_tag(self, project_uid: str, workspace_uid: str, tag_uid: str, /) -> None:
         """
         Tag the given workspace with the given tag.
@@ -1202,7 +1196,7 @@ class SessionsNamespace(APINamespace):
         Finds a session
         """
         ...
-    def delete(self, project_uid: str, session_uid: str, /) -> None:
+    def delete(self, project_uid: str, session_uid: str, /) -> Any:
         """
         Sets the session document as "deleted"
         Will throw an error if any undeleted jobs exist within the session.
@@ -1809,12 +1803,7 @@ class ProjectsNamespace(APINamespace):
         Finds a project by its UID
         """
         ...
-    def delete(self, project_uid: str, /) -> None:
-        """
-        Deletes the project, its full directory, and all associated workspaces, sessions, jobs and results.
-        """
-        ...
-    def delete_async(self, project_uid: str, /) -> Any:
+    def delete(self, project_uid: str, /) -> Any:
         """
         Starts project deletion task. Will delete the project, its full directory, and all associated workspaces, sessions, jobs and results.
         """
@@ -1846,13 +1835,7 @@ class ProjectsNamespace(APINamespace):
         Removes a user's access from a project.
         """
         ...
-    def refresh_size(self, project_uid: str, /) -> Project:
-        """
-        Walks the project directory and update the project size with the sum
-        of all the file sizes.
-        """
-        ...
-    def refresh_size_async(self, project_uid: str, /) -> Any:
+    def refresh_size(self, project_uid: str, /) -> Any:
         """
         Starts project size recalculation asynchronously.
         """
@@ -1972,6 +1955,13 @@ class ProjectsNamespace(APINamespace):
         Unstars a project for a user
         """
         ...
+    def reset_autodump(self, project_uid: str, /) -> Project:
+        """
+        Clear project directory write failures. After calling this endpoint,
+        CryoSPARC's scheduler will attempt to write modified jobs and workspaces to
+        the project directory that previously could not be saved.
+        """
+        ...
 
 class ExposuresNamespace(APINamespace):
     """
@@ -2244,7 +2234,7 @@ class DeveloperNamespace(APINamespace):
         Restarts API service and scheduler.
         """
         ...
-    def save_job_registers(self) -> List[JobRegister]:
+    def save_job_registers(self, *, developer_name: Optional[str] = ...) -> List[JobRegister]:
         """
         Re-saves the current job registers. Call this when restarting the api
         service without executing the /startup route, as we do during developer

cryosparc/model_registry.py

@@ -36,24 +36,24 @@
 register_model_module(scheduler_target)
 register_model_module(gpu)
 register_model_module(api_request)
+register_model_module(user)
 register_model_module(api_response)
 register_model_module(job_spec)
 register_model_module(exposure)
 register_model_module(event)
-register_model_module(user)
 register_model_module(session_params)
 register_model_module(external)
 register_model_module(project)
 register_model_module(asset)
 register_model_module(signature)
 register_model_module(instance)
+register_model_module(workspace)
 register_model_module(job_register)
 register_model_module(license)
 register_model_module(service)
 register_model_module(notification)
 register_model_module(diagnostics)
 register_model_module(scheduler_lane)
-register_model_module(workspace)
 register_model_module(session_spec)
 register_model_module(session_config_profile)
 register_model_module(tag)

cryosparc/models/gpu.py

@@ -1,6 +1,6 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_models.py
-from typing import Literal
+from typing import Any, Literal
 
 from pydantic import BaseModel
 
@@ -20,7 +20,7 @@ class GpuInfo(BaseModel):
     name: str
     mem: int
     bus_id: str = ""
-    compute_mode: Literal["Default", "Exclusive Thread", "Prohibited", "Exclusive Process"] = "Default"
+    compute_mode: Any = "Default"
     persistence_mode: Literal["Disabled", "Enabled"] = "Disabled"
     power_limit: float = 0.0
     sw_power_limit: Literal["Not Active", "Active"] = "Not Active"

cryosparc/models/job.py

@@ -24,7 +24,7 @@ class AllocatedResources(BaseModel):
 
 
 class JobLastAccessed(BaseModel):
-    name: str = ""
+    name: str
     accessed_at: datetime.datetime = datetime.datetime(1, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
 
 
@@ -40,6 +40,12 @@ class UiTileImage(BaseModel):
     num_cols: Optional[int] = None
 
 
+class JobWorkflowInfo(BaseModel):
+    id: str
+    jobId: str
+    run: int
+
+
 class Job(BaseModel):
     """
     Specification for a Job document from the MongoDB database.
@@ -84,6 +90,7 @@ class Job(BaseModel):
     version: Optional[str] = None
     priority: int = 0
     deleted: bool = False
+    deleting: bool = False
     parents: List[str] = []
     children: List[str] = []
     resources_allocated: Optional[AllocatedResources] = None
@@ -141,6 +148,7 @@ class Job(BaseModel):
     last_exported_location: Optional[str] = None
     last_exported_version: Optional[str] = None
     tags: List[str] = []
+    workflow: Optional[JobWorkflowInfo] = None
     imported_at: Optional[datetime.datetime] = None
     deleted_at: Optional[datetime.datetime] = None
     import_status: Optional[Literal["importing", "complete", "failed"]] = None

cryosparc/models/project.py

@@ -27,6 +27,11 @@ class ProjectStats(BaseModel):
     updated_at: Optional[datetime.datetime] = None
 
 
+class ProjectWorkflowInfo(BaseModel):
+    latest_workflow_uid: str
+    runs: Dict[str, int] = {}
+
+
 class Project(BaseModel):
     id: str = Field("000000000000000000000000", alias="_id")
     updated_at: datetime.datetime = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
@@ -42,6 +47,7 @@ class Project(BaseModel):
     project_params_pdef: dict = {}
     queue_paused: bool = False
     deleted: bool = False
+    deleting: bool = False
     users_with_access: List[str] = []
     size: int = 0
     size_last_updated: datetime.datetime
@@ -55,11 +61,15 @@ class Project(BaseModel):
     imported_at: Optional[datetime.datetime] = None
     import_status: Optional[Literal["importing", "complete", "failed"]] = None
     project_stats: ProjectStats = ProjectStats()
+    created_at_version: str = "unknown"
     last_archived_version: Optional[str] = None
     last_detached_version: Optional[str] = None
     is_cleanup_in_progress: bool = False
     tags: List[str] = []
     starred_by: List[str] = []
+    autodump_failed: bool = False
+    autodump_errors: List[str] = []
+    workflows: Optional[ProjectWorkflowInfo] = None
     uid_num: int
 
 

cryosparc/models/session.py

@@ -9,7 +9,7 @@
 from .session_params import LiveAbinitParams, LivePreprocessingParams
 from .session_spec import SessionStatus
 from .signature import ImportSignature
-from .workspace import WorkspaceStats
+from .workspace import JobGroup, WorkspaceStats
 
 
 class AbInitioVolumeInfo(BaseModel):
@@ -222,12 +222,12 @@ class Session(BaseModel):
     tags: List[str] = []
     starred_by: List[str] = []
     deleted: bool = False
+    deleting: bool = False
     last_accessed: Optional[SessionLastAccessed] = None
     workspace_stats: WorkspaceStats = WorkspaceStats()
-    notes: str = ""
-    notes_lock: Optional[str] = None
     imported_at: Optional[datetime.datetime] = None
     workspace_type: str = "live"
+    groups: List[JobGroup] = []
     session_uid: str
     session_dir: str
     status: SessionStatus = "paused"
@@ -295,6 +295,8 @@ class Session(BaseModel):
     ]
     picking_thresholds: PickingThresholds = PickingThresholds()
     compute_resources: LiveComputeResources = LiveComputeResources()
+    notes: str = ""
+    notes_lock: Optional[str] = None
     phase_one_workers: Dict[str, RtpWorkerState] = {}
     phase_one_workers_soft_kill: List[Any] = []
     live_session_job_uid: Optional[str] = None

cryosparc/models/user.py

@@ -6,11 +6,31 @@
 from pydantic import BaseModel, Field
 
 
+class Bookmark(BaseModel):
+    id: str
+    path: str
+    name: str
+    description: str
+    color: str
+    last_accessed: datetime.datetime
+    created_at: datetime.datetime = datetime.datetime(2025, 3, 6, 16, 44, 32, 992643, tzinfo=datetime.timezone.utc)
+
+
 class Email(BaseModel):
     address: str
     verified: bool = False
 
 
+class RecentPath(BaseModel):
+    path: str
+    last_accessed: datetime.datetime
+
+
+class FileBrowserState(BaseModel):
+    recentPaths: List[RecentPath] = []
+    bookmarks: List[Bookmark] = []
+
+
 class LoginToken(BaseModel):
     hashedToken: str
     when: datetime.datetime
@@ -52,13 +72,13 @@ class Services(BaseModel):
 class UserState(BaseModel):
     licenseAccepted: bool = False
     userCanSetJobPriority: bool = False
-    userCanModifyLiveDataManagement: bool = False
     recentProjects: List[str] = []
     recentWorkspaces: List[RecentWorkspace] = []
     recentSessions: List[RecentSession] = []
     recentJobs: List[RecentJob] = []
     browserPath: Optional[str] = None
-    defaultJobPriority: int = 0
+    defaultJobPriority: Optional[int] = None
+    userFileBrowserState: FileBrowserState = FileBrowserState()
 
 
 class User(BaseModel):

cryosparc/models/workspace.py

@@ -6,6 +6,14 @@
 from pydantic import BaseModel, ConfigDict, Field
 
 
+class JobGroup(BaseModel):
+    id: int
+    jobs: List[str]
+    title: Optional[str] = None
+    description: Optional[str] = None
+    color: Optional[str] = None
+
+
 class WorkspaceStats(BaseModel):
     updated_at: Optional[datetime.datetime] = None
     job_count: int = 0
@@ -35,12 +43,12 @@ class Workspace(BaseModel):
     tags: List[str] = []
     starred_by: List[str] = []
     deleted: bool = False
+    deleting: bool = False
     last_accessed: Optional[WorkspaceLastAccessed] = None
     workspace_stats: WorkspaceStats = WorkspaceStats()
-    notes: str = ""
-    notes_lock: Optional[str] = None
     imported_at: Optional[datetime.datetime] = None
     workspace_type: Literal["base", "live"] = "base"
+    groups: List[JobGroup] = []
     uid_num: int
     project_uid_num: int