@toolpath/api 0.1.0 → 0.2.1

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.
Files changed (109) hide show
  1. package/dist/generated/apis/FeaturesApi.d.ts +1 -1
  2. package/dist/generated/apis/FeaturesApi.js +1 -1
  3. package/dist/generated/apis/JobsApi.d.ts +1 -1
  4. package/dist/generated/apis/JobsApi.js +1 -1
  5. package/dist/generated/apis/KeysApi.d.ts +1 -1
  6. package/dist/generated/apis/KeysApi.js +1 -1
  7. package/dist/generated/apis/PartsApi.d.ts +1 -1
  8. package/dist/generated/apis/PartsApi.js +1 -1
  9. package/dist/generated/apis/ServiceApi.d.ts +1 -1
  10. package/dist/generated/apis/ServiceApi.js +1 -1
  11. package/dist/generated/models/AnalyzeJobResponse.d.ts +4 -4
  12. package/dist/generated/models/AnalyzeJobResponse.js +1 -1
  13. package/dist/generated/models/BevelFacts.d.ts +62 -0
  14. package/dist/generated/models/BevelFacts.js +58 -0
  15. package/dist/generated/models/BossFacts.d.ts +64 -0
  16. package/dist/generated/models/BossFacts.js +68 -0
  17. package/dist/generated/models/CdBounds.d.ts +41 -0
  18. package/dist/generated/models/CdBounds.js +47 -0
  19. package/dist/generated/models/CdData.d.ts +52 -0
  20. package/dist/generated/models/CdData.js +56 -0
  21. package/dist/generated/models/ChamferFacts.d.ts +55 -0
  22. package/dist/generated/models/ChamferFacts.js +61 -0
  23. package/dist/generated/models/ComputeFeatureDatasheetsRequest.d.ts +2 -2
  24. package/dist/generated/models/ComputeFeatureDatasheetsRequest.js +1 -1
  25. package/dist/generated/models/ComputeFeatureDatasheetsResponse.d.ts +4 -4
  26. package/dist/generated/models/ComputeFeatureDatasheetsResponse.js +1 -1
  27. package/dist/generated/models/CreatePartResponse.d.ts +5 -5
  28. package/dist/generated/models/CreatePartResponse.js +1 -1
  29. package/dist/generated/models/DirectionZBounds.d.ts +6 -6
  30. package/dist/generated/models/DirectionZBounds.js +4 -4
  31. package/dist/generated/models/DirectionZBoundsDirection.d.ts +44 -0
  32. package/dist/generated/models/DirectionZBoundsDirection.js +51 -0
  33. package/dist/generated/models/DovetailFacts.d.ts +98 -0
  34. package/dist/generated/models/DovetailFacts.js +84 -0
  35. package/dist/generated/models/FaceFacts.d.ts +70 -0
  36. package/dist/generated/models/FaceFacts.js +72 -0
  37. package/dist/generated/models/FeatureDatasheet.d.ts +110 -0
  38. package/dist/generated/models/FeatureDatasheet.js +94 -0
  39. package/dist/generated/models/FeatureDatasheetEntry.d.ts +8 -9
  40. package/dist/generated/models/FeatureDatasheetEntry.js +8 -3
  41. package/dist/generated/models/FeatureDatasheetFacts.d.ts +51 -0
  42. package/dist/generated/models/FeatureDatasheetFacts.js +89 -0
  43. package/dist/generated/models/FeatureDatasheetsResponse.d.ts +3 -3
  44. package/dist/generated/models/FeatureDatasheetsResponse.js +1 -1
  45. package/dist/generated/models/FeatureType.d.ts +58 -0
  46. package/dist/generated/models/FeatureType.js +76 -0
  47. package/dist/generated/models/HealthResponse.d.ts +3 -3
  48. package/dist/generated/models/HealthResponse.js +1 -1
  49. package/dist/generated/models/HoleFacts.d.ts +109 -0
  50. package/dist/generated/models/HoleFacts.js +96 -0
  51. package/dist/generated/models/HoleProcess.d.ts +26 -0
  52. package/dist/generated/models/HoleProcess.js +44 -0
  53. package/dist/generated/models/JobDetail.d.ts +9 -9
  54. package/dist/generated/models/JobDetail.js +1 -1
  55. package/dist/generated/models/JobSummary.d.ts +7 -7
  56. package/dist/generated/models/JobSummary.js +1 -1
  57. package/dist/generated/models/KeyValidationResponse.d.ts +1 -1
  58. package/dist/generated/models/KeyValidationResponse.js +1 -1
  59. package/dist/generated/models/ListJobsResponse.d.ts +5 -5
  60. package/dist/generated/models/ListJobsResponse.js +1 -1
  61. package/dist/generated/models/OpenApiDocument.d.ts +2 -2
  62. package/dist/generated/models/OpenApiDocument.js +1 -1
  63. package/dist/generated/models/PartFeature.d.ts +8 -8
  64. package/dist/generated/models/PartFeature.js +4 -4
  65. package/dist/generated/models/PartFeatureAxis.d.ts +5 -5
  66. package/dist/generated/models/PartFeatureAxis.js +1 -1
  67. package/dist/generated/models/PartFeatureMachiningDirection.d.ts +44 -0
  68. package/dist/generated/models/PartFeatureMachiningDirection.js +51 -0
  69. package/dist/generated/models/PartReportResponse.d.ts +21 -21
  70. package/dist/generated/models/PartReportResponse.js +4 -4
  71. package/dist/generated/models/PartReportResponseUnits.d.ts +52 -0
  72. package/dist/generated/models/PartReportResponseUnits.js +63 -0
  73. package/dist/generated/models/PocketFacts.d.ts +65 -0
  74. package/dist/generated/models/PocketFacts.js +68 -0
  75. package/dist/generated/models/ProblemDetails.d.ts +1 -1
  76. package/dist/generated/models/ProblemDetails.js +1 -1
  77. package/dist/generated/models/ProfileFacts.d.ts +58 -0
  78. package/dist/generated/models/ProfileFacts.js +64 -0
  79. package/dist/generated/models/Region.d.ts +12 -6
  80. package/dist/generated/models/Region.js +5 -1
  81. package/dist/generated/models/ReportUnits.d.ts +3 -3
  82. package/dist/generated/models/ReportUnits.js +1 -1
  83. package/dist/generated/models/SinkFacts.d.ts +47 -0
  84. package/dist/generated/models/SinkFacts.js +52 -0
  85. package/dist/generated/models/SurfaceFacts.d.ts +97 -0
  86. package/dist/generated/models/SurfaceFacts.js +89 -0
  87. package/dist/generated/models/ThreadProcess.d.ts +26 -0
  88. package/dist/generated/models/ThreadProcess.js +44 -0
  89. package/dist/generated/models/ThreadSpec.d.ts +62 -0
  90. package/dist/generated/models/ThreadSpec.js +63 -0
  91. package/dist/generated/models/Threading.d.ts +40 -0
  92. package/dist/generated/models/Threading.js +49 -0
  93. package/dist/generated/models/ToleranceBand.d.ts +45 -0
  94. package/dist/generated/models/ToleranceBand.js +51 -0
  95. package/dist/generated/models/ToolFitResult.d.ts +44 -0
  96. package/dist/generated/models/ToolFitResult.js +51 -0
  97. package/dist/generated/models/TslotFacts.d.ts +81 -0
  98. package/dist/generated/models/TslotFacts.js +76 -0
  99. package/dist/generated/models/Vec2.d.ts +38 -0
  100. package/dist/generated/models/Vec2.js +47 -0
  101. package/dist/generated/models/Vec3.d.ts +4 -4
  102. package/dist/generated/models/Vec3.js +1 -1
  103. package/dist/generated/models/WallFacts.d.ts +46 -0
  104. package/dist/generated/models/WallFacts.js +56 -0
  105. package/dist/generated/models/index.d.ts +27 -0
  106. package/dist/generated/models/index.js +27 -0
  107. package/dist/generated/runtime.d.ts +1 -1
  108. package/dist/generated/runtime.js +1 -1
  109. package/package.json +3 -3
