@kittycad/lib 3.1.3 → 3.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +1 -1
- package/dist/mjs/index.js +1 -1
- package/dist/types/src/api/ml/create_proprietary_to_kcl.d.ts +8 -0
- package/dist/types/src/api/ml/create_proprietary_to_kcl.d.ts.map +1 -1
- package/dist/types/src/api/orgs/org_admin_details_get.d.ts +24 -0
- package/dist/types/src/api/orgs/org_admin_details_get.d.ts.map +1 -0
- package/dist/types/src/api/payments/delete_payment_method_for_user.d.ts +3 -1
- package/dist/types/src/api/payments/delete_payment_method_for_user.d.ts.map +1 -1
- package/dist/types/src/api/users/user_admin_details_get.d.ts +24 -0
- package/dist/types/src/api/users/user_admin_details_get.d.ts.map +1 -0
- package/dist/types/src/index.d.ts +5 -1
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/models.d.ts +483 -17
- package/dist/types/src/models.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -13,6 +13,28 @@ export interface AddOrgMember {
|
|
|
13
13
|
/** The organization role to give the user. */
|
|
14
14
|
role: UserOrgRole;
|
|
15
15
|
}
|
|
16
|
+
export interface Address {
|
|
17
|
+
/** The city component. */
|
|
18
|
+
city?: string;
|
|
19
|
+
/** The country component. This is a two-letter ISO country code. */
|
|
20
|
+
country: CountryCode;
|
|
21
|
+
/** title:DateTime, format:date-time, description:The time and date the address was created. */
|
|
22
|
+
created_at: string;
|
|
23
|
+
/** The unique identifier of the address. */
|
|
24
|
+
id: Uuid;
|
|
25
|
+
/** The state component. */
|
|
26
|
+
state?: string;
|
|
27
|
+
/** The first street component. */
|
|
28
|
+
street1?: string;
|
|
29
|
+
/** The second street component. */
|
|
30
|
+
street2?: string;
|
|
31
|
+
/** title:DateTime, format:date-time, description:The time and date the address was last updated. */
|
|
32
|
+
updated_at: string;
|
|
33
|
+
/** The user ID that this address belongs to. */
|
|
34
|
+
user_id: Uuid;
|
|
35
|
+
/** The zip component. */
|
|
36
|
+
zip?: string;
|
|
37
|
+
}
|
|
16
38
|
export interface AddressDetails {
|
|
17
39
|
/** The city component. */
|
|
18
40
|
city?: string;
|
|
@@ -46,18 +68,224 @@ export interface Angle {
|
|
|
46
68
|
*/
|
|
47
69
|
value: number;
|
|
48
70
|
}
|
|
71
|
+
export interface AnnotationBasicDimension {
|
|
72
|
+
/** Basic dimension parameters (symbol and tolerance) */
|
|
73
|
+
dimension: AnnotationMbdBasicDimension;
|
|
74
|
+
/**
|
|
75
|
+
* {
|
|
76
|
+
* "format": "uint32",
|
|
77
|
+
* "minimum": 0,
|
|
78
|
+
* "description": "The point size of the fonts used to generate the annotation label. Very large values can negatively affect performance."
|
|
79
|
+
* }
|
|
80
|
+
*/
|
|
81
|
+
font_point_size: number;
|
|
82
|
+
/** format:float, description:The scale of the font label in 3D space */
|
|
83
|
+
font_scale: number;
|
|
84
|
+
/** format:uuid, description:Entity to measure the dimension from */
|
|
85
|
+
from_entity_id: string;
|
|
86
|
+
/** Normalized position within the entity to position the dimension from */
|
|
87
|
+
from_entity_pos: Point2d;
|
|
88
|
+
/** 2D Position offset of the annotation within the plane. */
|
|
89
|
+
offset: Point2d;
|
|
90
|
+
/**
|
|
91
|
+
* {
|
|
92
|
+
* "format": "uuid",
|
|
93
|
+
* "description": "Orientation plane. The annotation will lie in this plane which is positioned about the leader position as its origin."
|
|
94
|
+
* }
|
|
95
|
+
*/
|
|
96
|
+
plane_id: string;
|
|
97
|
+
/**
|
|
98
|
+
* {
|
|
99
|
+
* "format": "uint32",
|
|
100
|
+
* "minimum": 0,
|
|
101
|
+
* "description": "Number of decimal places to use when displaying tolerance and dimension values"
|
|
102
|
+
* }
|
|
103
|
+
*/
|
|
104
|
+
precision: number;
|
|
105
|
+
/** format:uuid, description:Entity to measure the dimension to */
|
|
106
|
+
to_entity_id: string;
|
|
107
|
+
/** Normalized position within the entity to position the dimension to */
|
|
108
|
+
to_entity_pos: Point2d;
|
|
109
|
+
}
|
|
110
|
+
export interface AnnotationFeatureControl {
|
|
111
|
+
/** nullable:true, description:MBD Control frame for geometric control */
|
|
112
|
+
control_frame?: AnnotationMbdControlFrame;
|
|
113
|
+
/**
|
|
114
|
+
* {
|
|
115
|
+
* "nullable": true,
|
|
116
|
+
* "minLength": 1,
|
|
117
|
+
* "maxLength": 1,
|
|
118
|
+
* "description": "Set if this annotation is defining a datum"
|
|
119
|
+
* }
|
|
120
|
+
*/
|
|
121
|
+
defined_datum?: string;
|
|
122
|
+
/** nullable:true, description:Basic dimensions */
|
|
123
|
+
dimension?: AnnotationMbdBasicDimension;
|
|
124
|
+
/** format:uuid, description:Entity to place the annotation leader from */
|
|
125
|
+
entity_id: string;
|
|
126
|
+
/** Normalized position within the entity to position the annotation leader from */
|
|
127
|
+
entity_pos: Point2d;
|
|
128
|
+
/**
|
|
129
|
+
* {
|
|
130
|
+
* "format": "uint32",
|
|
131
|
+
* "minimum": 0,
|
|
132
|
+
* "description": "The point size of the fonts used to generate the annotation label. Very large values can negatively affect performance."
|
|
133
|
+
* }
|
|
134
|
+
*/
|
|
135
|
+
font_point_size: number;
|
|
136
|
+
/** format:float, description:The scale of the font label in 3D space */
|
|
137
|
+
font_scale: number;
|
|
138
|
+
/** Type of leader to use */
|
|
139
|
+
leader_type: AnnotationLineEnd;
|
|
140
|
+
/** 2D Position offset of the annotation within the plane. */
|
|
141
|
+
offset: Point2d;
|
|
142
|
+
/**
|
|
143
|
+
* {
|
|
144
|
+
* "format": "uuid",
|
|
145
|
+
* "description": "Orientation plane. The annotation will lie in this plane which is positioned about the leader position as its origin."
|
|
146
|
+
* }
|
|
147
|
+
*/
|
|
148
|
+
plane_id: string;
|
|
149
|
+
/**
|
|
150
|
+
* {
|
|
151
|
+
* "format": "uint32",
|
|
152
|
+
* "minimum": 0,
|
|
153
|
+
* "description": "Number of decimal places to use when displaying tolerance and dimension values"
|
|
154
|
+
* }
|
|
155
|
+
*/
|
|
156
|
+
precision: number;
|
|
157
|
+
/**
|
|
158
|
+
* {
|
|
159
|
+
* "nullable": true,
|
|
160
|
+
* "description": "Prefix text which will appear before the basic dimension"
|
|
161
|
+
* }
|
|
162
|
+
*/
|
|
163
|
+
prefix?: string;
|
|
164
|
+
/**
|
|
165
|
+
* {
|
|
166
|
+
* "nullable": true,
|
|
167
|
+
* "description": "Suffix text which will appear after the basic dimension"
|
|
168
|
+
* }
|
|
169
|
+
*/
|
|
170
|
+
suffix?: string;
|
|
171
|
+
}
|
|
172
|
+
export interface AnnotationFeatureTag {
|
|
173
|
+
/** format:uuid, description:Entity to place the annotation leader from */
|
|
174
|
+
entity_id: string;
|
|
175
|
+
/** Normalized position within the entity to position the annotation leader from */
|
|
176
|
+
entity_pos: Point2d;
|
|
177
|
+
/**
|
|
178
|
+
* {
|
|
179
|
+
* "format": "uint32",
|
|
180
|
+
* "minimum": 0,
|
|
181
|
+
* "description": "The point size of the fonts used to generate the annotation label. Very large values can negatively affect performance."
|
|
182
|
+
* }
|
|
183
|
+
*/
|
|
184
|
+
font_point_size: number;
|
|
185
|
+
/** format:float, description:The scale of the font label in 3D space */
|
|
186
|
+
font_scale: number;
|
|
187
|
+
/** Tag key */
|
|
188
|
+
key: string;
|
|
189
|
+
/** Type of leader to use */
|
|
190
|
+
leader_type: AnnotationLineEnd;
|
|
191
|
+
/** 2D Position offset of the annotation within the plane. */
|
|
192
|
+
offset: Point2d;
|
|
193
|
+
/**
|
|
194
|
+
* {
|
|
195
|
+
* "format": "uuid",
|
|
196
|
+
* "description": "Orientation plane. The annotation will lie in this plane which is positioned about the leader position as its origin."
|
|
197
|
+
* }
|
|
198
|
+
*/
|
|
199
|
+
plane_id: string;
|
|
200
|
+
/** Whether or not to display the key on the annotation label */
|
|
201
|
+
show_key: boolean;
|
|
202
|
+
/** Tag value */
|
|
203
|
+
value: string;
|
|
204
|
+
}
|
|
49
205
|
export declare type AnnotationLineEnd =
|
|
50
206
|
/** Annotation line end type */
|
|
51
|
-
'none' | 'arrow';
|
|
207
|
+
'none' | 'arrow' | 'dot';
|
|
52
208
|
export interface AnnotationLineEndOptions {
|
|
53
209
|
/** How to style the end of the annotation line. */
|
|
54
210
|
end: AnnotationLineEnd;
|
|
55
211
|
/** How to style the start of the annotation line. */
|
|
56
212
|
start: AnnotationLineEnd;
|
|
57
213
|
}
|
|
214
|
+
export interface AnnotationMbdBasicDimension {
|
|
215
|
+
/**
|
|
216
|
+
* {
|
|
217
|
+
* "nullable": true,
|
|
218
|
+
* "format": "double",
|
|
219
|
+
* "description": "The explicitly defined dimension. Only required if the measurement is not automatically calculated."
|
|
220
|
+
* }
|
|
221
|
+
*/
|
|
222
|
+
dimension?: number;
|
|
223
|
+
/**
|
|
224
|
+
* {
|
|
225
|
+
* "nullable": true,
|
|
226
|
+
* "description": "Type of symbol to use for this dimension (if required)"
|
|
227
|
+
* }
|
|
228
|
+
*/
|
|
229
|
+
symbol?: MbdSymbol;
|
|
230
|
+
/** format:double, description:The tolerance of the dimension */
|
|
231
|
+
tolerance: number;
|
|
232
|
+
}
|
|
233
|
+
export interface AnnotationMbdControlFrame {
|
|
234
|
+
/**
|
|
235
|
+
* {
|
|
236
|
+
* "nullable": true,
|
|
237
|
+
* "description": "Diameter symbol (if required) whether the geometric control requires a cylindrical or diameter tolerance"
|
|
238
|
+
* }
|
|
239
|
+
*/
|
|
240
|
+
diameter_symbol?: MbdSymbol;
|
|
241
|
+
/** nullable:true, description:Feature of size or tolerance modifiers */
|
|
242
|
+
modifier?: MbdSymbol;
|
|
243
|
+
/**
|
|
244
|
+
* {
|
|
245
|
+
* "nullable": true,
|
|
246
|
+
* "minLength": 1,
|
|
247
|
+
* "maxLength": 1,
|
|
248
|
+
* "description": "Primary datum"
|
|
249
|
+
* }
|
|
250
|
+
*/
|
|
251
|
+
primary_datum?: string;
|
|
252
|
+
/**
|
|
253
|
+
* {
|
|
254
|
+
* "nullable": true,
|
|
255
|
+
* "minLength": 1,
|
|
256
|
+
* "maxLength": 1,
|
|
257
|
+
* "description": "Secondary datum"
|
|
258
|
+
* }
|
|
259
|
+
*/
|
|
260
|
+
secondary_datum?: string;
|
|
261
|
+
/** Geometric symbol, the type of geometric control specified */
|
|
262
|
+
symbol: MbdSymbol;
|
|
263
|
+
/**
|
|
264
|
+
* {
|
|
265
|
+
* "nullable": true,
|
|
266
|
+
* "minLength": 1,
|
|
267
|
+
* "maxLength": 1,
|
|
268
|
+
* "description": "Tertiary datum"
|
|
269
|
+
* }
|
|
270
|
+
*/
|
|
271
|
+
tertiary_datum?: string;
|
|
272
|
+
/**
|
|
273
|
+
* {
|
|
274
|
+
* "format": "double",
|
|
275
|
+
* "description": "Tolerance value - the total tolerance of the geometric control. The unit is based on the drawing standard."
|
|
276
|
+
* }
|
|
277
|
+
*/
|
|
278
|
+
tolerance: number;
|
|
279
|
+
}
|
|
58
280
|
export interface AnnotationOptions {
|
|
59
281
|
/** nullable:true, description:Color to render the annotation */
|
|
60
282
|
color?: Color;
|
|
283
|
+
/** nullable:true, description:Set as an MBD measured basic dimension annotation */
|
|
284
|
+
dimension?: AnnotationBasicDimension;
|
|
285
|
+
/** nullable:true, description:Set as an MBD Feature control annotation */
|
|
286
|
+
feature_control?: AnnotationFeatureControl;
|
|
287
|
+
/** nullable:true, description:Set as a feature tag annotation */
|
|
288
|
+
feature_tag?: AnnotationFeatureTag;
|
|
61
289
|
/** nullable:true, description:How to style the start and end of the line */
|
|
62
290
|
line_ends?: AnnotationLineEndOptions;
|
|
63
291
|
/** nullable:true, format:float, description:Width of the annotation's line */
|
|
@@ -169,6 +397,14 @@ export interface ApiCallWithPrice {
|
|
|
169
397
|
* }
|
|
170
398
|
*/
|
|
171
399
|
response_body?: string;
|
|
400
|
+
/**
|
|
401
|
+
* {
|
|
402
|
+
* "nullable": true,
|
|
403
|
+
* "format": "int32",
|
|
404
|
+
* "description": "The number of seconds the API call was billed for."
|
|
405
|
+
* }
|
|
406
|
+
*/
|
|
407
|
+
seconds?: number;
|
|
172
408
|
/**
|
|
173
409
|
* {
|
|
174
410
|
* "nullable": true,
|
|
@@ -1316,10 +1552,6 @@ export interface Customer {
|
|
|
1316
1552
|
export interface CustomerBalance {
|
|
1317
1553
|
/** title:DateTime, format:date-time, description:The date and time the balance was created. */
|
|
1318
1554
|
created_at: string;
|
|
1319
|
-
/** The unique identifier for the balance. */
|
|
1320
|
-
id: Uuid;
|
|
1321
|
-
/** The mapping id of the user or org. */
|
|
1322
|
-
map_id: Uuid;
|
|
1323
1555
|
/**
|
|
1324
1556
|
* {
|
|
1325
1557
|
* "nullable": true,
|
|
@@ -1331,7 +1563,7 @@ export interface CustomerBalance {
|
|
|
1331
1563
|
* {
|
|
1332
1564
|
* "format": "uint64",
|
|
1333
1565
|
* "minimum": 0,
|
|
1334
|
-
* "description": "The number of monthly API credits remaining in the balance.
|
|
1566
|
+
* "description": "The number of monthly API credits remaining in the balance."
|
|
1335
1567
|
* }
|
|
1336
1568
|
*/
|
|
1337
1569
|
monthly_api_credits_remaining: number;
|
|
@@ -1339,7 +1571,7 @@ export interface CustomerBalance {
|
|
|
1339
1571
|
* {
|
|
1340
1572
|
* "title": "double",
|
|
1341
1573
|
* "format": "money-usd",
|
|
1342
|
-
* "description": "The monetary value of the monthly API credits remaining in the balance.
|
|
1574
|
+
* "description": "The monetary value of the monthly API credits remaining in the balance."
|
|
1343
1575
|
* }
|
|
1344
1576
|
*/
|
|
1345
1577
|
monthly_api_credits_remaining_monetary_value: number;
|
|
@@ -1347,7 +1579,7 @@ export interface CustomerBalance {
|
|
|
1347
1579
|
* {
|
|
1348
1580
|
* "format": "uint64",
|
|
1349
1581
|
* "minimum": 0,
|
|
1350
|
-
* "description": "The number of stable API credits remaining in the balance.
|
|
1582
|
+
* "description": "The number of stable API credits remaining in the balance."
|
|
1351
1583
|
* }
|
|
1352
1584
|
*/
|
|
1353
1585
|
stable_api_credits_remaining: number;
|
|
@@ -1355,7 +1587,7 @@ export interface CustomerBalance {
|
|
|
1355
1587
|
* {
|
|
1356
1588
|
* "title": "double",
|
|
1357
1589
|
* "format": "money-usd",
|
|
1358
|
-
* "description": "The monetary value of stable API credits remaining in the balance.
|
|
1590
|
+
* "description": "The monetary value of stable API credits remaining in the balance."
|
|
1359
1591
|
* }
|
|
1360
1592
|
*/
|
|
1361
1593
|
stable_api_credits_remaining_monetary_value: number;
|
|
@@ -1377,6 +1609,45 @@ export interface CustomerBalance {
|
|
|
1377
1609
|
}
|
|
1378
1610
|
export declare type CutStrategy = 'basic' | 'csg' | 'automatic';
|
|
1379
1611
|
export declare type CutType = 'fillet' | 'chamfer';
|
|
1612
|
+
export declare type CutTypeV2 = {
|
|
1613
|
+
fillet: {
|
|
1614
|
+
/** The radius of the fillet. */
|
|
1615
|
+
radius: LengthUnit;
|
|
1616
|
+
/**
|
|
1617
|
+
* {
|
|
1618
|
+
* "nullable": true,
|
|
1619
|
+
* "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."
|
|
1620
|
+
* }
|
|
1621
|
+
*/
|
|
1622
|
+
second_length?: LengthUnit;
|
|
1623
|
+
};
|
|
1624
|
+
} | {
|
|
1625
|
+
chamfer: {
|
|
1626
|
+
/** nullable:true, description:The angle of the chamfer, default is 45deg. */
|
|
1627
|
+
angle?: Angle;
|
|
1628
|
+
/** The distance from the edge to cut on each face. */
|
|
1629
|
+
distance: LengthUnit;
|
|
1630
|
+
/**
|
|
1631
|
+
* {
|
|
1632
|
+
* "nullable": true,
|
|
1633
|
+
* "description": "The second distance affects the edge length of the second face of the cut."
|
|
1634
|
+
* }
|
|
1635
|
+
*/
|
|
1636
|
+
second_distance?: LengthUnit;
|
|
1637
|
+
/** If true, the second distance or angle is applied to the other face of the cut. */
|
|
1638
|
+
swap: boolean;
|
|
1639
|
+
};
|
|
1640
|
+
} | {
|
|
1641
|
+
custom: {
|
|
1642
|
+
/**
|
|
1643
|
+
* {
|
|
1644
|
+
* "format": "uuid",
|
|
1645
|
+
* "description": "The path that will be used for the custom profile."
|
|
1646
|
+
* }
|
|
1647
|
+
*/
|
|
1648
|
+
path: string;
|
|
1649
|
+
};
|
|
1650
|
+
};
|
|
1380
1651
|
export interface DefaultCameraCenterToScene {
|
|
1381
1652
|
}
|
|
1382
1653
|
export interface DefaultCameraCenterToSelection {
|
|
@@ -1721,6 +1992,35 @@ export interface ExtendedUserResultsPage {
|
|
|
1721
1992
|
export interface Extrude {
|
|
1722
1993
|
}
|
|
1723
1994
|
export declare type ExtrudeMethod = 'new' | 'merge';
|
|
1995
|
+
export declare type ExtrudeReference = {
|
|
1996
|
+
entity_reference: {
|
|
1997
|
+
/** format:uuid, description:The UUID of the entity to extrude to. */
|
|
1998
|
+
entity_id: string;
|
|
1999
|
+
};
|
|
2000
|
+
} | {
|
|
2001
|
+
axis: {
|
|
2002
|
+
/** The axis to extrude to. */
|
|
2003
|
+
axis: Point3d;
|
|
2004
|
+
/**
|
|
2005
|
+
* {
|
|
2006
|
+
* "default": {
|
|
2007
|
+
* "x": 0,
|
|
2008
|
+
* "y": 0,
|
|
2009
|
+
* "z": 0
|
|
2010
|
+
* },
|
|
2011
|
+
* "description": "Point the axis goes through. Defaults to (0, 0, 0)."
|
|
2012
|
+
* }
|
|
2013
|
+
*/
|
|
2014
|
+
point?: Point3d;
|
|
2015
|
+
};
|
|
2016
|
+
} | {
|
|
2017
|
+
point: {
|
|
2018
|
+
/** The point to extrude to. */
|
|
2019
|
+
point: Point3d;
|
|
2020
|
+
};
|
|
2021
|
+
};
|
|
2022
|
+
export interface ExtrudeToReference {
|
|
2023
|
+
}
|
|
1724
2024
|
export interface ExtrudedFaceInfo {
|
|
1725
2025
|
/**
|
|
1726
2026
|
* {
|
|
@@ -2322,6 +2622,13 @@ export interface Invoice {
|
|
|
2322
2622
|
* }
|
|
2323
2623
|
*/
|
|
2324
2624
|
paid?: boolean;
|
|
2625
|
+
/**
|
|
2626
|
+
* {
|
|
2627
|
+
* "nullable": true,
|
|
2628
|
+
* "description": "Identifier for the payment intent backing this invoice."
|
|
2629
|
+
* }
|
|
2630
|
+
*/
|
|
2631
|
+
payment_intent_id?: string;
|
|
2325
2632
|
/** nullable:true, format:uri, description:The link to download the PDF for the invoice. */
|
|
2326
2633
|
pdf?: string;
|
|
2327
2634
|
/** This is the transaction number that appears on email receipts sent for this invoice. */
|
|
@@ -2503,7 +2810,7 @@ export interface KclCodeCompletionRequest {
|
|
|
2503
2810
|
/**
|
|
2504
2811
|
* {
|
|
2505
2812
|
* "nullable": true,
|
|
2506
|
-
* "description": "Zoo provided model, or
|
|
2813
|
+
* "description": "Zoo provided model, or custom model which should be used to process this request."
|
|
2507
2814
|
* }
|
|
2508
2815
|
*/
|
|
2509
2816
|
model_version?: string;
|
|
@@ -2570,6 +2877,9 @@ export interface Mass {
|
|
|
2570
2877
|
/** The output unit for the mass. */
|
|
2571
2878
|
output_unit: UnitMass;
|
|
2572
2879
|
}
|
|
2880
|
+
export declare type MbdSymbol =
|
|
2881
|
+
/** MBD symbol type */
|
|
2882
|
+
'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';
|
|
2573
2883
|
export declare type Method = 'OPTIONS' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'TRACE' | 'CONNECT' | 'PATCH' | 'EXTENSION';
|
|
2574
2884
|
export declare type MlCopilotClientMessage = {
|
|
2575
2885
|
headers: {
|
|
@@ -2837,11 +3147,12 @@ export interface ModelingAppSubscriptionTier {
|
|
|
2837
3147
|
/**
|
|
2838
3148
|
* {
|
|
2839
3149
|
* "title": "double",
|
|
3150
|
+
* "default": 0,
|
|
2840
3151
|
* "format": "money-usd",
|
|
2841
3152
|
* "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."
|
|
2842
3153
|
* }
|
|
2843
3154
|
*/
|
|
2844
|
-
monthly_pay_as_you_go_api_credits_monetary_value
|
|
3155
|
+
monthly_pay_as_you_go_api_credits_monetary_value?: number;
|
|
2845
3156
|
/** The name of the tier. */
|
|
2846
3157
|
name: ModelingAppSubscriptionTierName;
|
|
2847
3158
|
/**
|
|
@@ -2849,7 +3160,7 @@ export interface ModelingAppSubscriptionTier {
|
|
|
2849
3160
|
* "title": "double",
|
|
2850
3161
|
* "default": 0,
|
|
2851
3162
|
* "format": "money-usd",
|
|
2852
|
-
* "description": "The price of an API credit (meaning 1 credit = 1
|
|
3163
|
+
* "description": "The price of an API credit (meaning 1 credit = 1 second of API usage)."
|
|
2853
3164
|
* }
|
|
2854
3165
|
*/
|
|
2855
3166
|
pay_as_you_go_api_credit_price?: number;
|
|
@@ -2887,6 +3198,13 @@ export declare type ModelingCmd = {
|
|
|
2887
3198
|
to: Point3d;
|
|
2888
3199
|
type: 'move_path_pen';
|
|
2889
3200
|
} | {
|
|
3201
|
+
/**
|
|
3202
|
+
* {
|
|
3203
|
+
* "nullable": true,
|
|
3204
|
+
* "description": "Optional label to associate with the new path segment."
|
|
3205
|
+
* }
|
|
3206
|
+
*/
|
|
3207
|
+
label?: string;
|
|
2890
3208
|
/** The ID of the command which created the path. */
|
|
2891
3209
|
path: ModelingCmdId;
|
|
2892
3210
|
/** Segment to append to the path. This segment will implicitly begin at the current "pen" location. */
|
|
@@ -2919,6 +3237,26 @@ export declare type ModelingCmd = {
|
|
|
2919
3237
|
/** Which sketch to extrude. Must be a closed 2D solid. */
|
|
2920
3238
|
target: ModelingCmdId;
|
|
2921
3239
|
type: 'extrude';
|
|
3240
|
+
} | {
|
|
3241
|
+
/**
|
|
3242
|
+
* {
|
|
3243
|
+
* "default": "merge",
|
|
3244
|
+
* "description": "Should the extrusion create a new object or be part of the existing object."
|
|
3245
|
+
* }
|
|
3246
|
+
*/
|
|
3247
|
+
extrude_method?: ExtrudeMethod;
|
|
3248
|
+
/**
|
|
3249
|
+
* {
|
|
3250
|
+
* "nullable": true,
|
|
3251
|
+
* "description": "Which IDs should the new faces have? If this isn't given, the engine will generate IDs."
|
|
3252
|
+
* }
|
|
3253
|
+
*/
|
|
3254
|
+
faces?: ExtrudedFaceInfo;
|
|
3255
|
+
/** Reference to extrude to. Extrusion occurs along the target's normal until it is as close to the reference as possible. */
|
|
3256
|
+
reference: ExtrudeReference;
|
|
3257
|
+
/** Which sketch to extrude. Must be a closed 2D solid. */
|
|
3258
|
+
target: ModelingCmdId;
|
|
3259
|
+
type: 'extrude_to_reference';
|
|
2922
3260
|
} | {
|
|
2923
3261
|
/**
|
|
2924
3262
|
* {
|
|
@@ -3255,8 +3593,13 @@ export declare type ModelingCmd = {
|
|
|
3255
3593
|
cylinder_id: string;
|
|
3256
3594
|
/** Is the helix rotation clockwise? */
|
|
3257
3595
|
is_clockwise: boolean;
|
|
3258
|
-
/**
|
|
3259
|
-
|
|
3596
|
+
/**
|
|
3597
|
+
* {
|
|
3598
|
+
* "nullable": true,
|
|
3599
|
+
* "description": "Length of the helix. If None, the length of the cylinder will be used instead."
|
|
3600
|
+
* }
|
|
3601
|
+
*/
|
|
3602
|
+
length?: LengthUnit;
|
|
3260
3603
|
/** format:double, description:Number of revolutions. */
|
|
3261
3604
|
revolutions: number;
|
|
3262
3605
|
/** default:{unit:degrees, value:0}, description:Start angle. */
|
|
@@ -3526,6 +3869,28 @@ export declare type ModelingCmd = {
|
|
|
3526
3869
|
/** The maximum acceptable surface gap computed between the filleted surfaces. Must be positive (i.e. greater than zero). */
|
|
3527
3870
|
tolerance: LengthUnit;
|
|
3528
3871
|
type: 'solid3d_fillet_edge';
|
|
3872
|
+
} | {
|
|
3873
|
+
/** The cut type and information required to perform the cut. */
|
|
3874
|
+
cut_type: CutTypeV2;
|
|
3875
|
+
/**
|
|
3876
|
+
* {
|
|
3877
|
+
* "format": "uuid"
|
|
3878
|
+
* }
|
|
3879
|
+
*/
|
|
3880
|
+
edge_ids?: string[];
|
|
3881
|
+
/**
|
|
3882
|
+
* {
|
|
3883
|
+
* "format": "uuid"
|
|
3884
|
+
* }
|
|
3885
|
+
*/
|
|
3886
|
+
extra_face_ids?: string[];
|
|
3887
|
+
/** format:uuid, description:Which object is being cut. */
|
|
3888
|
+
object_id: string;
|
|
3889
|
+
/** default:automatic, description:Which cutting algorithm to use. */
|
|
3890
|
+
strategy?: CutStrategy;
|
|
3891
|
+
/** The maximum acceptable surface gap computed between the cut surfaces. Must be positive (i.e. greater than zero). */
|
|
3892
|
+
tolerance: LengthUnit;
|
|
3893
|
+
type: 'solid3d_cut_edges';
|
|
3529
3894
|
} | {
|
|
3530
3895
|
/** format:uuid, description:Which face is being queried. */
|
|
3531
3896
|
object_id: string;
|
|
@@ -4164,6 +4529,14 @@ export declare type OkModelingCmdResponse = {
|
|
|
4164
4529
|
*/
|
|
4165
4530
|
data: Extrude;
|
|
4166
4531
|
type: 'extrude';
|
|
4532
|
+
} | {
|
|
4533
|
+
/**
|
|
4534
|
+
* {
|
|
4535
|
+
* "$ref": "#/components/schemas/ExtrudeToReference"
|
|
4536
|
+
* }
|
|
4537
|
+
*/
|
|
4538
|
+
data: ExtrudeToReference;
|
|
4539
|
+
type: 'extrude_to_reference';
|
|
4167
4540
|
} | {
|
|
4168
4541
|
/**
|
|
4169
4542
|
* {
|
|
@@ -4332,6 +4705,14 @@ export declare type OkModelingCmdResponse = {
|
|
|
4332
4705
|
*/
|
|
4333
4706
|
data: Solid3dFilletEdge;
|
|
4334
4707
|
type: 'solid3d_fillet_edge';
|
|
4708
|
+
} | {
|
|
4709
|
+
/**
|
|
4710
|
+
* {
|
|
4711
|
+
* "$ref": "#/components/schemas/Solid3dCutEdges"
|
|
4712
|
+
* }
|
|
4713
|
+
*/
|
|
4714
|
+
data: Solid3dCutEdges;
|
|
4715
|
+
type: 'solid3d_cut_edges';
|
|
4335
4716
|
} | {
|
|
4336
4717
|
/**
|
|
4337
4718
|
* {
|
|
@@ -5347,6 +5728,50 @@ export interface Org {
|
|
|
5347
5728
|
/** title:DateTime, format:date-time, description:The date and time the org was last updated. */
|
|
5348
5729
|
updated_at: string;
|
|
5349
5730
|
}
|
|
5731
|
+
export interface OrgAddress {
|
|
5732
|
+
/** The city component. */
|
|
5733
|
+
city?: string;
|
|
5734
|
+
/** The country component. This is a two-letter ISO country code. */
|
|
5735
|
+
country: CountryCode;
|
|
5736
|
+
/** title:DateTime, format:date-time, description:The time and date the address was created. */
|
|
5737
|
+
created_at: string;
|
|
5738
|
+
/** The unique identifier of the address. */
|
|
5739
|
+
id: Uuid;
|
|
5740
|
+
/** The org ID that this address belongs to. */
|
|
5741
|
+
org_id: Uuid;
|
|
5742
|
+
/** The state component. */
|
|
5743
|
+
state?: string;
|
|
5744
|
+
/** The first street component. */
|
|
5745
|
+
street1?: string;
|
|
5746
|
+
/** The second street component. */
|
|
5747
|
+
street2?: string;
|
|
5748
|
+
/** title:DateTime, format:date-time, description:The time and date the address was last updated. */
|
|
5749
|
+
updated_at: string;
|
|
5750
|
+
/** The zip component. */
|
|
5751
|
+
zip?: string;
|
|
5752
|
+
}
|
|
5753
|
+
export interface OrgAdminDetails {
|
|
5754
|
+
/**
|
|
5755
|
+
* {
|
|
5756
|
+
* "nullable": true,
|
|
5757
|
+
* "description": "Latest billing address stored for the organization."
|
|
5758
|
+
* }
|
|
5759
|
+
*/
|
|
5760
|
+
address?: OrgAddress;
|
|
5761
|
+
/** nullable:true, description:Readable billing address summary. */
|
|
5762
|
+
address_summary?: string;
|
|
5763
|
+
/** nullable:true, description:Block reason when the org is blocked. */
|
|
5764
|
+
block?: BlockReason;
|
|
5765
|
+
/** nullable:true, description:Human-friendly block reason message. */
|
|
5766
|
+
block_message?: string;
|
|
5767
|
+
/** Known payment methods on file. */
|
|
5768
|
+
payment_methods: PaymentMethod[];
|
|
5769
|
+
payment_methods_summary: string[];
|
|
5770
|
+
/** nullable:true, description:Stripe customer identifier if one exists. */
|
|
5771
|
+
stripe_customer_id?: string;
|
|
5772
|
+
/** nullable:true, description:Direct link to the Stripe customer dashboard. */
|
|
5773
|
+
stripe_dashboard_url?: string;
|
|
5774
|
+
}
|
|
5350
5775
|
export interface OrgDetails {
|
|
5351
5776
|
/**
|
|
5352
5777
|
* {
|
|
@@ -6155,6 +6580,8 @@ export interface SketchModeDisable {
|
|
|
6155
6580
|
}
|
|
6156
6581
|
export interface Solid2dAddHole {
|
|
6157
6582
|
}
|
|
6583
|
+
export interface Solid3dCutEdges {
|
|
6584
|
+
}
|
|
6158
6585
|
export interface Solid3dFilletEdge {
|
|
6159
6586
|
}
|
|
6160
6587
|
export interface Solid3dGetAdjacencyInfo {
|
|
@@ -6364,7 +6791,7 @@ export interface TextToCadCreateBody {
|
|
|
6364
6791
|
/**
|
|
6365
6792
|
* {
|
|
6366
6793
|
* "nullable": true,
|
|
6367
|
-
* "description": "Zoo provided model, or
|
|
6794
|
+
* "description": "Zoo provided model, or custom model which should be used to process this request."
|
|
6368
6795
|
* }
|
|
6369
6796
|
*/
|
|
6370
6797
|
model_version?: string;
|
|
@@ -7540,6 +7967,30 @@ export interface User {
|
|
|
7540
7967
|
/** title:DateTime, format:date-time, description:The date and time the user was last updated. */
|
|
7541
7968
|
updated_at: string;
|
|
7542
7969
|
}
|
|
7970
|
+
export interface UserAdminDetails {
|
|
7971
|
+
/** nullable:true, description:Latest billing address stored for the user. */
|
|
7972
|
+
address?: Address;
|
|
7973
|
+
/** nullable:true, description:Readable billing address summary. */
|
|
7974
|
+
address_summary?: string;
|
|
7975
|
+
/** nullable:true, description:Block reason when the user is blocked. */
|
|
7976
|
+
block?: BlockReason;
|
|
7977
|
+
/** nullable:true, description:Human-friendly block reason message. */
|
|
7978
|
+
block_message?: string;
|
|
7979
|
+
/**
|
|
7980
|
+
* {
|
|
7981
|
+
* "nullable": true,
|
|
7982
|
+
* "description": "Direct or search link to the HubSpot contact record."
|
|
7983
|
+
* }
|
|
7984
|
+
*/
|
|
7985
|
+
hubspot_contact_url?: string;
|
|
7986
|
+
/** Known payment methods on file. */
|
|
7987
|
+
payment_methods: PaymentMethod[];
|
|
7988
|
+
payment_methods_summary: string[];
|
|
7989
|
+
/** nullable:true, description:Stripe customer identifier if one exists. */
|
|
7990
|
+
stripe_customer_id?: string;
|
|
7991
|
+
/** nullable:true, description:Direct link to the Stripe customer dashboard. */
|
|
7992
|
+
stripe_dashboard_url?: string;
|
|
7993
|
+
}
|
|
7543
7994
|
export interface UserOrgInfo {
|
|
7544
7995
|
/**
|
|
7545
7996
|
* {
|
|
@@ -7753,11 +8204,12 @@ export declare type ZooProductSubscription = {
|
|
|
7753
8204
|
/**
|
|
7754
8205
|
* {
|
|
7755
8206
|
* "title": "double",
|
|
8207
|
+
* "default": 0,
|
|
7756
8208
|
* "format": "money-usd",
|
|
7757
8209
|
* "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."
|
|
7758
8210
|
* }
|
|
7759
8211
|
*/
|
|
7760
|
-
monthly_pay_as_you_go_api_credits_monetary_value
|
|
8212
|
+
monthly_pay_as_you_go_api_credits_monetary_value?: number;
|
|
7761
8213
|
/** The name of the tier. */
|
|
7762
8214
|
name: ModelingAppSubscriptionTierName;
|
|
7763
8215
|
/**
|
|
@@ -7765,7 +8217,7 @@ export declare type ZooProductSubscription = {
|
|
|
7765
8217
|
* "title": "double",
|
|
7766
8218
|
* "default": 0,
|
|
7767
8219
|
* "format": "money-usd",
|
|
7768
|
-
* "description": "The price of an API credit (meaning 1 credit = 1
|
|
8220
|
+
* "description": "The price of an API credit (meaning 1 credit = 1 second of API usage)."
|
|
7769
8221
|
* }
|
|
7770
8222
|
*/
|
|
7771
8223
|
pay_as_you_go_api_credit_price?: number;
|
|
@@ -7831,11 +8283,17 @@ export interface Models {
|
|
|
7831
8283
|
AccountProvider: AccountProvider;
|
|
7832
8284
|
AddHoleFromOffset: AddHoleFromOffset;
|
|
7833
8285
|
AddOrgMember: AddOrgMember;
|
|
8286
|
+
Address: Address;
|
|
7834
8287
|
AddressDetails: AddressDetails;
|
|
7835
8288
|
AdjacencyInfo: AdjacencyInfo;
|
|
7836
8289
|
Angle: Angle;
|
|
8290
|
+
AnnotationBasicDimension: AnnotationBasicDimension;
|
|
8291
|
+
AnnotationFeatureControl: AnnotationFeatureControl;
|
|
8292
|
+
AnnotationFeatureTag: AnnotationFeatureTag;
|
|
7837
8293
|
AnnotationLineEnd: AnnotationLineEnd;
|
|
7838
8294
|
AnnotationLineEndOptions: AnnotationLineEndOptions;
|
|
8295
|
+
AnnotationMbdBasicDimension: AnnotationMbdBasicDimension;
|
|
8296
|
+
AnnotationMbdControlFrame: AnnotationMbdControlFrame;
|
|
7839
8297
|
AnnotationOptions: AnnotationOptions;
|
|
7840
8298
|
AnnotationTextAlignmentX: AnnotationTextAlignmentX;
|
|
7841
8299
|
AnnotationTextAlignmentY: AnnotationTextAlignmentY;
|
|
@@ -7898,6 +8356,7 @@ export interface Models {
|
|
|
7898
8356
|
CustomerBalance: CustomerBalance;
|
|
7899
8357
|
CutStrategy: CutStrategy;
|
|
7900
8358
|
CutType: CutType;
|
|
8359
|
+
CutTypeV2: CutTypeV2;
|
|
7901
8360
|
DefaultCameraCenterToScene: DefaultCameraCenterToScene;
|
|
7902
8361
|
DefaultCameraCenterToSelection: DefaultCameraCenterToSelection;
|
|
7903
8362
|
DefaultCameraFocusOn: DefaultCameraFocusOn;
|
|
@@ -7958,6 +8417,8 @@ export interface Models {
|
|
|
7958
8417
|
ExtendedUserResultsPage: ExtendedUserResultsPage;
|
|
7959
8418
|
Extrude: Extrude;
|
|
7960
8419
|
ExtrudeMethod: ExtrudeMethod;
|
|
8420
|
+
ExtrudeReference: ExtrudeReference;
|
|
8421
|
+
ExtrudeToReference: ExtrudeToReference;
|
|
7961
8422
|
ExtrudedFaceInfo: ExtrudedFaceInfo;
|
|
7962
8423
|
ExtrusionFaceCapType: ExtrusionFaceCapType;
|
|
7963
8424
|
ExtrusionFaceInfo: ExtrusionFaceInfo;
|
|
@@ -8010,6 +8471,7 @@ export interface Models {
|
|
|
8010
8471
|
MakeOffsetPath: MakeOffsetPath;
|
|
8011
8472
|
MakePlane: MakePlane;
|
|
8012
8473
|
Mass: Mass;
|
|
8474
|
+
MbdSymbol: MbdSymbol;
|
|
8013
8475
|
Method: Method;
|
|
8014
8476
|
MlCopilotClientMessage: MlCopilotClientMessage;
|
|
8015
8477
|
MlCopilotServerMessage: MlCopilotServerMessage;
|
|
@@ -8045,6 +8507,8 @@ export interface Models {
|
|
|
8045
8507
|
OppositeForAngle: OppositeForAngle;
|
|
8046
8508
|
OppositeForLengthUnit: OppositeForLengthUnit;
|
|
8047
8509
|
Org: Org;
|
|
8510
|
+
OrgAddress: OrgAddress;
|
|
8511
|
+
OrgAdminDetails: OrgAdminDetails;
|
|
8048
8512
|
OrgDetails: OrgDetails;
|
|
8049
8513
|
OrgMember: OrgMember;
|
|
8050
8514
|
OrgMemberResultsPage: OrgMemberResultsPage;
|
|
@@ -8127,6 +8591,7 @@ export interface Models {
|
|
|
8127
8591
|
SideFace: SideFace;
|
|
8128
8592
|
SketchModeDisable: SketchModeDisable;
|
|
8129
8593
|
Solid2dAddHole: Solid2dAddHole;
|
|
8594
|
+
Solid3dCutEdges: Solid3dCutEdges;
|
|
8130
8595
|
Solid3dFilletEdge: Solid3dFilletEdge;
|
|
8131
8596
|
Solid3dGetAdjacencyInfo: Solid3dGetAdjacencyInfo;
|
|
8132
8597
|
Solid3dGetAllEdgeFaces: Solid3dGetAllEdgeFaces;
|
|
@@ -8201,6 +8666,7 @@ export interface Models {
|
|
|
8201
8666
|
UpdateShortlinkRequest: UpdateShortlinkRequest;
|
|
8202
8667
|
UpdateUser: UpdateUser;
|
|
8203
8668
|
User: User;
|
|
8669
|
+
UserAdminDetails: UserAdminDetails;
|
|
8204
8670
|
UserOrgInfo: UserOrgInfo;
|
|
8205
8671
|
UserOrgRole: UserOrgRole;
|
|
8206
8672
|
UserResultsPage: UserResultsPage;
|