@toolpath/api 0.1.0

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 (67) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +29 -0
  3. package/dist/client.d.ts +14 -0
  4. package/dist/client.js +15 -0
  5. package/dist/generated/apis/FeaturesApi.d.ts +50 -0
  6. package/dist/generated/apis/FeaturesApi.js +102 -0
  7. package/dist/generated/apis/JobsApi.d.ts +79 -0
  8. package/dist/generated/apis/JobsApi.js +165 -0
  9. package/dist/generated/apis/KeysApi.d.ts +32 -0
  10. package/dist/generated/apis/KeysApi.js +58 -0
  11. package/dist/generated/apis/PartsApi.d.ts +76 -0
  12. package/dist/generated/apis/PartsApi.js +157 -0
  13. package/dist/generated/apis/ServiceApi.d.ts +43 -0
  14. package/dist/generated/apis/ServiceApi.js +79 -0
  15. package/dist/generated/apis/index.d.ts +5 -0
  16. package/dist/generated/apis/index.js +7 -0
  17. package/dist/generated/index.d.ts +3 -0
  18. package/dist/generated/index.js +5 -0
  19. package/dist/generated/models/AnalyzeJobResponse.d.ts +51 -0
  20. package/dist/generated/models/AnalyzeJobResponse.js +59 -0
  21. package/dist/generated/models/ComputeFeatureDatasheetsRequest.d.ts +32 -0
  22. package/dist/generated/models/ComputeFeatureDatasheetsRequest.js +43 -0
  23. package/dist/generated/models/ComputeFeatureDatasheetsResponse.d.ts +51 -0
  24. package/dist/generated/models/ComputeFeatureDatasheetsResponse.js +59 -0
  25. package/dist/generated/models/CreatePartResponse.d.ts +50 -0
  26. package/dist/generated/models/CreatePartResponse.js +55 -0
  27. package/dist/generated/models/DirectionZBounds.d.ts +45 -0
  28. package/dist/generated/models/DirectionZBounds.js +52 -0
  29. package/dist/generated/models/FeatureDatasheetEntry.d.ts +52 -0
  30. package/dist/generated/models/FeatureDatasheetEntry.js +53 -0
  31. package/dist/generated/models/FeatureDatasheetsResponse.d.ts +39 -0
  32. package/dist/generated/models/FeatureDatasheetsResponse.js +48 -0
  33. package/dist/generated/models/HealthResponse.d.ts +54 -0
  34. package/dist/generated/models/HealthResponse.js +61 -0
  35. package/dist/generated/models/JobDetail.d.ts +84 -0
  36. package/dist/generated/models/JobDetail.js +80 -0
  37. package/dist/generated/models/JobSummary.d.ts +72 -0
  38. package/dist/generated/models/JobSummary.js +72 -0
  39. package/dist/generated/models/KeyValidationResponse.d.ts +48 -0
  40. package/dist/generated/models/KeyValidationResponse.js +56 -0
  41. package/dist/generated/models/ListJobsResponse.d.ts +51 -0
  42. package/dist/generated/models/ListJobsResponse.js +56 -0
  43. package/dist/generated/models/OpenApiDocument.d.ts +33 -0
  44. package/dist/generated/models/OpenApiDocument.js +45 -0
  45. package/dist/generated/models/PartFeature.d.ts +64 -0
  46. package/dist/generated/models/PartFeature.js +65 -0
  47. package/dist/generated/models/PartFeatureAxis.d.ts +44 -0
  48. package/dist/generated/models/PartFeatureAxis.js +51 -0
  49. package/dist/generated/models/PartReportResponse.d.ts +139 -0
  50. package/dist/generated/models/PartReportResponse.js +120 -0
  51. package/dist/generated/models/ProblemDetails.d.ts +62 -0
  52. package/dist/generated/models/ProblemDetails.js +59 -0
  53. package/dist/generated/models/Region.d.ts +56 -0
  54. package/dist/generated/models/Region.js +59 -0
  55. package/dist/generated/models/ReportUnits.d.ts +52 -0
  56. package/dist/generated/models/ReportUnits.js +63 -0
  57. package/dist/generated/models/Vec3.d.ts +44 -0
  58. package/dist/generated/models/Vec3.js +51 -0
  59. package/dist/generated/models/index.d.ts +20 -0
  60. package/dist/generated/models/index.js +22 -0
  61. package/dist/generated/runtime.d.ts +185 -0
  62. package/dist/generated/runtime.js +351 -0
  63. package/dist/index.d.ts +3 -0
  64. package/dist/index.js +3 -0
  65. package/dist/upload.d.ts +5 -0
  66. package/dist/upload.js +13 -0
  67. package/package.json +48 -0
