Update api spec (#433)

zoo-github-actions-auth[bot] · github-actions[bot] · web-flow · commit 06a646e5581a · 2025-05-08T12:57:30.000-07:00
* YOYO NEW API SPEC!

* I have generated the latest API!

---------

Co-authored-by: github-actions[bot] &lt;github-actions[bot]@users.noreply.github.com&gt;
diff --git a/kittycad.py.patch.json b/kittycad.py.patch.json
diff --git a/kittycad/models/__init__.py b/kittycad/models/__init__.py
@@ -52,6 +52,7 @@
 from .code_language import CodeLanguage
 from .code_output import CodeOutput
 from .color import Color
+from .complementary_edges import ComplementaryEdges
 from .component_transform import ComponentTransform
 from .connection import Connection
 from .country_code import CountryCode
@@ -67,6 +68,7 @@
 from .curve_type import CurveType
 from .customer import Customer
 from .customer_balance import CustomerBalance
+from .cut_strategy import CutStrategy
 from .cut_type import CutType
 from .default_camera_center_to_scene import DefaultCameraCenterToScene
 from .default_camera_center_to_selection import DefaultCameraCenterToSelection
@@ -131,6 +133,7 @@
 from .extruded_face_info import ExtrudedFaceInfo
 from .extrusion_face_cap_type import ExtrusionFaceCapType
 from .extrusion_face_info import ExtrusionFaceInfo
+from .face_edge_info import FaceEdgeInfo
 from .face_get_center import FaceGetCenter
 from .face_get_gradient import FaceGetGradient
 from .face_get_position import FaceGetPosition
@@ -304,10 +307,12 @@
 from .solid3d_get_all_opposite_edges import Solid3dGetAllOppositeEdges
 from .solid3d_get_common_edge import Solid3dGetCommonEdge
 from .solid3d_get_extrusion_face_info import Solid3dGetExtrusionFaceInfo
+from .solid3d_get_info import Solid3dGetInfo
 from .solid3d_get_next_adjacent_edge import Solid3dGetNextAdjacentEdge
 from .solid3d_get_opposite_edge import Solid3dGetOppositeEdge
 from .solid3d_get_prev_adjacent_edge import Solid3dGetPrevAdjacentEdge
 from .solid3d_shell_face import Solid3dShellFace
+from .solid_info import SolidInfo
 from .source_position import SourcePosition
 from .source_range import SourceRange
 from .source_range_prompt import SourceRangePrompt
diff --git a/kittycad/models/complementary_edges.py b/kittycad/models/complementary_edges.py
@@ -0,0 +1,13 @@
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+
+class ComplementaryEdges(BaseModel):
+    """Struct to contain the edge information of a wall of an extrude/rotate/loft/sweep."""
+
+    adjacent_ids: List[str]
+
+    opposite_id: Optional[str] = None
+
+    model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/cut_strategy.py b/kittycad/models/cut_strategy.py
@@ -0,0 +1,15 @@
+from enum import Enum
+
+
+class CutStrategy(str, Enum):
+    """What strategy (algorithm) should be used for cutting? Defaults to Automatic."""  # noqa: E501
+
+    """# Basic fillet cut. This has limitations, like the filletted edges can't touch each other. But it's very fast and simple. """  # noqa: E501
+    BASIC = "basic"
+    """# More complicated fillet cut. It works for more use-cases, like edges that touch each other. But it's slower than the Basic method. """  # noqa: E501
+    CSG = "csg"
+    """# Tries the Basic method, and if that doesn't work, tries the CSG strategy. """  # noqa: E501
+    AUTOMATIC = "automatic"
+
+    def __str__(self) -> str:
+        return str(self.value)
diff --git a/kittycad/models/entity_circular_pattern.py b/kittycad/models/entity_circular_pattern.py
@@ -1,11 +1,15 @@
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel, ConfigDict
 
+from ..models.face_edge_info import FaceEdgeInfo
+
 
 class EntityCircularPattern(BaseModel):
     """The response from the `EntityCircularPattern` command."""
 
-    entity_ids: List[str]
+    entity_face_edge_ids: Optional[List[FaceEdgeInfo]] = None
+
+    entity_ids: Optional[List[str]] = None
 
     model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/entity_clone.py b/kittycad/models/entity_clone.py
@@ -1,7 +1,15 @@
+from typing import List, Optional
+
 from pydantic import BaseModel, ConfigDict
 
+from ..models.face_edge_info import FaceEdgeInfo
+
 
 class EntityClone(BaseModel):
     """The response from the `EntityClone` command."""
 
+    entity_ids: Optional[List[str]] = None
+
+    face_edge_ids: Optional[List[FaceEdgeInfo]] = None
+
     model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/entity_linear_pattern.py b/kittycad/models/entity_linear_pattern.py
@@ -1,11 +1,15 @@
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel, ConfigDict
 
+from ..models.face_edge_info import FaceEdgeInfo
+
 
 class EntityLinearPattern(BaseModel):
     """The response from the `EntityLinearPattern` command."""
 
-    entity_ids: List[str]
+    entity_face_edge_ids: Optional[List[FaceEdgeInfo]] = None
+
+    entity_ids: Optional[List[str]] = None
 
     model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/entity_linear_pattern_transform.py b/kittycad/models/entity_linear_pattern_transform.py
@@ -1,11 +1,15 @@
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel, ConfigDict
 
+from ..models.face_edge_info import FaceEdgeInfo
+
 
 class EntityLinearPatternTransform(BaseModel):
     """The response from the `EntityLinearPatternTransform` command."""
 
-    entity_ids: List[str]
+    entity_face_edge_ids: Optional[List[FaceEdgeInfo]] = None
+
+    entity_ids: Optional[List[str]] = None
 
     model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/entity_mirror.py b/kittycad/models/entity_mirror.py
@@ -1,11 +1,15 @@
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel, ConfigDict
 
+from ..models.face_edge_info import FaceEdgeInfo
+
 
 class EntityMirror(BaseModel):
     """The response from the `EntityMirror` endpoint."""
 
-    entity_ids: List[str]
+    entity_face_edge_ids: Optional[List[FaceEdgeInfo]] = None
+
+    entity_ids: Optional[List[str]] = None
 
     model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/entity_mirror_across_edge.py b/kittycad/models/entity_mirror_across_edge.py
@@ -1,11 +1,15 @@
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel, ConfigDict
 
+from ..models.face_edge_info import FaceEdgeInfo
+
 
 class EntityMirrorAcrossEdge(BaseModel):
     """The response from the `EntityMirrorAcrossEdge` endpoint."""
 
-    entity_ids: List[str]
+    entity_face_edge_ids: Optional[List[FaceEdgeInfo]] = None
+
+    entity_ids: Optional[List[str]] = None
 
     model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/face_edge_info.py b/kittycad/models/face_edge_info.py
@@ -0,0 +1,15 @@
+from typing import List
+
+from pydantic import BaseModel, ConfigDict
+
+
+class FaceEdgeInfo(BaseModel):
+    """Faces and edges id info (most used in identifying geometry in patterned and mirrored objects)."""
+
+    edges: List[str]
+
+    faces: List[str]
+
+    object_id: str
+
+    model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/modeling_cmd.py b/kittycad/models/modeling_cmd.py
@@ -11,6 +11,7 @@
 from ..models.camera_view_state import CameraViewState
 from ..models.color import Color
 from ..models.component_transform import ComponentTransform
+from ..models.cut_strategy import CutStrategy
 from ..models.cut_type import CutType
 from ..models.distance_type import DistanceType
 from ..models.entity_type import EntityType
@@ -817,12 +818,18 @@ class OptionSolid3DFilletEdge(BaseModel):
 
     cut_type: CutType = "fillet"  # type: ignore
 
-    edge_id: str
+    edge_id: Optional[str] = None
+
+    edge_ids: List[str] = []
+
+    extra_face_ids: List[str] = []
 
     object_id: str
 
     radius: LengthUnit
 
+    strategy: CutStrategy = "automatic"  # type: ignore
+
     tolerance: LengthUnit
 
     type: Literal["solid3d_fillet_edge"] = "solid3d_fillet_edge"
@@ -1486,6 +1493,16 @@ class OptionSolid3DGetExtrusionFaceInfo(BaseModel):
     model_config = ConfigDict(protected_namespaces=())
 
 
+class OptionSolid3DGetInfo(BaseModel):
+    """Get a concise description of all of solids edges."""
+
+    object_id: str
+
+    type: Literal["solid3d_get_info"] = "solid3d_get_info"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
 class OptionSelectClear(BaseModel):
     """Clear the selection"""
 
@@ -1718,6 +1735,7 @@ class OptionSetGridReferencePlane(BaseModel):
             OptionOrientToFace,
             OptionViewIsometric,
             OptionSolid3DGetExtrusionFaceInfo,
+            OptionSolid3DGetInfo,
             OptionSelectClear,
             OptionSelectGet,
             OptionGetNumObjects,
diff --git a/kittycad/models/ok_modeling_cmd_response.py b/kittycad/models/ok_modeling_cmd_response.py
@@ -12,6 +12,7 @@
 from ..models.camera_drag_start import CameraDragStart
 from ..models.center_of_mass import CenterOfMass
 from ..models.close_path import ClosePath
+from ..models.complementary_edges import ComplementaryEdges
 from ..models.curve_get_control_points import CurveGetControlPoints
 from ..models.curve_get_end_points import CurveGetEndPoints
 from ..models.curve_get_type import CurveGetType
@@ -58,6 +59,7 @@
 from ..models.extend_path import ExtendPath
 from ..models.extrude import Extrude
 from ..models.extrusion_face_info import ExtrusionFaceInfo
+from ..models.face_edge_info import FaceEdgeInfo
 from ..models.face_get_center import FaceGetCenter
 from ..models.face_get_gradient import FaceGetGradient
 from ..models.face_get_position import FaceGetPosition
@@ -123,10 +125,12 @@
 from ..models.solid3d_get_all_opposite_edges import Solid3dGetAllOppositeEdges
 from ..models.solid3d_get_common_edge import Solid3dGetCommonEdge
 from ..models.solid3d_get_extrusion_face_info import Solid3dGetExtrusionFaceInfo
+from ..models.solid3d_get_info import Solid3dGetInfo
 from ..models.solid3d_get_next_adjacent_edge import Solid3dGetNextAdjacentEdge
 from ..models.solid3d_get_opposite_edge import Solid3dGetOppositeEdge
 from ..models.solid3d_get_prev_adjacent_edge import Solid3dGetPrevAdjacentEdge
 from ..models.solid3d_shell_face import Solid3dShellFace
+from ..models.solid_info import SolidInfo
 from ..models.start_path import StartPath
 from ..models.surface_area import SurfaceArea
 from ..models.sweep import Sweep
@@ -1301,6 +1305,16 @@ class OptionEntityGetDistance(BaseModel):
     model_config = ConfigDict(protected_namespaces=())
 
 
+class OptionFaceEdgeInfo(BaseModel):
+    """"""
+
+    data: FaceEdgeInfo
+
+    type: Literal["face_edge_info"] = "face_edge_info"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
 class OptionEntityClone(BaseModel):
     """"""
 
@@ -1411,6 +1425,36 @@ class OptionExtrusionFaceInfo(BaseModel):
     model_config = ConfigDict(protected_namespaces=())
 
 
+class OptionComplementaryEdges(BaseModel):
+    """"""
+
+    data: ComplementaryEdges
+
+    type: Literal["complementary_edges"] = "complementary_edges"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionSolid3DGetInfo(BaseModel):
+    """"""
+
+    data: Solid3dGetInfo
+
+    type: Literal["solid3d_get_info"] = "solid3d_get_info"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionSolidInfo(BaseModel):
+    """"""
+
+    data: SolidInfo
+
+    type: Literal["solid_info"] = "solid_info"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
 class OptionSetGridReferencePlane(BaseModel):
     """"""
 
@@ -1570,6 +1614,7 @@ class OptionBooleanSubtract(BaseModel):
             OptionCenterOfMass,
             OptionGetSketchModePlane,
             OptionEntityGetDistance,
+            OptionFaceEdgeInfo,
             OptionEntityClone,
             OptionEntityLinearPatternTransform,
             OptionEntityLinearPattern,
@@ -1581,6 +1626,9 @@ class OptionBooleanSubtract(BaseModel):
             OptionEntityMakeHelixFromEdge,
             OptionSolid3DGetExtrusionFaceInfo,
             OptionExtrusionFaceInfo,
+            OptionComplementaryEdges,
+            OptionSolid3DGetInfo,
+            OptionSolidInfo,
             OptionSetGridReferencePlane,
             OptionBooleanUnion,
             OptionBooleanIntersection,
diff --git a/kittycad/models/solid3d_get_info.py b/kittycad/models/solid3d_get_info.py
@@ -0,0 +1,11 @@
+from pydantic import BaseModel, ConfigDict
+
+from ..models.solid_info import SolidInfo
+
+
+class Solid3dGetInfo(BaseModel):
+    """Extrusion face info struct (useful for maintaining mappings between source path segment ids and extrusion faces)"""
+
+    info: SolidInfo
+
+    model_config = ConfigDict(protected_namespaces=())
diff --git a/kittycad/models/solid_info.py b/kittycad/models/solid_info.py
@@ -0,0 +1,19 @@
+from typing import Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+from ..models.complementary_edges import ComplementaryEdges
+
+
+class SolidInfo(BaseModel):
+    """Solid info struct (useful for maintaining mappings between edges and faces and adjacent/opposite edges)."""
+
+    bottom_cap_id: Optional[str] = None
+
+    common_edges: Dict[str, List[str]]
+
+    complementary_edges: Dict[str, ComplementaryEdges]
+
+    top_cap_id: Optional[str] = None
+
+    model_config = ConfigDict(protected_namespaces=())
diff --git a/spec.json b/spec.json
