Update api spec (#439)

* YOYO NEW API SPEC!

* I have generated the latest API!

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: zoo-github-actions-auth[bot]

kittycad.py.patch.json

@@ -3,19 +3,27 @@
 import httpx
 
 from ...client import Client
+from ...models.code_option import CodeOption
 from ...models.error import Error
 from ...models.kcl_model import KclModel
 from ...types import Response
 
 
 def _get_kwargs(
+    code_option: CodeOption,
     *,
     client: Client,
 ) -> Dict[str, Any]:
     url = "{}/ml/convert/proprietary-to-kcl".format(
         client.base_url,
     )  # noqa: E501
 
+    if code_option is not None:
+        if "?" in url:
+            url = url + "&code_option=" + str(code_option)
+        else:
+            url = url + "?code_option=" + str(code_option)
+
     headers: Dict[str, Any] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
 
@@ -52,10 +60,12 @@ def _build_response(
 
 
 def sync_detailed(
+    code_option: CodeOption,
     *,
     client: Client,
 ) -> Response[Optional[Union[KclModel, Error]]]:
     kwargs = _get_kwargs(
+        code_option=code_option,
         client=client,
     )
 
@@ -68,6 +78,7 @@ def sync_detailed(
 
 
 def sync(
+    code_option: CodeOption,
     *,
     client: Client,
 ) -> Optional[Union[KclModel, Error]]:
@@ -76,15 +87,18 @@ def sync(
     A STEP file does not have feature tree data, so it will not work. A sldprt file does have feature tree data, so it will work."""  # noqa: E501
 
     return sync_detailed(
+        code_option=code_option,
         client=client,
     ).parsed
 
 
 async def asyncio_detailed(
+    code_option: CodeOption,
     *,
     client: Client,
 ) -> Response[Optional[Union[KclModel, Error]]]:
     kwargs = _get_kwargs(
+        code_option=code_option,
         client=client,
     )
 
@@ -95,6 +109,7 @@ async def asyncio_detailed(
 
 
 async def asyncio(
+    code_option: CodeOption,
     *,
     client: Client,
 ) -> Optional[Union[KclModel, Error]]:
@@ -104,6 +119,7 @@ async def asyncio(
 
     return (
         await asyncio_detailed(
+            code_option=code_option,
             client=client,
         )
     ).parsed

kittycad/api/ml/create_proprietary_to_kcl.py

@@ -241,6 +241,7 @@
 from kittycad.models.base64data import Base64Data
 from kittycad.models.billing_info import BillingInfo
 from kittycad.models.code_language import CodeLanguage
+from kittycad.models.code_option import CodeOption
 from kittycad.models.create_shortlink_request import CreateShortlinkRequest
 from kittycad.models.created_at_sort_mode import CreatedAtSortMode
 from kittycad.models.crm_data import CrmData
@@ -1916,6 +1917,7 @@ def test_create_proprietary_to_kcl():
 
     result: Optional[Union[KclModel, Error]] = create_proprietary_to_kcl.sync(
         client=client,
+        code_option=CodeOption.PARSE,
     )
 
     if isinstance(result, Error) or result is None:
@@ -1929,6 +1931,7 @@ def test_create_proprietary_to_kcl():
     response: Response[Optional[Union[KclModel, Error]]] = (
         create_proprietary_to_kcl.sync_detailed(
             client=client,
+            code_option=CodeOption.PARSE,
         )
     )
 
@@ -1942,13 +1945,15 @@ async def test_create_proprietary_to_kcl_async():
 
     result: Optional[Union[KclModel, Error]] = await create_proprietary_to_kcl.asyncio(
         client=client,
+        code_option=CodeOption.PARSE,
     )
 
     # OR run async with more info
     response: Response[
         Optional[Union[KclModel, Error]]
     ] = await create_proprietary_to_kcl.asyncio_detailed(
         client=client,
+        code_option=CodeOption.PARSE,
     )
 
 

kittycad/examples_test.py

@@ -4,6 +4,7 @@
 from .add_hole_from_offset import AddHoleFromOffset
 from .add_org_member import AddOrgMember
 from .address_details import AddressDetails
+from .adjacency_info import AdjacencyInfo
 from .angle import Angle
 from .annotation_line_end import AnnotationLineEnd
 from .annotation_line_end_options import AnnotationLineEndOptions
@@ -50,6 +51,7 @@
 from .close_path import ClosePath
 from .cluster import Cluster
 from .code_language import CodeLanguage
+from .code_option import CodeOption
 from .code_output import CodeOutput
 from .color import Color
 from .complementary_edges import ComplementaryEdges
@@ -94,6 +96,7 @@
 from .discount_code import DiscountCode
 from .distance_type import DistanceType
 from .dxf_storage import DxfStorage
+from .edge_info import EdgeInfo
 from .edge_lines_visible import EdgeLinesVisible
 from .email_authentication_form import EmailAuthenticationForm
 from .empty import Empty
@@ -266,6 +269,7 @@
 from .project_points_to_plane import ProjectPointsToPlane
 from .raw_file import RawFile
 from .reconfigure_stream import ReconfigureStream
+from .relative_to import RelativeTo
 from .remove_scene_objects import RemoveSceneObjects
 from .revolve import Revolve
 from .revolve_about_edge import RevolveAboutEdge
@@ -306,16 +310,15 @@
 from .sketch_mode_disable import SketchModeDisable
 from .solid2d_add_hole import Solid2dAddHole
 from .solid3d_fillet_edge import Solid3dFilletEdge
+from .solid3d_get_adjacency_info import Solid3dGetAdjacencyInfo
 from .solid3d_get_all_edge_faces import Solid3dGetAllEdgeFaces
 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

kittycad/models/__init__.py

@@ -0,0 +1,17 @@
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict
+
+from ..models.edge_info import EdgeInfo
+
+
+class AdjacencyInfo(BaseModel):
+    """Edge info struct (useful for maintaining mappings between edges and faces and adjacent/opposite edges)."""
+
+    adjacent_info: Optional[EdgeInfo] = None
+
+    opposite_info: Optional[EdgeInfo] = None
+
+    original_info: Optional[EdgeInfo] = None
+
+    model_config = ConfigDict(protected_namespaces=())

kittycad/models/adjacency_info.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+
+class CodeOption(str, Enum):
+    """Code option for running and verifying kcl.
+
+    <details><summary>JSON schema</summary>
+
+    ```json { "title": "CodeOption", "description": "Code option for running and verifying kcl.", "type": "string", "enum": [ "parse", "execute", "cleanup", "mock_execute" ] } ``` </details>"""  # noqa: E501
+
+    PARSE = "parse"
+    EXECUTE = "execute"
+    CLEANUP = "cleanup"
+    MOCK_EXECUTE = "mock_execute"
+
+    def __str__(self) -> str:
+        return str(self.value)

kittycad/models/code_option.py

@@ -0,0 +1,13 @@
+from typing import List
+
+from pydantic import BaseModel, ConfigDict
+
+
+class EdgeInfo(BaseModel):
+    """A list of faces for a specific edge."""
+
+    edge_id: str
+
+    faces: List[str]
+
+    model_config = ConfigDict(protected_namespaces=())

kittycad/models/edge_info.py

@@ -31,6 +31,7 @@
 from ..models.perspective_camera_parameters import PerspectiveCameraParameters
 from ..models.point2d import Point2d
 from ..models.point3d import Point3d
+from ..models.relative_to import RelativeTo
 from ..models.scene_selection_type import SceneSelectionType
 from ..models.scene_tool_type import SceneToolType
 from ..models.transform import Transform
@@ -104,6 +105,8 @@ class OptionExtrude(BaseModel):
 class OptionSweep(BaseModel):
     """Extrude the object along a path."""
 
+    relative_to: RelativeTo = "sketch_plane"  # type: ignore
+
     sectional: bool
 
     target: ModelingCmdId
@@ -1493,12 +1496,14 @@ class OptionSolid3DGetExtrusionFaceInfo(BaseModel):
     model_config = ConfigDict(protected_namespaces=())
 
 
-class OptionSolid3DGetInfo(BaseModel):
+class OptionSolid3DGetAdjacencyInfo(BaseModel):
     """Get a concise description of all of solids edges."""
 
+    edge_id: str
+
     object_id: str
 
-    type: Literal["solid3d_get_info"] = "solid3d_get_info"
+    type: Literal["solid3d_get_adjacency_info"] = "solid3d_get_adjacency_info"
 
     model_config = ConfigDict(protected_namespaces=())
 
@@ -1735,7 +1740,7 @@ class OptionSetGridReferencePlane(BaseModel):
             OptionOrientToFace,
             OptionViewIsometric,
             OptionSolid3DGetExtrusionFaceInfo,
-            OptionSolid3DGetInfo,
+            OptionSolid3DGetAdjacencyInfo,
             OptionSelectClear,
             OptionSelectGet,
             OptionGetNumObjects,

kittycad/models/modeling_cmd.py

@@ -4,6 +4,7 @@
 from typing_extensions import Annotated
 
 from ..models.add_hole_from_offset import AddHoleFromOffset
+from ..models.adjacency_info import AdjacencyInfo
 from ..models.boolean_intersection import BooleanIntersection
 from ..models.boolean_subtract import BooleanSubtract
 from ..models.boolean_union import BooleanUnion
@@ -32,6 +33,7 @@
 from ..models.default_camera_zoom import DefaultCameraZoom
 from ..models.density import Density
 from ..models.disable_dry_run import DisableDryRun
+from ..models.edge_info import EdgeInfo
 from ..models.edge_lines_visible import EdgeLinesVisible
 from ..models.enable_dry_run import EnableDryRun
 from ..models.enable_sketch_mode import EnableSketchMode
@@ -121,16 +123,15 @@
 from ..models.sketch_mode_disable import SketchModeDisable
 from ..models.solid2d_add_hole import Solid2dAddHole
 from ..models.solid3d_fillet_edge import Solid3dFilletEdge
+from ..models.solid3d_get_adjacency_info import Solid3dGetAdjacencyInfo
 from ..models.solid3d_get_all_edge_faces import Solid3dGetAllEdgeFaces
 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
@@ -963,6 +964,16 @@ class OptionSelectGet(BaseModel):
     model_config = ConfigDict(protected_namespaces=())
 
 
+class OptionSolid3DGetAdjacencyInfo(BaseModel):
+    """"""
+
+    data: Solid3dGetAdjacencyInfo
+
+    type: Literal["solid3d_get_adjacency_info"] = "solid3d_get_adjacency_info"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
 class OptionSolid3DGetAllEdgeFaces(BaseModel):
     """"""
 
@@ -1315,6 +1326,16 @@ class OptionFaceEdgeInfo(BaseModel):
     model_config = ConfigDict(protected_namespaces=())
 
 
+class OptionEdgeInfo(BaseModel):
+    """"""
+
+    data: EdgeInfo
+
+    type: Literal["edge_info"] = "edge_info"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
 class OptionEntityClone(BaseModel):
     """"""
 
@@ -1435,22 +1456,12 @@ class OptionComplementaryEdges(BaseModel):
     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):
+class OptionAdjacencyInfo(BaseModel):
     """"""
 
-    data: SolidInfo
+    data: AdjacencyInfo
 
-    type: Literal["solid_info"] = "solid_info"
+    type: Literal["adjacency_info"] = "adjacency_info"
 
     model_config = ConfigDict(protected_namespaces=())
 
@@ -1580,6 +1591,7 @@ class OptionBooleanSubtract(BaseModel):
             OptionAddHoleFromOffset,
             OptionDefaultCameraFocusOn,
             OptionSelectGet,
+            OptionSolid3DGetAdjacencyInfo,
             OptionSolid3DGetAllEdgeFaces,
             OptionSolid3DGetAllOppositeEdges,
             OptionSolid3DGetOppositeEdge,
@@ -1615,6 +1627,7 @@ class OptionBooleanSubtract(BaseModel):
             OptionGetSketchModePlane,
             OptionEntityGetDistance,
             OptionFaceEdgeInfo,
+            OptionEdgeInfo,
             OptionEntityClone,
             OptionEntityLinearPatternTransform,
             OptionEntityLinearPattern,
@@ -1627,8 +1640,7 @@ class OptionBooleanSubtract(BaseModel):
             OptionSolid3DGetExtrusionFaceInfo,
             OptionExtrusionFaceInfo,
             OptionComplementaryEdges,
-            OptionSolid3DGetInfo,
-            OptionSolidInfo,
+            OptionAdjacencyInfo,
             OptionSetGridReferencePlane,
             OptionBooleanUnion,
             OptionBooleanIntersection,