@toolpath/api 0.1.0 → 0.2.2

package/dist/generated/models/DirectionZBounds.js

@@ -4,14 +4,14 @@
  * Toolpath Engine API
  * 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.
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { Vec3FromJSON, Vec3ToJSON } from './Vec3.js';
+import { DirectionZBoundsDirectionFromJSON, DirectionZBoundsDirectionToJSON, } from './DirectionZBoundsDirection.js';
 /**
  * Check if a given object implements the DirectionZBounds interface.
  */
@@ -32,7 +32,7 @@ export function DirectionZBoundsFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        direction: Vec3FromJSON(json['direction']),
+        direction: DirectionZBoundsDirectionFromJSON(json['direction']),
         zMin: json['zMin'],
         zMax: json['zMax'],
     };
@@ -45,7 +45,7 @@ export function DirectionZBoundsToJSONTyped(value, ignoreDiscriminator = false)
         return value;
     }
     return {
-        direction: Vec3ToJSON(value['direction']),
+        direction: DirectionZBoundsDirectionToJSON(value['direction']),
         zMin: value['zMin'],
         zMax: value['zMax'],
     };

package/dist/generated/models/DirectionZBoundsDirection.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Candidate machining direction whose tool-axis frame defines these bounds.
+ * @export
+ * @interface DirectionZBoundsDirection
+ */
+export interface DirectionZBoundsDirection {
+    /**
+     * X coordinate or direction component.
+     * @type {number}
+     * @memberof DirectionZBoundsDirection
+     */
+    x: number;
+    /**
+     * Y coordinate or direction component.
+     * @type {number}
+     * @memberof DirectionZBoundsDirection
+     */
+    y: number;
+    /**
+     * Z coordinate or direction component.
+     * @type {number}
+     * @memberof DirectionZBoundsDirection
+     */
+    z: number;
+}
+/**
+ * Check if a given object implements the DirectionZBoundsDirection interface.
+ */
+export declare function instanceOfDirectionZBoundsDirection(value: object): value is DirectionZBoundsDirection;
+export declare function DirectionZBoundsDirectionFromJSON(json: any): DirectionZBoundsDirection;
+export declare function DirectionZBoundsDirectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): DirectionZBoundsDirection;
+export declare function DirectionZBoundsDirectionToJSON(json: any): DirectionZBoundsDirection;
+export declare function DirectionZBoundsDirectionToJSONTyped(value?: DirectionZBoundsDirection | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/DirectionZBoundsDirection.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the DirectionZBoundsDirection interface.
+ */
+export function instanceOfDirectionZBoundsDirection(value) {
+    if (!('x' in value) || value['x'] === undefined)
+        return false;
+    if (!('y' in value) || value['y'] === undefined)
+        return false;
+    if (!('z' in value) || value['z'] === undefined)
+        return false;
+    return true;
+}
+export function DirectionZBoundsDirectionFromJSON(json) {
+    return DirectionZBoundsDirectionFromJSONTyped(json, false);
+}
+export function DirectionZBoundsDirectionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        x: json['x'],
+        y: json['y'],
+        z: json['z'],
+    };
+}
+export function DirectionZBoundsDirectionToJSON(json) {
+    return DirectionZBoundsDirectionToJSONTyped(json, false);
+}
+export function DirectionZBoundsDirectionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        x: value['x'],
+        y: value['y'],
+        z: value['z'],
+    };
+}

