Update api spec (#527)

* 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

@@ -179,7 +179,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 OptionMeshByIndex\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 OptionGltf\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(OptionMeshByIndex(\n        index=10,\n        )),\n        storage=PlyStorage.ASCII,\n        units=UnitLength.CM,\n        )),\n        src_format=InputFormat3d(OptionGltf()),\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 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 OptionSldprt\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(OptionSldprt(\n        split_closed_faces=False,\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"
     }
   },
@@ -571,15 +571,15 @@
     "op": "add",
     "path": "/paths/~1org~1saml~1idp/post/x-python",
     "value": {
-      "example": "from kittycad.models.saml_identity_provider_create import SamlIdentityProviderCreate\nfrom kittycad.models.idp_metadata_source import OptionBase64EncodedXml\nfrom kittycad.models.base64data import Base64Data\nfrom kittycad.models.idp_metadata_source import IdpMetadataSource\nfrom kittycad.models import SamlIdentityProvider\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_create_org_saml_idp():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: SamlIdentityProvider = client.orgs.create_org_saml_idp(body=SamlIdentityProviderCreate(\n        idp_entity_id=\"<string>\",\n        idp_metadata_source=IdpMetadataSource(OptionBase64EncodedXml(\n        data=Base64Data(b\"<bytes>\"),\n        )),\n        technical_contact_email=\"<string>\",\n        ))\n\n\n    body: SamlIdentityProvider = result\n    print(body)\n\n",
+      "example": "from kittycad.models.saml_identity_provider_create import SamlIdentityProviderCreate\nfrom kittycad.models.idp_metadata_source import OptionUrl\nfrom kittycad.models.idp_metadata_source import IdpMetadataSource\nfrom kittycad.models import SamlIdentityProvider\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_create_org_saml_idp():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: SamlIdentityProvider = client.orgs.create_org_saml_idp(body=SamlIdentityProviderCreate(\n        idp_entity_id=\"<string>\",\n        idp_metadata_source=IdpMetadataSource(OptionUrl(\n        url=\"<string>\",\n        )),\n        technical_contact_email=\"<string>\",\n        ))\n\n\n    body: SamlIdentityProvider = result\n    print(body)\n\n",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.orgs"
     }
   },
   {
     "op": "add",
     "path": "/paths/~1org~1saml~1idp/put/x-python",
     "value": {
-      "example": "from kittycad.models.saml_identity_provider_create import SamlIdentityProviderCreate\nfrom kittycad.models.idp_metadata_source import OptionBase64EncodedXml\nfrom kittycad.models.base64data import Base64Data\nfrom kittycad.models.idp_metadata_source import IdpMetadataSource\nfrom kittycad.models import SamlIdentityProvider\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_update_org_saml_idp():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: SamlIdentityProvider = client.orgs.update_org_saml_idp(body=SamlIdentityProviderCreate(\n        idp_entity_id=\"<string>\",\n        idp_metadata_source=IdpMetadataSource(OptionBase64EncodedXml(\n        data=Base64Data(b\"<bytes>\"),\n        )),\n        technical_contact_email=\"<string>\",\n        ))\n\n\n    body: SamlIdentityProvider = result\n    print(body)\n\n",
+      "example": "from kittycad.models.saml_identity_provider_create import SamlIdentityProviderCreate\nfrom kittycad.models.idp_metadata_source import OptionUrl\nfrom kittycad.models.idp_metadata_source import IdpMetadataSource\nfrom kittycad.models import SamlIdentityProvider\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_update_org_saml_idp():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: SamlIdentityProvider = client.orgs.update_org_saml_idp(body=SamlIdentityProviderCreate(\n        idp_entity_id=\"<string>\",\n        idp_metadata_source=IdpMetadataSource(OptionUrl(\n        url=\"<string>\",\n        )),\n        technical_contact_email=\"<string>\",\n        ))\n\n\n    body: SamlIdentityProvider = result\n    print(body)\n\n",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.orgs"
     }
   },
@@ -1163,7 +1163,7 @@
     "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 OptionHeaders\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        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) as websocket:\n\n                # Send a message.\n                websocket.send(WebSocketRequest(OptionHeaders(\nheaders={\"<string>\": \"<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 OptionTrickleIce\nfrom kittycad.models.rtc_ice_candidate_init import RtcIceCandidateInit\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        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) as websocket:\n\n                # Send a message.\n                websocket.send(WebSocketRequest(OptionTrickleIce(\ncandidate=RtcIceCandidateInit(\ncandidate=\"<string>\",\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.modeling"
     }
   }

kittycad/models/__init__.py

@@ -6,8 +6,13 @@
 from .address_details import AddressDetails
 from .adjacency_info import AdjacencyInfo
 from .angle import Angle
