@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.
- package/README.md +1 -1
- package/dist/generated/apis/FeaturesApi.d.ts +22 -20
- package/dist/generated/apis/FeaturesApi.js +41 -33
- package/dist/generated/apis/JobsApi.d.ts +1 -1
- package/dist/generated/apis/JobsApi.js +1 -1
- package/dist/generated/apis/KeysApi.d.ts +1 -1
- package/dist/generated/apis/KeysApi.js +1 -1
- package/dist/generated/apis/PartsApi.d.ts +28 -28
- package/dist/generated/apis/PartsApi.js +49 -49
- package/dist/generated/apis/ServiceApi.d.ts +1 -1
- package/dist/generated/apis/ServiceApi.js +1 -1
- package/dist/generated/models/BevelFacts.d.ts +62 -0
- package/dist/generated/models/BevelFacts.js +58 -0
- package/dist/generated/models/BossFacts.d.ts +64 -0
- package/dist/generated/models/BossFacts.js +68 -0
- package/dist/generated/models/CdBounds.d.ts +41 -0
- package/dist/generated/models/CdBounds.js +47 -0
- package/dist/generated/models/CdData.d.ts +52 -0
- package/dist/generated/models/CdData.js +56 -0
- package/dist/generated/models/ChamferFacts.d.ts +55 -0
- package/dist/generated/models/ChamferFacts.js +61 -0
- package/dist/generated/models/CreatePartResponse.d.ts +5 -5
- package/dist/generated/models/CreatePartResponse.js +1 -1
- package/dist/generated/models/DirectionZBounds.d.ts +6 -6
- package/dist/generated/models/DirectionZBounds.js +4 -4
- package/dist/generated/models/DirectionZBoundsDirection.d.ts +44 -0
- package/dist/generated/models/DirectionZBoundsDirection.js +51 -0
- package/dist/generated/models/DovetailFacts.d.ts +98 -0
- package/dist/generated/models/DovetailFacts.js +84 -0
- package/dist/generated/models/FaceFacts.d.ts +70 -0
- package/dist/generated/models/FaceFacts.js +72 -0
- package/dist/generated/models/FeatureDatasheet.d.ts +110 -0
- package/dist/generated/models/FeatureDatasheet.js +94 -0
- package/dist/generated/models/FeatureDatasheetFacts.d.ts +51 -0
- package/dist/generated/models/FeatureDatasheetFacts.js +89 -0
- package/dist/generated/models/FeatureType.d.ts +58 -0
- package/dist/generated/models/FeatureType.js +76 -0
- package/dist/generated/models/HealthResponse.d.ts +3 -3
- package/dist/generated/models/HealthResponse.js +1 -1
- package/dist/generated/models/HoleFacts.d.ts +109 -0
- package/dist/generated/models/HoleFacts.js +96 -0
- package/dist/generated/models/HoleProcess.d.ts +26 -0
- package/dist/generated/models/HoleProcess.js +44 -0
- package/dist/generated/models/JobDetail.d.ts +9 -9
- package/dist/generated/models/JobDetail.js +1 -1
- package/dist/generated/models/JobSummary.d.ts +7 -7
- package/dist/generated/models/JobSummary.js +1 -1
- package/dist/generated/models/KeyValidationResponse.d.ts +1 -1
- package/dist/generated/models/KeyValidationResponse.js +1 -1
- package/dist/generated/models/ListJobsResponse.d.ts +5 -5
- package/dist/generated/models/ListJobsResponse.js +1 -1
- package/dist/generated/models/OpenApiDocument.d.ts +2 -2
- package/dist/generated/models/OpenApiDocument.js +1 -1
- package/dist/generated/models/PartFeature.d.ts +8 -8
- package/dist/generated/models/PartFeature.js +4 -4
- package/dist/generated/models/PartFeatureAxis.d.ts +5 -5
- package/dist/generated/models/PartFeatureAxis.js +1 -1
- package/dist/generated/models/PartFeatureEntry.d.ts +51 -0
- package/dist/generated/models/{FeatureDatasheetEntry.js → PartFeatureEntry.js} +16 -11
- package/dist/generated/models/PartFeatureMachiningDirection.d.ts +44 -0
- package/dist/generated/models/PartFeatureMachiningDirection.js +51 -0
- package/dist/generated/models/PartFeaturesResponse.d.ts +39 -0
- package/dist/generated/models/{FeatureDatasheetsResponse.js → PartFeaturesResponse.js} +12 -12
- package/dist/generated/models/PartReportResponse.d.ts +21 -21
- package/dist/generated/models/PartReportResponse.js +4 -4
- package/dist/generated/models/PartReportResponseUnits.d.ts +52 -0
- package/dist/generated/models/PartReportResponseUnits.js +63 -0
- package/dist/generated/models/PocketFacts.d.ts +65 -0
- package/dist/generated/models/PocketFacts.js +68 -0
- package/dist/generated/models/ProblemDetails.d.ts +1 -1
- package/dist/generated/models/ProblemDetails.js +1 -1
- package/dist/generated/models/ProfileFacts.d.ts +58 -0
- package/dist/generated/models/ProfileFacts.js +64 -0
- package/dist/generated/models/Region.d.ts +12 -6
- package/dist/generated/models/Region.js +5 -1
- package/dist/generated/models/ReportUnits.d.ts +3 -3
- package/dist/generated/models/ReportUnits.js +1 -1
- package/dist/generated/models/SinkFacts.d.ts +47 -0
- package/dist/generated/models/SinkFacts.js +52 -0
- package/dist/generated/models/SurfaceFacts.d.ts +97 -0
- package/dist/generated/models/SurfaceFacts.js +89 -0
- package/dist/generated/models/ThreadProcess.d.ts +26 -0
- package/dist/generated/models/ThreadProcess.js +44 -0
- package/dist/generated/models/ThreadSpec.d.ts +62 -0
- package/dist/generated/models/ThreadSpec.js +63 -0
- package/dist/generated/models/Threading.d.ts +40 -0
- package/dist/generated/models/Threading.js +49 -0
- package/dist/generated/models/ToleranceBand.d.ts +45 -0
- package/dist/generated/models/ToleranceBand.js +51 -0
- package/dist/generated/models/ToolFitResult.d.ts +44 -0
- package/dist/generated/models/ToolFitResult.js +51 -0
- package/dist/generated/models/TslotFacts.d.ts +81 -0
- package/dist/generated/models/TslotFacts.js +76 -0
- package/dist/generated/models/{ComputeFeatureDatasheetsRequest.d.ts → UpdatePartFeaturesRequest.d.ts} +11 -11
- package/dist/generated/models/{ComputeFeatureDatasheetsRequest.js → UpdatePartFeaturesRequest.js} +9 -9
- package/dist/generated/models/UpdatePartFeaturesResponse.d.ts +51 -0
- package/dist/generated/models/{ComputeFeatureDatasheetsResponse.js → UpdatePartFeaturesResponse.js} +10 -10
- package/dist/generated/models/UpdatePartResponse.d.ts +51 -0
- package/dist/generated/models/{AnalyzeJobResponse.js → UpdatePartResponse.js} +10 -10
- package/dist/generated/models/Vec2.d.ts +38 -0
- package/dist/generated/models/Vec2.js +47 -0
- package/dist/generated/models/Vec3.d.ts +4 -4
- package/dist/generated/models/Vec3.js +1 -1
- package/dist/generated/models/WallFacts.d.ts +46 -0
- package/dist/generated/models/WallFacts.js +56 -0
- package/dist/generated/models/index.d.ts +32 -5
- package/dist/generated/models/index.js +32 -5
- package/dist/generated/runtime.d.ts +1 -1
- package/dist/generated/runtime.js +1 -1
- package/package.json +3 -3
- package/dist/generated/models/AnalyzeJobResponse.d.ts +0 -51
- package/dist/generated/models/ComputeFeatureDatasheetsResponse.d.ts +0 -51
- package/dist/generated/models/FeatureDatasheetEntry.d.ts +0 -52
- package/dist/generated/models/FeatureDatasheetsResponse.d.ts +0 -39
|
@@ -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 { BossFacts } from './BossFacts.js';
|
|
13
|
+
import type { ChamferFacts } from './ChamferFacts.js';
|
|
14
|
+
import type { DovetailFacts } from './DovetailFacts.js';
|
|
15
|
+
import type { FaceFacts } from './FaceFacts.js';
|
|
16
|
+
import type { HoleFacts } from './HoleFacts.js';
|
|
17
|
+
import type { PocketFacts } from './PocketFacts.js';
|
|
18
|
+
import type { ProfileFacts } from './ProfileFacts.js';
|
|
19
|
+
import type { SurfaceFacts } from './SurfaceFacts.js';
|
|
20
|
+
import type { TslotFacts } from './TslotFacts.js';
|
|
21
|
+
import type { WallFacts } from './WallFacts.js';
|
|
22
|
+
/**
|
|
23
|
+
* @type FeatureDatasheetFacts
|
|
24
|
+
* The per-kind facts; narrow on `facts.kind`.
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
export type FeatureDatasheetFacts = ({
|
|
28
|
+
kind: 'Boss';
|
|
29
|
+
} & BossFacts) | ({
|
|
30
|
+
kind: 'Chamfer';
|
|
31
|
+
} & ChamferFacts) | ({
|
|
32
|
+
kind: 'Dovetail';
|
|
33
|
+
} & DovetailFacts) | ({
|
|
34
|
+
kind: 'Face';
|
|
35
|
+
} & FaceFacts) | ({
|
|
36
|
+
kind: 'Hole';
|
|
37
|
+
} & HoleFacts) | ({
|
|
38
|
+
kind: 'Pocket';
|
|
39
|
+
} & PocketFacts) | ({
|
|
40
|
+
kind: 'Profile';
|
|
41
|
+
} & ProfileFacts) | ({
|
|
42
|
+
kind: 'Three';
|
|
43
|
+
} & SurfaceFacts) | ({
|
|
44
|
+
kind: 'Tslot';
|
|
45
|
+
} & TslotFacts) | ({
|
|
46
|
+
kind: 'Wall';
|
|
47
|
+
} & WallFacts);
|
|
48
|
+
export declare function FeatureDatasheetFactsFromJSON(json: any): FeatureDatasheetFacts;
|
|
49
|
+
export declare function FeatureDatasheetFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureDatasheetFacts;
|
|
50
|
+
export declare function FeatureDatasheetFactsToJSON(json: any): any;
|
|
51
|
+
export declare function FeatureDatasheetFactsToJSONTyped(value?: FeatureDatasheetFacts | 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.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
|
+
import { BossFactsFromJSONTyped, BossFactsToJSON, } from './BossFacts.js';
|
|
15
|
+
import { ChamferFactsFromJSONTyped, ChamferFactsToJSON, } from './ChamferFacts.js';
|
|
16
|
+
import { DovetailFactsFromJSONTyped, DovetailFactsToJSON, } from './DovetailFacts.js';
|
|
17
|
+
import { FaceFactsFromJSONTyped, FaceFactsToJSON, } from './FaceFacts.js';
|
|
18
|
+
import { HoleFactsFromJSONTyped, HoleFactsToJSON, } from './HoleFacts.js';
|
|
19
|
+
import { PocketFactsFromJSONTyped, PocketFactsToJSON, } from './PocketFacts.js';
|
|
20
|
+
import { ProfileFactsFromJSONTyped, ProfileFactsToJSON, } from './ProfileFacts.js';
|
|
21
|
+
import { SurfaceFactsFromJSONTyped, SurfaceFactsToJSON, } from './SurfaceFacts.js';
|
|
22
|
+
import { TslotFactsFromJSONTyped, TslotFactsToJSON, } from './TslotFacts.js';
|
|
23
|
+
import { WallFactsFromJSONTyped, WallFactsToJSON, } from './WallFacts.js';
|
|
24
|
+
export function FeatureDatasheetFactsFromJSON(json) {
|
|
25
|
+
return FeatureDatasheetFactsFromJSONTyped(json, false);
|
|
26
|
+
}
|
|
27
|
+
export function FeatureDatasheetFactsFromJSONTyped(json, ignoreDiscriminator) {
|
|
28
|
+
if (json == null) {
|
|
29
|
+
return json;
|
|
30
|
+
}
|
|
31
|
+
switch (json['kind']) {
|
|
32
|
+
case 'Boss':
|
|
33
|
+
return Object.assign({}, BossFactsFromJSONTyped(json, true), { kind: 'Boss' });
|
|
34
|
+
case 'Chamfer':
|
|
35
|
+
return Object.assign({}, ChamferFactsFromJSONTyped(json, true), { kind: 'Chamfer' });
|
|
36
|
+
case 'Dovetail':
|
|
37
|
+
return Object.assign({}, DovetailFactsFromJSONTyped(json, true), {
|
|
38
|
+
kind: 'Dovetail',
|
|
39
|
+
});
|
|
40
|
+
case 'Face':
|
|
41
|
+
return Object.assign({}, FaceFactsFromJSONTyped(json, true), { kind: 'Face' });
|
|
42
|
+
case 'Hole':
|
|
43
|
+
return Object.assign({}, HoleFactsFromJSONTyped(json, true), { kind: 'Hole' });
|
|
44
|
+
case 'Pocket':
|
|
45
|
+
return Object.assign({}, PocketFactsFromJSONTyped(json, true), { kind: 'Pocket' });
|
|
46
|
+
case 'Profile':
|
|
47
|
+
return Object.assign({}, ProfileFactsFromJSONTyped(json, true), { kind: 'Profile' });
|
|
48
|
+
case 'Three':
|
|
49
|
+
return Object.assign({}, SurfaceFactsFromJSONTyped(json, true), { kind: 'Three' });
|
|
50
|
+
case 'Tslot':
|
|
51
|
+
return Object.assign({}, TslotFactsFromJSONTyped(json, true), { kind: 'Tslot' });
|
|
52
|
+
case 'Wall':
|
|
53
|
+
return Object.assign({}, WallFactsFromJSONTyped(json, true), { kind: 'Wall' });
|
|
54
|
+
default:
|
|
55
|
+
return json;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
export function FeatureDatasheetFactsToJSON(json) {
|
|
59
|
+
return FeatureDatasheetFactsToJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
export function FeatureDatasheetFactsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
62
|
+
if (value == null) {
|
|
63
|
+
return value;
|
|
64
|
+
}
|
|
65
|
+
switch (value['kind']) {
|
|
66
|
+
case 'Boss':
|
|
67
|
+
return Object.assign({}, BossFactsToJSON(value), { kind: 'Boss' });
|
|
68
|
+
case 'Chamfer':
|
|
69
|
+
return Object.assign({}, ChamferFactsToJSON(value), { kind: 'Chamfer' });
|
|
70
|
+
case 'Dovetail':
|
|
71
|
+
return Object.assign({}, DovetailFactsToJSON(value), { kind: 'Dovetail' });
|
|
72
|
+
case 'Face':
|
|
73
|
+
return Object.assign({}, FaceFactsToJSON(value), { kind: 'Face' });
|
|
74
|
+
case 'Hole':
|
|
75
|
+
return Object.assign({}, HoleFactsToJSON(value), { kind: 'Hole' });
|
|
76
|
+
case 'Pocket':
|
|
77
|
+
return Object.assign({}, PocketFactsToJSON(value), { kind: 'Pocket' });
|
|
78
|
+
case 'Profile':
|
|
79
|
+
return Object.assign({}, ProfileFactsToJSON(value), { kind: 'Profile' });
|
|
80
|
+
case 'Three':
|
|
81
|
+
return Object.assign({}, SurfaceFactsToJSON(value), { kind: 'Three' });
|
|
82
|
+
case 'Tslot':
|
|
83
|
+
return Object.assign({}, TslotFactsToJSON(value), { kind: 'Tslot' });
|
|
84
|
+
case 'Wall':
|
|
85
|
+
return Object.assign({}, WallFactsToJSON(value), { kind: 'Wall' });
|
|
86
|
+
default:
|
|
87
|
+
return value;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
@@ -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.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
|
+
* What kind of thing a feature is, and so how it gets machined. The names are the
|
|
14
|
+
* contract at this boundary (the shared numeric wire format stays inside the binary
|
|
15
|
+
* API).
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export declare const FeatureType: {
|
|
19
|
+
readonly ThroughHole: "ThroughHole";
|
|
20
|
+
readonly BlindHole: "BlindHole";
|
|
21
|
+
readonly ThroughPocket: "ThroughPocket";
|
|
22
|
+
readonly Pocket: "Pocket";
|
|
23
|
+
readonly OpenPocket: "OpenPocket";
|
|
24
|
+
readonly Profile: "Profile";
|
|
25
|
+
readonly Boss: "Boss";
|
|
26
|
+
readonly Face: "Face";
|
|
27
|
+
readonly Sink: "Sink";
|
|
28
|
+
readonly Chamfer: "Chamfer";
|
|
29
|
+
readonly Fillet: "Fillet";
|
|
30
|
+
readonly ContourSurface: "ContourSurface";
|
|
31
|
+
readonly FilletedPocket: "FilletedPocket";
|
|
32
|
+
readonly Thread: "Thread";
|
|
33
|
+
readonly FilletedOpenPocket: "FilletedOpenPocket";
|
|
34
|
+
readonly FilletedBlindHole: "FilletedBlindHole";
|
|
35
|
+
readonly Wall: "Wall";
|
|
36
|
+
readonly SlantedFace: "SlantedFace";
|
|
37
|
+
readonly InnerFillet: "InnerFillet";
|
|
38
|
+
readonly OuterFillet: "OuterFillet";
|
|
39
|
+
readonly SyntheticHole: "SyntheticHole";
|
|
40
|
+
readonly FilletedBoss: "FilletedBoss";
|
|
41
|
+
readonly UndercutTslot: "UndercutTslot";
|
|
42
|
+
readonly UndercutDovetail: "UndercutDovetail";
|
|
43
|
+
readonly UndercutFilletedTslot: "UndercutFilletedTslot";
|
|
44
|
+
readonly BackSink: "BackSink";
|
|
45
|
+
readonly BackChamfer: "BackChamfer";
|
|
46
|
+
readonly UndercutWall: "UndercutWall";
|
|
47
|
+
readonly USlot: "USlot";
|
|
48
|
+
readonly UndercutFilletedDovetail: "UndercutFilletedDovetail";
|
|
49
|
+
readonly TaperedThroughHole: "TaperedThroughHole";
|
|
50
|
+
readonly ThreadedBlindHole: "ThreadedBlindHole";
|
|
51
|
+
readonly ThreadedThroughHole: "ThreadedThroughHole";
|
|
52
|
+
};
|
|
53
|
+
export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
|
|
54
|
+
export declare function instanceOfFeatureType(value: any): boolean;
|
|
55
|
+
export declare function FeatureTypeFromJSON(json: any): FeatureType;
|
|
56
|
+
export declare function FeatureTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureType;
|
|
57
|
+
export declare function FeatureTypeToJSON(value?: FeatureType | null): any;
|
|
58
|
+
export declare function FeatureTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): FeatureType;
|
|
@@ -0,0 +1,76 @@
|
|
|
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
|
+
* What kind of thing a feature is, and so how it gets machined. The names are the
|
|
16
|
+
* contract at this boundary (the shared numeric wire format stays inside the binary
|
|
17
|
+
* API).
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const FeatureType = {
|
|
21
|
+
ThroughHole: 'ThroughHole',
|
|
22
|
+
BlindHole: 'BlindHole',
|
|
23
|
+
ThroughPocket: 'ThroughPocket',
|
|
24
|
+
Pocket: 'Pocket',
|
|
25
|
+
OpenPocket: 'OpenPocket',
|
|
26
|
+
Profile: 'Profile',
|
|
27
|
+
Boss: 'Boss',
|
|
28
|
+
Face: 'Face',
|
|
29
|
+
Sink: 'Sink',
|
|
30
|
+
Chamfer: 'Chamfer',
|
|
31
|
+
Fillet: 'Fillet',
|
|
32
|
+
ContourSurface: 'ContourSurface',
|
|
33
|
+
FilletedPocket: 'FilletedPocket',
|
|
34
|
+
Thread: 'Thread',
|
|
35
|
+
FilletedOpenPocket: 'FilletedOpenPocket',
|
|
36
|
+
FilletedBlindHole: 'FilletedBlindHole',
|
|
37
|
+
Wall: 'Wall',
|
|
38
|
+
SlantedFace: 'SlantedFace',
|
|
39
|
+
InnerFillet: 'InnerFillet',
|
|
40
|
+
OuterFillet: 'OuterFillet',
|
|
41
|
+
SyntheticHole: 'SyntheticHole',
|
|
42
|
+
FilletedBoss: 'FilletedBoss',
|
|
43
|
+
UndercutTslot: 'UndercutTslot',
|
|
44
|
+
UndercutDovetail: 'UndercutDovetail',
|
|
45
|
+
UndercutFilletedTslot: 'UndercutFilletedTslot',
|
|
46
|
+
BackSink: 'BackSink',
|
|
47
|
+
BackChamfer: 'BackChamfer',
|
|
48
|
+
UndercutWall: 'UndercutWall',
|
|
49
|
+
USlot: 'USlot',
|
|
50
|
+
UndercutFilletedDovetail: 'UndercutFilletedDovetail',
|
|
51
|
+
TaperedThroughHole: 'TaperedThroughHole',
|
|
52
|
+
ThreadedBlindHole: 'ThreadedBlindHole',
|
|
53
|
+
ThreadedThroughHole: 'ThreadedThroughHole',
|
|
54
|
+
};
|
|
55
|
+
export function instanceOfFeatureType(value) {
|
|
56
|
+
for (const key in FeatureType) {
|
|
57
|
+
if (Object.prototype.hasOwnProperty.call(FeatureType, key)) {
|
|
58
|
+
if (FeatureType[key] === value) {
|
|
59
|
+
return true;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
return false;
|
|
64
|
+
}
|
|
65
|
+
export function FeatureTypeFromJSON(json) {
|
|
66
|
+
return FeatureTypeFromJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
export function FeatureTypeFromJSONTyped(json, ignoreDiscriminator) {
|
|
69
|
+
return json;
|
|
70
|
+
}
|
|
71
|
+
export function FeatureTypeToJSON(value) {
|
|
72
|
+
return value;
|
|
73
|
+
}
|
|
74
|
+
export function FeatureTypeToJSONTyped(value, ignoreDiscriminator) {
|
|
75
|
+
return value;
|
|
76
|
+
}
|
|
@@ -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.
|
|
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,13 +16,13 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface HealthResponse {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Overall Engine API health state.
|
|
20
20
|
* @type {HealthResponseStatusEnum}
|
|
21
21
|
* @memberof HealthResponse
|
|
22
22
|
*/
|
|
23
23
|
status: HealthResponseStatusEnum;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* PostgreSQL connectivity state.
|
|
26
26
|
* @type {HealthResponseDbEnum}
|
|
27
27
|
* @memberof HealthResponse
|
|
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.
|
|
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,109 @@
|
|
|
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 { HoleProcess } from './HoleProcess.js';
|
|
13
|
+
import type { Threading } from './Threading.js';
|
|
14
|
+
import type { CdData } from './CdData.js';
|
|
15
|
+
/**
|
|
16
|
+
* A hole's facts. See `HoleFacts` in the `api` crate for what each figure means.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface HoleFacts
|
|
19
|
+
*/
|
|
20
|
+
export interface HoleFacts {
|
|
21
|
+
/**
|
|
22
|
+
* Discriminator for this facts variant.
|
|
23
|
+
* @type {HoleFactsKindEnum}
|
|
24
|
+
* @memberof HoleFacts
|
|
25
|
+
*/
|
|
26
|
+
kind: HoleFactsKindEnum;
|
|
27
|
+
/**
|
|
28
|
+
* What the hole is actually drilled to — narrower than modelled for a threaded
|
|
29
|
+
* hole.
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof HoleFacts
|
|
32
|
+
*/
|
|
33
|
+
diameter: number;
|
|
34
|
+
/**
|
|
35
|
+
* Full apex angle of the cone at the hole bottom, degrees; 180 for a flat bottom.
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof HoleFacts
|
|
38
|
+
*/
|
|
39
|
+
fullConeDeg: number;
|
|
40
|
+
/**
|
|
41
|
+
* Whether the hole includes a larger counterbore above its bore.
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof HoleFacts
|
|
44
|
+
*/
|
|
45
|
+
isCounterbore: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* The requested machining process for this hole.
|
|
48
|
+
* @type {HoleProcess}
|
|
49
|
+
* @memberof HoleFacts
|
|
50
|
+
*/
|
|
51
|
+
holeProcess: HoleProcess;
|
|
52
|
+
/**
|
|
53
|
+
* The thread this hole is to receive and how it is cut; absent for a plain hole.
|
|
54
|
+
* @type {Threading}
|
|
55
|
+
* @memberof HoleFacts
|
|
56
|
+
*/
|
|
57
|
+
threading?: Threading;
|
|
58
|
+
/**
|
|
59
|
+
* Clearance-diameter limits for tools entering the hole.
|
|
60
|
+
* @type {CdData}
|
|
61
|
+
* @memberof HoleFacts
|
|
62
|
+
*/
|
|
63
|
+
cd: CdData;
|
|
64
|
+
/**
|
|
65
|
+
* Largest spot-drill diameter that reaches the hole without collision, in mm.
|
|
66
|
+
* @type {number}
|
|
67
|
+
* @memberof HoleFacts
|
|
68
|
+
*/
|
|
69
|
+
maxSpotDiameter: number;
|
|
70
|
+
/**
|
|
71
|
+
* Largest drill diameter that leaves the hole within its permitted oversize, in mm.
|
|
72
|
+
* @type {number}
|
|
73
|
+
* @memberof HoleFacts
|
|
74
|
+
*/
|
|
75
|
+
maxDrillDiameter: number;
|
|
76
|
+
/**
|
|
77
|
+
* Largest end-mill diameter that can machine the hole, in mm.
|
|
78
|
+
* @type {number}
|
|
79
|
+
* @memberof HoleFacts
|
|
80
|
+
*/
|
|
81
|
+
maxEndmillDiameter: number;
|
|
82
|
+
/**
|
|
83
|
+
* Radius of the blend at the hole bottom, in mm; zero when sharp.
|
|
84
|
+
* @type {number}
|
|
85
|
+
* @memberof HoleFacts
|
|
86
|
+
*/
|
|
87
|
+
filletRadius: number;
|
|
88
|
+
/**
|
|
89
|
+
* Height of the bottom blend, in mm; zero when sharp.
|
|
90
|
+
* @type {number}
|
|
91
|
+
* @memberof HoleFacts
|
|
92
|
+
*/
|
|
93
|
+
filletHeight: number;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* @export
|
|
97
|
+
*/
|
|
98
|
+
export declare const HoleFactsKindEnum: {
|
|
99
|
+
readonly Hole: "Hole";
|
|
100
|
+
};
|
|
101
|
+
export type HoleFactsKindEnum = (typeof HoleFactsKindEnum)[keyof typeof HoleFactsKindEnum];
|
|
102
|
+
/**
|
|
103
|
+
* Check if a given object implements the HoleFacts interface.
|
|
104
|
+
*/
|
|
105
|
+
export declare function instanceOfHoleFacts(value: object): value is HoleFacts;
|
|
106
|
+
export declare function HoleFactsFromJSON(json: any): HoleFacts;
|
|
107
|
+
export declare function HoleFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): HoleFacts;
|
|
108
|
+
export declare function HoleFactsToJSON(json: any): HoleFacts;
|
|
109
|
+
export declare function HoleFactsToJSONTyped(value?: HoleFacts | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,96 @@
|
|
|
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
|
+
import { HoleProcessFromJSON, HoleProcessToJSON, } from './HoleProcess.js';
|
|
15
|
+
import { ThreadingFromJSON, ThreadingToJSON, } from './Threading.js';
|
|
16
|
+
import { CdDataFromJSON, CdDataToJSON } from './CdData.js';
|
|
17
|
+
/**
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const HoleFactsKindEnum = {
|
|
21
|
+
Hole: 'Hole',
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the HoleFacts interface.
|
|
25
|
+
*/
|
|
26
|
+
export function instanceOfHoleFacts(value) {
|
|
27
|
+
if (!('kind' in value) || value['kind'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (value['kind'] !== 'Hole')
|
|
30
|
+
return false;
|
|
31
|
+
if (!('diameter' in value) || value['diameter'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('fullConeDeg' in value) || value['fullConeDeg'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('isCounterbore' in value) || value['isCounterbore'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('holeProcess' in value) || value['holeProcess'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('cd' in value) || value['cd'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('maxSpotDiameter' in value) || value['maxSpotDiameter'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('maxDrillDiameter' in value) || value['maxDrillDiameter'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('maxEndmillDiameter' in value) || value['maxEndmillDiameter'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('filletRadius' in value) || value['filletRadius'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('filletHeight' in value) || value['filletHeight'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
return true;
|
|
52
|
+
}
|
|
53
|
+
export function HoleFactsFromJSON(json) {
|
|
54
|
+
return HoleFactsFromJSONTyped(json, false);
|
|
55
|
+
}
|
|
56
|
+
export function HoleFactsFromJSONTyped(json, ignoreDiscriminator) {
|
|
57
|
+
if (json == null) {
|
|
58
|
+
return json;
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
kind: json['kind'],
|
|
62
|
+
diameter: json['diameter'],
|
|
63
|
+
fullConeDeg: json['fullConeDeg'],
|
|
64
|
+
isCounterbore: json['isCounterbore'],
|
|
65
|
+
holeProcess: HoleProcessFromJSON(json['holeProcess']),
|
|
66
|
+
threading: json['threading'] == null ? undefined : ThreadingFromJSON(json['threading']),
|
|
67
|
+
cd: CdDataFromJSON(json['cd']),
|
|
68
|
+
maxSpotDiameter: json['maxSpotDiameter'],
|
|
69
|
+
maxDrillDiameter: json['maxDrillDiameter'],
|
|
70
|
+
maxEndmillDiameter: json['maxEndmillDiameter'],
|
|
71
|
+
filletRadius: json['filletRadius'],
|
|
72
|
+
filletHeight: json['filletHeight'],
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
export function HoleFactsToJSON(json) {
|
|
76
|
+
return HoleFactsToJSONTyped(json, false);
|
|
77
|
+
}
|
|
78
|
+
export function HoleFactsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
79
|
+
if (value == null) {
|
|
80
|
+
return value;
|
|
81
|
+
}
|
|
82
|
+
return {
|
|
83
|
+
kind: value['kind'],
|
|
84
|
+
diameter: value['diameter'],
|
|
85
|
+
fullConeDeg: value['fullConeDeg'],
|
|
86
|
+
isCounterbore: value['isCounterbore'],
|
|
87
|
+
holeProcess: HoleProcessToJSON(value['holeProcess']),
|
|
88
|
+
threading: ThreadingToJSON(value['threading']),
|
|
89
|
+
cd: CdDataToJSON(value['cd']),
|
|
90
|
+
maxSpotDiameter: value['maxSpotDiameter'],
|
|
91
|
+
maxDrillDiameter: value['maxDrillDiameter'],
|
|
92
|
+
maxEndmillDiameter: value['maxEndmillDiameter'],
|
|
93
|
+
filletRadius: value['filletRadius'],
|
|
94
|
+
filletHeight: value['filletHeight'],
|
|
95
|
+
};
|
|
96
|
+
}
|
|
@@ -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.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
|
+
* How the user wants a hole machined.
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const HoleProcess: {
|
|
17
|
+
readonly Automatic: "Automatic";
|
|
18
|
+
readonly Drill: "Drill";
|
|
19
|
+
readonly Mill: "Mill";
|
|
20
|
+
};
|
|
21
|
+
export type HoleProcess = (typeof HoleProcess)[keyof typeof HoleProcess];
|
|
22
|
+
export declare function instanceOfHoleProcess(value: any): boolean;
|
|
23
|
+
export declare function HoleProcessFromJSON(json: any): HoleProcess;
|
|
24
|
+
export declare function HoleProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): HoleProcess;
|
|
25
|
+
export declare function HoleProcessToJSON(value?: HoleProcess | null): any;
|
|
26
|
+
export declare function HoleProcessToJSONTyped(value: any, ignoreDiscriminator: boolean): HoleProcess;
|
|
@@ -0,0 +1,44 @@
|
|
|
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
|
+
* How the user wants a hole machined.
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const HoleProcess = {
|
|
19
|
+
Automatic: 'Automatic',
|
|
20
|
+
Drill: 'Drill',
|
|
21
|
+
Mill: 'Mill',
|
|
22
|
+
};
|
|
23
|
+
export function instanceOfHoleProcess(value) {
|
|
24
|
+
for (const key in HoleProcess) {
|
|
25
|
+
if (Object.prototype.hasOwnProperty.call(HoleProcess, key)) {
|
|
26
|
+
if (HoleProcess[key] === value) {
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
return false;
|
|
32
|
+
}
|
|
33
|
+
export function HoleProcessFromJSON(json) {
|
|
34
|
+
return HoleProcessFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
export function HoleProcessFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
export function HoleProcessToJSON(value) {
|
|
40
|
+
return value;
|
|
41
|
+
}
|
|
42
|
+
export function HoleProcessToJSONTyped(value, ignoreDiscriminator) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
@@ -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.
|
|
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,49 +16,49 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface JobDetail {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Identifier of the part this job processes.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof JobDetail
|
|
22
22
|
*/
|
|
23
23
|
partUuid: string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Identifier of this job.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof JobDetail
|
|
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 JobDetail
|
|
34
34
|
*/
|
|
35
35
|
productType: string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Current durable state of the job.
|
|
38
38
|
* @type {JobDetailStatusEnum}
|
|
39
39
|
* @memberof JobDetail
|
|
40
40
|
*/
|
|
41
41
|
status: JobDetailStatusEnum;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* Worker-reported completion percentage, or null before progress is available.
|
|
44
44
|
* @type {number}
|
|
45
45
|
* @memberof JobDetail
|
|
46
46
|
*/
|
|
47
47
|
progress: number | null;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Failure reason when the job status is failed; otherwise null.
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof JobDetail
|
|
52
52
|
*/
|
|
53
53
|
error: string | null;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* Identifier of the report produced by a successful analysis, or null until available.
|
|
56
56
|
* @type {string}
|
|
57
57
|
* @memberof JobDetail
|
|
58
58
|
*/
|
|
59
59
|
reportId: string | null;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Time at which the job was created, in ISO 8601 format.
|
|
62
62
|
* @type {Date}
|
|
63
63
|
* @memberof JobDetail
|
|
64
64
|
*/
|
|
@@ -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.
|
|
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).
|