@kittycad/lib 3.1.2 → 3.1.4

package/dist/types/src/models.d.ts

@@ -46,18 +46,224 @@ export interface Angle {
      */
     value: number;
 }
+export interface AnnotationBasicDimension {
+    /** Basic dimension parameters (symbol and tolerance) */
+    dimension: AnnotationMbdBasicDimension;
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "The point size of the fonts used to generate the annotation label.  Very large values can negatively affect performance."
+     * }
+     */
+    font_point_size: number;
+    /** format:float, description:The scale of the font label in 3D space */
+    font_scale: number;
+    /** format:uuid, description:Entity to measure the dimension from */
+    from_entity_id: string;
+    /** Normalized position within the entity to position the dimension from */
+    from_entity_pos: Point2d;
+    /** 2D Position offset of the annotation within the plane. */
+    offset: Point2d;
+    /**
+     * {
+     *   "format": "uuid",
+     *   "description": "Orientation plane.  The annotation will lie in this plane which is positioned about the leader position as its origin."
+     * }
+     */
+    plane_id: string;
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "Number of decimal places to use when displaying tolerance and dimension values"
+     * }
+     */
+    precision: number;
+    /** format:uuid, description:Entity to measure the dimension to */
+    to_entity_id: string;
+    /** Normalized position within the entity to position the dimension to */
+    to_entity_pos: Point2d;
+}
+export interface AnnotationFeatureControl {
+    /** nullable:true, description:MBD Control frame for geometric control */
+    control_frame?: AnnotationMbdControlFrame;
+    /**
+     * {
+     *   "nullable": true,
+     *   "minLength": 1,
+     *   "maxLength": 1,
+     *   "description": "Set if this annotation is defining a datum"
+     * }
+     */
+    defined_datum?: string;
+    /** nullable:true, description:Basic dimensions */
+    dimension?: AnnotationMbdBasicDimension;
+    /** format:uuid, description:Entity to place the annotation leader from */
+    entity_id: string;
+    /** Normalized position within the entity to position the annotation leader from */
+    entity_pos: Point2d;
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "The point size of the fonts used to generate the annotation label.  Very large values can negatively affect performance."
+     * }
+     */
+    font_point_size: number;
+    /** format:float, description:The scale of the font label in 3D space */
+    font_scale: number;
+    /** Type of leader to use */
+    leader_type: AnnotationLineEnd;
+    /** 2D Position offset of the annotation within the plane. */
+    offset: Point2d;
+    /**
+     * {
+     *   "format": "uuid",
+     *   "description": "Orientation plane.  The annotation will lie in this plane which is positioned about the leader position as its origin."
+     * }
+     */
+    plane_id: string;
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "Number of decimal places to use when displaying tolerance and dimension values"
+     * }
+     */
+    precision: number;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Prefix text which will appear before the basic dimension"
+     * }
+     */
+    prefix?: string;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Suffix text which will appear after the basic dimension"
+     * }
+     */
+    suffix?: string;
+}
+export interface AnnotationFeatureTag {
+    /** format:uuid, description:Entity to place the annotation leader from */
+    entity_id: string;
+    /** Normalized position within the entity to position the annotation leader from */
+    entity_pos: Point2d;
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "The point size of the fonts used to generate the annotation label.  Very large values can negatively affect performance."
+     * }
+     */
+    font_point_size: number;
+    /** format:float, description:The scale of the font label in 3D space */
+    font_scale: number;
+    /** Tag key */
+    key: string;
+    /** Type of leader to use */
+    leader_type: AnnotationLineEnd;
+    /** 2D Position offset of the annotation within the plane. */
+    offset: Point2d;
+    /**
+     * {
+     *   "format": "uuid",
+     *   "description": "Orientation plane.  The annotation will lie in this plane which is positioned about the leader position as its origin."
+     * }
+     */
+    plane_id: string;
+    /** Whether or not to display the key on the annotation label */
+    show_key: boolean;
+    /** Tag value */
+    value: string;
+}
 export declare type AnnotationLineEnd = 
 /** Annotation line end type */
-'none' | 'arrow';
+'none' | 'arrow' | 'dot';
 export interface AnnotationLineEndOptions {
     /** How to style the end of the annotation line. */
     end: AnnotationLineEnd;
     /** How to style the start of the annotation line. */
     start: AnnotationLineEnd;
 }
