Update api spec (#604)

* YOYO NEW API SPEC!

* I have generated the latest API!

---------

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

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

kittycad.py.patch.json

@@ -187,7 +187,7 @@
     "op": "add",
     "path": "/paths/~1file~1conversion/post/x-python",
     "value": {
-      "example": "from kittycad.models.conversion_params import ConversionParams\nfrom kittycad.models.output_format3d import OptionPly\nfrom kittycad.models.system import System\nfrom kittycad.models.axis_direction_pair import AxisDirectionPair\nfrom kittycad.models.axis import Axis\nfrom kittycad.models.direction import Direction\nfrom kittycad.models.axis_direction_pair import AxisDirectionPair\nfrom kittycad.models.axis import Axis\nfrom kittycad.models.direction import Direction\nfrom kittycad.models.selection import OptionDefaultScene\nfrom kittycad.models.selection import Selection\nfrom kittycad.models.ply_storage import PlyStorage\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.models.output_format3d import OutputFormat3d\nfrom kittycad.models.input_format3d import OptionPly\nfrom kittycad.models.system import System\nfrom kittycad.models.axis_direction_pair import AxisDirectionPair\nfrom kittycad.models.axis import Axis\nfrom kittycad.models.direction import Direction\nfrom kittycad.models.axis_direction_pair import AxisDirectionPair\nfrom kittycad.models.axis import Axis\nfrom kittycad.models.direction import Direction\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.models.input_format3d import InputFormat3d\nfrom pathlib import Path\nfrom typing import Dict\nfrom kittycad._io_types import SyncUpload\nfrom kittycad.models import FileConversion\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_create_file_conversion_options():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: FileConversion = client.file.create_file_conversion_options(body=ConversionParams(\n        output_format=OutputFormat3d(OptionPly(\n        coords=System(\n        forward=AxisDirectionPair(\n        axis=Axis.Y,\n        direction=Direction.POSITIVE,\n        ),\n        up=AxisDirectionPair(\n        axis=Axis.Y,\n        direction=Direction.POSITIVE,\n        ),\n        ),\n        selection=Selection(OptionDefaultScene()),\n        storage=PlyStorage.ASCII,\n        units=UnitLength.CM,\n        )),\n        src_format=InputFormat3d(OptionPly(\n        coords=System(\n        forward=AxisDirectionPair(\n        axis=Axis.Y,\n        direction=Direction.POSITIVE,\n        ),\n        up=AxisDirectionPair(\n        axis=Axis.Y,\n        direction=Direction.POSITIVE,\n        ),\n        ),\n        units=UnitLength.CM,\n        )),\n        ),\n        file_attachments={\n        \"main.kcl\": Path(\"path/to/main.kcl\"),\n        \"helper.kcl\": Path(\"path/to/helper.kcl\"),\n        })\n\n\n    body: FileConversion = result\n    print(body)\n\n",
+      "example": "from kittycad.models.conversion_params import ConversionParams\nfrom kittycad.models.output_format3d import OptionGltf\nfrom kittycad.models.gltf_presentation import GltfPresentation\nfrom kittycad.models.gltf_storage import GltfStorage\nfrom kittycad.models.output_format3d import OutputFormat3d\nfrom kittycad.models.input_format3d import OptionStl\nfrom kittycad.models.system import System\nfrom kittycad.models.axis_direction_pair import AxisDirectionPair\nfrom kittycad.models.axis import Axis\nfrom kittycad.models.direction import Direction\nfrom kittycad.models.axis_direction_pair import AxisDirectionPair\nfrom kittycad.models.axis import Axis\nfrom kittycad.models.direction import Direction\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.models.input_format3d import InputFormat3d\nfrom pathlib import Path\nfrom typing import Dict\nfrom kittycad._io_types import SyncUpload\nfrom kittycad.models import FileConversion\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_create_file_conversion_options():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: FileConversion = client.file.create_file_conversion_options(body=ConversionParams(\n        output_format=OutputFormat3d(OptionGltf(\n        presentation=GltfPresentation.COMPACT,\n        storage=GltfStorage.BINARY,\n        )),\n        src_format=InputFormat3d(OptionStl(\n        coords=System(\n        forward=AxisDirectionPair(\n        axis=Axis.Y,\n        direction=Direction.POSITIVE,\n        ),\n        up=AxisDirectionPair(\n        axis=Axis.Y,\n        direction=Direction.POSITIVE,\n        ),\n        ),\n        units=UnitLength.CM,\n        )),\n        ),\n        file_attachments={\n        \"main.kcl\": Path(\"path/to/main.kcl\"),\n        \"helper.kcl\": Path(\"path/to/helper.kcl\"),\n        })\n\n\n    body: FileConversion = result\n    print(body)\n\n",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.file"
     }
   },
