@vertexvis/api-client-node 0.16.0 → 0.17.0

package/dist/esm/api.js

@@ -54,6 +54,9 @@ export const ClearTransformOperationTypeEnum = {
 export const DeselectOperationTypeEnum = {
     Deselect: 'deselect',
 };
+export const ExportRelationshipDataTypeEnum = {
+    Scene: 'scene',
+};
 export const FileRelationshipDataTypeEnum = {
     File: 'file',
 };
@@ -1110,6 +1113,237 @@ export class BatchesApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * ExportsApi - axios parameter creator
+ * @export
+ */
+export const ExportsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'createExportRequest' is not null or undefined
+            assertParamExists('createExport', 'createExportRequest', createExportRequest);
+            const localVarPath = `/exports`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createExportRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get an `export` by ID.
+         * @param {string} id The `export` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExport: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getExport', 'id', id);
+            const localVarPath = `/exports/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * 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 `queued-export` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQueuedExport: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getQueuedExport', 'id', id);
+            const localVarPath = `/queued-exports/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ExportsApi - functional programming interface
+ * @export
+ */
+export const ExportsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ExportsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * 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, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createExport(createExportRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Get an `export` by ID.
+         * @param {string} id The `export` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExport(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getExport(id, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * 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 `queued-export` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQueuedExport(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedExport(id, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * ExportsApi - factory interface
+ * @export
+ */
+export const ExportsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ExportsApiFp(configuration);
+    return {
+        /**
+         * 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, options) {
+            return localVarFp
+                .createExport(createExportRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Get an `export` by ID.
+         * @param {string} id The `export` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExport(id, options) {
+            return localVarFp
+                .getExport(id, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * 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 `queued-export` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQueuedExport(id, options) {
+            return localVarFp
+                .getQueuedExport(id, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ExportsApi - object-oriented interface
+ * @export
+ * @class ExportsApi
+ * @extends {BaseAPI}
+ */
+export 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, options) {
+        return ExportsApiFp(this.configuration)
+            .createExport(requestParameters.createExportRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get an `export` by ID.
+     * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    getExport(requestParameters, options) {
+        return ExportsApiFp(this.configuration)
+            .getExport(requestParameters.id, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * 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, options) {
+        return ExportsApiFp(this.configuration)
+            .getQueuedExport(requestParameters.id, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * FilesApi - axios parameter creator
  * @export

package/dist/esm/client/helpers/exports.d.ts

@@ -0,0 +1,15 @@
+import { CreateExportRequest, Export } from '../../index';
+import { BaseReq } from '../index';
+/**
+ * Create export arguments.
+ */
+export interface CreateExportReq extends BaseReq {
+    /** Function returning a {@link CreateExportRequest}. */
+    readonly createExportReq: () => CreateExportRequest;
+}
+/**
+ * Create an export.
+ *
+ * @param args - The {@link CreateExportReq}.
+ */
+export declare function createExport({ client, createExportReq, onMsg, verbose, }: CreateExportReq): Promise<Export>;

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

@@ -0,0 +1,35 @@
+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());
+    });
+};
+import { isPollError, MaxAttempts, PollIntervalMs, pollQueuedJob, throwOnError, } from '../index';
+/**
+ * Create an export.
+ *
+ * @param args - The {@link CreateExportReq}.
+ */
+export 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 pollQueuedJob({
+            id: queuedId,
+            getQueuedJob: (id) => client.exports.getQueuedExport({ id }),
+            polling: { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts },
+        });
+        if (isPollError(pollRes.res))
+            throwOnError(pollRes);
+        if (verbose)
+            onMsg(`Completed export ${pollRes.res.data.id}`);
+        return pollRes.res;
+    });
+}

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

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

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

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

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

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

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.15.6';
+export const version = '0.17.0';

package/dist/esm/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/esm/client/vertex-client.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 var _a;
 import axios from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi, } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi, } from '../index';
 import { createToken, isFailure, nowEpochMs, prettyJson, } from './index';
 import { version } from './version';
 const TenMinsInMs = 600000;
@@ -73,6 +73,7 @@ export class VertexClient {
         this.accounts = new AccountsApi(this.config, undefined, axiosInst);
         this.applications = new ApplicationsApi(this.config, undefined, axiosInst);
         this.batches = new BatchesApi(this.config, undefined, axiosInst);
+        this.exports = new ExportsApi(this.config, undefined, axiosInst);
         this.files = new FilesApi(this.config, undefined, axiosInst);
         this.geometrySets = new GeometrySetsApi(this.config, undefined, axiosInst);
         this.hits = new HitsApi(this.config, undefined, axiosInst);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",