@vertexvis/api-client-node 0.16.0 → 0.17.0

package/dist/cjs/client/helpers/exports.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createExport = void 0;
+const index_1 = require("../index");
+/**
+ * Create an export.
+ *
+ * @param args - The {@link CreateExportReq}.
+ */
+function createExport({ client, createExportReq, onMsg = console.log, verbose, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield client.exports.createExport({
+            createExportRequest: createExportReq(),
+        });
+        const queuedId = res.data.data.id;
+        if (verbose)
+            onMsg(`Created export with queued-export ${queuedId}`);
+        const pollRes = yield (0, index_1.pollQueuedJob)({
+            id: queuedId,
+            getQueuedJob: (id) => client.exports.getQueuedExport({ id }),
+            polling: { intervalMs: index_1.PollIntervalMs, maxAttempts: index_1.MaxAttempts },
+        });
+        if ((0, index_1.isPollError)(pollRes.res))
+            (0, index_1.throwOnError)(pollRes);
+        if (verbose)
+            onMsg(`Completed export ${pollRes.res.data.id}`);
+        return pollRes.res;
+    });
+}
+exports.createExport = createExport;

package/dist/cjs/client/helpers/index.d.ts

@@ -1,3 +1,4 @@
+export * from './exports';
 export * from './files';
 export * from './parts';
 export * from './scenes';

package/dist/cjs/client/helpers/index.js

@@ -10,6 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./exports"), exports);
 __exportStar(require("./files"), exports);
 __exportStar(require("./parts"), exports);
 __exportStar(require("./scenes"), exports);

package/dist/cjs/client/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.15.6";
+export declare const version = "0.17.0";

package/dist/cjs/client/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.15.6';
+exports.version = '0.17.0';

package/dist/cjs/client/vertex-client.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
 import { BasePath } from './index';
 /**
  * Static `build` function arguments.
@@ -72,6 +72,7 @@ export declare class VertexClient {
     accounts: AccountsApi;
     applications: ApplicationsApi;
     batches: BatchesApi;
+    exports: ExportsApi;
     files: FilesApi;
     geometrySets: GeometrySetsApi;
     hits: HitsApi;

package/dist/cjs/client/vertex-client.js

@@ -79,6 +79,7 @@ class VertexClient {
         this.accounts = new index_1.AccountsApi(this.config, undefined, axiosInst);
         this.applications = new index_1.ApplicationsApi(this.config, undefined, axiosInst);
         this.batches = new index_1.BatchesApi(this.config, undefined, axiosInst);
+        this.exports = new index_1.ExportsApi(this.config, undefined, axiosInst);
         this.files = new index_1.FilesApi(this.config, undefined, axiosInst);
         this.geometrySets = new index_1.GeometrySetsApi(this.config, undefined, axiosInst);
         this.hits = new index_1.HitsApi(this.config, undefined, axiosInst);

package/dist/esm/api.d.ts

@@ -511,6 +511,13 @@ export interface BoundingBox {
      */
     max: Vector3;
 }
+/**
+ * Describes the options for configuring a CAD file export.
+ * @export
+ * @interface CADExportConfig
+ */
+export interface CADExportConfig extends ExportConfig {
+}
 /**
  * Fit camera in 3D space based on items in scene.
  * @export
@@ -814,6 +821,70 @@ export interface CreateBatchRequest {
      */
     'vertexvis/batch:operations': Array<BatchOperation>;
 }
+/**
+ *
+ * @export
+ * @interface CreateExportRequest
+ */
+export interface CreateExportRequest {
+    /**
+     *
+     * @type {CreateExportRequestData}
+     * @memberof CreateExportRequest
+     */
+    data: CreateExportRequestData;
+}
+/**
+ *
+ * @export
+ * @interface CreateExportRequestData
+ */
+export interface CreateExportRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof CreateExportRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {CreateExportRequestDataAttributes}
+     * @memberof CreateExportRequestData
+     */
+    attributes: CreateExportRequestDataAttributes;
+    /**
+     *
+     * @type {CreateExportRequestDataRelationships}
+     * @memberof CreateExportRequestData
+     */
+    relationships: CreateExportRequestDataRelationships;
+}
+/**
+ *
+ * @export
+ * @interface CreateExportRequestDataAttributes
+ */
+export interface CreateExportRequestDataAttributes {
+    /**
+     * Specifies the export format and options to configure the export.
+     * @type {CADExportConfig}
+     * @memberof CreateExportRequestDataAttributes
+     */
+    config: CADExportConfig;
+}
+/**
+ *
+ * @export
+ * @interface CreateExportRequestDataRelationships
+ */
+export interface CreateExportRequestDataRelationships {
+    /**
+     *
+     * @type {ExportRelationship}
+     * @memberof CreateExportRequestDataRelationships
+     */
+    source: ExportRelationship;
+}
 /**
  *
  * @export
@@ -1779,6 +1850,128 @@ export interface Dimensions {
      */
     width: number;
 }