@@ -1379,23 +1379,23 @@
     "op": "add",
     "path": "/paths/~1ws~1ml~1copilot/get/x-python",
     "value": {
-      "example": "from kittycad.models import MlCopilotClientMessage\nfrom kittycad.models.ml_copilot_client_message import OptionHeaders\nfrom kittycad.models import MlCopilotServerMessage\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_ml_copilot_ws():\n            client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n            # Connect to the websocket.\n            with client.ml.ml_copilot_ws(conversation_id=None,\n        replay=None,\n        pr=None) as websocket:\n\n                # Send a message.\n                websocket.send(MlCopilotClientMessage(OptionHeaders(\nheaders={\"<string>\": \"<string>\"},\n)))\n\n                # Get a message.\n                message = websocket.recv()\n                print(message)\n\n        ",
+      "example": "from kittycad.models import MlCopilotClientMessage\nfrom kittycad.models.ml_copilot_client_message import OptionUser\nfrom kittycad.models.ml_copilot_file import MlCopilotFile\nfrom typing import List\nfrom kittycad.models.ml_copilot_tool import MlCopilotTool\nfrom typing import List\nfrom kittycad.models.source_range_prompt import SourceRangePrompt\nfrom kittycad.models.source_range import SourceRange\nfrom kittycad.models.source_position import SourcePosition\nfrom kittycad.models.source_position import SourcePosition\nfrom typing import List\nfrom kittycad.models import MlCopilotServerMessage\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_ml_copilot_ws():\n            client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n            # Connect to the websocket.\n            with client.ml.ml_copilot_ws(conversation_id=None,\n        replay=None,\n        pr=None) as websocket:\n\n                # Send a message.\n                websocket.send(MlCopilotClientMessage(OptionUser(\nadditional_files=[MlCopilotFile(\ndata=b\"<bytes>\",\n\nmimetype=\"<string>\",\n\nname=\"<string>\",\n)],\n\ncontent=\"<string>\",\n\ncurrent_files={\"<string>\": b\"<bytes>\"},\n\nforced_tools=[MlCopilotTool.EDIT_KCL_CODE],\n\nsource_ranges=[SourceRangePrompt(\nprompt=\"<string>\",\n\nrange=SourceRange(\nend=SourcePosition(\ncolumn=10,\n\nline=10,\n),\n\nstart=SourcePosition(\ncolumn=10,\n\nline=10,\n),\n),\n)],\n)))\n\n                # Get a message.\n                message = websocket.recv()\n                print(message)\n\n        ",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.ml"
     }
   },
   {
     "op": "add",
     "path": "/paths/~1ws~1ml~1reasoning~1{id}/get/x-python",
     "value": {
-      "example": "from kittycad.models import MlCopilotClientMessage\nfrom kittycad.models.ml_copilot_client_message import OptionSystem\nfrom kittycad.models.ml_copilot_system_command import MlCopilotSystemCommand\nfrom kittycad.models import MlCopilotServerMessage\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_ml_reasoning_ws():\n            client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n            # Connect to the websocket.\n            with client.ml.ml_reasoning_ws(id=\"<string>\") as websocket:\n\n                # Send a message.\n                websocket.send(MlCopilotClientMessage(OptionSystem(\ncommand=MlCopilotSystemCommand.NEW,\n)))\n\n                # Get a message.\n                message = websocket.recv()\n                print(message)\n\n        ",
+      "example": "from kittycad.models import MlCopilotClientMessage\nfrom kittycad.models.ml_copilot_client_message import OptionHeaders\nfrom kittycad.models import MlCopilotServerMessage\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_ml_reasoning_ws():\n            client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n            # Connect to the websocket.\n            with client.ml.ml_reasoning_ws(id=\"<string>\") as websocket:\n\n                # Send a message.\n                websocket.send(MlCopilotClientMessage(OptionHeaders(\nheaders={\"<string>\": \"<string>\"},\n)))\n\n                # Get a message.\n                message = websocket.recv()\n                print(message)\n\n        ",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.ml"
     }
   },
   {
     "op": "add",
     "path": "/paths/~1ws~1modeling~1commands/get/x-python",
     "value": {
-      "example": "from kittycad.models.post_effect_type import PostEffectType\nfrom kittycad.models import WebSocketRequest\nfrom kittycad.models.web_socket_request import OptionModelingCmdReq\nfrom kittycad.models.modeling_cmd import OptionEntityFade\nfrom kittycad.models.modeling_cmd import ModelingCmd\nfrom kittycad.models.modeling_cmd_id import ModelingCmdId\nfrom kittycad.models.modeling_cmd_id import ModelingCmdId\nfrom kittycad.models import WebSocketResponse\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_modeling_commands_ws():\n            client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n            # Connect to the websocket.\n            with client.modeling.modeling_commands_ws(fps=10,\n        order_independent_transparency=False,\n        post_effect=PostEffectType.PHOSPHOR,\n        show_grid=False,\n        unlocked_framerate=False,\n        video_res_height=10,\n        video_res_width=10,\n        webrtc=False,\n        api_call_id=None,\n        pool=None,\n        replay=None,\n        pr=None) as websocket:\n\n                # Send a message.\n                websocket.send(WebSocketRequest(OptionModelingCmdReq(\ncmd=ModelingCmd(OptionEntityFade(\nduration_seconds=3.14,\n\nentity_id=\"<string>\",\n\nfade_in=False,\n)),\n\ncmd_id=ModelingCmdId(\"<string>\"),\n)))\n\n                # Get a message.\n                message = websocket.recv()\n                print(message)\n\n        ",
+      "example": "from kittycad.models.post_effect_type import PostEffectType\nfrom kittycad.models import WebSocketRequest\nfrom kittycad.models.web_socket_request import OptionModelingCmdReq\nfrom kittycad.models.modeling_cmd import OptionEntityMakeHelix\nfrom kittycad.models.angle import Angle\nfrom kittycad.models.unit_angle import UnitAngle\nfrom kittycad.models.modeling_cmd import ModelingCmd\nfrom kittycad.models.modeling_cmd_id import ModelingCmdId\nfrom kittycad.models.modeling_cmd_id import ModelingCmdId\nfrom kittycad.models import WebSocketResponse\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_modeling_commands_ws():\n            client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n            # Connect to the websocket.\n            with client.modeling.modeling_commands_ws(fps=10,\n        order_independent_transparency=False,\n        post_effect=PostEffectType.PHOSPHOR,\n        show_grid=False,\n        unlocked_framerate=False,\n        video_res_height=10,\n        video_res_width=10,\n        webrtc=False,\n        api_call_id=None,\n        pool=None,\n        replay=None,\n        pr=None) as websocket:\n\n                # Send a message.\n                websocket.send(WebSocketRequest(OptionModelingCmdReq(\ncmd=ModelingCmd(OptionEntityMakeHelix(\ncylinder_id=\"<string>\",\n\nis_clockwise=False,\n\nrevolutions=3.14,\n\nstart_angle=Angle(\nunit=UnitAngle.DEGREES,\n\nvalue=3.14,\n),\n)),\n\ncmd_id=ModelingCmdId(\"<string>\"),\n)))\n\n                # Get a message.\n                message = websocket.recv()\n                print(message)\n\n        ",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.modeling"
     }
   }

