@vertexvis/api-client-node 0.20.0 → 0.20.4

package/dist/cjs/api.d.ts

@@ -671,7 +671,7 @@ export interface Color3 {
  */
 export interface ColorMaterial {
     /**
-     * Opacity from 0 to 100.
+     * An opacity value from 0 to 255.
      * @type {number}
      * @memberof ColorMaterial
      */
@@ -714,7 +714,7 @@ export interface ColorMaterial {
  */
 export interface ColorMaterialNullable {
     /**
-     * Opacity from 0 to 100.
+     * An opacity value from 0 to 255.
      * @type {number}
      * @memberof ColorMaterialNullable
      */
@@ -1107,11 +1107,19 @@ export interface CreatePartRequestDataAttributes {
      */
     suppliedRevisionId?: string;
     /**
-     * Whether or not to index metadata in the part file.
+     * Whether or not to index metadata in the part file. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
      * @type {boolean}
      * @memberof CreatePartRequestDataAttributes
      */
     indexMetadata?: boolean;
+    /**
+     * Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @memberof CreatePartRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+    };
     /**
      * Name to be used for the root part.
      * @type {string}
@@ -1356,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;
+    };
 }
 /**
  *
@@ -1590,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;
 }
 /**
  *
@@ -2577,30 +2599,54 @@ export interface Matrix4Nullable {
 /**
  *
  * @export
- * @interface MetadataValue
+ * @interface MetadataFloatType
  */
-export interface MetadataValue {
+export interface MetadataFloatType {
     /**
-     * Metadata value.
+     * Type of metadata value.
      * @type {string}
-     * @memberof MetadataValue
+     * @memberof MetadataFloatType
      */
-    value?: string;
+    type: string;
+    /**
+     * A numerical floating-point value.
+     * @type {number}
+     * @memberof MetadataFloatType
+     */
+    value: number;
+}
+/**
+ *
+ * @export
+ * @interface MetadataNullType
+ */
+export interface MetadataNullType {
     /**
      * Type of metadata value.
      * @type {string}
-     * @memberof MetadataValue
+     * @memberof MetadataNullType
      */
-    type: MetadataValueTypeEnum;
+    type: string;
+}
+/**
+ *
+ * @export
+ * @interface MetadataStringType
+ */
+export interface MetadataStringType {
+    /**
+     * Type of metadata value.
+     * @type {string}
+     * @memberof MetadataStringType
+     */
+    type: string;
+    /**
+     * A string value.
+     * @type {string}
+     * @memberof MetadataStringType
+     */
+    value: string;
 }
-export declare const MetadataValueTypeEnum: {
-    readonly String: "string";
-    readonly Long: "long";
-    readonly Float: "float";
-    readonly Date: "date";
-    readonly Null: "null";
-};
-export declare type MetadataValueTypeEnum = typeof MetadataValueTypeEnum[keyof typeof MetadataValueTypeEnum];
 /**
  *
  * @export
@@ -2958,11 +3004,11 @@ export interface PartRevisionDataAttributes {
     created?: string;
     /**
      *
-     * @type {{ [key: string]: MetadataValue; }}
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
      * @memberof PartRevisionDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataValue;
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
     };
     /**
      *
@@ -3694,11 +3740,11 @@ export interface SceneItemDataAttributes {
     materialOverride?: ColorMaterial;
     /**
      *
-     * @type {{ [key: string]: MetadataValue; }}
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
      * @memberof SceneItemDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataValue;
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
     };
     /**
      *
@@ -4296,6 +4342,12 @@ export interface SceneViewStateDataAttributes {
      * @memberof SceneViewStateDataAttributes
      */
     noDefaultLights?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneViewStateDataAttributes
+     */
+    suppliedId?: string;
 }
 /**
  *
@@ -4737,15 +4789,15 @@ export interface UpdatePartRevisionRequestData {
  */
 export interface UpdatePartRevisionRequestDataAttributes {
     /**
-     * Metadata about the `part` and/or `part-revision`.
-     * @type {{ [key: string]: MetadataValue; }}
+     * Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
      * @memberof UpdatePartRevisionRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataValue;
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
     };
     /**
-     * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise.
+     * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
      * @type {boolean}
      * @memberof UpdatePartRevisionRequestDataAttributes
      */
@@ -4918,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;
+    };
 }
 /**
  *
@@ -8710,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.
@@ -8758,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.
@@ -8806,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.
@@ -8906,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

@@ -25,9 +25,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOperationTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PartRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.MetadataValueTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOperationTypeEnum = exports.ClearMaterialOperationTypeEnum = exports.ChangeVisibilityOperationTypeEnum = exports.ChangeTransformOperationTypeEnum = exports.ChangeMaterialOperationTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
-exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = void 0;
-exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = void 0;
+exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOperationTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PartRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOperationTypeEnum = exports.ClearMaterialOperationTypeEnum = exports.ChangeVisibilityOperationTypeEnum = exports.ChangeTransformOperationTypeEnum = exports.ChangeMaterialOperationTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
+exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = void 0;
+exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -74,13 +74,6 @@ exports.FileRelationshipDataTypeEnum = {
 exports.GeometrySetRelationshipDataTypeEnum = {
     GeometrySet: 'geometry-set',
 };
-exports.MetadataValueTypeEnum = {
-    String: 'string',
-    Long: 'long',
-    Float: 'float',
-    Date: 'date',
-    Null: 'null',
-};
 exports.PartDataRelationshipsPartRevisionsTypeEnum = {
     PartRevision: 'part-revision',
 };
@@ -4759,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)));
@@ -4791,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);
@@ -4889,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);
             });
         },
@@ -4963,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));
         },
         /**
@@ -5038,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/helpers/queued-jobs.js

@@ -74,9 +74,10 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
         let attempts = 1;
         let pollRes = yield poll(attempts);
         /* eslint-disable no-await-in-loop */
-        while ((allowed404(allow404, pollRes.status) ||
-            validJob(pollRes.res) ||
-            isClientError(pollRes.res)) &&
+        while (!completeJob(pollRes.res) &&
+            (allowed404(allow404, pollRes.status) ||
+                validJob(pollRes.res) ||
+                isClientError(pollRes.res)) &&
             attempts <= maxAttempts) {
             attempts += 1;
             yield (0, utils_1.delay)(intervalMs);
@@ -85,7 +86,7 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
         /* eslint-enable no-await-in-loop */
         // At this point, the result is one of the following,
         //  - An item of type `T` after being redirected to it
-        //  - A QueuedJob (after either exceeding `maxAttempts` or with `error` status)
+        //  - A QueuedJob (after either exceeding `maxAttempts` or with `complete` or `error` status)
         //  - A Failure
         return Object.assign(Object.assign({}, pollRes), { attempts, id });
     });
@@ -115,10 +116,16 @@ function allowed404(allow404, status) {
 function validJob(r) {
     return (0, utils_1.isQueuedJob)(r) && !isStatusError(r);
 }
+function completeJob(r) {
+    return (0, utils_1.isQueuedJob)(r) && isStatusComplete(r);
+}
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 function isQueuedJobError(obj) {
     return (0, utils_1.isQueuedJob)(obj) && isStatusError(obj);
 }
+function isStatusComplete(job) {
+    return job.data.attributes.status === 'complete';
+}
 function isStatusError(job) {
     return job.data.attributes.status === 'error';
 }

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

@@ -17,6 +17,22 @@ export interface CreateSceneAndSceneItemsReq extends BaseReq {
     /** Whether or not to return queued scene items. */
     readonly returnQueued?: boolean;
 }
+export interface CreateSceneAndSceneItemsReqEXPERIMENTAL extends BaseReq {
+    /** A list of {@link CreateSceneItemRequest}. */
+    readonly createSceneItemReqs: Array<Array<CreateSceneItemRequest>>;
+    /** Function returning a {@link CreateSceneRequest}. */
+    readonly createSceneReq: () => CreateSceneRequest;
+    /** Whether or not to fail if any scene item fails initial validation. */
+    readonly failFast?: boolean;
+    /** How many requests to run in parallel. */
+    readonly parallelism: number;
+    /** {@link Polling} */
+    readonly polling?: Polling;
+    /** Callback with total number of requests and number complete. */
+    onProgress?: (complete: number, total: number) => void;
+    /** Whether or not to return queued scene items. */
+    readonly returnQueued?: boolean;
+}
 export interface CreateSceneAndSceneItemsRes {
     readonly errors: QueuedSceneItem[];
     readonly scene: Scene;
@@ -90,13 +106,13 @@ export declare function createSceneAndSceneItems({ client, createSceneItemReqs,
  */
 export declare function createSceneItems({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsRes>;
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
-export declare function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast, onMsg, onProgress, parallelism, polling, returnQueued, verbose, }: CreateSceneAndSceneItemsReq): Promise<CreateSceneAndSceneItemsResEXPERIMENTAL>;
+export declare function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast, onMsg, onProgress, parallelism, polling, returnQueued, verbose, }: CreateSceneAndSceneItemsReqEXPERIMENTAL): Promise<CreateSceneAndSceneItemsResEXPERIMENTAL>;
 /**
  * Create scene items within a scene.
  */
-export declare function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsResEXPERIMENTAL>;
+export declare function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsResEXPERIMENTAL>;
 /**
  * Delete all scenes.
  *

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

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateScene = exports.renderScene = exports.pollSceneReady = exports.deleteAllScenes = exports.createSceneItemsEXPERIMENTAL = exports.createSceneAndSceneItemsEXPERIMENTAL = exports.createSceneItems = exports.createSceneAndSceneItems = void 0;
 const p_limit_1 = __importDefault(require("p-limit"));
+const process_1 = require("process");
 const index_1 = require("../../index");
 const index_2 = require("../index");
 const utils_1 = require("../utils");
@@ -121,45 +122,93 @@ function createSceneItems({ client, createSceneItemReqs, failFast, onProgress, p
 }
 exports.createSceneItems = createSceneItems;
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
 function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast = false, onMsg = console.log, onProgress, parallelism, polling = { intervalMs: index_2.PollIntervalMs, maxAttempts: index_2.MaxAttempts }, returnQueued = false, verbose, }) {
     return __awaiter(this, void 0, void 0, function* () {
+        const startTime = process_1.hrtime.bigint();
+        if (verbose)
+            onMsg(`Creating scene...`);
         const scene = (yield client.scenes.createScene({ createSceneRequest: createSceneReq() })).data;
         const sceneId = scene.data.id;
-        const createRes = yield createSceneItemsEXPERIMENTAL({
-            client,
-            createSceneItemReqs,
-            failFast,
-            onProgress,
-            parallelism,
-            sceneId,
-        });
-        const { a: queuedOps, b: errors } = (0, index_2.partition)(createRes.queuedBatchOps, (i) => (0, index_2.isQueuedJob)(i.res));
-        const queued = returnQueued ? createRes.queuedBatchOps : [];
-        // Nothing succeeded, return early as something is likely wrong
-        if (queuedOps.length === 0 || errors.length === createRes.chunks) {
-            return { errors, queued, scene, sceneItemErrors: [] };
-        }
         if (verbose)
-            onMsg(`Polling for completed scene-item batches...`);
-        const limit = (0, p_limit_1.default)(Math.min(parallelism, 20));
-        function poll({ ops, res, }) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const r = yield (0, queued_jobs_1.pollQueuedJob)({
-                    id: res.data.id,
-                    getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
-                    allow404: true,
-                    limit,
-                    polling,
-                });
-                if ((0, queued_jobs_1.isPollError)(r.res)) {
-                    failFast ? (0, queued_jobs_1.throwOnError)(r) : errors.push({ ops, res: r.res });
-                }
-                return r;
+            onMsg(`Creating scene items...`);
+        let itemCount = 0;
+        let batchQueuedOps = [];
+        let batchErrors = [];
+        let sceneItemErrors = [];
+        for (let depth = 0; depth < createSceneItemReqs.length; depth++) {
+            const createItemReqs = createSceneItemReqs[depth];
+            itemCount += createItemReqs.length;
+            if (verbose)
+                onMsg(`Creating ${createItemReqs.length} scene items at depth ${depth}...`);
+            // Await is used intentionally to defer loop iteration
+            // until all scene items have been created at each depth.
+            // eslint-disable-next-line no-await-in-loop
+            const createRes = yield createSceneItemsEXPERIMENTAL({
+                client,
+                createSceneItemReqs: createItemReqs,
+                failFast,
+                onProgress,
+                parallelism,
+                sceneId,
             });
+            const { a: queuedOps, b: errors } = (0, index_2.partition)(createRes.queuedBatchOps, (i) => (0, index_2.isQueuedJob)(i.res));
+            batchQueuedOps = batchQueuedOps.concat(queuedOps);
+            if (errors.length) {
+                batchErrors = batchErrors.concat(errors);
+                if (verbose)
+                    onMsg(`WARNING: ${errors.length} scene item batch errors at depth ${depth}.`);
+            }
+            // Nothing succeeded, return early as something is likely wrong
+            if (queuedOps.length === 0 || errors.length === createRes.chunks) {
+                return {
+                    errors,
+                    queued: returnQueued ? createRes.queuedBatchOps : [],
+                    scene,
+                    sceneItemErrors: [],
+                };
+            }
+            const limit = (0, p_limit_1.default)(Math.min(parallelism, 20));
+            function poll({ ops, res, }) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const r = yield (0, queued_jobs_1.pollQueuedJob)({
+                        id: res.data.id,
+                        getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
+                        allow404: true,
+                        limit,
+                        polling,
+                    });
+                    if ((0, queued_jobs_1.isPollError)(r.res)) {
+                        failFast ? (0, queued_jobs_1.throwOnError)(r) : errors.push({ ops, res: r.res });
+                    }
+                    return r;
+                });
+            }
+            // eslint-disable-next-line no-await-in-loop
+            const batchRes = yield Promise.all(queuedOps.map((is) => limit(poll, is)));
+            const batchItemErrors = batchRes
+                .flatMap((b, i) => (0, queued_jobs_1.isBatch)(b.res)
+                ? b.res['vertexvis/batch:results'].map((r, j) => (0, utils_1.isApiError)(r)
+                    ? { req: queuedOps[i].ops[j].data, res: r }
+                    : undefined)
+                : [])
+                .filter(index_2.defined);
+            if (batchItemErrors.length) {
+                sceneItemErrors = sceneItemErrors.concat(batchItemErrors);
+                if (verbose)
+                    onMsg(`WARNING: ${batchItemErrors.length} scene item creation errors at depth ${depth}.`);
+            }
+        }
+        if (verbose) {
+            onMsg(`Scene item creation complete for ${itemCount} scene items with max depth of ${createSceneItemReqs.length - 1}.`);
+            if (batchErrors.length) {
+                onMsg(`  Batch errors: ${batchErrors.length}`);
+            }
+            if (sceneItemErrors.length) {
+                onMsg(`  Scene item errors: ${sceneItemErrors.length}`);
+            }
         }
-        const batchRes = yield Promise.all(queuedOps.map((is) => limit(poll, is)));
         if (verbose)
             onMsg(`Committing scene and polling until ready...`);
         yield updateScene({
@@ -169,24 +218,30 @@ function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, cre
         });
         yield pollSceneReady({ client, id: sceneId, onMsg, polling, verbose });
         if (verbose)
-            onMsg(`Fitting scene's camera to scene-items...`);
+            onMsg(`Fitting scene's camera to scene items...`);
+        const sceneResult = (yield updateScene({
+            attributes: {
+                camera: { type: index_1.CameraFitTypeEnum.FitVisibleSceneItems },
+            },
+            client,
+            sceneId,
+        })).scene;
+        if (verbose) {
+            const formatTime = (seconds) => {
+                const h = Math.floor(seconds / 3600);
+                const m = Math.floor((seconds % 3600) / 60);
+                const s = Math.round(seconds % 60);
+                return [h, m > 9 ? m : h ? '0' + m : m || '0', s > 9 ? s : '0' + s]
+                    .filter(Boolean)
+                    .join(':');
+            };
+            onMsg(`Scene creation completed in ${formatTime(Number(process_1.hrtime.bigint() - startTime) / 1000000000)}.`);
+        }
         return {
-            errors,
-            queued,
-            scene: (yield updateScene({
-                attributes: {
-                    camera: { type: index_1.CameraFitTypeEnum.FitVisibleSceneItems },
-                },
-                client,
-                sceneId,
-            })).scene,
-            sceneItemErrors: batchRes
-                .flatMap((b, i) => (0, queued_jobs_1.isBatch)(b.res)
-                ? b.res['vertexvis/batch:results'].map((r, j) => (0, utils_1.isApiError)(r)
-                    ? { req: queuedOps[i].ops[j].data, res: r }
-                    : undefined)
-                : [])
-                .filter(index_2.defined),
+            errors: batchErrors,
+            queued: batchQueuedOps,
+            scene: sceneResult,
+            sceneItemErrors,
         };
     });
 }
@@ -194,11 +249,10 @@ exports.createSceneAndSceneItemsEXPERIMENTAL = createSceneAndSceneItemsEXPERIMEN
 /**
  * Create scene items within a scene.
  */
-function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }) {
+function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const limit = (0, p_limit_1.default)(parallelism);
         const batchSize = 500;
-        let complete = 0;
         const opChunks = (0, utils_1.arrayChunked)(createSceneItemReqs.map((req) => ({
             data: req.data,
             op: index_1.BatchOperationOpEnum.Add,
@@ -222,10 +276,6 @@ function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, o
                 else
                     throw error;
             }
-            if (onProgress != null) {
-                complete += opChunk.length;
-                onProgress(complete, createSceneItemReqs.length);
-            }
             return { ops, res };
         }), opChunk)));
         return { chunks: opChunks.length, queuedBatchOps };

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

@@ -1 +1 @@
-export declare const version = "0.20.0";
+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.0';
+exports.version = '0.20.4';

package/dist/esm/api.d.ts

@@ -671,7 +671,7 @@ export interface Color3 {
  */
 export interface ColorMaterial {
     /**
-     * Opacity from 0 to 100.
+     * An opacity value from 0 to 255.
      * @type {number}
      * @memberof ColorMaterial
      */
@@ -714,7 +714,7 @@ export interface ColorMaterial {
  */
 export interface ColorMaterialNullable {
     /**
-     * Opacity from 0 to 100.
+     * An opacity value from 0 to 255.
      * @type {number}
      * @memberof ColorMaterialNullable
      */
@@ -1107,11 +1107,19 @@ export interface CreatePartRequestDataAttributes {
      */
     suppliedRevisionId?: string;
     /**
-     * Whether or not to index metadata in the part file.
+     * Whether or not to index metadata in the part file. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
      * @type {boolean}
      * @memberof CreatePartRequestDataAttributes
      */
     indexMetadata?: boolean;
+    /**
+     * Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @memberof CreatePartRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+    };
     /**
      * Name to be used for the root part.
      * @type {string}
@@ -1356,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;
+    };
 }
 /**
  *
@@ -1590,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;
 }
 /**
  *
@@ -2577,30 +2599,54 @@ export interface Matrix4Nullable {
 /**
  *
  * @export
- * @interface MetadataValue
+ * @interface MetadataFloatType
  */
-export interface MetadataValue {
+export interface MetadataFloatType {
     /**
-     * Metadata value.
+     * Type of metadata value.
      * @type {string}
-     * @memberof MetadataValue
+     * @memberof MetadataFloatType
      */
-    value?: string;
+    type: string;
+    /**
+     * A numerical floating-point value.
+     * @type {number}
+     * @memberof MetadataFloatType
+     */
+    value: number;
+}
+/**
+ *
+ * @export
+ * @interface MetadataNullType
+ */
+export interface MetadataNullType {
     /**
      * Type of metadata value.
      * @type {string}
-     * @memberof MetadataValue
+     * @memberof MetadataNullType
      */
-    type: MetadataValueTypeEnum;
+    type: string;
+}
+/**
+ *
+ * @export
+ * @interface MetadataStringType
+ */
+export interface MetadataStringType {
+    /**
+     * Type of metadata value.
+     * @type {string}
+     * @memberof MetadataStringType
+     */
+    type: string;
+    /**
+     * A string value.
+     * @type {string}
+     * @memberof MetadataStringType
+     */
+    value: string;
 }
-export declare const MetadataValueTypeEnum: {
-    readonly String: "string";
-    readonly Long: "long";
-    readonly Float: "float";
-    readonly Date: "date";
-    readonly Null: "null";
-};
-export declare type MetadataValueTypeEnum = typeof MetadataValueTypeEnum[keyof typeof MetadataValueTypeEnum];
 /**
  *
  * @export
@@ -2958,11 +3004,11 @@ export interface PartRevisionDataAttributes {
     created?: string;
     /**
      *
-     * @type {{ [key: string]: MetadataValue; }}
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
      * @memberof PartRevisionDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataValue;
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
     };
     /**
      *
@@ -3694,11 +3740,11 @@ export interface SceneItemDataAttributes {
     materialOverride?: ColorMaterial;
     /**
      *
-     * @type {{ [key: string]: MetadataValue; }}
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
      * @memberof SceneItemDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataValue;
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
     };
     /**
      *
@@ -4296,6 +4342,12 @@ export interface SceneViewStateDataAttributes {
      * @memberof SceneViewStateDataAttributes
      */
     noDefaultLights?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneViewStateDataAttributes
+     */
+    suppliedId?: string;
 }
 /**
  *
@@ -4737,15 +4789,15 @@ export interface UpdatePartRevisionRequestData {
  */
 export interface UpdatePartRevisionRequestDataAttributes {
     /**
-     * Metadata about the `part` and/or `part-revision`.
-     * @type {{ [key: string]: MetadataValue; }}
+     * Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
+     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
      * @memberof UpdatePartRevisionRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataValue;
+        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
     };
     /**
-     * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise.
+     * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
      * @type {boolean}
      * @memberof UpdatePartRevisionRequestDataAttributes
      */
@@ -4918,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;
+    };
 }
 /**
  *
@@ -8710,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.
@@ -8758,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.
@@ -8806,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.
@@ -8906,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

@@ -66,13 +66,6 @@ export const FileRelationshipDataTypeEnum = {
 export const GeometrySetRelationshipDataTypeEnum = {
     GeometrySet: 'geometry-set',
 };
-export const MetadataValueTypeEnum = {
-    String: 'string',
-    Long: 'long',
-    Float: 'float',
-    Date: 'date',
-    Null: 'null',
-};
 export const PartDataRelationshipsPartRevisionsTypeEnum = {
     PartRevision: 'part-revision',
 };
@@ -4699,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)));
@@ -4731,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);
@@ -4828,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);
             });
         },
@@ -4901,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));
         },
         /**
@@ -4975,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/helpers/queued-jobs.js

@@ -68,9 +68,10 @@ export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polli
         let attempts = 1;
         let pollRes = yield poll(attempts);
         /* eslint-disable no-await-in-loop */
-        while ((allowed404(allow404, pollRes.status) ||
-            validJob(pollRes.res) ||
-            isClientError(pollRes.res)) &&
+        while (!completeJob(pollRes.res) &&
+            (allowed404(allow404, pollRes.status) ||
+                validJob(pollRes.res) ||
+                isClientError(pollRes.res)) &&
             attempts <= maxAttempts) {
             attempts += 1;
             yield delay(intervalMs);
@@ -79,7 +80,7 @@ export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polli
         /* eslint-enable no-await-in-loop */
         // At this point, the result is one of the following,
         //  - An item of type `T` after being redirected to it
-        //  - A QueuedJob (after either exceeding `maxAttempts` or with `error` status)
+        //  - A QueuedJob (after either exceeding `maxAttempts` or with `complete` or `error` status)
         //  - A Failure
         return Object.assign(Object.assign({}, pollRes), { attempts, id });
     });
@@ -105,10 +106,16 @@ function allowed404(allow404, status) {
 function validJob(r) {
     return isQueuedJob(r) && !isStatusError(r);
 }
+function completeJob(r) {
+    return isQueuedJob(r) && isStatusComplete(r);
+}
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 function isQueuedJobError(obj) {
     return isQueuedJob(obj) && isStatusError(obj);
 }
+function isStatusComplete(job) {
+    return job.data.attributes.status === 'complete';
+}
 function isStatusError(job) {
     return job.data.attributes.status === 'error';
 }

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

@@ -17,6 +17,22 @@ export interface CreateSceneAndSceneItemsReq extends BaseReq {
     /** Whether or not to return queued scene items. */
     readonly returnQueued?: boolean;
 }
+export interface CreateSceneAndSceneItemsReqEXPERIMENTAL extends BaseReq {
+    /** A list of {@link CreateSceneItemRequest}. */
+    readonly createSceneItemReqs: Array<Array<CreateSceneItemRequest>>;
+    /** Function returning a {@link CreateSceneRequest}. */
+    readonly createSceneReq: () => CreateSceneRequest;
+    /** Whether or not to fail if any scene item fails initial validation. */
+    readonly failFast?: boolean;
+    /** How many requests to run in parallel. */
+    readonly parallelism: number;
+    /** {@link Polling} */
+    readonly polling?: Polling;
+    /** Callback with total number of requests and number complete. */
+    onProgress?: (complete: number, total: number) => void;
+    /** Whether or not to return queued scene items. */
+    readonly returnQueued?: boolean;
+}
 export interface CreateSceneAndSceneItemsRes {
     readonly errors: QueuedSceneItem[];
     readonly scene: Scene;
@@ -90,13 +106,13 @@ export declare function createSceneAndSceneItems({ client, createSceneItemReqs,
  */
 export declare function createSceneItems({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsRes>;
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
-export declare function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast, onMsg, onProgress, parallelism, polling, returnQueued, verbose, }: CreateSceneAndSceneItemsReq): Promise<CreateSceneAndSceneItemsResEXPERIMENTAL>;
+export declare function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast, onMsg, onProgress, parallelism, polling, returnQueued, verbose, }: CreateSceneAndSceneItemsReqEXPERIMENTAL): Promise<CreateSceneAndSceneItemsResEXPERIMENTAL>;
 /**
  * Create scene items within a scene.
  */
-export declare function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsResEXPERIMENTAL>;
+export declare function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsResEXPERIMENTAL>;
 /**
  * Delete all scenes.
  *

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

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import pLimit from 'p-limit';
+import { hrtime } from 'process';
 import { BatchOperationOpEnum, BatchOperationRefTypeEnum, CameraFitTypeEnum, SceneRelationshipDataTypeEnum, UpdateSceneRequestDataAttributesStateEnum, } from '../../index';
 import { defined, getPage, hasVertexError, isQueuedJob, MaxAttempts, partition, PollIntervalMs, tryStream, } from '../index';
 import { arrayChunked, delay, isApiError, toAccept } from '../utils';
@@ -113,45 +114,93 @@ export function createSceneItems({ client, createSceneItemReqs, failFast, onProg
     });
 }
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
 export function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast = false, onMsg = console.log, onProgress, parallelism, polling = { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts }, returnQueued = false, verbose, }) {
     return __awaiter(this, void 0, void 0, function* () {
+        const startTime = hrtime.bigint();
+        if (verbose)
+            onMsg(`Creating scene...`);
         const scene = (yield client.scenes.createScene({ createSceneRequest: createSceneReq() })).data;
         const sceneId = scene.data.id;
-        const createRes = yield createSceneItemsEXPERIMENTAL({
-            client,
-            createSceneItemReqs,
-            failFast,
-            onProgress,
-            parallelism,
-            sceneId,
-        });
-        const { a: queuedOps, b: errors } = partition(createRes.queuedBatchOps, (i) => isQueuedJob(i.res));
-        const queued = returnQueued ? createRes.queuedBatchOps : [];
-        // Nothing succeeded, return early as something is likely wrong
-        if (queuedOps.length === 0 || errors.length === createRes.chunks) {
-            return { errors, queued, scene, sceneItemErrors: [] };
-        }
         if (verbose)
-            onMsg(`Polling for completed scene-item batches...`);
-        const limit = pLimit(Math.min(parallelism, 20));
-        function poll({ ops, res, }) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const r = yield pollQueuedJob({
-                    id: res.data.id,
-                    getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
-                    allow404: true,
-                    limit,
-                    polling,
-                });
-                if (isPollError(r.res)) {
-                    failFast ? throwOnError(r) : errors.push({ ops, res: r.res });
-                }
-                return r;
+            onMsg(`Creating scene items...`);
+        let itemCount = 0;
+        let batchQueuedOps = [];
+        let batchErrors = [];
+        let sceneItemErrors = [];
+        for (let depth = 0; depth < createSceneItemReqs.length; depth++) {
+            const createItemReqs = createSceneItemReqs[depth];
+            itemCount += createItemReqs.length;
+            if (verbose)
+                onMsg(`Creating ${createItemReqs.length} scene items at depth ${depth}...`);
+            // Await is used intentionally to defer loop iteration
+            // until all scene items have been created at each depth.
+            // eslint-disable-next-line no-await-in-loop
+            const createRes = yield createSceneItemsEXPERIMENTAL({
+                client,
+                createSceneItemReqs: createItemReqs,
+                failFast,
+                onProgress,
+                parallelism,
+                sceneId,
             });
+            const { a: queuedOps, b: errors } = partition(createRes.queuedBatchOps, (i) => isQueuedJob(i.res));
+            batchQueuedOps = batchQueuedOps.concat(queuedOps);
+            if (errors.length) {
+                batchErrors = batchErrors.concat(errors);
+                if (verbose)
+                    onMsg(`WARNING: ${errors.length} scene item batch errors at depth ${depth}.`);
+            }
+            // Nothing succeeded, return early as something is likely wrong
+            if (queuedOps.length === 0 || errors.length === createRes.chunks) {
+                return {
+                    errors,
+                    queued: returnQueued ? createRes.queuedBatchOps : [],
+                    scene,
+                    sceneItemErrors: [],
+                };
+            }
+            const limit = pLimit(Math.min(parallelism, 20));
+            function poll({ ops, res, }) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const r = yield pollQueuedJob({
+                        id: res.data.id,
+                        getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
+                        allow404: true,
+                        limit,
+                        polling,
+                    });
+                    if (isPollError(r.res)) {
+                        failFast ? throwOnError(r) : errors.push({ ops, res: r.res });
+                    }
+                    return r;
+                });
+            }
+            // eslint-disable-next-line no-await-in-loop
+            const batchRes = yield Promise.all(queuedOps.map((is) => limit(poll, is)));
+            const batchItemErrors = batchRes
+                .flatMap((b, i) => isBatch(b.res)
+                ? b.res['vertexvis/batch:results'].map((r, j) => isApiError(r)
+                    ? { req: queuedOps[i].ops[j].data, res: r }
+                    : undefined)
+                : [])
+                .filter(defined);
+            if (batchItemErrors.length) {
+                sceneItemErrors = sceneItemErrors.concat(batchItemErrors);
+                if (verbose)
+                    onMsg(`WARNING: ${batchItemErrors.length} scene item creation errors at depth ${depth}.`);
+            }
+        }
+        if (verbose) {
+            onMsg(`Scene item creation complete for ${itemCount} scene items with max depth of ${createSceneItemReqs.length - 1}.`);
+            if (batchErrors.length) {
+                onMsg(`  Batch errors: ${batchErrors.length}`);
+            }
+            if (sceneItemErrors.length) {
+                onMsg(`  Scene item errors: ${sceneItemErrors.length}`);
+            }
         }
-        const batchRes = yield Promise.all(queuedOps.map((is) => limit(poll, is)));
         if (verbose)
             onMsg(`Committing scene and polling until ready...`);
         yield updateScene({
@@ -161,35 +210,40 @@ export function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemRe
         });
         yield pollSceneReady({ client, id: sceneId, onMsg, polling, verbose });
         if (verbose)
-            onMsg(`Fitting scene's camera to scene-items...`);
+            onMsg(`Fitting scene's camera to scene items...`);
+        const sceneResult = (yield updateScene({
+            attributes: {
+                camera: { type: CameraFitTypeEnum.FitVisibleSceneItems },
+            },
+            client,
+            sceneId,
+        })).scene;
+        if (verbose) {
+            const formatTime = (seconds) => {
+                const h = Math.floor(seconds / 3600);
+                const m = Math.floor((seconds % 3600) / 60);
+                const s = Math.round(seconds % 60);
+                return [h, m > 9 ? m : h ? '0' + m : m || '0', s > 9 ? s : '0' + s]
+                    .filter(Boolean)
+                    .join(':');
+            };
+            onMsg(`Scene creation completed in ${formatTime(Number(hrtime.bigint() - startTime) / 1000000000)}.`);
+        }
         return {
-            errors,
-            queued,
-            scene: (yield updateScene({
-                attributes: {
-                    camera: { type: CameraFitTypeEnum.FitVisibleSceneItems },
-                },
-                client,
-                sceneId,
-            })).scene,
-            sceneItemErrors: batchRes
-                .flatMap((b, i) => isBatch(b.res)
-                ? b.res['vertexvis/batch:results'].map((r, j) => isApiError(r)
-                    ? { req: queuedOps[i].ops[j].data, res: r }
-                    : undefined)
-                : [])
-                .filter(defined),
+            errors: batchErrors,
+            queued: batchQueuedOps,
+            scene: sceneResult,
+            sceneItemErrors,
         };
     });
 }
 /**
  * Create scene items within a scene.
  */
-export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }) {
+export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const limit = pLimit(parallelism);
         const batchSize = 500;
-        let complete = 0;
         const opChunks = arrayChunked(createSceneItemReqs.map((req) => ({
             data: req.data,
             op: BatchOperationOpEnum.Add,
@@ -213,10 +267,6 @@ export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, fail
                 else
                     throw error;
             }
-            if (onProgress != null) {
-                complete += opChunk.length;
-                onProgress(complete, createSceneItemReqs.length);
-            }
             return { ops, res };
         }), opChunk)));
         return { chunks: opChunks.length, queuedBatchOps };

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

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

package/dist/esm/client/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.20.0",
+  "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)",