Update api spec (#536)

* 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 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",
+      "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"
     }
   },
@@ -363,7 +363,7 @@
     "op": "add",
     "path": "/paths/~1orgs~1{id}~1enterprise~1pricing/put/x-python",
     "value": {
-      "example": "from kittycad.models.uuid import Uuid\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.models.enterprise_subscription_tier_price import OptionPerUser\nfrom kittycad.models.plan_interval import PlanInterval\nfrom kittycad.models.enterprise_subscription_tier_price import EnterpriseSubscriptionTierPrice\nfrom kittycad.models import ZooProductSubscriptions\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_update_enterprise_pricing_for_org():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: ZooProductSubscriptions = client.orgs.update_enterprise_pricing_for_org(id=Uuid(\"<string>\"),\n        body=EnterpriseSubscriptionTierPrice(OptionPerUser(\n        interval=PlanInterval.DAY,\n        price=3.14,\n        )))\n\n\n    body: ZooProductSubscriptions = result\n    print(body)\n\n",
+      "example": "from kittycad.models.uuid import Uuid\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.models.enterprise_subscription_tier_price import OptionFlat\nfrom kittycad.models.plan_interval import PlanInterval\nfrom kittycad.models.enterprise_subscription_tier_price import EnterpriseSubscriptionTierPrice\nfrom kittycad.models import ZooProductSubscriptions\nfrom typing import Union, Any, Optional, List, Tuple\nfrom kittycad.types import Response\ndef example_update_enterprise_pricing_for_org():\n    client = KittyCAD()  # Uses KITTYCAD_API_TOKEN environment variable\n\n    result: ZooProductSubscriptions = client.orgs.update_enterprise_pricing_for_org(id=Uuid(\"<string>\"),\n        body=EnterpriseSubscriptionTierPrice(OptionFlat(\n        interval=PlanInterval.DAY,\n        price=3.14,\n        )))\n\n\n    body: ZooProductSubscriptions = result\n    print(body)\n\n",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.orgs"
     }
   },
@@ -579,15 +579,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 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",
+      "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",
       "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 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",
+      "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",
       "libDocsLink": "https://python.api.docs.zoo.dev/_autosummary/kittycad.KittyCAD.html#kittycad.KittyCAD.orgs"
     }
   },
@@ -1163,7 +1163,7 @@
     "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 OptionUser\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) as websocket:\n\n                # Send a message.\n                websocket.send(MlCopilotClientMessage(OptionUser(\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        ",
+      "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) 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"
     }
   },

kittycad/models/__init__.py

@@ -287,6 +287,7 @@
 from .saml_identity_provider import SamlIdentityProvider
 from .saml_identity_provider_create import SamlIdentityProviderCreate
 from .scene_clear_all import SceneClearAll
+from .scene_get_entity_ids import SceneGetEntityIds
 from .scene_selection_type import SceneSelectionType
 from .scene_tool_type import SceneToolType
 from .select_add import SelectAdd

kittycad/models/invoice.py

@@ -45,8 +45,6 @@ class Invoice(KittyCadBaseModel):
 
     paid: bool = False
 
-    payment_intent_id: Optional[str] = None
-
     pdf: Optional[str] = None
 
     receipt_number: Optional[str] = None

kittycad/models/ml_copilot_supported_models.py

@@ -20,9 +20,9 @@ class MlCopilotSupportedModels(str, Enum):
 
     GPT5 = "gpt5"
 
-    """# o3"""  # noqa: E501
+    """# o3-mini"""  # noqa: E501
 
-    O3 = "o3"
+    O3_MINI = "o3_mini"
 
     def __str__(self) -> str:
         return str(self.value)

kittycad/models/modeling_cmd.py

@@ -1248,6 +1248,18 @@ class OptionSetSelectionFilter(KittyCadBaseModel):
     type: Literal["set_selection_filter"] = "set_selection_filter"
 
 
+class OptionSceneGetEntityIds(KittyCadBaseModel):
+    """Get the ids of a given entity type."""
+
+    filter: List[EntityType]
+
+    skip: int
+
+    take: int
+
+    type: Literal["scene_get_entity_ids"] = "scene_get_entity_ids"
+
+
 class OptionDefaultCameraSetOrthographic(KittyCadBaseModel):
     """Use orthographic projection."""
 
@@ -1555,6 +1567,7 @@ class OptionSetGridAutoScale(KittyCadBaseModel):
             OptionDefaultCameraFocusOn,
             OptionSetSelectionType,
             OptionSetSelectionFilter,
+            OptionSceneGetEntityIds,
             OptionDefaultCameraSetOrthographic,
             OptionDefaultCameraSetPerspective,
             OptionDefaultCameraCenterToSelection,

kittycad/models/ok_modeling_cmd_response.py

@@ -105,6 +105,7 @@
 from ..models.revolve import Revolve
 from ..models.revolve_about_edge import RevolveAboutEdge
 from ..models.scene_clear_all import SceneClearAll
+from ..models.scene_get_entity_ids import SceneGetEntityIds
 from ..models.select_add import SelectAdd
 from ..models.select_clear import SelectClear
 from ..models.select_get import SelectGet
@@ -894,6 +895,14 @@ class OptionGetEntityType(KittyCadBaseModel):
     type: Literal["get_entity_type"] = "get_entity_type"
 
 
+class OptionSceneGetEntityIds(KittyCadBaseModel):
+    """"""
+
+    data: SceneGetEntityIds
+
+    type: Literal["scene_get_entity_ids"] = "scene_get_entity_ids"
+
+
 class OptionCurveGetControlPoints(KittyCadBaseModel):
     """"""
 
@@ -1376,6 +1385,7 @@ class OptionSetGridAutoScale(KittyCadBaseModel):
             OptionSolid3dGetPrevAdjacentEdge,
             OptionSolid3dGetCommonEdge,
             OptionGetEntityType,
+            OptionSceneGetEntityIds,
             OptionCurveGetControlPoints,
             OptionProjectEntityToPlane,
             OptionProjectPointsToPlane,

kittycad/models/scene_get_entity_ids.py

@@ -0,0 +1,9 @@
+from typing import List
+
+from .base import KittyCadBaseModel
+
+
+class SceneGetEntityIds(KittyCadBaseModel):
+    """The response from the `SceneGetEntityIds` command."""
+
+    entity_ids: List[List[str]]