+export interface AnnotationMbdBasicDimension {
+    /**
+     * {
+     *   "nullable": true,
+     *   "format": "double",
+     *   "description": "The explicitly defined dimension.  Only required if the measurement is not automatically calculated."
+     * }
+     */
+    dimension?: number;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Type of symbol to use for this dimension (if required)"
+     * }
+     */
+    symbol?: MbdSymbol;
+    /** format:double, description:The tolerance of the dimension */
+    tolerance: number;
+}
+export interface AnnotationMbdControlFrame {
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Diameter symbol (if required) whether the geometric control requires a cylindrical or diameter tolerance"
+     * }
+     */
+    diameter_symbol?: MbdSymbol;
+    /** nullable:true, description:Feature of size or tolerance modifiers */
+    modifier?: MbdSymbol;
+    /**
+     * {
+     *   "nullable": true,
+     *   "minLength": 1,
+     *   "maxLength": 1,
+     *   "description": "Primary datum"
+     * }
+     */
+    primary_datum?: string;
+    /**
+     * {
+     *   "nullable": true,
+     *   "minLength": 1,
+     *   "maxLength": 1,
+     *   "description": "Secondary datum"
+     * }
+     */
+    secondary_datum?: string;
+    /** Geometric symbol, the type of geometric control specified */
+    symbol: MbdSymbol;
+    /**
+     * {
+     *   "nullable": true,
+     *   "minLength": 1,
+     *   "maxLength": 1,
+     *   "description": "Tertiary datum"
+     * }
+     */
+    tertiary_datum?: string;
+    /**
+     * {
+     *   "format": "double",
+     *   "description": "Tolerance value - the total tolerance of the geometric control.  The unit is based on the drawing standard."
+     * }
+     */
+    tolerance: number;
+}
 export interface AnnotationOptions {
     /** nullable:true, description:Color to render the annotation */
     color?: Color;
+    /** nullable:true, description:Set as an MBD measured basic dimension annotation */
+    dimension?: AnnotationBasicDimension;
+    /** nullable:true, description:Set as an MBD Feature control annotation */
+    feature_control?: AnnotationFeatureControl;
+    /** nullable:true, description:Set as a feature tag annotation */
+    feature_tag?: AnnotationFeatureTag;
     /** nullable:true, description:How to style the start and end of the line */
     line_ends?: AnnotationLineEndOptions;
     /** nullable:true, format:float, description:Width of the annotation's line */
@@ -169,6 +375,14 @@ export interface ApiCallWithPrice {
      * }
      */
     response_body?: string;
+    /**
+     * {
+     *   "nullable": true,
+     *   "format": "int32",
+     *   "description": "The number of seconds the API call was billed for."
+     * }
+     */
+    seconds?: number;
     /**
      * {
      *   "nullable": true,
@@ -1377,6 +1591,45 @@ export interface CustomerBalance {
 }
 export declare type CutStrategy = 'basic' | 'csg' | 'automatic';
 export declare type CutType = 'fillet' | 'chamfer';
+export declare type CutTypeV2 = {
+    fillet: {
+        /** The radius of the fillet. */
+        radius: LengthUnit;
+        /**
+         * {
+         *   "nullable": true,
+         *   "description": "The second length affects the edge length of the second face of the cut. This will cause the fillet to take on the shape of a conic section, instead of an arc."
+         * }
+         */
+        second_length?: LengthUnit;
+    };
+} | {
+    chamfer: {
+        /** nullable:true, description:The angle of the chamfer, default is 45deg. */
+        angle?: Angle;
+        /** The distance from the edge to cut on each face. */
+        distance: LengthUnit;
+        /**
+         * {
+         *   "nullable": true,
+         *   "description": "The second distance affects the edge length of the second face of the cut."
+         * }
+         */
+        second_distance?: LengthUnit;
+        /** If true, the second distance or angle is applied to the other face of the cut. */
+        swap: boolean;
+    };
+} | {
+    custom: {
+        /**
+         * {
+         *   "format": "uuid",
+         *   "description": "The path that will be used for the custom profile."
+         * }
+         */
+        path: string;
+    };
+};
 export interface DefaultCameraCenterToScene {
 }
 export interface DefaultCameraCenterToSelection {
@@ -1721,6 +1974,35 @@ export interface ExtendedUserResultsPage {
 export interface Extrude {
 }
 export declare type ExtrudeMethod = 'new' | 'merge';
+export declare type ExtrudeReference = {
+    entity_reference: {
+        /** format:uuid, description:The UUID of the entity to extrude to. */
+        entity_id: string;
+    };
+} | {
+    axis: {
+        /** The axis to extrude to. */
+        axis: Point3d;
+        /**
+         * {
+         *   "default": {
+         *     "x": 0,
+         *     "y": 0,
+         *     "z": 0
+         *   },
+         *   "description": "Point the axis goes through. Defaults to (0, 0, 0)."
+         * }
+         */
+        point?: Point3d;
+    };
+} | {
+    point: {
+        /** The point to extrude to. */
+        point: Point3d;
+    };
+};
+export interface ExtrudeToReference {
+}
 export interface ExtrudedFaceInfo {
     /**
      * {
@@ -2322,6 +2604,13 @@ export interface Invoice {
      * }
      */
     paid?: boolean;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Identifier for the payment intent backing this invoice."
+     * }
+     */
+    payment_intent_id?: string;
     /** nullable:true, format:uri, description:The link to download the PDF for the invoice. */
     pdf?: string;
     /** This is the transaction number that appears on email receipts sent for this invoice. */
@@ -2500,6 +2789,13 @@ export interface KclCodeCompletionRequest {
      * }
      */
     max_tokens?: number;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Zoo provided model, or custom model which should be used to process this request."
+     * }
+     */
+    model_version?: string;
     /**
      * {
      *   "nullable": true,
@@ -2516,7 +2812,7 @@ export interface KclCodeCompletionRequest {
      * }
      */
     nwo?: string;
-    /** default:, description:The prompt for the model. */
+    /** default:, description:The prompt for the desired part. */
     prompt?: string;
     stop?: string[];
     /**
@@ -2526,7 +2822,7 @@ export interface KclCodeCompletionRequest {
      * }
      */
     stream?: boolean;
-    /** default:, description:The suffix for the model. */
+    /** default:, description:The suffix for the desired part. */
     suffix?: string;
     /** nullable:true, format:float, description:The temperature for the model. */
     temperature?: number;
@@ -2563,6 +2859,9 @@ export interface Mass {
     /** The output unit for the mass. */
     output_unit: UnitMass;
 }
+export declare type MbdSymbol = 
+/** MBD symbol type */
+'none' | 'arclength' | 'between' | 'degrees' | 'plusminus' | 'angularity' | 'cylindricity' | 'roundness' | 'concentricity' | 'straightness' | 'parallelism' | 'flatness' | 'profileofline' | 'surfaceprofile' | 'symmetry' | 'perpendicularity' | 'runout' | 'totalrunout' | 'position' | 'centerline' | 'partingline' | 'isoenvelope' | 'isoenvelopenony145m' | 'freestate' | 'statisticaltolerance' | 'continuousfeature' | 'independency' | 'depth' | 'start' | 'leastcondition' | 'maxcondition' | 'conicaltaper' | 'projected' | 'slope' | 'micro' | 'tangentplane' | 'unilateral' | 'squarefeature' | 'countersink' | 'spotface' | 'target' | 'diameter' | 'radius' | 'sphericalradius' | 'sphericaldiameter' | 'controlledradius' | 'boxstart' | 'boxbar' | 'boxbarbetween' | 'letterbackwardunderline' | 'punctuationbackwardunderline' | 'modifierbackwardunderline' | 'numericbackwardunderline' | 'boxend' | 'datumup' | 'datumleft' | 'datumright' | 'datumdown' | 'datumtriangle' | 'halfspace' | 'quarterspace' | 'eighthspace' | 'modifierspace';
 export declare type Method = 'OPTIONS' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'TRACE' | 'CONNECT' | 'PATCH' | 'EXTENSION';
 export declare type MlCopilotClientMessage = {
     headers: {
@@ -2830,11 +3129,12 @@ export interface ModelingAppSubscriptionTier {
     /**
      * {
      *   "title": "double",
+     *   "default": 0,
      *   "format": "money-usd",
      *   "description": "The monetary value of pay-as-you-go API credits the individual or org gets outside the modeling app per month. This re-ups on the 1st of each month."
      * }
      */
-    monthly_pay_as_you_go_api_credits_monetary_value: number;
+    monthly_pay_as_you_go_api_credits_monetary_value?: number;
     /** The name of the tier. */
     name: ModelingAppSubscriptionTierName;
     /**
@@ -2842,7 +3142,7 @@ export interface ModelingAppSubscriptionTier {
      *   "title": "double",
      *   "default": 0,
      *   "format": "money-usd",
-     *   "description": "The price of an API credit (meaning 1 credit = 1 minute of API usage)."
+     *   "description": "The price of an API credit (meaning 1 credit = 1 second of API usage)."
      * }
      */
     pay_as_you_go_api_credit_price?: number;
@@ -2880,6 +3180,13 @@ export declare type ModelingCmd = {
     to: Point3d;
     type: 'move_path_pen';
 } | {
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Optional label to associate with the new path segment."
+     * }
+     */
+    label?: string;
     /** The ID of the command which created the path. */
     path: ModelingCmdId;
     /** Segment to append to the path. This segment will implicitly begin at the current "pen" location. */
@@ -2912,6 +3219,26 @@ export declare type ModelingCmd = {
     /** Which sketch to extrude. Must be a closed 2D solid. */
     target: ModelingCmdId;
     type: 'extrude';
+} | {
+    /**
+     * {
+     *   "default": "merge",
+     *   "description": "Should the extrusion create a new object or be part of the existing object."
+     * }
+     */
+    extrude_method?: ExtrudeMethod;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Which IDs should the new faces have? If this isn't given, the engine will generate IDs."
+     * }
+     */
+    faces?: ExtrudedFaceInfo;
+    /** Reference to extrude to. Extrusion occurs along the target's normal until it is as close to the reference as possible. */
+    reference: ExtrudeReference;
+    /** Which sketch to extrude. Must be a closed 2D solid. */
+    target: ModelingCmdId;
+    type: 'extrude_to_reference';
 } | {
     /**
      * {
@@ -3248,8 +3575,13 @@ export declare type ModelingCmd = {
     cylinder_id: string;
     /** Is the helix rotation clockwise? */
     is_clockwise: boolean;
-    /** Length of the helix. */
-    length: LengthUnit;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Length of the helix. If None, the length of the cylinder will be used instead."
+     * }
+     */
+    length?: LengthUnit;
     /** format:double, description:Number of revolutions. */
     revolutions: number;
     /** default:{unit:degrees, value:0}, description:Start angle. */
@@ -3519,6 +3851,28 @@ export declare type ModelingCmd = {
     /** The maximum acceptable surface gap computed between the filleted surfaces. Must be positive (i.e. greater than zero). */
     tolerance: LengthUnit;
     type: 'solid3d_fillet_edge';
+} | {
+    /** The cut type and information required to perform the cut. */
+    cut_type: CutTypeV2;
+    /**
+     * {
+     *   "format": "uuid"
+     * }
+     */
+    edge_ids?: string[];
+    /**
+     * {
+     *   "format": "uuid"
+     * }
+     */
+    extra_face_ids?: string[];
+    /** format:uuid, description:Which object is being cut. */
+    object_id: string;
+    /** default:automatic, description:Which cutting algorithm to use. */
+    strategy?: CutStrategy;
+    /** The maximum acceptable surface gap computed between the cut surfaces. Must be positive (i.e. greater than zero). */
+    tolerance: LengthUnit;
+    type: 'solid3d_cut_edges';
 } | {
     /** format:uuid, description:Which face is being queried. */
     object_id: string;
@@ -4157,6 +4511,14 @@ export declare type OkModelingCmdResponse = {
      */
     data: Extrude;
     type: 'extrude';
+} | {
+    /**
+     * {
+     *   "$ref": "#/components/schemas/ExtrudeToReference"
+     * }
+     */
+    data: ExtrudeToReference;
+    type: 'extrude_to_reference';
 } | {
     /**
      * {
@@ -4325,6 +4687,14 @@ export declare type OkModelingCmdResponse = {
      */
     data: Solid3dFilletEdge;
     type: 'solid3d_fillet_edge';
+} | {
+    /**
+     * {
+     *   "$ref": "#/components/schemas/Solid3dCutEdges"
+     * }
+     */
+    data: Solid3dCutEdges;
+    type: 'solid3d_cut_edges';
 } | {
     /**
      * {
@@ -6148,6 +6518,8 @@ export interface SketchModeDisable {
 }
 export interface Solid2dAddHole {
 }
+export interface Solid3dCutEdges {
+}
 export interface Solid3dFilletEdge {
 }
 export interface Solid3dGetAdjacencyInfo {
@@ -6354,6 +6726,13 @@ export interface TextToCadCreateBody {
      * }
      */
     kcl_version?: string;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Zoo provided model, or custom model which should be used to process this request."
+     * }
+     */
+    model_version?: string;
     /**
      * {
      *   "nullable": true,
@@ -6361,7 +6740,7 @@ export interface TextToCadCreateBody {
      * }
      */
     project_name?: string;
-    /** The prompt for the model. */
+    /** The prompt for the desired part. */
     prompt: string;
 }
 export interface TextToCadIteration {
@@ -7739,11 +8118,12 @@ export declare type ZooProductSubscription = {
     /**
      * {
      *   "title": "double",
+     *   "default": 0,
      *   "format": "money-usd",
      *   "description": "The monetary value of pay-as-you-go API credits the individual or org gets outside the modeling app per month. This re-ups on the 1st of each month."
      * }
      */
-    monthly_pay_as_you_go_api_credits_monetary_value: number;
+    monthly_pay_as_you_go_api_credits_monetary_value?: number;
     /** The name of the tier. */
     name: ModelingAppSubscriptionTierName;
     /**
@@ -7751,7 +8131,7 @@ export declare type ZooProductSubscription = {
      *   "title": "double",
      *   "default": 0,
      *   "format": "money-usd",
-     *   "description": "The price of an API credit (meaning 1 credit = 1 minute of API usage)."
+     *   "description": "The price of an API credit (meaning 1 credit = 1 second of API usage)."
      * }
      */
     pay_as_you_go_api_credit_price?: number;
@@ -7820,8 +8200,13 @@ export interface Models {
     AddressDetails: AddressDetails;
     AdjacencyInfo: AdjacencyInfo;
     Angle: Angle;
+    AnnotationBasicDimension: AnnotationBasicDimension;
+    AnnotationFeatureControl: AnnotationFeatureControl;
+    AnnotationFeatureTag: AnnotationFeatureTag;
     AnnotationLineEnd: AnnotationLineEnd;
     AnnotationLineEndOptions: AnnotationLineEndOptions;
+    AnnotationMbdBasicDimension: AnnotationMbdBasicDimension;
+    AnnotationMbdControlFrame: AnnotationMbdControlFrame;
     AnnotationOptions: AnnotationOptions;
     AnnotationTextAlignmentX: AnnotationTextAlignmentX;
     AnnotationTextAlignmentY: AnnotationTextAlignmentY;
@@ -7884,6 +8269,7 @@ export interface Models {
     CustomerBalance: CustomerBalance;
     CutStrategy: CutStrategy;
     CutType: CutType;
+    CutTypeV2: CutTypeV2;
     DefaultCameraCenterToScene: DefaultCameraCenterToScene;
     DefaultCameraCenterToSelection: DefaultCameraCenterToSelection;
     DefaultCameraFocusOn: DefaultCameraFocusOn;
@@ -7944,6 +8330,8 @@ export interface Models {
     ExtendedUserResultsPage: ExtendedUserResultsPage;
     Extrude: Extrude;
     ExtrudeMethod: ExtrudeMethod;
+    ExtrudeReference: ExtrudeReference;
+    ExtrudeToReference: ExtrudeToReference;
     ExtrudedFaceInfo: ExtrudedFaceInfo;
     ExtrusionFaceCapType: ExtrusionFaceCapType;
     ExtrusionFaceInfo: ExtrusionFaceInfo;
@@ -7996,6 +8384,7 @@ export interface Models {
     MakeOffsetPath: MakeOffsetPath;
     MakePlane: MakePlane;
     Mass: Mass;
+    MbdSymbol: MbdSymbol;
     Method: Method;
     MlCopilotClientMessage: MlCopilotClientMessage;
     MlCopilotServerMessage: MlCopilotServerMessage;
@@ -8113,6 +8502,7 @@ export interface Models {
     SideFace: SideFace;
     SketchModeDisable: SketchModeDisable;
     Solid2dAddHole: Solid2dAddHole;
+    Solid3dCutEdges: Solid3dCutEdges;
     Solid3dFilletEdge: Solid3dFilletEdge;
     Solid3dGetAdjacencyInfo: Solid3dGetAdjacencyInfo;
     Solid3dGetAllEdgeFaces: Solid3dGetAllEdgeFaces;