@toolpath/api 0.1.0 → 0.2.2

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 (114) hide show
  1. package/README.md +1 -1
  2. package/dist/generated/apis/FeaturesApi.d.ts +22 -20
  3. package/dist/generated/apis/FeaturesApi.js +41 -33
  4. package/dist/generated/apis/JobsApi.d.ts +1 -1
  5. package/dist/generated/apis/JobsApi.js +1 -1
  6. package/dist/generated/apis/KeysApi.d.ts +1 -1
  7. package/dist/generated/apis/KeysApi.js +1 -1
  8. package/dist/generated/apis/PartsApi.d.ts +28 -28
  9. package/dist/generated/apis/PartsApi.js +49 -49
  10. package/dist/generated/apis/ServiceApi.d.ts +1 -1
  11. package/dist/generated/apis/ServiceApi.js +1 -1
  12. package/dist/generated/models/BevelFacts.d.ts +62 -0
  13. package/dist/generated/models/BevelFacts.js +58 -0
  14. package/dist/generated/models/BossFacts.d.ts +64 -0
  15. package/dist/generated/models/BossFacts.js +68 -0
  16. package/dist/generated/models/CdBounds.d.ts +41 -0
  17. package/dist/generated/models/CdBounds.js +47 -0
  18. package/dist/generated/models/CdData.d.ts +52 -0
  19. package/dist/generated/models/CdData.js +56 -0
  20. package/dist/generated/models/ChamferFacts.d.ts +55 -0
  21. package/dist/generated/models/ChamferFacts.js +61 -0
  22. package/dist/generated/models/CreatePartResponse.d.ts +5 -5
  23. package/dist/generated/models/CreatePartResponse.js +1 -1
  24. package/dist/generated/models/DirectionZBounds.d.ts +6 -6
  25. package/dist/generated/models/DirectionZBounds.js +4 -4
  26. package/dist/generated/models/DirectionZBoundsDirection.d.ts +44 -0
  27. package/dist/generated/models/DirectionZBoundsDirection.js +51 -0
  28. package/dist/generated/models/DovetailFacts.d.ts +98 -0
  29. package/dist/generated/models/DovetailFacts.js +84 -0
  30. package/dist/generated/models/FaceFacts.d.ts +70 -0
  31. package/dist/generated/models/FaceFacts.js +72 -0
  32. package/dist/generated/models/FeatureDatasheet.d.ts +110 -0
  33. package/dist/generated/models/FeatureDatasheet.js +94 -0
  34. package/dist/generated/models/FeatureDatasheetFacts.d.ts +51 -0
  35. package/dist/generated/models/FeatureDatasheetFacts.js +89 -0
  36. package/dist/generated/models/FeatureType.d.ts +58 -0
  37. package/dist/generated/models/FeatureType.js +76 -0
  38. package/dist/generated/models/HealthResponse.d.ts +3 -3
  39. package/dist/generated/models/HealthResponse.js +1 -1
  40. package/dist/generated/models/HoleFacts.d.ts +109 -0
  41. package/dist/generated/models/HoleFacts.js +96 -0
  42. package/dist/generated/models/HoleProcess.d.ts +26 -0
  43. package/dist/generated/models/HoleProcess.js +44 -0
  44. package/dist/generated/models/JobDetail.d.ts +9 -9
  45. package/dist/generated/models/JobDetail.js +1 -1
  46. package/dist/generated/models/JobSummary.d.ts +7 -7
  47. package/dist/generated/models/JobSummary.js +1 -1
  48. package/dist/generated/models/KeyValidationResponse.d.ts +1 -1
  49. package/dist/generated/models/KeyValidationResponse.js +1 -1
  50. package/dist/generated/models/ListJobsResponse.d.ts +5 -5
  51. package/dist/generated/models/ListJobsResponse.js +1 -1
  52. package/dist/generated/models/OpenApiDocument.d.ts +2 -2
  53. package/dist/generated/models/OpenApiDocument.js +1 -1
  54. package/dist/generated/models/PartFeature.d.ts +8 -8
  55. package/dist/generated/models/PartFeature.js +4 -4
  56. package/dist/generated/models/PartFeatureAxis.d.ts +5 -5
  57. package/dist/generated/models/PartFeatureAxis.js +1 -1
  58. package/dist/generated/models/PartFeatureEntry.d.ts +51 -0
  59. package/dist/generated/models/{FeatureDatasheetEntry.js → PartFeatureEntry.js} +16 -11
  60. package/dist/generated/models/PartFeatureMachiningDirection.d.ts +44 -0
  61. package/dist/generated/models/PartFeatureMachiningDirection.js +51 -0
  62. package/dist/generated/models/PartFeaturesResponse.d.ts +39 -0
  63. package/dist/generated/models/{FeatureDatasheetsResponse.js → PartFeaturesResponse.js} +12 -12
  64. package/dist/generated/models/PartReportResponse.d.ts +21 -21
  65. package/dist/generated/models/PartReportResponse.js +4 -4
  66. package/dist/generated/models/PartReportResponseUnits.d.ts +52 -0
  67. package/dist/generated/models/PartReportResponseUnits.js +63 -0
  68. package/dist/generated/models/PocketFacts.d.ts +65 -0
  69. package/dist/generated/models/PocketFacts.js +68 -0
  70. package/dist/generated/models/ProblemDetails.d.ts +1 -1
  71. package/dist/generated/models/ProblemDetails.js +1 -1
  72. package/dist/generated/models/ProfileFacts.d.ts +58 -0
  73. package/dist/generated/models/ProfileFacts.js +64 -0
  74. package/dist/generated/models/Region.d.ts +12 -6
  75. package/dist/generated/models/Region.js +5 -1
  76. package/dist/generated/models/ReportUnits.d.ts +3 -3
  77. package/dist/generated/models/ReportUnits.js +1 -1
  78. package/dist/generated/models/SinkFacts.d.ts +47 -0
  79. package/dist/generated/models/SinkFacts.js +52 -0
  80. package/dist/generated/models/SurfaceFacts.d.ts +97 -0
  81. package/dist/generated/models/SurfaceFacts.js +89 -0
  82. package/dist/generated/models/ThreadProcess.d.ts +26 -0
  83. package/dist/generated/models/ThreadProcess.js +44 -0
  84. package/dist/generated/models/ThreadSpec.d.ts +62 -0
  85. package/dist/generated/models/ThreadSpec.js +63 -0
  86. package/dist/generated/models/Threading.d.ts +40 -0
  87. package/dist/generated/models/Threading.js +49 -0
  88. package/dist/generated/models/ToleranceBand.d.ts +45 -0
  89. package/dist/generated/models/ToleranceBand.js +51 -0
  90. package/dist/generated/models/ToolFitResult.d.ts +44 -0
  91. package/dist/generated/models/ToolFitResult.js +51 -0
  92. package/dist/generated/models/TslotFacts.d.ts +81 -0
  93. package/dist/generated/models/TslotFacts.js +76 -0
  94. package/dist/generated/models/{ComputeFeatureDatasheetsRequest.d.ts → UpdatePartFeaturesRequest.d.ts} +11 -11
  95. package/dist/generated/models/{ComputeFeatureDatasheetsRequest.js → UpdatePartFeaturesRequest.js} +9 -9
  96. package/dist/generated/models/UpdatePartFeaturesResponse.d.ts +51 -0
  97. package/dist/generated/models/{ComputeFeatureDatasheetsResponse.js → UpdatePartFeaturesResponse.js} +10 -10
  98. package/dist/generated/models/UpdatePartResponse.d.ts +51 -0
  99. package/dist/generated/models/{AnalyzeJobResponse.js → UpdatePartResponse.js} +10 -10
  100. package/dist/generated/models/Vec2.d.ts +38 -0
  101. package/dist/generated/models/Vec2.js +47 -0
  102. package/dist/generated/models/Vec3.d.ts +4 -4
  103. package/dist/generated/models/Vec3.js +1 -1
  104. package/dist/generated/models/WallFacts.d.ts +46 -0
  105. package/dist/generated/models/WallFacts.js +56 -0
  106. package/dist/generated/models/index.d.ts +32 -5
  107. package/dist/generated/models/index.js +32 -5
  108. package/dist/generated/runtime.d.ts +1 -1
  109. package/dist/generated/runtime.js +1 -1
  110. package/package.json +3 -3
  111. package/dist/generated/models/AnalyzeJobResponse.d.ts +0 -51
  112. package/dist/generated/models/ComputeFeatureDatasheetsResponse.d.ts +0 -51
  113. package/dist/generated/models/FeatureDatasheetEntry.d.ts +0 -52
  114. package/dist/generated/models/FeatureDatasheetsResponse.d.ts +0 -39
