@toolpath/api 0.2.1 → 0.2.3

package/dist/generated/models/ComputeFeatureDatasheetsResponse.js

@@ -1,59 +0,0 @@
-/* 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.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * @export
- */
-export const ComputeFeatureDatasheetsResponseStatusEnum = {
-    Queued: 'queued',
-};
-/**
- * Check if a given object implements the ComputeFeatureDatasheetsResponse interface.
- */
-export function instanceOfComputeFeatureDatasheetsResponse(value) {
-    if (!('jobId' in value) || value['jobId'] === undefined)
-        return false;
-    if (!('partId' in value) || value['partId'] === undefined)
-        return false;
-    if (!('status' in value) || value['status'] === undefined)
-        return false;
-    if (value['status'] !== 'queued')
-        return false;
-    return true;
-}
-export function ComputeFeatureDatasheetsResponseFromJSON(json) {
-    return ComputeFeatureDatasheetsResponseFromJSONTyped(json, false);
-}
-export function ComputeFeatureDatasheetsResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        jobId: json['jobId'],
-        partId: json['partId'],
-        status: json['status'],
-    };
-}
-export function ComputeFeatureDatasheetsResponseToJSON(json) {
-    return ComputeFeatureDatasheetsResponseToJSONTyped(json, false);
-}
-export function ComputeFeatureDatasheetsResponseToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        jobId: value['jobId'],
-        partId: value['partId'],
-        status: value['status'],
-    };
-}

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

@@ -1,51 +0,0 @@
-/**
- * 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.1
- *
- *
- * 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 { FeatureDatasheet } from './FeatureDatasheet.js';
-/**
- *
- * @export
- * @interface FeatureDatasheetEntry
- */
-export interface FeatureDatasheetEntry {
-    /**
-     * Identifier of the resolved feature.
-     * @type {string}
-     * @memberof FeatureDatasheetEntry
-     */
-    featureId: string;
-    /**
-     * Stable kernel feature tag, encoded as a lowercase hexadecimal string.
-     * @type {string}
-     * @memberof FeatureDatasheetEntry
-     */
-    featureTag: string;
-    /**
-     * Kernel-recognized feature type; the vocabulary is open-ended.
-     * @type {string}
-     * @memberof FeatureDatasheetEntry
-     */
-    featureType: string;
-    /**
-     * Generated machining datasheet, or null when this feature has no datasheet yet.
-     * @type {FeatureDatasheet}
-     * @memberof FeatureDatasheetEntry
-     */
-    datasheet?: FeatureDatasheet | null;
-}
-/**
- * Check if a given object implements the FeatureDatasheetEntry interface.
- */
-export declare function instanceOfFeatureDatasheetEntry(value: object): value is FeatureDatasheetEntry;
-export declare function FeatureDatasheetEntryFromJSON(json: any): FeatureDatasheetEntry;
-export declare function FeatureDatasheetEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureDatasheetEntry;
-export declare function FeatureDatasheetEntryToJSON(json: any): FeatureDatasheetEntry;
-export declare function FeatureDatasheetEntryToJSONTyped(value?: FeatureDatasheetEntry | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,39 +0,0 @@
-/**
- * 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.1
- *
- *
- * 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 { FeatureDatasheetEntry } from './FeatureDatasheetEntry.js';
-/**
- *
- * @export
- * @interface FeatureDatasheetsResponse
- */
-export interface FeatureDatasheetsResponse {
-    /**
-     * Datasheets for requested features that belong to the authorized organization.
-     * @type {Array<FeatureDatasheetEntry>}
-     * @memberof FeatureDatasheetsResponse
-     */
-    datasheets: Array<FeatureDatasheetEntry>;
-    /**
-     * Requested feature identifiers that were unknown or inaccessible to this organization.
-     * @type {Array<string>}
-     * @memberof FeatureDatasheetsResponse
-     */
-    notFound: Array<string>;
-}
-/**
- * Check if a given object implements the FeatureDatasheetsResponse interface.
- */
-export declare function instanceOfFeatureDatasheetsResponse(value: object): value is FeatureDatasheetsResponse;
-export declare function FeatureDatasheetsResponseFromJSON(json: any): FeatureDatasheetsResponse;
-export declare function FeatureDatasheetsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureDatasheetsResponse;
-export declare function FeatureDatasheetsResponseToJSON(json: any): FeatureDatasheetsResponse;
-export declare function FeatureDatasheetsResponseToJSONTyped(value?: FeatureDatasheetsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/FeatureDatasheetsResponse.js

@@ -1,48 +0,0 @@
-/* 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.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { FeatureDatasheetEntryFromJSON, FeatureDatasheetEntryToJSON, } from './FeatureDatasheetEntry.js';
-/**
- * Check if a given object implements the FeatureDatasheetsResponse interface.
- */
-export function instanceOfFeatureDatasheetsResponse(value) {
-    if (!('datasheets' in value) || value['datasheets'] === undefined)
-        return false;
-    if (!('notFound' in value) || value['notFound'] === undefined)
-        return false;
-    return true;
-}
-export function FeatureDatasheetsResponseFromJSON(json) {
-    return FeatureDatasheetsResponseFromJSONTyped(json, false);
-}
-export function FeatureDatasheetsResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        datasheets: json['datasheets'].map(FeatureDatasheetEntryFromJSON),
-        notFound: json['notFound'],
-    };
-}
-export function FeatureDatasheetsResponseToJSON(json) {
-    return FeatureDatasheetsResponseToJSONTyped(json, false);
-}
-export function FeatureDatasheetsResponseToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        datasheets: value['datasheets'].map(FeatureDatasheetEntryToJSON),
-        notFound: value['notFound'],
-    };
-}

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

