@vertexvis/api-client-node 0.20.3 → 0.20.4

package/dist/cjs/api.d.ts

@@ -1364,6 +1364,14 @@ export interface CreateSceneItemRequestDataAttributes {
      * @memberof CreateSceneItemRequestDataAttributes
      */
     visible?: boolean;
+    /**
+     * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @memberof CreateSceneItemRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+    };
 }
 /**
  *
@@ -1598,6 +1606,12 @@ export interface CreateSceneViewStateRequestDataAttributes {
      * @memberof CreateSceneViewStateRequestDataAttributes
      */
     name?: string;
+    /**
+     * ID provided for correlation. For example, an existing ID from a PLM system.
+     * @type {string}
+     * @memberof CreateSceneViewStateRequestDataAttributes
+     */
+    suppliedId?: string;
 }
 /**
  *
@@ -4328,6 +4342,12 @@ export interface SceneViewStateDataAttributes {
      * @memberof SceneViewStateDataAttributes
      */
     noDefaultLights?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneViewStateDataAttributes
+     */
+    suppliedId?: string;
 }
 /**
  *
@@ -4950,6 +4970,14 @@ export interface UpdateSceneItemRequestDataAttributes {
      * @memberof UpdateSceneItemRequestDataAttributes
      */
     suppliedId?: string;
+    /**
+     * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @memberof UpdateSceneItemRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+    };
 }
 /**
  *
@@ -8742,10 +8770,11 @@ export declare const SceneViewStatesApiAxiosParamCreator: (configuration?: Confi
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
      * @param {string} [filterId] Comma-separated list of IDs to filter on.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneViewStates: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getSceneViewStates: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update a `scene-view-state`.
      * @param {string} id The &#x60;scene-view-state&#x60; ID.
@@ -8790,10 +8819,11 @@ export declare const SceneViewStatesApiFp: (configuration?: Configuration | unde
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;thumbnails&#x60; is only returned if explicitly requested.
      * @param {string} [filterId] Comma-separated list of IDs to filter on.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneViewStateList>>;
+    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneViewStateList>>;
     /**
      * Update a `scene-view-state`.
      * @param {string} id The &#x60;scene-view-state&#x60; ID.
@@ -8838,10 +8868,11 @@ export declare const SceneViewStatesApiFactory: (configuration?: Configuration |
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;thumbnails&#x60; is only returned if explicitly requested.
      * @param {string} [filterId] Comma-separated list of IDs to filter on.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, options?: any): AxiosPromise<SceneViewStateList>;
+    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneViewStateList>;
     /**
      * Update a `scene-view-state`.
      * @param {string} id The &#x60;scene-view-state&#x60; ID.
@@ -8938,6 +8969,12 @@ export interface SceneViewStatesApiGetSceneViewStatesRequest {
      * @memberof SceneViewStatesApiGetSceneViewStates
      */
     readonly filterId?: string;
+    /**
+     * Comma-separated list of supplied IDs to filter on.
+     * @type {string}
+     * @memberof SceneViewStatesApiGetSceneViewStates
+     */
+    readonly filterSuppliedId?: string;
 }
 /**
  * Request parameters for updateSceneViewState operation in SceneViewStatesApi.

package/dist/cjs/api.js

@@ -4752,10 +4752,11 @@ const SceneViewStatesApiAxiosParamCreator = function (configuration) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
          * @param {string} [filterId] Comma-separated list of IDs to filter on.
+         * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneViewStates: (id, pageCursor, pageSize, fieldsSceneViewState, filterId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getSceneViewStates: (id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'id' is not null or undefined
             (0, common_1.assertParamExists)('getSceneViewStates', 'id', id);
             const localVarPath = `/scenes/{id}/scene-view-states`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -4784,6 +4785,9 @@ const SceneViewStatesApiAxiosParamCreator = function (configuration) {
             if (filterId !== undefined) {
                 localVarQueryParameter['filter[id]'] = filterId;
             }
+            if (filterSuppliedId !== undefined) {
+                localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
+            }
             (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);
@@ -4882,12 +4886,13 @@ const SceneViewStatesApiFp = function (configuration) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
          * @param {string} [filterId] Comma-separated list of IDs to filter on.
+         * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options) {
+        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -4956,12 +4961,13 @@ const SceneViewStatesApiFactory = function (configuration, basePath, axios) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
          * @param {string} [filterId] Comma-separated list of IDs to filter on.
+         * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options) {
+        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options) {
             return localVarFp
-                .getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options)
+                .getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options)
                 .then((request) => request(axios, basePath));
         },
         /**
@@ -5031,7 +5037,7 @@ class SceneViewStatesApi extends base_1.BaseAPI {
      */
     getSceneViewStates(requestParameters, options) {
         return (0, exports.SceneViewStatesApiFp)(this.configuration)
-            .getSceneViewStates(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.fieldsSceneViewState, requestParameters.filterId, options)
+            .getSceneViewStates(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.fieldsSceneViewState, requestParameters.filterId, requestParameters.filterSuppliedId, options)
             .then((request) => request(this.axios, this.basePath));
     }
     /**

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

@@ -1 +1 @@
-export declare const version = "0.20.3";
+export declare const version = "0.20.4";

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.3';
+exports.version = '0.20.4';

package/dist/esm/api.d.ts

@@ -1364,6 +1364,14 @@ export interface CreateSceneItemRequestDataAttributes {
      * @memberof CreateSceneItemRequestDataAttributes
      */
     visible?: boolean;