@@ -0,0 +1,157 @@
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.0
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 * as runtime from '../runtime.js';
15
+ import { AnalyzeJobResponseFromJSON, } from '../models/AnalyzeJobResponse.js';
16
+ import { CreatePartResponseFromJSON, } from '../models/CreatePartResponse.js';
17
+ import { PartReportResponseFromJSON, } from '../models/PartReportResponse.js';
18
+ /**
19
+ *
20
+ */
21
+ export class PartsApi extends runtime.BaseAPI {
22
+ /**
23
+ * Creates request options for analyzePart without sending the request
24
+ */
25
+ async analyzePartRequestOpts(requestParameters) {
26
+ if (requestParameters['id'] == null) {
27
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling analyzePart().');
28
+ }
29
+ const queryParameters = {};
30
+ if (requestParameters['featureDetails'] != null) {
31
+ queryParameters['featureDetails'] = requestParameters['featureDetails'];
32
+ }
33
+ const headerParameters = {};
34
+ if (requestParameters['idempotencyKey'] != null) {
35
+ headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
36
+ }
37
+ if (this.configuration && this.configuration.accessToken) {
38
+ const token = this.configuration.accessToken;
39
+ const tokenString = await token('ApiKeyAuth', []);
40
+ if (tokenString) {
41
+ headerParameters['Authorization'] = `Bearer ${tokenString}`;
42
+ }
43
+ }
44
+ let urlPath = `/v1/parts/{id}/analyze`;
45
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
46
+ return {
47
+ path: urlPath,
48
+ method: 'POST',
49
+ headers: headerParameters,
50
+ query: queryParameters,
51
+ };
52
+ }
53
+ /**
54
+ * Start part analysis
55
+ */
56
+ async analyzePartRaw(requestParameters, initOverrides) {
57
+ const requestOptions = await this.analyzePartRequestOpts(requestParameters);
58
+ const response = await this.request(requestOptions, initOverrides);
59
+ return new runtime.JSONApiResponse(response, (jsonValue) => AnalyzeJobResponseFromJSON(jsonValue));
60
+ }
61
+ /**
62
+ * Start part analysis
63
+ */
64
+ async analyzePart(requestParameters, initOverrides) {
65
+ const response = await this.analyzePartRaw(requestParameters, initOverrides);
66
+ return await response.value();
67
+ }
68
+ /**
69
+ * Creates request options for createPart without sending the request
70
+ */
71
+ async createPartRequestOpts(requestParameters) {
72
+ const queryParameters = {};
73
+ if (requestParameters['filename'] != null) {
74
+ queryParameters['filename'] = requestParameters['filename'];
75
+ }
76
+ const headerParameters = {};
77
+ if (this.configuration && this.configuration.accessToken) {
78
+ const token = this.configuration.accessToken;
79
+ const tokenString = await token('ApiKeyAuth', []);
80
+ if (tokenString) {
81
+ headerParameters['Authorization'] = `Bearer ${tokenString}`;
82
+ }
83
+ }
84
+ let urlPath = `/v1/parts`;
85
+ return {
86
+ path: urlPath,
87
+ method: 'POST',
88
+ headers: headerParameters,
89
+ query: queryParameters,
90
+ };
91
+ }
92
+ /**
93
+ * Create a part upload
94
+ */
95
+ async createPartRaw(requestParameters, initOverrides) {
96
+ const requestOptions = await this.createPartRequestOpts(requestParameters);
97
+ const response = await this.request(requestOptions, initOverrides);
98
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreatePartResponseFromJSON(jsonValue));
99
+ }
100
+ /**
101
+ * Create a part upload
102
+ */
103
+ async createPart(requestParameters = {}, initOverrides) {
104
+ const response = await this.createPartRaw(requestParameters, initOverrides);
105
+ return await response.value();
106
+ }
107
+ /**
108
+ * Creates request options for getPartReport without sending the request
109
+ */
110
+ async getPartReportRequestOpts(requestParameters) {
111
+ if (requestParameters['id'] == null) {
112
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getPartReport().');
113
+ }
114
+ const queryParameters = {};
115
+ if (requestParameters['jobId'] != null) {
116
+ queryParameters['jobId'] = requestParameters['jobId'];
117
+ }
118
+ const headerParameters = {};
119
+ if (this.configuration && this.configuration.accessToken) {
120
+ const token = this.configuration.accessToken;
121
+ const tokenString = await token('ApiKeyAuth', []);
122
+ if (tokenString) {
123
+ headerParameters['Authorization'] = `Bearer ${tokenString}`;
124
+ }
125
+ }
126
+ let urlPath = `/v1/parts/{id}/report`;
127
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
128
+ return {
129
+ path: urlPath,
130
+ method: 'GET',
131
+ headers: headerParameters,
132
+ query: queryParameters,
133
+ };
134
+ }
135
+ /**
136
+ * Get the latest part report
137
+ */
138
+ async getPartReportRaw(requestParameters, initOverrides) {
139
+ const requestOptions = await this.getPartReportRequestOpts(requestParameters);
140
+ const response = await this.request(requestOptions, initOverrides);
141
+ return new runtime.JSONApiResponse(response, (jsonValue) => PartReportResponseFromJSON(jsonValue));
142
+ }
143
+ /**
144
+ * Get the latest part report
145
+ */
146
+ async getPartReport(requestParameters, initOverrides) {
147
+ const response = await this.getPartReportRaw(requestParameters, initOverrides);
148
+ return await response.value();
149
+ }
150
+ }
151
+ /**
152
+ * @export
153
+ */
154
+ export const AnalyzePartFeatureDetailsEnum = {
155
+ True: 'true',
156
+ False: 'false',
157
+ };
@@ -0,0 +1,43 @@
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.0
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 * as runtime from '../runtime.js';
13
+ import { type HealthResponse } from '../models/HealthResponse.js';
14
+ import { type OpenApiDocument } from '../models/OpenApiDocument.js';
15
+ /**
16
+ *
17
+ */
18
+ export declare class ServiceApi extends runtime.BaseAPI {
19
+ /**
20
+ * Creates request options for getHealth without sending the request
21
+ */
22
+ getHealthRequestOpts(): Promise<runtime.RequestOpts>;
23
+ /**
24
+ * Check Engine API health
25
+ */
26
+ getHealthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HealthResponse>>;
27
+ /**
28
+ * Check Engine API health
29
+ */
30
+ getHealth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HealthResponse>;
31
+ /**
32
+ * Creates request options for getOpenApiDocument without sending the request
33
+ */
34
+ getOpenApiDocumentRequestOpts(): Promise<runtime.RequestOpts>;
35
+ /**
36
+ * Get the Engine API OpenAPI document
37
+ */
38
+ getOpenApiDocumentRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OpenApiDocument>>;
39
+ /**
40
+ * Get the Engine API OpenAPI document
41
+ */
42
+ getOpenApiDocument(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OpenApiDocument>;
43
+ }
@@ -0,0 +1,79 @@
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.0
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 * as runtime from '../runtime.js';
15
+ import { HealthResponseFromJSON, } from '../models/HealthResponse.js';
16
+ import { OpenApiDocumentFromJSON, } from '../models/OpenApiDocument.js';
17
+ /**
18
+ *
19
+ */
20
+ export class ServiceApi extends runtime.BaseAPI {
21
+ /**
22
+ * Creates request options for getHealth without sending the request
23
+ */
24
+ async getHealthRequestOpts() {
25
+ const queryParameters = {};
26
+ const headerParameters = {};
27
+ let urlPath = `/health`;
28
+ return {
29
+ path: urlPath,
30
+ method: 'GET',
31
+ headers: headerParameters,
32
+ query: queryParameters,
33
+ };
34
+ }
35
+ /**
36
+ * Check Engine API health
37
+ */
38
+ async getHealthRaw(initOverrides) {
39
+ const requestOptions = await this.getHealthRequestOpts();
40
+ const response = await this.request(requestOptions, initOverrides);
41
+ return new runtime.JSONApiResponse(response, (jsonValue) => HealthResponseFromJSON(jsonValue));
42
+ }
43
+ /**
44
+ * Check Engine API health
45
+ */
46
+ async getHealth(initOverrides) {
47
+ const response = await this.getHealthRaw(initOverrides);
48
+ return await response.value();
49
+ }
50
+ /**
51
+ * Creates request options for getOpenApiDocument without sending the request
52
+ */
53
+ async getOpenApiDocumentRequestOpts() {
54
+ const queryParameters = {};
55
+ const headerParameters = {};
56
+ let urlPath = `/v1/openapi.json`;
57
+ return {
58
+ path: urlPath,
59
+ method: 'GET',
60
+ headers: headerParameters,
61
+ query: queryParameters,
62
+ };
63
+ }
64
+ /**
65
+ * Get the Engine API OpenAPI document
66
+ */
67
+ async getOpenApiDocumentRaw(initOverrides) {
68
+ const requestOptions = await this.getOpenApiDocumentRequestOpts();
69
+ const response = await this.request(requestOptions, initOverrides);
70
+ return new runtime.JSONApiResponse(response, (jsonValue) => OpenApiDocumentFromJSON(jsonValue));
71
+ }
72
+ /**
73
+ * Get the Engine API OpenAPI document
74
+ */
75
+ async getOpenApiDocument(initOverrides) {
76
+ const response = await this.getOpenApiDocumentRaw(initOverrides);
77
+ return await response.value();
78
+ }
79
+ }
@@ -0,0 +1,5 @@
1
+ export * from './FeaturesApi.js';
2
+ export * from './JobsApi.js';
3
+ export * from './KeysApi.js';
4
+ export * from './PartsApi.js';
5
+ export * from './ServiceApi.js';
@@ -0,0 +1,7 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ export * from './FeaturesApi.js';
4
+ export * from './JobsApi.js';
5
+ export * from './KeysApi.js';
6
+ export * from './PartsApi.js';
7
+ export * from './ServiceApi.js';
@@ -0,0 +1,3 @@
1
+ export * from './runtime.js';
2
+ export * from './apis/index.js';
3
+ export * from './models/index.js';
@@ -0,0 +1,5 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ export * from './runtime.js';
4
+ export * from './apis/index.js';
5
+ export * from './models/index.js';
@@ -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.0
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
+ *
14
+ * @export
15
+ * @interface AnalyzeJobResponse
16
+ */
17
+ export interface AnalyzeJobResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof AnalyzeJobResponse
22
+ */
23
+ jobId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof AnalyzeJobResponse
28
+ */
29
+ partId: string;
30
+ /**
31
+ *
32
+ * @type {AnalyzeJobResponseStatusEnum}
33
+ * @memberof AnalyzeJobResponse
34
+ */
35
+ status: AnalyzeJobResponseStatusEnum;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const AnalyzeJobResponseStatusEnum: {
41
+ readonly Queued: "queued";
42
+ };
43
+ export type AnalyzeJobResponseStatusEnum = (typeof AnalyzeJobResponseStatusEnum)[keyof typeof AnalyzeJobResponseStatusEnum];
44
+ /**
45
+ * Check if a given object implements the AnalyzeJobResponse interface.
46
+ */
47
+ export declare function instanceOfAnalyzeJobResponse(value: object): value is AnalyzeJobResponse;
48
+ export declare function AnalyzeJobResponseFromJSON(json: any): AnalyzeJobResponse;
49
+ export declare function AnalyzeJobResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnalyzeJobResponse;
50
+ export declare function AnalyzeJobResponseToJSON(json: any): AnalyzeJobResponse;
51
+ export declare function AnalyzeJobResponseToJSONTyped(value?: AnalyzeJobResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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.0
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 AnalyzeJobResponseStatusEnum = {
18
+ Queued: 'queued',
19
+ };
20
+ /**
21
+ * Check if a given object implements the AnalyzeJobResponse interface.
22
+ */
23
+ export function instanceOfAnalyzeJobResponse(value) {
24
+ if (!('jobId' in value) || value['jobId'] === undefined)
25
+ return false;
26
+ if (!('partId' in value) || value['partId'] === undefined)
27
+ return false;
28
+ if (!('status' in value) || value['status'] === undefined)
29
+ return false;
30
+ if (value['status'] !== 'queued')
31
+ return false;
32
+ return true;
33
+ }
34
+ export function AnalyzeJobResponseFromJSON(json) {
35
+ return AnalyzeJobResponseFromJSONTyped(json, false);
36
+ }
37
+ export function AnalyzeJobResponseFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ jobId: json['jobId'],
43
+ partId: json['partId'],
44
+ status: json['status'],
45
+ };
46
+ }
47
+ export function AnalyzeJobResponseToJSON(json) {
48
+ return AnalyzeJobResponseToJSONTyped(json, false);
49
+ }
50
+ export function AnalyzeJobResponseToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ jobId: value['jobId'],
56
+ partId: value['partId'],
57
+ status: value['status'],
58
+ };
59
+ }
@@ -0,0 +1,32 @@
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.0
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
+ *
14
+ * @export
15
+ * @interface ComputeFeatureDatasheetsRequest
16
+ */
17
+ export interface ComputeFeatureDatasheetsRequest {
18
+ /**
19
+ *
20
+ * @type {Array<string>}
21
+ * @memberof ComputeFeatureDatasheetsRequest
22
+ */
23
+ featureIds: Array<string>;
24
+ }
25
+ /**
26
+ * Check if a given object implements the ComputeFeatureDatasheetsRequest interface.
27
+ */
28
+ export declare function instanceOfComputeFeatureDatasheetsRequest(value: object): value is ComputeFeatureDatasheetsRequest;
29
+ export declare function ComputeFeatureDatasheetsRequestFromJSON(json: any): ComputeFeatureDatasheetsRequest;
30
+ export declare function ComputeFeatureDatasheetsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComputeFeatureDatasheetsRequest;
31
+ export declare function ComputeFeatureDatasheetsRequestToJSON(json: any): ComputeFeatureDatasheetsRequest;
32
+ export declare function ComputeFeatureDatasheetsRequestToJSONTyped(value?: ComputeFeatureDatasheetsRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
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.0
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 ComputeFeatureDatasheetsRequest interface.
16
+ */
17
+ export function instanceOfComputeFeatureDatasheetsRequest(value) {
18
+ if (!('featureIds' in value) || value['featureIds'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function ComputeFeatureDatasheetsRequestFromJSON(json) {
23
+ return ComputeFeatureDatasheetsRequestFromJSONTyped(json, false);
24
+ }
25
+ export function ComputeFeatureDatasheetsRequestFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ featureIds: json['featureIds'],
31
+ };
32
+ }
33
+ export function ComputeFeatureDatasheetsRequestToJSON(json) {
34
+ return ComputeFeatureDatasheetsRequestToJSONTyped(json, false);
35
+ }
36
+ export function ComputeFeatureDatasheetsRequestToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ featureIds: value['featureIds'],
42
+ };
43
+ }
@@ -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.0
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
+ *
14
+ * @export
15
+ * @interface ComputeFeatureDatasheetsResponse
16
+ */
17
+ export interface ComputeFeatureDatasheetsResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ComputeFeatureDatasheetsResponse
22
+ */
23
+ jobId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof ComputeFeatureDatasheetsResponse
28
+ */
29
+ partId: string;
30
+ /**
31
+ *
32
+ * @type {ComputeFeatureDatasheetsResponseStatusEnum}
33
+ * @memberof ComputeFeatureDatasheetsResponse
34
+ */
35
+ status: ComputeFeatureDatasheetsResponseStatusEnum;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const ComputeFeatureDatasheetsResponseStatusEnum: {
41
+ readonly Queued: "queued";
42
+ };
43
+ export type ComputeFeatureDatasheetsResponseStatusEnum = (typeof ComputeFeatureDatasheetsResponseStatusEnum)[keyof typeof ComputeFeatureDatasheetsResponseStatusEnum];
44
+ /**
45
+ * Check if a given object implements the ComputeFeatureDatasheetsResponse interface.
46
+ */
47
+ export declare function instanceOfComputeFeatureDatasheetsResponse(value: object): value is ComputeFeatureDatasheetsResponse;
48
+ export declare function ComputeFeatureDatasheetsResponseFromJSON(json: any): ComputeFeatureDatasheetsResponse;
49
+ export declare function ComputeFeatureDatasheetsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComputeFeatureDatasheetsResponse;
50
+ export declare function ComputeFeatureDatasheetsResponseToJSON(json: any): ComputeFeatureDatasheetsResponse;
51
+ export declare function ComputeFeatureDatasheetsResponseToJSONTyped(value?: ComputeFeatureDatasheetsResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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.0
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 ComputeFeatureDatasheetsResponseStatusEnum = {
18
+ Queued: 'queued',
19
+ };
20
+ /**
21
+ * Check if a given object implements the ComputeFeatureDatasheetsResponse interface.
22
+ */
23
+ export function instanceOfComputeFeatureDatasheetsResponse(value) {
24
+ if (!('jobId' in value) || value['jobId'] === undefined)
25
+ return false;
26
+ if (!('partId' in value) || value['partId'] === undefined)
27
+ return false;
28
+ if (!('status' in value) || value['status'] === undefined)
29
+ return false;
30
+ if (value['status'] !== 'queued')
31
+ return false;
32
+ return true;
33
+ }
34
+ export function ComputeFeatureDatasheetsResponseFromJSON(json) {
35
+ return ComputeFeatureDatasheetsResponseFromJSONTyped(json, false);
36
+ }
37
+ export function ComputeFeatureDatasheetsResponseFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ jobId: json['jobId'],
43
+ partId: json['partId'],
44
+ status: json['status'],
45
+ };
46
+ }
47
+ export function ComputeFeatureDatasheetsResponseToJSON(json) {
48
+ return ComputeFeatureDatasheetsResponseToJSONTyped(json, false);
49
+ }
50
+ export function ComputeFeatureDatasheetsResponseToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ jobId: value['jobId'],
56
+ partId: value['partId'],
57
+ status: value['status'],
58
+ };
59
+ }
@@ -0,0 +1,50 @@
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.0
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
+ *
14
+ * @export
15
+ * @interface CreatePartResponse
16
+ */
17
+ export interface CreatePartResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof CreatePartResponse
22
+ */
23
+ partId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CreatePartResponse
28
+ */
29
+ uploadUrl: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof CreatePartResponse
34
+ */
35
+ sourceBucket: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof CreatePartResponse
40
+ */
41
+ sourceS3Key: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the CreatePartResponse interface.
45
+ */
46
+ export declare function instanceOfCreatePartResponse(value: object): value is CreatePartResponse;
47
+ export declare function CreatePartResponseFromJSON(json: any): CreatePartResponse;
48
+ export declare function CreatePartResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePartResponse;
49
+ export declare function CreatePartResponseToJSON(json: any): CreatePartResponse;
50
+ export declare function CreatePartResponseToJSONTyped(value?: CreatePartResponse | null, ignoreDiscriminator?: boolean): any;