+from .annotation_basic_dimension import AnnotationBasicDimension
+from .annotation_feature_control import AnnotationFeatureControl
+from .annotation_feature_tag import AnnotationFeatureTag
 from .annotation_line_end import AnnotationLineEnd
 from .annotation_line_end_options import AnnotationLineEndOptions
+from .annotation_mbd_basic_dimension import AnnotationMbdBasicDimension
+from .annotation_mbd_control_frame import AnnotationMbdControlFrame
 from .annotation_options import AnnotationOptions
 from .annotation_text_alignment_x import AnnotationTextAlignmentX
 from .annotation_text_alignment_y import AnnotationTextAlignmentY
@@ -75,6 +80,7 @@
 from .customer_balance import CustomerBalance
 from .cut_strategy import CutStrategy
 from .cut_type import CutType
+from .cut_type_v2 import CutTypeV2
 from .default_camera_center_to_scene import DefaultCameraCenterToScene
 from .default_camera_center_to_selection import DefaultCameraCenterToSelection
 from .default_camera_focus_on import DefaultCameraFocusOn
@@ -136,6 +142,8 @@
 from .extended_user_results_page import ExtendedUserResultsPage
 from .extrude import Extrude
 from .extrude_method import ExtrudeMethod
+from .extrude_reference import ExtrudeReference
+from .extrude_to_reference import ExtrudeToReference
 from .extruded_face_info import ExtrudedFaceInfo
 from .extrusion_face_cap_type import ExtrusionFaceCapType
 from .extrusion_face_info import ExtrusionFaceInfo
@@ -188,6 +196,7 @@
 from .make_offset_path import MakeOffsetPath
 from .make_plane import MakePlane
 from .mass import Mass
+from .mbd_symbol import MbdSymbol
 from .method import Method
 from .ml_copilot_client_message import MlCopilotClientMessage
 from .ml_copilot_server_message import MlCopilotServerMessage
@@ -310,6 +319,7 @@
 from .side_face import SideFace
 from .sketch_mode_disable import SketchModeDisable
 from .solid2d_add_hole import Solid2dAddHole
+from .solid3d_cut_edges import Solid3dCutEdges
 from .solid3d_fillet_edge import Solid3dFilletEdge
 from .solid3d_get_adjacency_info import Solid3dGetAdjacencyInfo
 from .solid3d_get_all_edge_faces import Solid3dGetAllEdgeFaces

kittycad/models/annotation_basic_dimension.py

@@ -0,0 +1,27 @@
+from ..models.annotation_mbd_basic_dimension import AnnotationMbdBasicDimension
+from ..models.point2d import Point2d
+from .base import KittyCadBaseModel
+
+
+class AnnotationBasicDimension(KittyCadBaseModel):
+    """Parameters for defining an MBD Basic Dimension Annotation state which is measured between two positions in 3D"""
+
+    dimension: AnnotationMbdBasicDimension
+
+    font_point_size: int
+
+    font_scale: float
+
+    from_entity_id: str
+
+    from_entity_pos: Point2d
+
+    offset: Point2d
+
+    plane_id: str
+
+    precision: int
+
+    to_entity_id: str
+
+    to_entity_pos: Point2d

kittycad/models/annotation_feature_control.py

@@ -0,0 +1,37 @@
+from typing import Optional
+
+from ..models.annotation_line_end import AnnotationLineEnd
+from ..models.annotation_mbd_basic_dimension import AnnotationMbdBasicDimension
+from ..models.annotation_mbd_control_frame import AnnotationMbdControlFrame
+from ..models.point2d import Point2d
+from .base import KittyCadBaseModel
+
+
+class AnnotationFeatureControl(KittyCadBaseModel):
+    """Parameters for defining an MBD Feature Control Annotation state"""
+
+    control_frame: Optional[AnnotationMbdControlFrame] = None
+
+    defined_datum: Optional[str] = None
+
+    dimension: Optional[AnnotationMbdBasicDimension] = None
+
+    entity_id: str
+
+    entity_pos: Point2d
+
+    font_point_size: int
+
+    font_scale: float
+
+    leader_type: AnnotationLineEnd
+
+    offset: Point2d
+
+    plane_id: str
+
+    precision: int
+
+    prefix: Optional[str] = None
+
+    suffix: Optional[str] = None

kittycad/models/annotation_feature_tag.py

@@ -0,0 +1,27 @@
+from ..models.annotation_line_end import AnnotationLineEnd
+from ..models.point2d import Point2d
+from .base import KittyCadBaseModel
+
+
+class AnnotationFeatureTag(KittyCadBaseModel):
+    """Parameters for defining an MBD Feature Tag Annotation state"""
+
+    entity_id: str
+
+    entity_pos: Point2d
+
+    font_point_size: int
+
+    font_scale: float
+
+    key: str
+
+    leader_type: AnnotationLineEnd
+
+    offset: Point2d
+
+    plane_id: str
+
+    show_key: bool
+
+    value: str