@@ -0,0 +1,68 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Toolpath Engine API
5
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { CdDataFromJSON, CdDataToJSON } from './CdData.js';
15
+ /**
16
+ * @export
17
+ */
18
+ export const PocketFactsKindEnum = {
19
+ Pocket: 'Pocket',
20
+ };
21
+ /**
22
+ * Check if a given object implements the PocketFacts interface.
23
+ */
24
+ export function instanceOfPocketFacts(value) {
25
+ if (!('kind' in value) || value['kind'] === undefined)
26
+ return false;
27
+ if (value['kind'] !== 'Pocket')
28
+ return false;
29
+ if (!('cd' in value) || value['cd'] === undefined)
30
+ return false;
31
+ if (!('maxBottomDiameter' in value) || value['maxBottomDiameter'] === undefined)
32
+ return false;
33
+ if (!('filletRadius' in value) || value['filletRadius'] === undefined)
34
+ return false;
35
+ if (!('filletHeight' in value) || value['filletHeight'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ export function PocketFactsFromJSON(json) {
40
+ return PocketFactsFromJSONTyped(json, false);
41
+ }
42
+ export function PocketFactsFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ kind: json['kind'],
48
+ cd: CdDataFromJSON(json['cd']),
49
+ maxBottomDiameter: json['maxBottomDiameter'],
50
+ filletRadius: json['filletRadius'],
51
+ filletHeight: json['filletHeight'],
52
+ };
53
+ }
54
+ export function PocketFactsToJSON(json) {
55
+ return PocketFactsToJSONTyped(json, false);
56
+ }
57
+ export function PocketFactsToJSONTyped(value, ignoreDiscriminator = false) {
58
+ if (value == null) {
59
+ return value;
60
+ }
61
+ return {
62
+ kind: value['kind'],
63
+ cd: CdDataToJSON(value['cd']),
64
+ maxBottomDiameter: value['maxBottomDiameter'],
65
+ filletRadius: value['filletRadius'],
66
+ filletHeight: value['filletHeight'],
67
+ };
68
+ }
@@ -2,7 +2,7 @@
2
2
  * Toolpath Engine API
3
3
  * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
4
  *
5
- * The version of the OpenAPI document: 1.0.0
5
+ * The version of the OpenAPI document: 1.0.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Toolpath Engine API
5
5
  * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
6
  *
7
- * The version of the OpenAPI document: 1.0.0
7
+ * The version of the OpenAPI document: 1.0.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,58 @@
1
+ /**
2
+ * Toolpath Engine API
3
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { CdData } from './CdData.js';
13
+ /**
14
+ * A profile: one pass around the part's outline.
15
+ * @export
16
+ * @interface ProfileFacts
17
+ */
18
+ export interface ProfileFacts {
19
+ /**
20
+ * Discriminator for this facts variant.
21
+ * @type {ProfileFactsKindEnum}
22
+ * @memberof ProfileFacts
23
+ */
24
+ kind: ProfileFactsKindEnum;
25
+ /**
26
+ * Clearance-diameter limits for tools following the profile.
27
+ * @type {CdData}
28
+ * @memberof ProfileFacts
29
+ */
30
+ cd: CdData;
31
+ /**
32
+ * How far the pass travels, mm — the outline's own length.
33
+ * @type {number}
34
+ * @memberof ProfileFacts
35
+ */
36
+ length: number;
37
+ /**
38
+ * Whether the outline is the part's silhouette or the bridged reading of it.
39
+ * @type {boolean}
40
+ * @memberof ProfileFacts
41
+ */
42
+ isModified: boolean;
43
+ }
44
+ /**
45
+ * @export
46
+ */
47
+ export declare const ProfileFactsKindEnum: {
48
+ readonly Profile: "Profile";
49
+ };
50
+ export type ProfileFactsKindEnum = (typeof ProfileFactsKindEnum)[keyof typeof ProfileFactsKindEnum];
51
+ /**
52
+ * Check if a given object implements the ProfileFacts interface.
53
+ */
54
+ export declare function instanceOfProfileFacts(value: object): value is ProfileFacts;
55
+ export declare function ProfileFactsFromJSON(json: any): ProfileFacts;
56
+ export declare function ProfileFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProfileFacts;
57
+ export declare function ProfileFactsToJSON(json: any): ProfileFacts;
58
+ export declare function ProfileFactsToJSONTyped(value?: ProfileFacts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,64 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Toolpath Engine API
5
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { CdDataFromJSON, CdDataToJSON } from './CdData.js';
15
+ /**
16
+ * @export
17
+ */
18
+ export const ProfileFactsKindEnum = {
19
+ Profile: 'Profile',
20
+ };
21
+ /**
22
+ * Check if a given object implements the ProfileFacts interface.
23
+ */
24
+ export function instanceOfProfileFacts(value) {
25
+ if (!('kind' in value) || value['kind'] === undefined)
26
+ return false;
27
+ if (value['kind'] !== 'Profile')
28
+ return false;
29
+ if (!('cd' in value) || value['cd'] === undefined)
30
+ return false;
31
+ if (!('length' in value) || value['length'] === undefined)
32
+ return false;
33
+ if (!('isModified' in value) || value['isModified'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ export function ProfileFactsFromJSON(json) {
38
+ return ProfileFactsFromJSONTyped(json, false);
39
+ }
40
+ export function ProfileFactsFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ kind: json['kind'],
46
+ cd: CdDataFromJSON(json['cd']),
47
+ length: json['length'],
48
+ isModified: json['isModified'],
49
+ };
50
+ }
51
+ export function ProfileFactsToJSON(json) {
52
+ return ProfileFactsToJSONTyped(json, false);
53
+ }
54
+ export function ProfileFactsToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ kind: value['kind'],
60
+ cd: CdDataToJSON(value['cd']),
61
+ length: value['length'],
62
+ isModified: value['isModified'],
63
+ };
64
+ }
@@ -2,7 +2,7 @@
2
2
  * Toolpath Engine API
3
3
  * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
4
  *
5
- * The version of the OpenAPI document: 1.0.0
5
+ * The version of the OpenAPI document: 1.0.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,31 +16,37 @@
16
16
  */
17
17
  export interface Region {
18
18
  /**
19
- *
19
+ * Stable region index referenced by `features[].regionIdxs`.
20
20
  * @type {number}
21
21
  * @memberof Region
22
22
  */
23
23
  idx: number;
24
24
  /**
25
- *
25
+ * Report-local source-face group; equal values identify regions split from one B-rep face.
26
+ * @type {number}
27
+ * @memberof Region
28
+ */
29
+ splitOrigin: number;
30
+ /**
31
+ * Recognized surface kind, such as Plane, Cylinder, Cone, Sphere, Torus, or Freeform.
26
32
  * @type {string}
27
33
  * @memberof Region
28
34
  */
29
35
  shapeKind: string;
30
36
  /**
31
- *
37
+ * Surface area of the region, in mm².
32
38
  * @type {number}
33
39
  * @memberof Region
34
40
  */
35
41
  area: number;
36
42
  /**
37
- *
43
+ * Inclusive start of this region’s triangle range in the returned mesh ordering.
38
44
  * @type {number}
39
45
  * @memberof Region
40
46
  */
41
47
  triangleStart: number;
42
48
  /**
43
- *
49
+ * Exclusive end of this region’s triangle range in the returned mesh ordering.
44
50
  * @type {number}
45
51
  * @memberof Region
46
52
  */
@@ -4,7 +4,7 @@
4
4
  * Toolpath Engine API
5
5
  * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
6
  *
7
- * The version of the OpenAPI document: 1.0.0
7
+ * The version of the OpenAPI document: 1.0.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,6 +17,8 @@
17
17
  export function instanceOfRegion(value) {
18
18
  if (!('idx' in value) || value['idx'] === undefined)
19
19
  return false;
20
+ if (!('splitOrigin' in value) || value['splitOrigin'] === undefined)
21
+ return false;
20
22
  if (!('shapeKind' in value) || value['shapeKind'] === undefined)
21
23
  return false;
22
24
  if (!('area' in value) || value['area'] === undefined)
@@ -36,6 +38,7 @@ export function RegionFromJSONTyped(json, ignoreDiscriminator) {
36
38
  }
37
39
  return {
38
40
  idx: json['idx'],
41
+ splitOrigin: json['splitOrigin'],
39
42
  shapeKind: json['shapeKind'],
40
43
  area: json['area'],
41
44
  triangleStart: json['triangleStart'],
@@ -51,6 +54,7 @@ export function RegionToJSONTyped(value, ignoreDiscriminator = false) {
51
54
  }
52
55
  return {
53
56
  idx: value['idx'],
57
+ splitOrigin: value['splitOrigin'],
54
58
  shapeKind: value['shapeKind'],
55
59
  area: value['area'],
56
60
  triangleStart: value['triangleStart'],
@@ -2,7 +2,7 @@
2
2
  * Toolpath Engine API
3
3
  * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
4
  *
5
- * The version of the OpenAPI document: 1.0.0
5
+ * The version of the OpenAPI document: 1.0.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,13 +16,13 @@
16
16
  */
17
17
  export interface ReportUnits {
18
18
  /**
19
- *
19
+ * Unit used by every length and area measurement.
20
20
  * @type {ReportUnitsLengthEnum}
21
21
  * @memberof ReportUnits
22
22
  */
23
23
  length: ReportUnitsLengthEnum;
24
24
  /**
25
- *
25
+ * Unit used by every angular measurement.
26
26
  * @type {ReportUnitsAngleEnum}
27
27
  * @memberof ReportUnits
28
28
  */
@@ -4,7 +4,7 @@
4
4
  * Toolpath Engine API
5
5
  * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
6
  *
7
- * The version of the OpenAPI document: 1.0.0
7
+ * The version of the OpenAPI document: 1.0.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,47 @@
1
+ /**
2
+ * Toolpath Engine API
3
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Vec2 } from './Vec2.js';
13
+ /**
14
+ * A countersink read as a cone of revolution: the circle its bevel starts from and the
15
+ * one it opens to.
16
+ * @export
17
+ * @interface SinkFacts
18
+ */
19
+ export interface SinkFacts {
20
+ /**
21
+ * Where the cone's axis crosses the plane the contours are read in (the tool
22
+ * frame's) — the sink's position across the part, not along the tool.
23
+ * @type {Vec2}
24
+ * @memberof SinkFacts
25
+ */
26
+ center: Vec2;
27
+ /**
28
+ * Radius of the circle the bevel starts from, at its lower edge — the pilot hole.
29
+ * @type {number}
30
+ * @memberof SinkFacts
31
+ */
32
+ innerRadius: number;
33
+ /**
34
+ * Radius it has opened to at the upper edge.
35
+ * @type {number}
36
+ * @memberof SinkFacts
37
+ */
38
+ outerRadius: number;
39
+ }
40
+ /**
41
+ * Check if a given object implements the SinkFacts interface.
42
+ */
43
+ export declare function instanceOfSinkFacts(value: object): value is SinkFacts;
44
+ export declare function SinkFactsFromJSON(json: any): SinkFacts;
45
+ export declare function SinkFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SinkFacts;
46
+ export declare function SinkFactsToJSON(json: any): SinkFacts;
47
+ export declare function SinkFactsToJSONTyped(value?: SinkFacts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Toolpath Engine API
5
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { Vec2FromJSON, Vec2ToJSON } from './Vec2.js';
15
+ /**
16
+ * Check if a given object implements the SinkFacts interface.
17
+ */
18
+ export function instanceOfSinkFacts(value) {
19
+ if (!('center' in value) || value['center'] === undefined)
20
+ return false;
21
+ if (!('innerRadius' in value) || value['innerRadius'] === undefined)
22
+ return false;
23
+ if (!('outerRadius' in value) || value['outerRadius'] === undefined)
24
+ return false;
25
+ return true;
26
+ }
27
+ export function SinkFactsFromJSON(json) {
28
+ return SinkFactsFromJSONTyped(json, false);
29
+ }
30
+ export function SinkFactsFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ center: Vec2FromJSON(json['center']),
36
+ innerRadius: json['innerRadius'],
37
+ outerRadius: json['outerRadius'],
38
+ };
39
+ }
40
+ export function SinkFactsToJSON(json) {
41
+ return SinkFactsToJSONTyped(json, false);
42
+ }
43
+ export function SinkFactsToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ center: Vec2ToJSON(value['center']),
49
+ innerRadius: value['innerRadius'],
50
+ outerRadius: value['outerRadius'],
51
+ };
52
+ }
@@ -0,0 +1,97 @@
1
+ /**
2
+ * Toolpath Engine API
3
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ToolFitResult } from './ToolFitResult.js';
13
+ import type { CdData } from './CdData.js';
14
+ /**
15
+ * A three-dimensional surface a tool has to follow rather than sweep; also the surface
16
+ * half of a chamfer.
17
+ * @export
18
+ * @interface SurfaceFacts
19
+ */
20
+ export interface SurfaceFacts {
21
+ /**
22
+ * Discriminator for this facts variant.
23
+ * @type {SurfaceFactsKindEnum}
24
+ * @memberof SurfaceFacts
25
+ */
26
+ kind: SurfaceFactsKindEnum;
27
+ /**
28
+ * The blend radius, signed by which way the surface turns: positive rolling over
29
+ * an edge, negative running into a corner, zero for no blend at all.
30
+ * @type {number}
31
+ * @memberof SurfaceFacts
32
+ */
33
+ filletRadius: number;
34
+ /**
35
+ * The deepest cut taken in one pass down the surface, mm.
36
+ * @type {number}
37
+ * @memberof SurfaceFacts
38
+ */
39
+ maxStepdown: number;
40
+ /**
41
+ * How much scallop the finishing pass may leave between neighbouring passes, mm.
42
+ * @type {number}
43
+ * @memberof SurfaceFacts
44
+ */
45
+ surfaceFinishCuspHeight: number;
46
+ /**
47
+ * Whether the fillet has a U-shaped cross section.
48
+ * @type {boolean}
49
+ * @memberof SurfaceFacts
50
+ */
51
+ isUShapedFillet: boolean;
52
+ /**
53
+ * Whether the surface includes a sharp corner a tool must respect.
54
+ * @type {boolean}
55
+ * @memberof SurfaceFacts
56
+ */
57
+ hasSharpCorner: boolean;
58
+ /**
59
+ * Whether only ball tools are suitable for the finishing pass.
60
+ * @type {boolean}
61
+ * @memberof SurfaceFacts
62
+ */
63
+ useOnlyBallToolsForFinish: boolean;
64
+ /**
65
+ * Largest bottom diameter a terminal tool may have, in mm.
66
+ * @type {number}
67
+ * @memberof SurfaceFacts
68
+ */
69
+ maxBottomDiameter: number;
70
+ /**
71
+ * Clearance-diameter limits for tools reaching the surface.
72
+ * @type {CdData}
73
+ * @memberof SurfaceFacts
74
+ */
75
+ cd: CdData;
76
+ /**
77
+ * Geometry limits imposed by the surface shape itself.
78
+ * @type {ToolFitResult}
79
+ * @memberof SurfaceFacts
80
+ */
81
+ toolFit: ToolFitResult;
82
+ }
83
+ /**
84
+ * @export
85
+ */
86
+ export declare const SurfaceFactsKindEnum: {
87
+ readonly Three: "Three";
88
+ };
89
+ export type SurfaceFactsKindEnum = (typeof SurfaceFactsKindEnum)[keyof typeof SurfaceFactsKindEnum];
90
+ /**
91
+ * Check if a given object implements the SurfaceFacts interface.
92
+ */
93
+ export declare function instanceOfSurfaceFacts(value: object): value is SurfaceFacts;
94
+ export declare function SurfaceFactsFromJSON(json: any): SurfaceFacts;
95
+ export declare function SurfaceFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SurfaceFacts;
96
+ export declare function SurfaceFactsToJSON(json: any): SurfaceFacts;
97
+ export declare function SurfaceFactsToJSONTyped(value?: SurfaceFacts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,89 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Toolpath Engine API
5
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ToolFitResultFromJSON, ToolFitResultToJSON, } from './ToolFitResult.js';
15
+ import { CdDataFromJSON, CdDataToJSON } from './CdData.js';
16
+ /**
17
+ * @export
18
+ */
19
+ export const SurfaceFactsKindEnum = {
20
+ Three: 'Three',
21
+ };
22
+ /**
23
+ * Check if a given object implements the SurfaceFacts interface.
24
+ */
25
+ export function instanceOfSurfaceFacts(value) {
26
+ if (!('kind' in value) || value['kind'] === undefined)
27
+ return false;
28
+ if (value['kind'] !== 'Three')
29
+ return false;
30
+ if (!('filletRadius' in value) || value['filletRadius'] === undefined)
31
+ return false;
32
+ if (!('maxStepdown' in value) || value['maxStepdown'] === undefined)
33
+ return false;
34
+ if (!('surfaceFinishCuspHeight' in value) || value['surfaceFinishCuspHeight'] === undefined)
35
+ return false;
36
+ if (!('isUShapedFillet' in value) || value['isUShapedFillet'] === undefined)
37
+ return false;
38
+ if (!('hasSharpCorner' in value) || value['hasSharpCorner'] === undefined)
39
+ return false;
40
+ if (!('useOnlyBallToolsForFinish' in value) || value['useOnlyBallToolsForFinish'] === undefined)
41
+ return false;
42
+ if (!('maxBottomDiameter' in value) || value['maxBottomDiameter'] === undefined)
43
+ return false;
44
+ if (!('cd' in value) || value['cd'] === undefined)
45
+ return false;
46
+ if (!('toolFit' in value) || value['toolFit'] === undefined)
47
+ return false;
48
+ return true;
49
+ }
50
+ export function SurfaceFactsFromJSON(json) {
51
+ return SurfaceFactsFromJSONTyped(json, false);
52
+ }
53
+ export function SurfaceFactsFromJSONTyped(json, ignoreDiscriminator) {
54
+ if (json == null) {
55
+ return json;
56
+ }
57
+ return {
58
+ kind: json['kind'],
59
+ filletRadius: json['filletRadius'],
60
+ maxStepdown: json['maxStepdown'],
61
+ surfaceFinishCuspHeight: json['surfaceFinishCuspHeight'],
62
+ isUShapedFillet: json['isUShapedFillet'],
63
+ hasSharpCorner: json['hasSharpCorner'],
64
+ useOnlyBallToolsForFinish: json['useOnlyBallToolsForFinish'],
65
+ maxBottomDiameter: json['maxBottomDiameter'],
66
+ cd: CdDataFromJSON(json['cd']),
67
+ toolFit: ToolFitResultFromJSON(json['toolFit']),
68
+ };
69
+ }
70
+ export function SurfaceFactsToJSON(json) {
71
+ return SurfaceFactsToJSONTyped(json, false);
72
+ }
73
+ export function SurfaceFactsToJSONTyped(value, ignoreDiscriminator = false) {
74
+ if (value == null) {
75
+ return value;
76
+ }
77
+ return {
78
+ kind: value['kind'],
79
+ filletRadius: value['filletRadius'],
80
+ maxStepdown: value['maxStepdown'],
81
+ surfaceFinishCuspHeight: value['surfaceFinishCuspHeight'],
82
+ isUShapedFillet: value['isUShapedFillet'],
83
+ hasSharpCorner: value['hasSharpCorner'],
84
+ useOnlyBallToolsForFinish: value['useOnlyBallToolsForFinish'],
85
+ maxBottomDiameter: value['maxBottomDiameter'],
86
+ cd: CdDataToJSON(value['cd']),
87
+ toolFit: ToolFitResultToJSON(value['toolFit']),
88
+ };
89
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Toolpath Engine API
3
+ * Public REST API for Toolpath engine operations. **Units.** All dimensional values — in reports and in feature datasheets — are in millimetres; all angles are in degrees. Each report also states this in its `units` field. **Browser use.** CORS is per API key: a request only receives an `Access-Control-Allow-Origin` header when its `Origin` is in the allowlist configured on the key used (set when creating or editing the key in the portal). A key with no allowed origins is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by anyone — restrict its origins, prefer a `read_only` key (read_only keys may call GET operations only; writes are rejected with 403), or proxy requests through your own server.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * How a thread is to be cut: the three ways there are.
14
+ * @export
15
+ */
16
+ export declare const ThreadProcess: {
17
+ readonly ThreadMill: "ThreadMill";
18
+ readonly CutTap: "CutTap";
19
+ readonly FormTap: "FormTap";
20
+ };
21
+ export type ThreadProcess = (typeof ThreadProcess)[keyof typeof ThreadProcess];
22
+ export declare function instanceOfThreadProcess(value: any): boolean;
23
+ export declare function ThreadProcessFromJSON(json: any): ThreadProcess;
24
+ export declare function ThreadProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): ThreadProcess;
25
+ export declare function ThreadProcessToJSON(value?: ThreadProcess | null): any;
26
+ export declare function ThreadProcessToJSONTyped(value: any, ignoreDiscriminator: boolean): ThreadProcess;