@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
@@ -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).
@@ -17,7 +17,7 @@
17
17
  export interface OpenApiDocument {
18
18
  [key: string]: any | any;
19
19
  /**
20
- *
20
+ * OpenAPI specification version used by this document.
21
21
  * @type {string}
22
22
  * @memberof OpenApiDocument
23
23
  */
@@ -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).
@@ -2,14 +2,14 @@
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).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { Vec3 } from './Vec3.js';
12
+ import type { PartFeatureMachiningDirection } from './PartFeatureMachiningDirection.js';
13
13
  import type { PartFeatureAxis } from './PartFeatureAxis.js';
14
14
  /**
15
15
  *
@@ -18,35 +18,35 @@ import type { PartFeatureAxis } from './PartFeatureAxis.js';
18
18
  */
19
19
  export interface PartFeature {
20
20
  /**
21
- *
21
+ * Globally unique identifier of this feature record within its report.
22
22
  * @type {string}
23
23
  * @memberof PartFeature
24
24
  */
25
25
  featureId: string;
26
26
  /**
27
- *
27
+ * Stable kernel feature tag, encoded as a lowercase hexadecimal string.
28
28
  * @type {string}
29
29
  * @memberof PartFeature
30
30
  */
31
31
  featureTag: string;
32
32
  /**
33
- *
33
+ * Indexes of regions this feature covers; join each value to `regions[].idx`.
34
34
  * @type {Array<number>}
35
35
  * @memberof PartFeature
36
36
  */
37
37
  regionIdxs: Array<number>;
38
38
  /**
39
- *
39
+ * Kernel-recognized feature type. This vocabulary is open-ended as the kernel evolves.
40
40
  * @type {string}
41
41
  * @memberof PartFeature
42
42
  */
43
43
  featureType: string;
44
44
  /**
45
45
  *
46
- * @type {Vec3}
46
+ * @type {PartFeatureMachiningDirection}
47
47
  * @memberof PartFeature
48
48
  */
49
- machiningDirection: Vec3;
49
+ machiningDirection: PartFeatureMachiningDirection;
50
50
  /**
51
51
  *
52
52
  * @type {PartFeatureAxis}
@@ -4,14 +4,14 @@
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).
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { Vec3FromJSON, Vec3ToJSON } from './Vec3.js';
14
+ import { PartFeatureMachiningDirectionFromJSON, PartFeatureMachiningDirectionToJSON, } from './PartFeatureMachiningDirection.js';
15
15
  import { PartFeatureAxisFromJSON, PartFeatureAxisToJSON, } from './PartFeatureAxis.js';
16
16
  /**
17
17
  * Check if a given object implements the PartFeature interface.
@@ -43,7 +43,7 @@ export function PartFeatureFromJSONTyped(json, ignoreDiscriminator) {
43
43
  featureTag: json['featureTag'],
44
44
  regionIdxs: json['regionIdxs'],
45
45
  featureType: json['featureType'],
46
- machiningDirection: Vec3FromJSON(json['machiningDirection']),
46
+ machiningDirection: PartFeatureMachiningDirectionFromJSON(json['machiningDirection']),
47
47
  axis: PartFeatureAxisFromJSON(json['axis']),
48
48
  };
49
49
  }
@@ -59,7 +59,7 @@ export function PartFeatureToJSONTyped(value, ignoreDiscriminator = false) {
59
59
  featureTag: value['featureTag'],
60
60
  regionIdxs: value['regionIdxs'],
61
61
  featureType: value['featureType'],
62
- machiningDirection: Vec3ToJSON(value['machiningDirection']),
62
+ machiningDirection: PartFeatureMachiningDirectionToJSON(value['machiningDirection']),
63
63
  axis: PartFeatureAxisToJSON(value['axis']),
64
64
  };
65
65
  }
@@ -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).
@@ -10,25 +10,25 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- *
13
+ * Feature-local machining axis, such as a face normal; null for older reports.
14
14
  * @export
15
15
  * @interface PartFeatureAxis
16
16
  */
17
17
  export interface PartFeatureAxis {
18
18
  /**
19
- *
19
+ * X coordinate or direction component.
20
20
  * @type {number}
21
21
  * @memberof PartFeatureAxis
22
22
  */
23
23
  x: number;
24
24
  /**
25
- *
25
+ * Y coordinate or direction component.
26
26
  * @type {number}
27
27
  * @memberof PartFeatureAxis
28
28
  */
29
29
  y: number;
30
30
  /**
31
- *
31
+ * Z coordinate or direction component.
32
32
  * @type {number}
33
33
  * @memberof PartFeatureAxis
34
34
  */
@@ -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,44 @@
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
+ * Access direction from which the kernel extracted this feature.
14
+ * @export
15
+ * @interface PartFeatureMachiningDirection
16
+ */
17
+ export interface PartFeatureMachiningDirection {
18
+ /**
19
+ * X coordinate or direction component.
20
+ * @type {number}
21
+ * @memberof PartFeatureMachiningDirection
22
+ */
23
+ x: number;
24
+ /**
25
+ * Y coordinate or direction component.
26
+ * @type {number}
27
+ * @memberof PartFeatureMachiningDirection
28
+ */
29
+ y: number;
30
+ /**
31
+ * Z coordinate or direction component.
32
+ * @type {number}
33
+ * @memberof PartFeatureMachiningDirection
34
+ */
35
+ z: number;
36
+ }
37
+ /**
38
+ * Check if a given object implements the PartFeatureMachiningDirection interface.
39
+ */
40
+ export declare function instanceOfPartFeatureMachiningDirection(value: object): value is PartFeatureMachiningDirection;
41
+ export declare function PartFeatureMachiningDirectionFromJSON(json: any): PartFeatureMachiningDirection;
42
+ export declare function PartFeatureMachiningDirectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartFeatureMachiningDirection;
43
+ export declare function PartFeatureMachiningDirectionToJSON(json: any): PartFeatureMachiningDirection;
44
+ export declare function PartFeatureMachiningDirectionToJSONTyped(value?: PartFeatureMachiningDirection | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
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
+ /**
15
+ * Check if a given object implements the PartFeatureMachiningDirection interface.
16
+ */
17
+ export function instanceOfPartFeatureMachiningDirection(value) {
18
+ if (!('x' in value) || value['x'] === undefined)
19
+ return false;
20
+ if (!('y' in value) || value['y'] === undefined)
21
+ return false;
22
+ if (!('z' in value) || value['z'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function PartFeatureMachiningDirectionFromJSON(json) {
27
+ return PartFeatureMachiningDirectionFromJSONTyped(json, false);
28
+ }
29
+ export function PartFeatureMachiningDirectionFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ x: json['x'],
35
+ y: json['y'],
36
+ z: json['z'],
37
+ };
38
+ }
39
+ export function PartFeatureMachiningDirectionToJSON(json) {
40
+ return PartFeatureMachiningDirectionToJSONTyped(json, false);
41
+ }
42
+ export function PartFeatureMachiningDirectionToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ x: value['x'],
48
+ y: value['y'],
49
+ z: value['z'],
50
+ };
51
+ }
@@ -2,18 +2,18 @@
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).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { PartReportResponseUnits } from './PartReportResponseUnits.js';
12
13
  import type { DirectionZBounds } from './DirectionZBounds.js';
13
14
  import type { Vec3 } from './Vec3.js';
14
15
  import type { Region } from './Region.js';
15
16
  import type { PartFeature } from './PartFeature.js';
16
- import type { ReportUnits } from './ReportUnits.js';
17
17
  /**
18
18
  *
19
19
  * @export
@@ -21,109 +21,109 @@ import type { ReportUnits } from './ReportUnits.js';
21
21
  */
22
22
  export interface PartReportResponse {
23
23
  /**
24
- *
24
+ * Identifier of the part this report describes.
25
25
  * @type {string}
26
26
  * @memberof PartReportResponse
27
27
  */
28
28
  partId: string;
29
29
  /**
30
- *
30
+ * Identifier of this immutable analysis report.
31
31
  * @type {string}
32
32
  * @memberof PartReportResponse
33
33
  */
34
34
  reportId: string;
35
35
  /**
36
- *
36
+ * Identifier of the analysis job that produced this report.
37
37
  * @type {string}
38
38
  * @memberof PartReportResponse
39
39
  */
40
40
  jobId: string;
41
41
  /**
42
- *
42
+ * Version of the Toolpath kernel that produced this report.
43
43
  * @type {string}
44
44
  * @memberof PartReportResponse
45
45
  */
46
46
  kernelVersion: string;
47
47
  /**
48
48
  *
49
- * @type {ReportUnits}
49
+ * @type {PartReportResponseUnits}
50
50
  * @memberof PartReportResponse
51
51
  */
52
- units: ReportUnits;
52
+ units: PartReportResponseUnits;
53
53
  /**
54
- *
54
+ * Recognized B-rep regions, ordered by region index.
55
55
  * @type {Array<Region>}
56
56
  * @memberof PartReportResponse
57
57
  */
58
58
  regions: Array<Region>;
59
59
  /**
60
- *
60
+ * Features recognized in this analysis run.
61
61
  * @type {Array<PartFeature>}
62
62
  * @memberof PartReportResponse
63
63
  */
64
64
  features: Array<PartFeature>;
65
65
  /**
66
- *
66
+ * Directions from which the part can be analyzed or machined.
67
67
  * @type {Array<Vec3>}
68
68
  * @memberof PartReportResponse
69
69
  */
70
70
  candidateDirections: Array<Vec3>;
71
71
  /**
72
- *
72
+ * Part z extents for each candidate direction, or null when detail enrichment did not run.
73
73
  * @type {Array<DirectionZBounds>}
74
74
  * @memberof PartReportResponse
75
75
  */
76
76
  directionZBounds: Array<DirectionZBounds> | null;
77
77
  /**
78
- *
78
+ * Number of points in the generated mesh.
79
79
  * @type {number}
80
80
  * @memberof PartReportResponse
81
81
  */
82
82
  meshPointCount: number;
83
83
  /**
84
- *
84
+ * Number of triangles in the generated mesh.
85
85
  * @type {number}
86
86
  * @memberof PartReportResponse
87
87
  */
88
88
  meshTriangleCount: number;
89
89
  /**
90
- *
90
+ * 15-minute URL for the rendered PNG thumbnail, or null when absent.
91
91
  * @type {string}
92
92
  * @memberof PartReportResponse
93
93
  */
94
94
  thumbnailUrl: string | null;
95
95
  /**
96
- *
96
+ * 15-minute URL for the generated STL mesh, or null when absent.
97
97
  * @type {string}
98
98
  * @memberof PartReportResponse
99
99
  */
100
100
  meshStlUrl: string | null;
101
101
  /**
102
- *
102
+ * 15-minute URL for the generated GLB mesh, or null when absent.
103
103
  * @type {string}
104
104
  * @memberof PartReportResponse
105
105
  */
106
106
  meshGlbUrl: string | null;
107
107
  /**
108
- *
108
+ * Worker time spent downloading the source CAD file, in milliseconds.
109
109
  * @type {number}
110
110
  * @memberof PartReportResponse
111
111
  */
112
112
  downloadMs: number;
113
113
  /**
114
- *
114
+ * Kernel time spent on initial part analysis, in milliseconds.
115
115
  * @type {number}
116
116
  * @memberof PartReportResponse
117
117
  */
118
118
  recognitionMs: number;
119
119
  /**
120
- *
120
+ * Kernel time spent building per-feature details, in milliseconds.
121
121
  * @type {number}
122
122
  * @memberof PartReportResponse
123
123
  */
124
124
  enrichmentMs: number;
125
125
  /**
126
- *
126
+ * Total worker processing time for this report, in milliseconds.
127
127
  * @type {number}
128
128
  * @memberof PartReportResponse
129
129
  */
@@ -4,18 +4,18 @@
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).
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { PartReportResponseUnitsFromJSON, PartReportResponseUnitsToJSON, } from './PartReportResponseUnits.js';
14
15
  import { DirectionZBoundsFromJSON, DirectionZBoundsToJSON, } from './DirectionZBounds.js';
15
16
  import { Vec3FromJSON, Vec3ToJSON } from './Vec3.js';
16
17
  import { RegionFromJSON, RegionToJSON } from './Region.js';
17
18
  import { PartFeatureFromJSON, PartFeatureToJSON, } from './PartFeature.js';
18
- import { ReportUnitsFromJSON, ReportUnitsToJSON, } from './ReportUnits.js';
19
19
  /**
20
20
  * Check if a given object implements the PartReportResponse interface.
21
21
  */
@@ -70,7 +70,7 @@ export function PartReportResponseFromJSONTyped(json, ignoreDiscriminator) {
70
70
  reportId: json['reportId'],
71
71
  jobId: json['jobId'],
72
72
  kernelVersion: json['kernelVersion'],
73
- units: ReportUnitsFromJSON(json['units']),
73
+ units: PartReportResponseUnitsFromJSON(json['units']),
74
74
  regions: json['regions'].map(RegionFromJSON),
75
75
  features: json['features'].map(PartFeatureFromJSON),
76
76
  candidateDirections: json['candidateDirections'].map(Vec3FromJSON),
@@ -100,7 +100,7 @@ export function PartReportResponseToJSONTyped(value, ignoreDiscriminator = false
100
100
  reportId: value['reportId'],
101
101
  jobId: value['jobId'],
102
102
  kernelVersion: value['kernelVersion'],
103
- units: ReportUnitsToJSON(value['units']),
103
+ units: PartReportResponseUnitsToJSON(value['units']),
104
104
  regions: value['regions'].map(RegionToJSON),
105
105
  features: value['features'].map(PartFeatureToJSON),
106
106
  candidateDirections: value['candidateDirections'].map(Vec3ToJSON),
@@ -0,0 +1,52 @@
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
+ * Units used by all dimensional values in this report.
14
+ * @export
15
+ * @interface PartReportResponseUnits
16
+ */
17
+ export interface PartReportResponseUnits {
18
+ /**
19
+ * Unit used by every length and area measurement.
20
+ * @type {PartReportResponseUnitsLengthEnum}
21
+ * @memberof PartReportResponseUnits
22
+ */
23
+ length: PartReportResponseUnitsLengthEnum;
24
+ /**
25
+ * Unit used by every angular measurement.
26
+ * @type {PartReportResponseUnitsAngleEnum}
27
+ * @memberof PartReportResponseUnits
28
+ */
29
+ angle: PartReportResponseUnitsAngleEnum;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const PartReportResponseUnitsLengthEnum: {
35
+ readonly Mm: "mm";
36
+ };
37
+ export type PartReportResponseUnitsLengthEnum = (typeof PartReportResponseUnitsLengthEnum)[keyof typeof PartReportResponseUnitsLengthEnum];
38
+ /**
39
+ * @export
40
+ */
41
+ export declare const PartReportResponseUnitsAngleEnum: {
42
+ readonly Deg: "deg";
43
+ };
44
+ export type PartReportResponseUnitsAngleEnum = (typeof PartReportResponseUnitsAngleEnum)[keyof typeof PartReportResponseUnitsAngleEnum];
45
+ /**
46
+ * Check if a given object implements the PartReportResponseUnits interface.
47
+ */
48
+ export declare function instanceOfPartReportResponseUnits(value: object): value is PartReportResponseUnits;
49
+ export declare function PartReportResponseUnitsFromJSON(json: any): PartReportResponseUnits;
50
+ export declare function PartReportResponseUnitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartReportResponseUnits;
51
+ export declare function PartReportResponseUnitsToJSON(json: any): PartReportResponseUnits;
52
+ export declare function PartReportResponseUnitsToJSONTyped(value?: PartReportResponseUnits | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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
+ /**
15
+ * @export
16
+ */
17
+ export const PartReportResponseUnitsLengthEnum = {
18
+ Mm: 'mm',
19
+ };
20
+ /**
21
+ * @export
22
+ */
23
+ export const PartReportResponseUnitsAngleEnum = {
24
+ Deg: 'deg',
25
+ };
26
+ /**
27
+ * Check if a given object implements the PartReportResponseUnits interface.
28
+ */
29
+ export function instanceOfPartReportResponseUnits(value) {
30
+ if (!('length' in value) || value['length'] === undefined)
31
+ return false;
32
+ if (value['length'] !== 'mm')
33
+ return false;
34
+ if (!('angle' in value) || value['angle'] === undefined)
35
+ return false;
36
+ if (value['angle'] !== 'deg')
37
+ return false;
38
+ return true;
39
+ }
40
+ export function PartReportResponseUnitsFromJSON(json) {
41
+ return PartReportResponseUnitsFromJSONTyped(json, false);
42
+ }
43
+ export function PartReportResponseUnitsFromJSONTyped(json, ignoreDiscriminator) {
44
+ if (json == null) {
45
+ return json;
46
+ }
47
+ return {
48
+ length: json['length'],
49
+ angle: json['angle'],
50
+ };
51
+ }
52
+ export function PartReportResponseUnitsToJSON(json) {
53
+ return PartReportResponseUnitsToJSONTyped(json, false);
54
+ }
55
+ export function PartReportResponseUnitsToJSONTyped(value, ignoreDiscriminator = false) {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+ return {
60
+ length: value['length'],
61
+ angle: value['angle'],
62
+ };
63
+ }
@@ -0,0 +1,65 @@
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 pocket: a walled space with a floor, and the blend where the two meet.
15
+ * @export
16
+ * @interface PocketFacts
17
+ */
18
+ export interface PocketFacts {
19
+ /**
20
+ * Discriminator for this facts variant.
21
+ * @type {PocketFactsKindEnum}
22
+ * @memberof PocketFacts
23
+ */
24
+ kind: PocketFactsKindEnum;
25
+ /**
26
+ * Clearance-diameter limits for tools sweeping the pocket.
27
+ * @type {CdData}
28
+ * @memberof PocketFacts
29
+ */
30
+ cd: CdData;
31
+ /**
32
+ * The bottom diameter a terminal tool must not exceed; negative infinity when
33
+ * unconstrained.
34
+ * @type {number}
35
+ * @memberof PocketFacts
36
+ */
37
+ maxBottomDiameter: number;
38
+ /**
39
+ * Radius of the floor fillet; 0.0 when unfilleted.
40
+ * @type {number}
41
+ * @memberof PocketFacts
42
+ */
43
+ filletRadius: number;
44
+ /**
45
+ * Height of the floor fillet; 0.0 when unfilleted.
46
+ * @type {number}
47
+ * @memberof PocketFacts
48
+ */
49
+ filletHeight: number;
50
+ }
51
+ /**
52
+ * @export
53
+ */
54
+ export declare const PocketFactsKindEnum: {
55
+ readonly Pocket: "Pocket";
56
+ };
57
+ export type PocketFactsKindEnum = (typeof PocketFactsKindEnum)[keyof typeof PocketFactsKindEnum];
58
+ /**
59
+ * Check if a given object implements the PocketFacts interface.
60
+ */
61
+ export declare function instanceOfPocketFacts(value: object): value is PocketFacts;
62
+ export declare function PocketFactsFromJSON(json: any): PocketFacts;
63
+ export declare function PocketFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PocketFacts;
64
+ export declare function PocketFactsToJSON(json: any): PocketFacts;
65
+ export declare function PocketFactsToJSONTyped(value?: PocketFacts | null, ignoreDiscriminator?: boolean): any;