@vertexvis/api-client-node 0.20.6 → 0.20.8

package/dist/cjs/api.js

@@ -4230,7 +4230,7 @@ const SceneItemsApiAxiosParamCreator = function (configuration) {
         /**
          * Get a `scene-item` by ID.
          * @param {string} id The `scene-item` ID.
-         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -4408,7 +4408,7 @@ const SceneItemsApiFp = function (configuration) {
         /**
          * Get a `scene-item` by ID.
          * @param {string} id The `scene-item` ID.
-         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -4506,7 +4506,7 @@ const SceneItemsApiFactory = function (configuration, basePath, axios) {
         /**
          * Get a `scene-item` by ID.
          * @param {string} id The `scene-item` ID.
-         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -5197,7 +5197,7 @@ const SceneViewsApiAxiosParamCreator = function (configuration) {
          * Get a `scene-item` within a view by ID.
          * @param {string} id The `scene-view` ID.
          * @param {string} itemId The `scene-item` ID.
-         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
          * @param {string} [include] Comma-separated list of relationships to include in response.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5374,7 +5374,7 @@ const SceneViewsApiFp = function (configuration) {
          * Get a `scene-item` within a view by ID.
          * @param {string} id The `scene-view` ID.
          * @param {string} itemId The `scene-item` ID.
-         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
          * @param {string} [include] Comma-separated list of relationships to include in response.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5473,7 +5473,7 @@ const SceneViewsApiFactory = function (configuration, basePath, axios) {
          * Get a `scene-item` within a view by ID.
          * @param {string} id The `scene-view` ID.
          * @param {string} itemId The `scene-item` ID.
-         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
+         * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
          * @param {string} [include] Comma-separated list of relationships to include in response.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5705,7 +5705,7 @@ const ScenesApiAxiosParamCreator = function (configuration) {
         /**
          * Get a `scene` by ID.
          * @param {string} id The `scene` ID.
-         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested.
+         * @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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -5742,10 +5742,11 @@ 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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/scenes`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -5771,6 +5772,9 @@ const ScenesApiAxiosParamCreator = function (configuration) {
             if (filterSuppliedId !== undefined) {
                 localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
             }
+            if (fieldsScene !== undefined) {
+                localVarQueryParameter['fields[scene]'] = fieldsScene;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -5901,7 +5905,7 @@ const ScenesApiFp = function (configuration) {
         /**
          * Get a `scene` by ID.
          * @param {string} id The `scene` ID.
-         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested.
+         * @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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -5917,12 +5921,13 @@ 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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
+        getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -5999,7 +6004,7 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
         /**
          * Get a `scene` by ID.
          * @param {string} id The `scene` ID.
-         * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested.
+         * @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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6014,12 +6019,13 @@ 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 {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
+        getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
             return localVarFp
-                .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options)
+                .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options)
                 .then((request) => request(axios, basePath));
         },
         /**
@@ -6114,7 +6120,7 @@ class ScenesApi extends base_1.BaseAPI {
      */
     getScenes(requestParameters = {}, options) {
         return (0, exports.ScenesApiFp)(this.configuration)
-            .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, options)
+            .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, options)
             .then((request) => request(this.axios, this.basePath));
     }
     /**
@@ -6494,6 +6500,36 @@ const TranslationInspectionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. 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.
+         * @throws {RequiredError}
+         */
+        getQueuedTranslationJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('getQueuedTranslationJob', 'id', id);
+            const localVarPath = `/queued-translation-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Get `queued-translation`s.
          * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6579,6 +6615,18 @@ const TranslationInspectionsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. 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.
+         * @throws {RequiredError}
+         */
+        getQueuedTranslationJob(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJob(id, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get `queued-translation`s.
          * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6636,6 +6684,17 @@ const TranslationInspectionsApiFactory = function (configuration, basePath, axio
                 .getQueuedTranslation(id, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. 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.
+         * @throws {RequiredError}
+         */
+        getQueuedTranslationJob(id, options) {
+            return localVarFp
+                .getQueuedTranslationJob(id, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Get `queued-translation`s.
          * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6695,6 +6754,18 @@ class TranslationInspectionsApi extends base_1.BaseAPI {
             .getQueuedTranslation(requestParameters.id, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. 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 {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TranslationInspectionsApi
+     */
+    getQueuedTranslationJob(requestParameters, options) {
+        return (0, exports.TranslationInspectionsApiFp)(this.configuration)
+            .getQueuedTranslationJob(requestParameters.id, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get `queued-translation`s.
      * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.

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

@@ -1 +1 @@
-export declare const version = "0.20.6";
+export declare const version = "0.20.8";

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.20.6';
+exports.version = '0.20.8';