package/dist/generated/models/DovetailFacts.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CdData } from './CdData.js';
+/**
+ * A dovetail groove: overhanging walls leaning back at one angle over a floor, so the
+ * space widens with depth and a tool has to enter through an opening narrower than where
+ * it cuts.
+ *
+ * That inversion is why this carries widths rather than a medial-axis measurement. All
+ * three are clearance diameters read at their own heights, with `0.0` standing for a
+ * measurement that failed — which is what `isInvalidGeometry` reports.
+ * @export
+ * @interface DovetailFacts
+ */
+export interface DovetailFacts {
+    /**
+     * Discriminator for this facts variant.
+     * @type {DovetailFactsKindEnum}
+     * @memberof DovetailFacts
+     */
+    kind: DovetailFactsKindEnum;
+    /**
+     * Between the overhanging wall and the tool axis, degrees, positive however the
+     * wall leans.
+     * @type {number}
+     * @memberof DovetailFacts
+     */
+    taperDeg: number;
+    /**
+     * Radius of the blend between wall and floor; 0.0 for the sharp kind.
+     * @type {number}
+     * @memberof DovetailFacts
+     */
+    filletRadius: number;
+    /**
+     * The widest clearance over the floor — the width the groove cuts at.
+     * @type {number}
+     * @memberof DovetailFacts
+     */
+    floorWidth: number;
+    /**
+     * The clearance through the opening at the top of the groove.
+     * @type {number}
+     * @memberof DovetailFacts
+     */
+    topOpeningWidth: number;
+    /**
+     * The clearance just above the floor, under the overhangs.
+     * @type {number}
+     * @memberof DovetailFacts
+     */
+    bottomOpeningWidth: number;
+    /**
+     * The groove's inner clearances vary from place to place — it runs out somewhere —
+     * rather than being the one constant width a closed internal dovetail has.
+     * @type {boolean}
+     * @memberof DovetailFacts
+     */
+    isExternal: boolean;
+    /**
+     * Derived from the widths and the taper, not measured off an axis, so the three
+     * regimes hold one answer.
+     * @type {CdData}
+     * @memberof DovetailFacts
+     */
+    cd: CdData;
+    /**
+     * A width could not be measured at all, so `cd` is arithmetic over a zero and no
+     * tool should be offered on its strength.
+     * @type {boolean}
+     * @memberof DovetailFacts
+     */
+    isInvalidGeometry: boolean;
+}
+/**
+ * @export
+ */
+export declare const DovetailFactsKindEnum: {
+    readonly Dovetail: "Dovetail";
+};
+export type DovetailFactsKindEnum = (typeof DovetailFactsKindEnum)[keyof typeof DovetailFactsKindEnum];
+/**
+ * Check if a given object implements the DovetailFacts interface.
+ */
+export declare function instanceOfDovetailFacts(value: object): value is DovetailFacts;
+export declare function DovetailFactsFromJSON(json: any): DovetailFacts;
+export declare function DovetailFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): DovetailFacts;
+export declare function DovetailFactsToJSON(json: any): DovetailFacts;
+export declare function DovetailFactsToJSONTyped(value?: DovetailFacts | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/DovetailFacts.js

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CdDataFromJSON, CdDataToJSON } from './CdData.js';
+/**
+ * @export
+ */
+export const DovetailFactsKindEnum = {
+    Dovetail: 'Dovetail',
+};
+/**
+ * Check if a given object implements the DovetailFacts interface.
+ */
+export function instanceOfDovetailFacts(value) {
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (value['kind'] !== 'Dovetail')
+        return false;
+    if (!('taperDeg' in value) || value['taperDeg'] === undefined)
+        return false;
+    if (!('filletRadius' in value) || value['filletRadius'] === undefined)
+        return false;
+    if (!('floorWidth' in value) || value['floorWidth'] === undefined)
+        return false;
+    if (!('topOpeningWidth' in value) || value['topOpeningWidth'] === undefined)
+        return false;
+    if (!('bottomOpeningWidth' in value) || value['bottomOpeningWidth'] === undefined)
+        return false;
+    if (!('isExternal' in value) || value['isExternal'] === undefined)
+        return false;
+    if (!('cd' in value) || value['cd'] === undefined)
+        return false;
+    if (!('isInvalidGeometry' in value) || value['isInvalidGeometry'] === undefined)
+        return false;
+    return true;
+}
+export function DovetailFactsFromJSON(json) {
+    return DovetailFactsFromJSONTyped(json, false);
+}
+export function DovetailFactsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        kind: json['kind'],
+        taperDeg: json['taperDeg'],
+        filletRadius: json['filletRadius'],
+        floorWidth: json['floorWidth'],
+        topOpeningWidth: json['topOpeningWidth'],
+        bottomOpeningWidth: json['bottomOpeningWidth'],
+        isExternal: json['isExternal'],
+        cd: CdDataFromJSON(json['cd']),
+        isInvalidGeometry: json['isInvalidGeometry'],
+    };
+}
+export function DovetailFactsToJSON(json) {
+    return DovetailFactsToJSONTyped(json, false);
+}
+export function DovetailFactsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        kind: value['kind'],
+        taperDeg: value['taperDeg'],
+        filletRadius: value['filletRadius'],
+        floorWidth: value['floorWidth'],
+        topOpeningWidth: value['topOpeningWidth'],
+        bottomOpeningWidth: value['bottomOpeningWidth'],
+        isExternal: value['isExternal'],
+        cd: CdDataToJSON(value['cd']),
+        isInvalidGeometry: value['isInvalidGeometry'],
+    };
+}