+    /**
+     * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @memberof CreateSceneItemRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+    };
 }
 /**
  *
@@ -1598,6 +1606,12 @@ export interface CreateSceneViewStateRequestDataAttributes {
      * @memberof CreateSceneViewStateRequestDataAttributes
      */
     name?: string;
+    /**
+     * ID provided for correlation. For example, an existing ID from a PLM system.
+     * @type {string}
+     * @memberof CreateSceneViewStateRequestDataAttributes
+     */
+    suppliedId?: string;
 }
 /**
  *
@@ -4328,6 +4342,12 @@ export interface SceneViewStateDataAttributes {
      * @memberof SceneViewStateDataAttributes
      */
     noDefaultLights?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneViewStateDataAttributes
+     */
+    suppliedId?: string;
 }
 /**
  *
@@ -4950,6 +4970,14 @@ export interface UpdateSceneItemRequestDataAttributes {
      * @memberof UpdateSceneItemRequestDataAttributes
      */
     suppliedId?: string;
+    /**
+     * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @memberof UpdateSceneItemRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+    };
 }
 /**
  *
@@ -8742,10 +8770,11 @@ export declare const SceneViewStatesApiAxiosParamCreator: (configuration?: Confi
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
      * @param {string} [filterId] Comma-separated list of IDs to filter on.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneViewStates: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getSceneViewStates: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update a `scene-view-state`.
      * @param {string} id The &#x60;scene-view-state&#x60; ID.
@@ -8790,10 +8819,11 @@ export declare const SceneViewStatesApiFp: (configuration?: Configuration | unde
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;thumbnails&#x60; is only returned if explicitly requested.
      * @param {string} [filterId] Comma-separated list of IDs to filter on.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneViewStateList>>;
+    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneViewStateList>>;
     /**
      * Update a `scene-view-state`.
      * @param {string} id The &#x60;scene-view-state&#x60; ID.
@@ -8838,10 +8868,11 @@ export declare const SceneViewStatesApiFactory: (configuration?: Configuration |
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;thumbnails&#x60; is only returned if explicitly requested.
      * @param {string} [filterId] Comma-separated list of IDs to filter on.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, options?: any): AxiosPromise<SceneViewStateList>;
+    getSceneViewStates(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, fieldsSceneViewState?: string | undefined, filterId?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneViewStateList>;
     /**
      * Update a `scene-view-state`.
      * @param {string} id The &#x60;scene-view-state&#x60; ID.
@@ -8938,6 +8969,12 @@ export interface SceneViewStatesApiGetSceneViewStatesRequest {
      * @memberof SceneViewStatesApiGetSceneViewStates
      */
     readonly filterId?: string;
+    /**
+     * Comma-separated list of supplied IDs to filter on.
+     * @type {string}
+     * @memberof SceneViewStatesApiGetSceneViewStates
+     */
+    readonly filterSuppliedId?: string;
 }
 /**
  * Request parameters for updateSceneViewState operation in SceneViewStatesApi.

package/dist/esm/api.js

@@ -4692,10 +4692,11 @@ export const SceneViewStatesApiAxiosParamCreator = function (configuration) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
          * @param {string} [filterId] Comma-separated list of IDs to filter on.
+         * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneViewStates: (id, pageCursor, pageSize, fieldsSceneViewState, filterId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getSceneViewStates: (id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('getSceneViewStates', 'id', id);
             const localVarPath = `/scenes/{id}/scene-view-states`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -4724,6 +4725,9 @@ export const SceneViewStatesApiAxiosParamCreator = function (configuration) {
             if (filterId !== undefined) {
                 localVarQueryParameter['filter[id]'] = filterId;
             }
+            if (filterSuppliedId !== undefined) {
+                localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -4821,12 +4825,13 @@ export const SceneViewStatesApiFp = function (configuration) {
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
          * @param {string} [filterId] Comma-separated list of IDs to filter on.
+         * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options) {
+        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -4894,12 +4899,13 @@ export const SceneViewStatesApiFactory = function (configuration, basePath, axio
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [fieldsSceneViewState] Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.
          * @param {string} [filterId] Comma-separated list of IDs to filter on.
+         * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options) {
+        getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options) {
             return localVarFp
-                .getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, options)
+                .getSceneViewStates(id, pageCursor, pageSize, fieldsSceneViewState, filterId, filterSuppliedId, options)
                 .then((request) => request(axios, basePath));
         },
         /**
@@ -4968,7 +4974,7 @@ export class SceneViewStatesApi extends BaseAPI {
      */
     getSceneViewStates(requestParameters, options) {
         return SceneViewStatesApiFp(this.configuration)
-            .getSceneViewStates(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.fieldsSceneViewState, requestParameters.filterId, options)
+            .getSceneViewStates(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.fieldsSceneViewState, requestParameters.filterId, requestParameters.filterSuppliedId, options)
             .then((request) => request(this.axios, this.basePath));
     }
     /**

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

@@ -1 +1 @@
-export declare const version = "0.20.3";
+export declare const version = "0.20.4";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.20.3';
+export const version = '0.20.4';

package/package.json

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