+/**
+ *
+ * @export
+ * @interface Export
+ */
+export interface Export {
+    /**
+     *
+     * @type {ExportData}
+     * @memberof Export
+     */
+    data: ExportData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof Export
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ * Describes the options for configuring a file export.
+ * @export
+ * @interface ExportConfig
+ */
+export interface ExportConfig {
+    /**
+     *
+     * @type {string}
+     * @memberof ExportConfig
+     */
+    format: string;
+}
+/**
+ *
+ * @export
+ * @interface ExportData
+ */
+export interface ExportData {
+    /**
+     *
+     * @type {string}
+     * @memberof ExportData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof ExportData
+     */
+    id: string;
+    /**
+     *
+     * @type {ExportDataAttributes}
+     * @memberof ExportData
+     */
+    attributes: ExportDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof ExportData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface ExportDataAttributes
+ */
+export interface ExportDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof ExportDataAttributes
+     */
+    created: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExportDataAttributes
+     */
+    downloadUrl: string;
+}
+/**
+ * Relationship to an `export`.
+ * @export
+ * @interface ExportRelationship
+ */
+export interface ExportRelationship {
+    /**
+     *
+     * @type {ExportRelationshipData}
+     * @memberof ExportRelationship
+     */
+    data: ExportRelationshipData;
+}
+/**
+ *
+ * @export
+ * @interface ExportRelationshipData
+ */
+export interface ExportRelationshipData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof ExportRelationshipData
+     */
+    type: ExportRelationshipDataTypeEnum;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof ExportRelationshipData
+     */
+    id: string;
+}
+export declare const ExportRelationshipDataTypeEnum: {
+    readonly Scene: "scene";
+};
+export declare type ExportRelationshipDataTypeEnum = typeof ExportRelationshipDataTypeEnum[keyof typeof ExportRelationshipDataTypeEnum];
 /**
  *
  * @export
@@ -5860,6 +6053,158 @@ export declare class BatchesApi extends BaseAPI {
      */
     getQueuedBatch(requestParameters: BatchesApiGetQueuedBatchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
 }
+/**
+ * ExportsApi - axios parameter creator
+ * @export
+ */
+export declare const ExportsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {CreateExportRequest} createExportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExport: (createExportRequest: CreateExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an `export` by ID.
+     * @param {string} id The &#x60;export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {string} id The &#x60;queued-export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedExport: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ExportsApi - functional programming interface
+ * @export
+ */
+export declare const ExportsApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {CreateExportRequest} createExportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExport(createExportRequest: CreateExportRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
+    /**
+     * Get an `export` by ID.
+     * @param {string} id The &#x60;export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Export>>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {string} id The &#x60;queued-export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedExport(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
+};
+/**
+ * ExportsApi - factory interface
+ * @export
+ */
+export declare const ExportsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {CreateExportRequest} createExportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExport(createExportRequest: CreateExportRequest, options?: any): AxiosPromise<QueuedJob>;
+    /**
+     * Get an `export` by ID.
+     * @param {string} id The &#x60;export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport(id: string, options?: any): AxiosPromise<Export>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {string} id The &#x60;queued-export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedExport(id: string, options?: any): AxiosPromise<QueuedJob>;
+};
+/**
+ * Request parameters for createExport operation in ExportsApi.
+ * @export
+ * @interface ExportsApiCreateExportRequest
+ */
+export interface ExportsApiCreateExportRequest {
+    /**
+     *
+     * @type {CreateExportRequest}
+     * @memberof ExportsApiCreateExport
+     */
+    readonly createExportRequest: CreateExportRequest;
+}
+/**
+ * Request parameters for getExport operation in ExportsApi.
+ * @export
+ * @interface ExportsApiGetExportRequest
+ */
+export interface ExportsApiGetExportRequest {
+    /**
+     * The &#x60;export&#x60; ID.
+     * @type {string}
+     * @memberof ExportsApiGetExport
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getQueuedExport operation in ExportsApi.
+ * @export
+ * @interface ExportsApiGetQueuedExportRequest
+ */
+export interface ExportsApiGetQueuedExportRequest {
+    /**
+     * The &#x60;queued-export&#x60; ID.
+     * @type {string}
+     * @memberof ExportsApiGetQueuedExport
+     */
+    readonly id: string;
+}
+/**
+ * ExportsApi - object-oriented interface
+ * @export
+ * @class ExportsApi
+ * @extends {BaseAPI}
+ */
+export declare class ExportsApi extends BaseAPI {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {ExportsApiCreateExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    createExport(requestParameters: ExportsApiCreateExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
+    /**
+     * Get an `export` by ID.
+     * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    getExport(requestParameters: ExportsApiGetExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Export, any>>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {ExportsApiGetQueuedExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
+}
 /**
  * FilesApi - axios parameter creator
  * @export