kittycad/models/__init__.py

@@ -48,6 +48,7 @@
 from .boolean_intersection import BooleanIntersection
 from .boolean_subtract import BooleanSubtract
 from .boolean_union import BooleanUnion
+from .bounding_box import BoundingBox
 from .cad_discovery_source import CadDiscoverySource
 from .cad_industry import CadIndustry
 from .cad_user_type import CadUserType
@@ -62,6 +63,7 @@
 from .center_of_mass import CenterOfMass
 from .client_metrics import ClientMetrics
 from .close_path import ClosePath
+from .closest_edge import ClosestEdge
 from .code_language import CodeLanguage
 from .code_option import CodeOption
 from .code_output import CodeOutput
@@ -78,6 +80,7 @@
 from .create_custom_model import CreateCustomModel
 from .create_org_dataset import CreateOrgDataset
 from .create_region import CreateRegion
+from .create_region_from_query_point import CreateRegionFromQueryPoint
 from .create_shortlink_request import CreateShortlinkRequest
 from .create_shortlink_response import CreateShortlinkResponse
 from .created_at_sort_mode import CreatedAtSortMode
@@ -246,6 +249,7 @@
 from .object_bring_to_front import ObjectBringToFront
 from .object_set_material_params_pbr import ObjectSetMaterialParamsPbr
 from .object_visible import ObjectVisible
+from .offset_surface import OffsetSurface
 from .ok_modeling_cmd_response import OkModelingCmdResponse
 from .ok_web_socket_response_data import OkWebSocketResponseData
 from .opposite_for_angle import OppositeForAngle