kittycad/models/annotation_line_end.py

@@ -8,5 +8,7 @@ class AnnotationLineEnd(str, Enum):
 
     ARROW = "arrow"
 
+    DOT = "dot"
+
     def __str__(self) -> str:
         return str(self.value)

kittycad/models/annotation_mbd_basic_dimension.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+from ..models.mbd_symbol import MbdSymbol
+from .base import KittyCadBaseModel
+
+
+class AnnotationMbdBasicDimension(KittyCadBaseModel):
+    """Parameters for defining an MBD basic dimension"""
+
+    dimension: Optional[float] = None
+
+    symbol: Optional[MbdSymbol] = None
+
+    tolerance: float

kittycad/models/annotation_mbd_control_frame.py

@@ -0,0 +1,22 @@
+from typing import Optional
+
+from ..models.mbd_symbol import MbdSymbol
+from .base import KittyCadBaseModel
+
+
+class AnnotationMbdControlFrame(KittyCadBaseModel):
+    """Parameters for defining an MBD Geometric control frame"""
+
+    diameter_symbol: Optional[MbdSymbol] = None
+
+    modifier: Optional[MbdSymbol] = None
+
+    primary_datum: Optional[str] = None
+
+    secondary_datum: Optional[str] = None
+
+    symbol: MbdSymbol
+
+    tertiary_datum: Optional[str] = None
+
+    tolerance: float

kittycad/models/annotation_options.py

@@ -1,5 +1,8 @@
 from typing import Optional
 
+from ..models.annotation_basic_dimension import AnnotationBasicDimension
+from ..models.annotation_feature_control import AnnotationFeatureControl
+from ..models.annotation_feature_tag import AnnotationFeatureTag
 from ..models.annotation_line_end_options import AnnotationLineEndOptions
 from ..models.annotation_text_options import AnnotationTextOptions
 from ..models.color import Color
@@ -12,6 +15,12 @@ class AnnotationOptions(KittyCadBaseModel):
 
     color: Optional[Color] = None
 
+    dimension: Optional[AnnotationBasicDimension] = None
+
+    feature_control: Optional[AnnotationFeatureControl] = None
+
+    feature_tag: Optional[AnnotationFeatureTag] = None
+
     line_ends: Optional[AnnotationLineEndOptions] = None
 
     line_width: Optional[float] = None

kittycad/models/cut_type_v2.py

@@ -0,0 +1,96 @@
+from typing import Optional, Union
+
+from pydantic import RootModel, model_serializer, model_validator
+
+from ..models.angle import Angle
+from ..models.length_unit import LengthUnit
+from .base import KittyCadBaseModel
+
+
+class Fillet(KittyCadBaseModel):
+    """Round off an edge."""
+
+    radius: LengthUnit
+
+    second_length: Optional[LengthUnit] = None
+
+    @model_validator(mode="before")
+    @classmethod
+    def _unwrap(cls, data):
+        if (
+            isinstance(data, dict)
+            and "fillet" in data
+            and isinstance(data["fillet"], dict)
+        ):
+            return data["fillet"]
+
+        return data
+
+    @model_serializer(mode="wrap")
+    def _wrap(self, handler, info):
+        payload = handler(self, info)
+
+        return {"fillet": payload}
+
+
+class Chamfer(KittyCadBaseModel):
+    """Cut away an edge."""
+
+    angle: Optional[Angle] = None
+
+    distance: LengthUnit
+
+    second_distance: Optional[LengthUnit] = None
+
+    swap: bool
+
+    @model_validator(mode="before")
+    @classmethod
+    def _unwrap(cls, data):
+        if (
+            isinstance(data, dict)
+            and "chamfer" in data
+            and isinstance(data["chamfer"], dict)
+        ):
+            return data["chamfer"]
+
+        return data
+
+    @model_serializer(mode="wrap")
+    def _wrap(self, handler, info):
+        payload = handler(self, info)
+
+        return {"chamfer": payload}
+
+
+class Custom(KittyCadBaseModel):
+    """A custom cut profile."""
+
+    path: str
+
+    @model_validator(mode="before")
+    @classmethod
+    def _unwrap(cls, data):
+        if (
+            isinstance(data, dict)
+            and "custom" in data
+            and isinstance(data["custom"], dict)
+        ):
+            return data["custom"]
+
+        return data
+
+    @model_serializer(mode="wrap")
+    def _wrap(self, handler, info):
+        payload = handler(self, info)
+
+        return {"custom": payload}
+
+
+CutTypeV2 = RootModel[
+    Union[
+        Fillet,
+        Chamfer,
+        Custom,
+    ]
+]