@@ -1,139 +0,0 @@
-/**
- * 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.1
- *
- *
- * 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 { PartReportResponseUnits } from './PartReportResponseUnits.js';
-import type { DirectionZBounds } from './DirectionZBounds.js';
-import type { Vec3 } from './Vec3.js';
-import type { Region } from './Region.js';
-import type { PartFeature } from './PartFeature.js';
-/**
- *
- * @export
- * @interface PartReportResponse
- */
-export interface PartReportResponse {
-    /**
-     * Identifier of the part this report describes.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    partId: string;
-    /**
-     * Identifier of this immutable analysis report.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    reportId: string;
-    /**
-     * Identifier of the analysis job that produced this report.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    jobId: string;
-    /**
-     * Version of the Toolpath kernel that produced this report.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    kernelVersion: string;
-    /**
-     *
-     * @type {PartReportResponseUnits}
-     * @memberof PartReportResponse
-     */
-    units: PartReportResponseUnits;
-    /**
-     * Recognized B-rep regions, ordered by region index.
-     * @type {Array<Region>}
-     * @memberof PartReportResponse
-     */
-    regions: Array<Region>;
-    /**
-     * Features recognized in this analysis run.
-     * @type {Array<PartFeature>}
-     * @memberof PartReportResponse
-     */
-    features: Array<PartFeature>;
-    /**
-     * Directions from which the part can be analyzed or machined.
-     * @type {Array<Vec3>}
-     * @memberof PartReportResponse
-     */
-    candidateDirections: Array<Vec3>;
-    /**
-     * Part z extents for each candidate direction, or null when detail enrichment did not run.
-     * @type {Array<DirectionZBounds>}
-     * @memberof PartReportResponse
-     */
-    directionZBounds: Array<DirectionZBounds> | null;
-    /**
-     * Number of points in the generated mesh.
-     * @type {number}
-     * @memberof PartReportResponse
-     */
-    meshPointCount: number;
-    /**
-     * Number of triangles in the generated mesh.
-     * @type {number}
-     * @memberof PartReportResponse
-     */
-    meshTriangleCount: number;
-    /**
-     * 15-minute URL for the rendered PNG thumbnail, or null when absent.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    thumbnailUrl: string | null;
-    /**
-     * 15-minute URL for the generated STL mesh, or null when absent.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    meshStlUrl: string | null;
-    /**
-     * 15-minute URL for the generated GLB mesh, or null when absent.
-     * @type {string}
-     * @memberof PartReportResponse
-     */
-    meshGlbUrl: string | null;
-    /**
-     * Worker time spent downloading the source CAD file, in milliseconds.
-     * @type {number}
-     * @memberof PartReportResponse
-     */
-    downloadMs: number;
-    /**
-     * Kernel time spent on initial part analysis, in milliseconds.
-     * @type {number}
-     * @memberof PartReportResponse
-     */
-    recognitionMs: number;
-    /**
-     * Kernel time spent building per-feature details, in milliseconds.
-     * @type {number}
-     * @memberof PartReportResponse
-     */
-    enrichmentMs: number;
-    /**
-     * Total worker processing time for this report, in milliseconds.
-     * @type {number}
-     * @memberof PartReportResponse
-     */
-    totalMs: number;
-}
-/**
- * Check if a given object implements the PartReportResponse interface.
- */
-export declare function instanceOfPartReportResponse(value: object): value is PartReportResponse;
-export declare function PartReportResponseFromJSON(json: any): PartReportResponse;
-export declare function PartReportResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartReportResponse;
-export declare function PartReportResponseToJSON(json: any): PartReportResponse;
-export declare function PartReportResponseToJSONTyped(value?: PartReportResponse | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,52 +0,0 @@
-/**
- * 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.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Units used by all dimensional values in this report.
- * @export
- * @interface PartReportResponseUnits
- */
-export interface PartReportResponseUnits {
-    /**
-     * Unit used by every length and area measurement.
-     * @type {PartReportResponseUnitsLengthEnum}
-     * @memberof PartReportResponseUnits
-     */
-    length: PartReportResponseUnitsLengthEnum;
-    /**
-     * Unit used by every angular measurement.
-     * @type {PartReportResponseUnitsAngleEnum}
-     * @memberof PartReportResponseUnits
-     */
-    angle: PartReportResponseUnitsAngleEnum;
-}
-/**
- * @export
- */
-export declare const PartReportResponseUnitsLengthEnum: {
-    readonly Mm: "mm";
-};
-export type PartReportResponseUnitsLengthEnum = (typeof PartReportResponseUnitsLengthEnum)[keyof typeof PartReportResponseUnitsLengthEnum];
-/**
- * @export
- */
-export declare const PartReportResponseUnitsAngleEnum: {
-    readonly Deg: "deg";
-};
-export type PartReportResponseUnitsAngleEnum = (typeof PartReportResponseUnitsAngleEnum)[keyof typeof PartReportResponseUnitsAngleEnum];
-/**
- * Check if a given object implements the PartReportResponseUnits interface.
- */
-export declare function instanceOfPartReportResponseUnits(value: object): value is PartReportResponseUnits;
-export declare function PartReportResponseUnitsFromJSON(json: any): PartReportResponseUnits;
-export declare function PartReportResponseUnitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartReportResponseUnits;
-export declare function PartReportResponseUnitsToJSON(json: any): PartReportResponseUnits;
-export declare function PartReportResponseUnitsToJSONTyped(value?: PartReportResponseUnits | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/PartReportResponseUnits.js

@@ -1,63 +0,0 @@
-/* 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.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * @export
- */
-export const PartReportResponseUnitsLengthEnum = {
-    Mm: 'mm',
-};
-/**
- * @export
- */
-export const PartReportResponseUnitsAngleEnum = {
-    Deg: 'deg',
-};
-/**
- * Check if a given object implements the PartReportResponseUnits interface.
- */
-export function instanceOfPartReportResponseUnits(value) {
-    if (!('length' in value) || value['length'] === undefined)
-        return false;
-    if (value['length'] !== 'mm')
-        return false;
-    if (!('angle' in value) || value['angle'] === undefined)
-        return false;
-    if (value['angle'] !== 'deg')
-        return false;
-    return true;
-}
-export function PartReportResponseUnitsFromJSON(json) {
-    return PartReportResponseUnitsFromJSONTyped(json, false);
-}
-export function PartReportResponseUnitsFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        length: json['length'],
-        angle: json['angle'],
-    };
-}
-export function PartReportResponseUnitsToJSON(json) {
-    return PartReportResponseUnitsToJSONTyped(json, false);
-}
-export function PartReportResponseUnitsToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        length: value['length'],
-        angle: value['angle'],
-    };
-}