package/dist/generated/models/FaceFacts.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CdData } from './CdData.js';
+/**
+ * A face: a plane square to the tool axis, cleared by sweeping across it.
+ * @export
+ * @interface FaceFacts
+ */
+export interface FaceFacts {
+    /**
+     * Discriminator for this facts variant.
+     * @type {FaceFactsKindEnum}
+     * @memberof FaceFacts
+     */
+    kind: FaceFactsKindEnum;
+    /**
+     * The face is the highest surface of the part along the tool axis.
+     * @type {boolean}
+     * @memberof FaceFacts
+     */
+    isTopFace: boolean;
+    /**
+     * The face is to be faced off: a top face the fixture does not rule out.
+     * @type {boolean}
+     * @memberof FaceFacts
+     */
+    isFacing: boolean;
+    /**
+     * Sweeping the floor does not clear the face on its own — a wall pass must follow.
+     * @type {boolean}
+     * @memberof FaceFacts
+     */
+    needsSidemill: boolean;
+    /**
+     * Clearance-diameter limits for tools sweeping the face.
+     * @type {CdData}
+     * @memberof FaceFacts
+     */
+    cd: CdData;
+    /**
+     * Largest bottom diameter a terminal tool may have, in mm.
+     * @type {number}
+     * @memberof FaceFacts
+     */
+    maxBottomDiameter: number;
+}
+/**
+ * @export
+ */
+export declare const FaceFactsKindEnum: {
+    readonly Face: "Face";
+};
+export type FaceFactsKindEnum = (typeof FaceFactsKindEnum)[keyof typeof FaceFactsKindEnum];
+/**
+ * Check if a given object implements the FaceFacts interface.
+ */
+export declare function instanceOfFaceFacts(value: object): value is FaceFacts;
+export declare function FaceFactsFromJSON(json: any): FaceFacts;
+export declare function FaceFactsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FaceFacts;
+export declare function FaceFactsToJSON(json: any): FaceFacts;
+export declare function FaceFactsToJSONTyped(value?: FaceFacts | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/FaceFacts.js

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CdDataFromJSON, CdDataToJSON } from './CdData.js';
+/**
+ * @export
+ */
+export const FaceFactsKindEnum = {
+    Face: 'Face',
+};
+/**
+ * Check if a given object implements the FaceFacts interface.
+ */
+export function instanceOfFaceFacts(value) {
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (value['kind'] !== 'Face')
+        return false;
+    if (!('isTopFace' in value) || value['isTopFace'] === undefined)
+        return false;
+    if (!('isFacing' in value) || value['isFacing'] === undefined)
+        return false;
+    if (!('needsSidemill' in value) || value['needsSidemill'] === undefined)
+        return false;
+    if (!('cd' in value) || value['cd'] === undefined)
+        return false;
+    if (!('maxBottomDiameter' in value) || value['maxBottomDiameter'] === undefined)
+        return false;
+    return true;
+}
+export function FaceFactsFromJSON(json) {
+    return FaceFactsFromJSONTyped(json, false);
+}
+export function FaceFactsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        kind: json['kind'],
+        isTopFace: json['isTopFace'],
+        isFacing: json['isFacing'],
+        needsSidemill: json['needsSidemill'],
+        cd: CdDataFromJSON(json['cd']),
+        maxBottomDiameter: json['maxBottomDiameter'],
+    };
+}
+export function FaceFactsToJSON(json) {
+    return FaceFactsToJSONTyped(json, false);
+}
+export function FaceFactsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        kind: value['kind'],
+        isTopFace: value['isTopFace'],
+        isFacing: value['isFacing'],
+        needsSidemill: value['needsSidemill'],
+        cd: CdDataToJSON(value['cd']),
+        maxBottomDiameter: value['maxBottomDiameter'],
+    };
+}