@@ -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.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,37 +16,37 @@
16
16
  */
17
17
  export interface JobSummary {
18
18
  /**
19
- *
19
+ * Identifier of the part this job processes.
20
20
  * @type {string}
21
21
  * @memberof JobSummary
22
22
  */
23
23
  partUuid: string;
24
24
  /**
25
- *
25
+ * Identifier of this job.
26
26
  * @type {string}
27
27
  * @memberof JobSummary
28
28
  */
29
29
  jobUuid: string;
30
30
  /**
31
- *
31
+ * Product operation performed by the job, such as analyze-part or enrich-features.
32
32
  * @type {string}
33
33
  * @memberof JobSummary
34
34
  */
35
35
  productType: string;
36
36
  /**
37
- *
37
+ * Current durable state of the job.
38
38
  * @type {JobSummaryStatusEnum}
39
39
  * @memberof JobSummary
40
40
  */
41
41
  status: JobSummaryStatusEnum;
42
42
  /**
43
- *
43
+ * Worker-reported completion percentage, or null before progress is available.
44
44
  * @type {number}
45
45
  * @memberof JobSummary
46
46
  */
47
47
  progress: number | null;
48
48
  /**
49
- *
49
+ * Time at which the job was created, in ISO 8601 format.
50
50
  * @type {Date}
51
51
  * @memberof JobSummary
52
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.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.2
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.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,25 +17,25 @@ import type { JobSummary } from './JobSummary.js';
17
17
  */
18
18
  export interface ListJobsResponse {
19
19
  /**
20
- *
20
+ * Jobs in this page, newest first.
21
21
  * @type {Array<JobSummary>}
22
22
  * @memberof ListJobsResponse
23
23
  */
24
24
  items: Array<JobSummary>;
25
25
  /**
26
- *
26
+ * One-based page number returned.
27
27
  * @type {number}
28
28
  * @memberof ListJobsResponse
29
29
  */
30
30
  page: number;
31
31
  /**
32
- *
32
+ * Maximum number of jobs returned in this page.
33
33
  * @type {number}
34
34
  * @memberof ListJobsResponse
35
35
  */
36
36
  pageSize: number;
37
37
  /**
38
- *
38
+ * Total number of jobs matching the query.
39
39
  * @type {number}
40
40
  * @memberof ListJobsResponse
41
41
  */
@@ -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.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.2
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.2
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.2
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.2
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.2
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.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,51 @@
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.2
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 { FeatureDatasheet } from './FeatureDatasheet.js';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PartFeatureEntry
17
+ */
18
+ export interface PartFeatureEntry {
19
+ /**
20
+ * Identifier of the resolved feature.
21
+ * @type {string}
22
+ * @memberof PartFeatureEntry
23
+ */
24
+ featureId: string;
25
+ /**
26
+ * Stable kernel feature tag, encoded as a lowercase hexadecimal string.
27
+ * @type {string}
28
+ * @memberof PartFeatureEntry
29
+ */
30
+ featureTag: string;
31
+ /**
32
+ * Kernel-recognized feature type; the vocabulary is open-ended.
33
+ * @type {string}
34
+ * @memberof PartFeatureEntry
35
+ */
36
+ featureType: string;
37
+ /**
38
+ * Generated machining datasheet, or null when this feature has no datasheet yet.
39
+ * @type {FeatureDatasheet}
40
+ * @memberof PartFeatureEntry
41
+ */
42
+ datasheet?: FeatureDatasheet | null;
43
+ }
44
+ /**
45
+ * Check if a given object implements the PartFeatureEntry interface.
46
+ */
47
+ export declare function instanceOfPartFeatureEntry(value: object): value is PartFeatureEntry;
48
+ export declare function PartFeatureEntryFromJSON(json: any): PartFeatureEntry;
49
+ export declare function PartFeatureEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartFeatureEntry;
50
+ export declare function PartFeatureEntryToJSON(json: any): PartFeatureEntry;
51
+ export declare function PartFeatureEntryToJSONTyped(value?: PartFeatureEntry | null, ignoreDiscriminator?: boolean): any;
@@ -4,17 +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.2
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 { FeatureDatasheetFromJSON, FeatureDatasheetToJSON, } from './FeatureDatasheet.js';
14
15
  /**
15
- * Check if a given object implements the FeatureDatasheetEntry interface.
16
+ * Check if a given object implements the PartFeatureEntry interface.
16
17
  */
17
- export function instanceOfFeatureDatasheetEntry(value) {
18
+ export function instanceOfPartFeatureEntry(value) {
18
19
  if (!('featureId' in value) || value['featureId'] === undefined)
19
20
  return false;
20
21
  if (!('featureTag' in value) || value['featureTag'] === undefined)
@@ -23,10 +24,10 @@ export function instanceOfFeatureDatasheetEntry(value) {
23
24
  return false;
24
25
  return true;
25
26
  }
26
- export function FeatureDatasheetEntryFromJSON(json) {
27
- return FeatureDatasheetEntryFromJSONTyped(json, false);
27
+ export function PartFeatureEntryFromJSON(json) {
28
+ return PartFeatureEntryFromJSONTyped(json, false);
28
29
  }
29
- export function FeatureDatasheetEntryFromJSONTyped(json, ignoreDiscriminator) {
30
+ export function PartFeatureEntryFromJSONTyped(json, ignoreDiscriminator) {
30
31
  if (json == null) {
31
32
  return json;
32
33
  }
@@ -34,13 +35,17 @@ export function FeatureDatasheetEntryFromJSONTyped(json, ignoreDiscriminator) {
34
35
  featureId: json['featureId'],
35
36
  featureTag: json['featureTag'],
36
37
  featureType: json['featureType'],
37
- datasheet: json['datasheet'] == null ? undefined : json['datasheet'],
38
+ datasheet: json['datasheet'] === undefined
39
+ ? undefined
40
+ : json['datasheet'] === null
41
+ ? null
42
+ : FeatureDatasheetFromJSON(json['datasheet']),
38
43
  };
39
44
  }
40
- export function FeatureDatasheetEntryToJSON(json) {
41
- return FeatureDatasheetEntryToJSONTyped(json, false);
45
+ export function PartFeatureEntryToJSON(json) {
46
+ return PartFeatureEntryToJSONTyped(json, false);
42
47
  }
43
- export function FeatureDatasheetEntryToJSONTyped(value, ignoreDiscriminator = false) {
48
+ export function PartFeatureEntryToJSONTyped(value, ignoreDiscriminator = false) {
44
49
  if (value == null) {
45
50
  return value;
46
51
  }
@@ -48,6 +53,6 @@ export function FeatureDatasheetEntryToJSONTyped(value, ignoreDiscriminator = fa
48
53
  featureId: value['featureId'],
49
54
  featureTag: value['featureTag'],
50
55
  featureType: value['featureType'],
51
- datasheet: value['datasheet'],
56
+ datasheet: FeatureDatasheetToJSON(value['datasheet']),
52
57
  };
53
58
  }
@@ -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.2
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.2
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
+ }
@@ -0,0 +1,39 @@
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.2
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 { PartFeatureEntry } from './PartFeatureEntry.js';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PartFeaturesResponse
17
+ */
18
+ export interface PartFeaturesResponse {
19
+ /**
20
+ * Datasheets for requested features that belong to the authorized organization.
21
+ * @type {Array<PartFeatureEntry>}
22
+ * @memberof PartFeaturesResponse
23
+ */
24
+ datasheets: Array<PartFeatureEntry>;
25
+ /**
26
+ * Requested feature identifiers that were unknown or inaccessible to this organization.
27
+ * @type {Array<string>}
28
+ * @memberof PartFeaturesResponse
29
+ */
30
+ notFound: Array<string>;
31
+ }
32
+ /**
33
+ * Check if a given object implements the PartFeaturesResponse interface.
34
+ */
35
+ export declare function instanceOfPartFeaturesResponse(value: object): value is PartFeaturesResponse;
36
+ export declare function PartFeaturesResponseFromJSON(json: any): PartFeaturesResponse;
37
+ export declare function PartFeaturesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartFeaturesResponse;
38
+ export declare function PartFeaturesResponseToJSON(json: any): PartFeaturesResponse;
39
+ export declare function PartFeaturesResponseToJSONTyped(value?: PartFeaturesResponse | null, ignoreDiscriminator?: boolean): any;
@@ -4,45 +4,45 @@
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.2
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 { FeatureDatasheetEntryFromJSON, FeatureDatasheetEntryToJSON, } from './FeatureDatasheetEntry.js';
14
+ import { PartFeatureEntryFromJSON, PartFeatureEntryToJSON, } from './PartFeatureEntry.js';
15
15
  /**
16
- * Check if a given object implements the FeatureDatasheetsResponse interface.
16
+ * Check if a given object implements the PartFeaturesResponse interface.
17
17
  */
18
- export function instanceOfFeatureDatasheetsResponse(value) {
18
+ export function instanceOfPartFeaturesResponse(value) {
19
19
  if (!('datasheets' in value) || value['datasheets'] === undefined)
20
20
  return false;
21
21
  if (!('notFound' in value) || value['notFound'] === undefined)
22
22
  return false;
23
23
  return true;
24
24
  }
25
- export function FeatureDatasheetsResponseFromJSON(json) {
26
- return FeatureDatasheetsResponseFromJSONTyped(json, false);
25
+ export function PartFeaturesResponseFromJSON(json) {
26
+ return PartFeaturesResponseFromJSONTyped(json, false);
27
27
  }
28
- export function FeatureDatasheetsResponseFromJSONTyped(json, ignoreDiscriminator) {
28
+ export function PartFeaturesResponseFromJSONTyped(json, ignoreDiscriminator) {
29
29
  if (json == null) {
30
30
  return json;
31
31
  }
32
32
  return {
33
- datasheets: json['datasheets'].map(FeatureDatasheetEntryFromJSON),
33
+ datasheets: json['datasheets'].map(PartFeatureEntryFromJSON),
34
34
  notFound: json['notFound'],
35
35
  };
36
36
  }
37
- export function FeatureDatasheetsResponseToJSON(json) {
38
- return FeatureDatasheetsResponseToJSONTyped(json, false);
37
+ export function PartFeaturesResponseToJSON(json) {
38
+ return PartFeaturesResponseToJSONTyped(json, false);
39
39
  }
40
- export function FeatureDatasheetsResponseToJSONTyped(value, ignoreDiscriminator = false) {
40
+ export function PartFeaturesResponseToJSONTyped(value, ignoreDiscriminator = false) {
41
41
  if (value == null) {
42
42
  return value;
43
43
  }
44
44
  return {
45
- datasheets: value['datasheets'].map(FeatureDatasheetEntryToJSON),
45
+ datasheets: value['datasheets'].map(PartFeatureEntryToJSON),
46
46
  notFound: value['notFound'],
47
47
  };
48
48
  }