@vertexvis/api-client-node 0.21.2 → 0.22.0

package/dist/esm/api.js

@@ -72,6 +72,9 @@ export const PartDataRelationshipsPartRevisionsTypeEnum = {
 export const PartRelationshipDataTypeEnum = {
     Part: 'part',
 };
+export const PartRenditionRelationshipDataTypeEnum = {
+    PartRendition: 'part-rendition',
+};
 /**
  * Resource object type.
  * @export
@@ -1122,6 +1125,113 @@ export class BatchesApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @param {string} id The `part-revision` ID.
+         * @param {CreatePartRenditionRequest} createPartRenditionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPartRendition: (id, createPartRenditionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('createPartRendition', 'id', id);
+            // verify required parameter 'createPartRenditionRequest' is not null or undefined
+            assertParamExists('createPartRendition', 'createPartRenditionRequest', createPartRenditionRequest);
+            const localVarPath = `/part-revisions/{id}/part-renditions`.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: '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 = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createPartRenditionRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export const DefaultApiFp = function (configuration) {
+    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration);
+    return {
+        /**
+         *
+         * @param {string} id The `part-revision` ID.
+         * @param {CreatePartRenditionRequest} createPartRenditionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPartRendition(id, createPartRenditionRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createPartRendition(id, createPartRenditionRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export const DefaultApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = DefaultApiFp(configuration);
+    return {
+        /**
+         *
+         * @param {string} id The `part-revision` ID.
+         * @param {CreatePartRenditionRequest} createPartRenditionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPartRendition(id, createPartRenditionRequest, options) {
+            return localVarFp
+                .createPartRendition(id, createPartRenditionRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export class DefaultApi extends BaseAPI {
+    /**
+     *
+     * @param {DefaultApiCreatePartRenditionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    createPartRendition(requestParameters, options) {
+        return DefaultApiFp(this.configuration)
+            .createPartRendition(requestParameters.id, requestParameters.createPartRenditionRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * ExportsApi - axios parameter creator
  * @export
@@ -5746,7 +5856,7 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterName] Comma-separated list of names to filter on.
          * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
-         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
          * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5931,7 +6041,7 @@ export const ScenesApiFp = function (configuration) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterName] Comma-separated list of names to filter on.
          * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
-         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
          * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -6029,7 +6139,7 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterName] Comma-separated list of names to filter on.
          * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
-         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
          * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -6481,9 +6591,10 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
             };
         }),
         /**
-         * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+         * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
          * @param {string} id The `queued-translation` ID.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getQueuedTranslation: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -6543,16 +6654,16 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
             };
         }),
         /**
-         * Get `queued-translation`s.
+         * Get all current translation jobs in progress.
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterStatus] Status to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getQueuedTranslations: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getQueuedTranslationJobs: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
             var _e;
-            const localVarPath = `/queued-translations`;
+            const localVarPath = `/queued-translation-jobs`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -6582,6 +6693,47 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {string} [filterStatus] Status to filter on.
+         * @param {*} [options] Override http request option.
+         * @deprecated
+         * @throws {RequiredError}
+         */
+        getQueuedTranslations: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _f;
+            const localVarPath = `/queued-translations`;
+            // 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);
+            if (pageCursor !== undefined) {
+                localVarQueryParameter['page[cursor]'] = pageCursor;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page[size]'] = pageSize;
+            }
+            if (filterStatus !== undefined) {
+                localVarQueryParameter['filter[status]'] = filterStatus;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 /**
@@ -6616,9 +6768,10 @@ export const TranslationInspectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+         * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
          * @param {string} id The `queued-translation` ID.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getQueuedTranslation(id, options) {
@@ -6640,11 +6793,26 @@ export const TranslationInspectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Get `queued-translation`s.
+         * Get all current translation jobs in progress.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {string} [filterStatus] Status to filter on.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterStatus] Status to filter on.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getQueuedTranslations(pageCursor, pageSize, filterStatus, options) {
@@ -6685,9 +6853,10 @@ export const TranslationInspectionsApiFactory = function (configuration, basePat
                 .then((request) => request(axios, basePath));
         },
         /**
-         * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+         * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
          * @param {string} id The `queued-translation` ID.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getQueuedTranslation(id, options) {
@@ -6707,13 +6876,27 @@ export const TranslationInspectionsApiFactory = function (configuration, basePat
                 .then((request) => request(axios, basePath));
         },
         /**
-         * Get `queued-translation`s.
+         * Get all current translation jobs in progress.
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterStatus] Status to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
+        getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options) {
+            return localVarFp
+                .getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {string} [filterStatus] Status to filter on.
+         * @param {*} [options] Override http request option.
+         * @deprecated
+         * @throws {RequiredError}
+         */
         getQueuedTranslations(pageCursor, pageSize, filterStatus, options) {
             return localVarFp
                 .getQueuedTranslations(pageCursor, pageSize, filterStatus, options)
@@ -6753,9 +6936,10 @@ export class TranslationInspectionsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+     * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
      * @param {TranslationInspectionsApiGetQueuedTranslationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TranslationInspectionsApi
      */
@@ -6777,9 +6961,22 @@ export class TranslationInspectionsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Get `queued-translation`s.
+     * Get all current translation jobs in progress.
+     * @param {TranslationInspectionsApiGetQueuedTranslationJobsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TranslationInspectionsApi
+     */
+    getQueuedTranslationJobs(requestParameters = {}, options) {
+        return TranslationInspectionsApiFp(this.configuration)
+            .getQueuedTranslationJobs(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterStatus, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
      * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TranslationInspectionsApi
      */

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { ReadStream } from 'fs';
 import { BaseReq, DeleteReq } from '../../client/index';
 import { CreateFileRequest, FileMetadataData } from '../../index';
 /** Upload file arguments. */
@@ -6,7 +7,7 @@ export interface UploadFileReq extends BaseReq {
     /** A {@link CreateFileRequest}. */
     readonly createFileReq: CreateFileRequest;
     /** File data. */
-    readonly fileData: Buffer;
+    readonly fileData: Buffer | ReadStream;
 }
 /**
  * Delete all files.

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

@@ -1,7 +1,7 @@
 export * from './exports';
 export * from './files';
 export * from './parts';
-export * from './scenes';
 export * from './queued-jobs';
 export * from './scene-items';
 export * from './scene-views';
+export * from './scenes';

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

@@ -1,7 +1,7 @@
 export * from './exports';
 export * from './files';
 export * from './parts';
-export * from './scenes';
 export * from './queued-jobs';
 export * from './scene-items';
 export * from './scene-views';
+export * from './scenes';

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

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { AxiosResponse } from 'axios';
+import { ReadStream } from 'fs';
 import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, Part, PartData, PartRevisionData, QueuedJob } from '../../index';
 import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
 /** Create parts from file arguments. */
@@ -9,7 +10,7 @@ export interface CreatePartFromFileReq extends BaseReq {
     /** Function returning a {@link CreatePartRequest}. */
     readonly createPartReq: (fileId: string) => CreatePartRequest;
     /** File data. */
-    readonly fileData: Buffer;
+    readonly fileData: Buffer | ReadStream;
     /** {@link Polling} */
     readonly polling?: Polling;
     /** Whether or not to return queued translation. */

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

@@ -1,7 +1,7 @@
 import { VertexClient } from './index';
+export * from './helpers/index';
 export * from './utils';
 export * from './vertex-client';
-export * from './helpers/index';
 /** Common helper arguments. */
 export interface BaseReq {
     /** An instance of {@link VertexClient}. */

package/dist/esm/client/index.js

@@ -1,3 +1,3 @@
+export * from './helpers/index';
 export * from './utils';
 export * from './vertex-client';
-export * from './helpers/index';

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

@@ -1 +1 @@
-export declare const version = "0.21.2";
+export declare const version = "0.22.0";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.21.2';
+export const version = '0.22.0';

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
 export * from './api';
 export * from './base';
-export * from './configuration';
 export * from './client';
+export * from './configuration';

package/dist/esm/index.js

@@ -1,4 +1,4 @@
 export * from './api';
 export * from './base';
-export * from './configuration';
 export * from './client';
+export * from './configuration';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.21.2",
+  "version": "0.22.0",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -33,21 +33,21 @@
     "typescript"
   ],
   "dependencies": {
-    "axios": "^0.27.2",
+    "axios": "^1.5.0",
     "p-limit": "^3"
   },
   "devDependencies": {
     "@types/jest": "^27.0",
     "@types/node": "^16",
-    "@vertexvis/eslint-config-vertexvis-typescript": "^0.4",
-    "eslint": "^7",
-    "eslint-plugin-promise": "^5.2",
-    "eslint-plugin-simple-import-sort": "^7.0",
-    "eslint-plugin-tsdoc": "^0.2",
-    "jest": "^27.4",
+    "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.1",
+    "eslint": "^8.49.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "jest": "^29.7.0",
     "pinst": "^2.1",
-    "prettier": "^2.5",
-    "ts-jest": "^27.1",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
     "typedoc": "^0.22",
     "typescript": "4.5.x"
   },