@@ -309,6 +313,7 @@
 from .raw_file import RawFile
 from .reasoning_message import ReasoningMessage
 from .reconfigure_stream import ReconfigureStream
+from .region_get_query_point import RegionGetQueryPoint
 from .relative_to import RelativeTo
 from .remove_scene_objects import RemoveSceneObjects
 from .revolve import Revolve

kittycad/models/bounding_box.py

@@ -0,0 +1,10 @@
+from ..models.point3d import Point3d
+from .base import KittyCadBaseModel
+
+
+class BoundingBox(KittyCadBaseModel):
+    """The response from the 'BoundingBox'."""
+
+    center: Point3d
+
+    dimensions: Point3d

kittycad/models/closest_edge.py

@@ -0,0 +1,9 @@
+from typing import Optional
+
+from .base import KittyCadBaseModel
+
+
+class ClosestEdge(KittyCadBaseModel):
+    """The response from the 'ClosestEdge'."""
+
+    edge_id: Optional[str] = None

kittycad/models/create_region_from_query_point.py

@@ -0,0 +1,5 @@
+from .base import KittyCadBaseModel
+
+
+class CreateRegionFromQueryPoint(KittyCadBaseModel):
+    """The response from the 'CreateRegionFromQueryPoint'. The region should have an ID taken from the ID of the 'CreateRegionFromQueryPoint' modeling command."""

kittycad/models/modeling_cmd.py

@@ -1528,10 +1528,14 @@ class OptionBooleanImprint(KittyCadBaseModel):
 
     body_ids: List[str]
 
+    keep_tools: bool = False
+
     separate_bodies: bool = False
 
     tolerance: LengthUnit
 
+    tool_ids: Optional[List[str]] = None
+
     type: Literal["boolean_imprint"] = "boolean_imprint"
 
 
@@ -1609,6 +1613,24 @@ class OptionCreateRegion(KittyCadBaseModel):
     type: Literal["create_region"] = "create_region"
 
 
+class OptionCreateRegionFromQueryPoint(KittyCadBaseModel):
+    """Create a region with a query point. The region should have an ID taken from the ID of the 'CreateRegionFromQueryPoint' modeling command."""
+
+    object_id: str
+
+    query_point: Point2d
+
+    type: Literal["create_region_from_query_point"] = "create_region_from_query_point"
+
+
+class OptionRegionGetQueryPoint(KittyCadBaseModel):
+    """Finds a suitable point inside the region for calling such that CreateRegionFromQueryPoint will generate an identical region."""
+
+    region_id: str
+
+    type: Literal["region_get_query_point"] = "region_get_query_point"
+
+
 class OptionSelectRegionFromPoint(KittyCadBaseModel):
     """The user clicked on a point in the window, returns the region the user clicked on, if any."""
 
@@ -1617,6 +1639,36 @@ class OptionSelectRegionFromPoint(KittyCadBaseModel):
     type: Literal["select_region_from_point"] = "select_region_from_point"
 
 
+class OptionBoundingBox(KittyCadBaseModel):
+    """Get the smallest box that could contain the given parts."""
+
+    entity_ids: List[str]
+
+    type: Literal["bounding_box"] = "bounding_box"
+
+
+class OptionOffsetSurface(KittyCadBaseModel):
+    """Offset a surface by a given distance."""
+
+    distance: LengthUnit
+
+    flip: bool
+
+    surface_id: str
+
+    type: Literal["offset_surface"] = "offset_surface"
+
+
+class OptionClosestEdge(KittyCadBaseModel):
+    """Returns the closest edge to this point."""
+
+    closest_to: Point3d
+
+    object_id: Optional[str] = None
+
+    type: Literal["closest_edge"] = "closest_edge"
+
+
 ModelingCmd = RootModel[
     Annotated[
         Union[
@@ -1767,7 +1819,12 @@ class OptionSelectRegionFromPoint(KittyCadBaseModel):
             OptionSetGridAutoScale,
             OptionSetOrderIndependentTransparency,
             OptionCreateRegion,
+            OptionCreateRegionFromQueryPoint,
+            OptionRegionGetQueryPoint,
             OptionSelectRegionFromPoint,
+            OptionBoundingBox,
+            OptionOffsetSurface,
+            OptionClosestEdge,
         ],
         Field(discriminator="type"),
     ]

kittycad/models/offset_surface.py

@@ -0,0 +1,5 @@
+from .base import KittyCadBaseModel
+
+
+class OffsetSurface(KittyCadBaseModel):
+    """The response from the 'OffsetSurface'."""