Created crud sdk for vision event use-case

Author: renzon

roboflow/adapters/vision_events_api.py

@@ -130,6 +130,97 @@ def get_custom_metadata_schema(api_key: str, use_case_id: str) -> dict:
     return response.json()
 
 
+def create_use_case(api_key: str, name: str) -> dict:
+    """Create a new vision event use case.
+
+    Args:
+        api_key: Roboflow API key.
+        name: Human-readable name for the use case.
+
+    Returns:
+        Parsed JSON response with ``id`` and ``name``.
+
+    Raises:
+        RoboflowError: On non-201 response status codes.
+    """
+    response = requests.post(
+        f"{_BASE}/use-cases",
+        json={"name": name},
+        headers=_auth_headers(api_key),
+    )
+    if response.status_code != 201:
+        raise RoboflowError(response.text)
+    return response.json()
+
+
+def rename_use_case(api_key: str, use_case_id: str, name: str) -> dict:
+    """Rename an existing vision event use case.
+
+    Args:
+        api_key: Roboflow API key.
+        use_case_id: Use case identifier.
+        name: New name for the use case.
+
+    Returns:
+        Parsed JSON response with ``id`` and ``name``.
+
+    Raises:
+        RoboflowError: On non-200 response status codes.
+    """
+    response = requests.put(
+        f"{_BASE}/use-cases/{use_case_id}",
+        json={"name": name},
+        headers=_auth_headers(api_key),
+    )
+    if response.status_code != 200:
+        raise RoboflowError(response.text)
+    return response.json()
+
+
+def archive_use_case(api_key: str, use_case_id: str) -> dict:
+    """Archive a vision event use case.
+
+    Args:
+        api_key: Roboflow API key.
+        use_case_id: Use case identifier.
+
+    Returns:
+        Parsed JSON response with ``success``.
+
+    Raises:
+        RoboflowError: On non-200 response status codes.
+    """
+    response = requests.post(
+        f"{_BASE}/use-cases/{use_case_id}/archive",
+        headers=_auth_headers(api_key),
+    )
+    if response.status_code != 200:
+        raise RoboflowError(response.text)
+    return response.json()
+
+
+def unarchive_use_case(api_key: str, use_case_id: str) -> dict:
+    """Unarchive a vision event use case.
+
+    Args:
+        api_key: Roboflow API key.
+        use_case_id: Use case identifier.
+
+    Returns:
+        Parsed JSON response with ``success``.
+
+    Raises:
+        RoboflowError: On non-200 response status codes.
+    """
+    response = requests.post(
+        f"{_BASE}/use-cases/{use_case_id}/unarchive",
+        headers=_auth_headers(api_key),
+    )
+    if response.status_code != 200:
+        raise RoboflowError(response.text)
+    return response.json()
+
+
 def upload_image(
     api_key: str,
     image_path: str,

roboflow/cli/handlers/vision_events.py

@@ -218,6 +218,139 @@ def _use_cases(args) -> None:  # noqa: ANN001
     output(args, result, text="\n".join(lines))
 
 
+# ---------------------------------------------------------------------------
+# create-use-case
+# ---------------------------------------------------------------------------
+
+
+@vision_events_app.command("create-use-case")
+def create_use_case(
+    ctx: typer.Context,
+    name: Annotated[str, typer.Argument(help="Name for the new use case")],
+) -> None:
+    """Create a new vision event use case."""
+    args = ctx_to_args(ctx, name=name)
+    _create_use_case(args)
+
+
+def _create_use_case(args) -> None:  # noqa: ANN001
+    from roboflow.adapters import vision_events_api
+    from roboflow.adapters.rfapi import RoboflowError
+    from roboflow.cli._output import output, output_error
+
+    api_key = _resolve(args)
+    if api_key is None:
+        return
+
+    try:
+        result = vision_events_api.create_use_case(api_key, args.name)
+    except RoboflowError as exc:
+        output_error(args, str(exc))
+        return
+
+    output(args, result, text=f"Created use case {result.get('id', '')} ({result.get('name', '')})")
+
+
+# ---------------------------------------------------------------------------
+# rename-use-case
+# ---------------------------------------------------------------------------
+
+
+@vision_events_app.command("rename-use-case")
+def rename_use_case(
+    ctx: typer.Context,
+    use_case: Annotated[str, typer.Argument(help="Use case identifier")],
+    name: Annotated[str, typer.Option("-n", "--name", help="New name for the use case")],
+) -> None:
+    """Rename an existing vision event use case."""
+    args = ctx_to_args(ctx, use_case=use_case, name=name)
+    _rename_use_case(args)
+
+
+def _rename_use_case(args) -> None:  # noqa: ANN001
+    from roboflow.adapters import vision_events_api
+    from roboflow.adapters.rfapi import RoboflowError
+    from roboflow.cli._output import output, output_error
+
+    api_key = _resolve(args)
+    if api_key is None:
+        return
+
+    try:
+        result = vision_events_api.rename_use_case(api_key, args.use_case, args.name)
+    except RoboflowError as exc:
+        output_error(args, str(exc))
+        return
+
+    output(args, result, text=f"Renamed use case {result.get('id', '')} to {result.get('name', '')}")
+
+
+# ---------------------------------------------------------------------------
+# archive-use-case
+# ---------------------------------------------------------------------------
+
+
+@vision_events_app.command("archive-use-case")
+def archive_use_case(
+    ctx: typer.Context,
+    use_case: Annotated[str, typer.Argument(help="Use case identifier")],
+) -> None:
+    """Archive a vision event use case."""
+    args = ctx_to_args(ctx, use_case=use_case)
+    _archive_use_case(args)
+
+
+def _archive_use_case(args) -> None:  # noqa: ANN001
+    from roboflow.adapters import vision_events_api
+    from roboflow.adapters.rfapi import RoboflowError
+    from roboflow.cli._output import output, output_error
+
+    api_key = _resolve(args)
+    if api_key is None:
+        return
+
+    try:
+        result = vision_events_api.archive_use_case(api_key, args.use_case)
+    except RoboflowError as exc:
+        output_error(args, str(exc))
+        return
+
+    output(args, result, text=f"Archived use case {args.use_case}")
+
+
+# ---------------------------------------------------------------------------
+# unarchive-use-case
+# ---------------------------------------------------------------------------
+
+
+@vision_events_app.command("unarchive-use-case")
+def unarchive_use_case(
+    ctx: typer.Context,
+    use_case: Annotated[str, typer.Argument(help="Use case identifier")],
+) -> None:
+    """Unarchive a vision event use case."""
+    args = ctx_to_args(ctx, use_case=use_case)
+    _unarchive_use_case(args)
+
+
+def _unarchive_use_case(args) -> None:  # noqa: ANN001
+    from roboflow.adapters import vision_events_api
+    from roboflow.adapters.rfapi import RoboflowError
+    from roboflow.cli._output import output, output_error
+
+    api_key = _resolve(args)
+    if api_key is None:
+        return
+
+    try:
+        result = vision_events_api.unarchive_use_case(api_key, args.use_case)
+    except RoboflowError as exc:
+        output_error(args, str(exc))
+        return
+
+    output(args, result, text=f"Unarchived use case {args.use_case}")
+
+
 # ---------------------------------------------------------------------------
 # metadata-schema
 # ---------------------------------------------------------------------------

roboflow/core/workspace.py

@@ -1140,6 +1140,81 @@ def list_vision_event_use_cases(self, status: Optional[str] = None) -> dict:
             result["useCases"] = result["solutions"]
         return result
 
+    def create_vision_event_use_case(self, name: str) -> dict:
+        """Create a new vision event use case.
+
+        Args:
+            name: Human-readable name for the use case.
+
+        Returns:
+            Dict with ``id`` and ``name``.
+
+        Example:
+            >>> ws = rf.workspace()
+            >>> result = ws.create_vision_event_use_case("manufacturing-qa")
+            >>> use_case_id = result["id"]
+        """
+        return vision_events_api.create_use_case(
+            api_key=self.__api_key,
+            name=name,
+        )
+
+    def rename_vision_event_use_case(self, use_case: str, name: str) -> dict:
+        """Rename an existing vision event use case.
+
+        Args:
+            use_case: Use case identifier.
+            name: New name for the use case.
+
+        Returns:
+            Dict with ``id`` and ``name``.
+
+        Example:
+            >>> ws = rf.workspace()
+            >>> ws.rename_vision_event_use_case("abc123", "new-name")
+        """
+        return vision_events_api.rename_use_case(
+            api_key=self.__api_key,
+            use_case_id=use_case,
+            name=name,
+        )
+
+    def archive_vision_event_use_case(self, use_case: str) -> dict:
+        """Archive a vision event use case.
+
+        Args:
+            use_case: Use case identifier.
+
+        Returns:
+            Dict with ``success``.
+
+        Example:
+            >>> ws = rf.workspace()
+            >>> ws.archive_vision_event_use_case("abc123")
+        """
+        return vision_events_api.archive_use_case(
+            api_key=self.__api_key,
+            use_case_id=use_case,
+        )
+
+    def unarchive_vision_event_use_case(self, use_case: str) -> dict:
+        """Unarchive a vision event use case.
+
+        Args:
+            use_case: Use case identifier.
+
+        Returns:
+            Dict with ``success``.
+
+        Example:
+            >>> ws = rf.workspace()
+            >>> ws.unarchive_vision_event_use_case("abc123")
+        """
+        return vision_events_api.unarchive_use_case(
+            api_key=self.__api_key,
+            use_case_id=use_case,
+        )
+
     def get_vision_event_metadata_schema(self, use_case: str) -> dict:
         """Get the custom metadata schema for a vision event use case.