package/dist/generated/models/FeatureDatasheet.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { FeatureType } from './FeatureType.js';
+import type { ToleranceBand } from './ToleranceBand.js';
+import type { FeatureDatasheetFacts } from './FeatureDatasheetFacts.js';
+/**
+ * One feature as machining sees it: static, self-contained, and enough to choose a
+ * tool against without having the part in hand. All lengths mm and angles degrees;
+ * z runs up the tool axis, so `zMin` is the bottom of the feature and `zMax` its top.
+ * @export
+ * @interface FeatureDatasheet
+ */
+export interface FeatureDatasheet {
+    /**
+     * Kernel-recognized feature type that this datasheet measures.
+     * @type {FeatureType}
+     * @memberof FeatureDatasheet
+     */
+    featureType: FeatureType;
+    /**
+     * Bottom of the feature along the tool axis, in mm.
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    zMin: number;
+    /**
+     * Top of the feature along the tool axis, in mm.
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    zMax: number;
+    /**
+     * The z range extended by adjacent geometry the tool passes over reaching the
+     * feature.
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    extendedZMin: number;
+    /**
+     * Highest z the tool passes over while reaching the feature, in mm.
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    extendedZMax: number;
+    /**
+     * Material intentionally left radially for a later operation, in mm.
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    radialStockToLeave: number;
+    /**
+     * Material intentionally left along the tool axis for a later operation, in mm.
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    axialStockToLeave: number;
+    /**
+     * Permitted deviation bands for the machined feature.
+     * @type {ToleranceBand}
+     * @memberof FeatureDatasheet
+     */
+    toleranceBand: ToleranceBand;
+    /**
+     * Whether the feature has a floor machined perpendicular to the tool axis.
+     * @type {boolean}
+     * @memberof FeatureDatasheet
+     */
+    hasFloor: boolean;
+    /**
+     * Whether the feature has a wall machined parallel to the tool axis.
+     * @type {boolean}
+     * @memberof FeatureDatasheet
+     */
+    hasWall: boolean;
+    /**
+     * Projected area machined floor-wise (perpendicular to the tool axis).
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    floorishArea: number;
+    /**
+     * Area machined wall-wise (parallel to the tool axis).
+     * @type {number}
+     * @memberof FeatureDatasheet
+     */
+    wallishArea: number;
+    /**
+     *
+     * @type {FeatureDatasheetFacts}
+     * @memberof FeatureDatasheet
+     */
+    facts: FeatureDatasheetFacts;
+}
+/**
+ * Check if a given object implements the FeatureDatasheet interface.
+ */
+export declare function instanceOfFeatureDatasheet(value: object): value is FeatureDatasheet;
+export declare function FeatureDatasheetFromJSON(json: any): FeatureDatasheet;
+export declare function FeatureDatasheetFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureDatasheet;
+export declare function FeatureDatasheetToJSON(json: any): FeatureDatasheet;
+export declare function FeatureDatasheetToJSONTyped(value?: FeatureDatasheet | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/FeatureDatasheet.js

@@ -0,0 +1,94 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Toolpath Engine API
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeatureTypeFromJSON, FeatureTypeToJSON, } from './FeatureType.js';
+import { ToleranceBandFromJSON, ToleranceBandToJSON, } from './ToleranceBand.js';
+import { FeatureDatasheetFactsFromJSON, FeatureDatasheetFactsToJSON, } from './FeatureDatasheetFacts.js';
+/**
+ * Check if a given object implements the FeatureDatasheet interface.
+ */
+export function instanceOfFeatureDatasheet(value) {
+    if (!('featureType' in value) || value['featureType'] === undefined)
+        return false;
+    if (!('zMin' in value) || value['zMin'] === undefined)
+        return false;
+    if (!('zMax' in value) || value['zMax'] === undefined)
+        return false;
+    if (!('extendedZMin' in value) || value['extendedZMin'] === undefined)
+        return false;
+    if (!('extendedZMax' in value) || value['extendedZMax'] === undefined)
+        return false;
+    if (!('radialStockToLeave' in value) || value['radialStockToLeave'] === undefined)
+        return false;
+    if (!('axialStockToLeave' in value) || value['axialStockToLeave'] === undefined)
+        return false;
+    if (!('toleranceBand' in value) || value['toleranceBand'] === undefined)
+        return false;
+    if (!('hasFloor' in value) || value['hasFloor'] === undefined)
+        return false;
+    if (!('hasWall' in value) || value['hasWall'] === undefined)
+        return false;
+    if (!('floorishArea' in value) || value['floorishArea'] === undefined)
+        return false;
+    if (!('wallishArea' in value) || value['wallishArea'] === undefined)
+        return false;
+    if (!('facts' in value) || value['facts'] === undefined)
+        return false;
+    return true;
+}
+export function FeatureDatasheetFromJSON(json) {
+    return FeatureDatasheetFromJSONTyped(json, false);
+}
+export function FeatureDatasheetFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        featureType: FeatureTypeFromJSON(json['featureType']),
+        zMin: json['zMin'],
+        zMax: json['zMax'],
+        extendedZMin: json['extendedZMin'],
+        extendedZMax: json['extendedZMax'],
+        radialStockToLeave: json['radialStockToLeave'],
+        axialStockToLeave: json['axialStockToLeave'],
+        toleranceBand: ToleranceBandFromJSON(json['toleranceBand']),
+        hasFloor: json['hasFloor'],
+        hasWall: json['hasWall'],
+        floorishArea: json['floorishArea'],
+        wallishArea: json['wallishArea'],
+        facts: FeatureDatasheetFactsFromJSON(json['facts']),
+    };
+}
+export function FeatureDatasheetToJSON(json) {
+    return FeatureDatasheetToJSONTyped(json, false);
+}
+export function FeatureDatasheetToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        featureType: FeatureTypeToJSON(value['featureType']),
+        zMin: value['zMin'],
+        zMax: value['zMax'],
+        extendedZMin: value['extendedZMin'],
+        extendedZMax: value['extendedZMax'],
+        radialStockToLeave: value['radialStockToLeave'],
+        axialStockToLeave: value['axialStockToLeave'],
+        toleranceBand: ToleranceBandToJSON(value['toleranceBand']),
+        hasFloor: value['hasFloor'],
+        hasWall: value['hasWall'],
+        floorishArea: value['floorishArea'],
+        wallishArea: value['wallishArea'],
+        facts: FeatureDatasheetFactsToJSON(value['facts']),
+    };
+}