@vertexvis/api-client-node 0.17.3 → 0.20.3

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
      */
@@ -1086,7 +1086,7 @@ export interface CreatePartRequestData {
      * @type {CreateGeometrySetRequestDataRelationships}
      * @memberof CreatePartRequestData
      */
-    relationships: CreateGeometrySetRequestDataRelationships;
+    relationships?: CreateGeometrySetRequestDataRelationships;
 }
 /**
  *
@@ -1101,17 +1101,25 @@ export interface CreatePartRequestDataAttributes {
      */
     suppliedId?: string;
     /**
-     * ID provided for correlation. For example, an existing ID from a PLM system.
+     * ID provided for correlation. For example, an existing ID from a PLM system. Sending a new suppliedRevisionId combined with an existing suppliedId will create a new part revision for an existing part.
      * @type {string}
      * @memberof 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}
@@ -2577,30 +2585,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
+     */
+    type: string;
+    /**
+     * A numerical floating-point value.
+     * @type {number}
+     * @memberof MetadataFloatType
      */
-    value?: string;
+    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 +2990,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 +3726,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;
     };
     /**
      *
@@ -4290,6 +4322,12 @@ export interface SceneViewStateDataAttributes {
      * @memberof SceneViewStateDataAttributes
      */
     featureLines?: FeatureLines;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SceneViewStateDataAttributes
+     */
+    noDefaultLights?: boolean;
 }
 /**
  *
@@ -4694,7 +4732,7 @@ export interface UpdatePartRevisionRequest {
     data: UpdatePartRevisionRequestData;
 }
 /**
- *
+ * Modify existing part revisions using this endpoint. When specifying a `relationship`, the generated output from that relationship will be used to replace any relationship that is present on the revision prior to the update. For example, sending a file relationship that has geometry will replace the existing geometry on the revision with the new geometry in the given file.
  * @export
  * @interface UpdatePartRevisionRequestData
  */
@@ -4717,6 +4755,12 @@ export interface UpdatePartRevisionRequestData {
      * @memberof UpdatePartRevisionRequestData
      */
     attributes: UpdatePartRevisionRequestDataAttributes;
+    /**
+     *
+     * @type {CreateGeometrySetRequestDataRelationships}
+     * @memberof UpdatePartRevisionRequestData
+     */
+    relationships?: CreateGeometrySetRequestDataRelationships;
 }
 /**
  *
@@ -4725,13 +4769,43 @@ 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. 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
+     */
+    indexMetadata?: boolean;
+    /**
+     * Name to be used for the root part. This will be used when given a file relationship - not used otherwise.
+     * @type {string}
+     * @memberof UpdatePartRevisionRequestDataAttributes
+     */
+    name?: string;
+    /**
+     * Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
+     * @type {string}
+     * @memberof UpdatePartRevisionRequestDataAttributes
+     */
+    suppliedIdKey?: string;
+    /**
+     * Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
+     * @type {string}
+     * @memberof UpdatePartRevisionRequestDataAttributes
+     */
+    suppliedRevisionIdKey?: string;
+    /**
+     * Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
+     * @type {string}
+     * @memberof UpdatePartRevisionRequestDataAttributes
+     */
+    suppliedInstanceIdKey?: string;
 }
 /**
  *
@@ -7171,7 +7245,7 @@ export declare const PartRevisionsApiAxiosParamCreator: (configuration?: Configu
      */
     renderPartRevision: (id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Update a `part-revision`. Note that metadata updates are eventually consistent.
+     * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
      * @param {string} id The &#x60;part-revision&#x60; ID.
      * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
      * @param {*} [options] Override http request option.
@@ -7236,7 +7310,7 @@ export declare const PartRevisionsApiFp: (configuration?: Configuration | undefi
      */
     renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<any>>;
     /**
-     * Update a `part-revision`. Note that metadata updates are eventually consistent.
+     * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
      * @param {string} id The &#x60;part-revision&#x60; ID.
      * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
      * @param {*} [options] Override http request option.
@@ -7301,7 +7375,7 @@ export declare const PartRevisionsApiFactory: (configuration?: Configuration | u
      */
     renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: any): AxiosPromise<any>;
     /**
-     * Update a `part-revision`. Note that metadata updates are eventually consistent.
+     * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
      * @param {string} id The &#x60;part-revision&#x60; ID.
      * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
      * @param {*} [options] Override http request option.
@@ -7537,7 +7611,7 @@ export declare class PartRevisionsApi extends BaseAPI {
      */
     renderPartRevision(requestParameters: PartRevisionsApiRenderPartRevisionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
     /**
-     * Update a `part-revision`. Note that metadata updates are eventually consistent.
+     * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
      * @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -7551,7 +7625,7 @@ export declare class PartRevisionsApi extends BaseAPI {
  */
 export declare const PartsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
     /**
-     * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+     * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
      * @param {CreatePartRequest} createPartRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -7595,12 +7669,12 @@ export declare const PartsApiAxiosParamCreator: (configuration?: Configuration |
  */
 export declare const PartsApiFp: (configuration?: Configuration | undefined) => {
     /**
-     * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+     * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
      * @param {CreatePartRequest} createPartRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPart(createPartRequest: CreatePartRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
+    createPart(createPartRequest: CreatePartRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Part>>;
     /**
      * Delete a `part`.
      * @param {string} id The &#x60;part&#x60; ID.
@@ -7639,12 +7713,12 @@ export declare const PartsApiFp: (configuration?: Configuration | undefined) =>
  */
 export declare const PartsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
     /**
-     * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+     * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
      * @param {CreatePartRequest} createPartRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPart(createPartRequest: CreatePartRequest, options?: any): AxiosPromise<QueuedJob>;
+    createPart(createPartRequest: CreatePartRequest, options?: any): AxiosPromise<Part>;
     /**
      * Delete a `part`.
      * @param {string} id The &#x60;part&#x60; ID.
@@ -7768,13 +7842,13 @@ export interface PartsApiGetQueuedPartDeletionRequest {
  */
 export declare class PartsApi extends BaseAPI {
     /**
-     * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+     * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
      * @param {PartsApiCreatePartRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PartsApi
      */
-    createPart(requestParameters: PartsApiCreatePartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
+    createPart(requestParameters: PartsApiCreatePartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Part, any>>;
     /**
      * Delete a `part`.
      * @param {PartsApiDeletePartRequest} requestParameters Request parameters.
@@ -8034,10 +8108,12 @@ export declare const SceneItemOverridesApiAxiosParamCreator: (configuration?: Co
     /**
      * Get `scene-item-overrides` for a `scene-view`.
      * @param {string} id The &#x60;scene-view&#x60; ID.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneItemOverrides: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getSceneItemOverrides: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update a `scene-item-override`.
      * @param {string} id The &#x60;scene-item-override&#x60; ID.
@@ -8070,10 +8146,12 @@ export declare const SceneItemOverridesApiFp: (configuration?: Configuration | u
     /**
      * Get `scene-item-overrides` for a `scene-view`.
      * @param {string} id The &#x60;scene-view&#x60; ID.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneItemOverrides(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneItemOverrideList>>;
+    getSceneItemOverrides(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneItemOverrideList>>;
     /**
      * Update a `scene-item-override`.
      * @param {string} id The &#x60;scene-item-override&#x60; ID.
@@ -8106,10 +8184,12 @@ export declare const SceneItemOverridesApiFactory: (configuration?: Configuratio
     /**
      * Get `scene-item-overrides` for a `scene-view`.
      * @param {string} id The &#x60;scene-view&#x60; ID.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSceneItemOverrides(id: string, options?: any): AxiosPromise<SceneItemOverrideList>;
+    getSceneItemOverrides(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<SceneItemOverrideList>;
     /**
      * Update a `scene-item-override`.
      * @param {string} id The &#x60;scene-item-override&#x60; ID.
@@ -8163,6 +8243,18 @@ export interface SceneItemOverridesApiGetSceneItemOverridesRequest {
      * @memberof SceneItemOverridesApiGetSceneItemOverrides
      */
     readonly id: string;
+    /**
+     * The cursor for the next page of items.
+     * @type {string}
+     * @memberof SceneItemOverridesApiGetSceneItemOverrides
+     */
+    readonly pageCursor?: string;
+    /**
+     * The number of items to return.
+     * @type {number}
+     * @memberof SceneItemOverridesApiGetSceneItemOverrides
+     */
+    readonly pageSize?: number;
 }
 /**
  * Request parameters for updateSceneItemOverride operation in SceneItemOverridesApi.

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',
 };
@@ -2740,7 +2733,7 @@ export const PartRevisionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Update a `part-revision`. Note that metadata updates are eventually consistent.
+         * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
          * @param {string} id The `part-revision` ID.
          * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
          * @param {*} [options] Override http request option.
@@ -2860,7 +2853,7 @@ export const PartRevisionsApiFp = function (configuration) {
             });
         },
         /**
-         * Update a `part-revision`. Note that metadata updates are eventually consistent.
+         * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
          * @param {string} id The `part-revision` ID.
          * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
          * @param {*} [options] Override http request option.
@@ -2953,7 +2946,7 @@ export const PartRevisionsApiFactory = function (configuration, basePath, axios)
                 .then((request) => request(axios, basePath));
         },
         /**
-         * Update a `part-revision`. Note that metadata updates are eventually consistent.
+         * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
          * @param {string} id The `part-revision` ID.
          * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
          * @param {*} [options] Override http request option.
@@ -3034,7 +3027,7 @@ export class PartRevisionsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Update a `part-revision`. Note that metadata updates are eventually consistent.
+     * Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.   For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes.   To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
      * @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3053,7 +3046,7 @@ export class PartRevisionsApi extends BaseAPI {
 export const PartsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+         * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
          * @param {CreatePartRequest} createPartRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3227,7 +3220,7 @@ export const PartsApiFp = function (configuration) {
     const localVarAxiosParamCreator = PartsApiAxiosParamCreator(configuration);
     return {
         /**
-         * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+         * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
          * @param {CreatePartRequest} createPartRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3299,7 +3292,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = PartsApiFp(configuration);
     return {
         /**
-         * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+         * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
          * @param {CreatePartRequest} createPartRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3366,7 +3359,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
  */
 export class PartsApi extends BaseAPI {
     /**
-     * Create a `part`. This API is asynchronous, returning the location of a `queued-translation`. Check the status via the getQueuedTranslation API. For details, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
+     * Create a `part`.  This endpoint includes multiple successful response codes: [`201`, `202`].  When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`  status code of the part.  When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry.  A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part.  See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
      * @param {PartsApiCreatePartRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3801,10 +3794,12 @@ export const SceneItemOverridesApiAxiosParamCreator = function (configuration) {
         /**
          * Get `scene-item-overrides` for a `scene-view`.
          * @param {string} id The `scene-view` ID.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneItemOverrides: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getSceneItemOverrides: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('getSceneItemOverrides', 'id', id);
             const localVarPath = `/scene-views/{id}/scene-item-overrides`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -3820,6 +3815,12 @@ export const SceneItemOverridesApiAxiosParamCreator = function (configuration) {
             // authentication OAuth2 required
             // oauth required
             yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            if (pageCursor !== undefined) {
+                localVarQueryParameter['page[cursor]'] = pageCursor;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page[size]'] = pageSize;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -3900,12 +3901,14 @@ export const SceneItemOverridesApiFp = function (configuration) {
         /**
          * Get `scene-item-overrides` for a `scene-view`.
          * @param {string} id The `scene-view` ID.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneItemOverrides(id, options) {
+        getSceneItemOverrides(id, pageCursor, pageSize, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneItemOverrides(id, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneItemOverrides(id, pageCursor, pageSize, options);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -3957,12 +3960,14 @@ export const SceneItemOverridesApiFactory = function (configuration, basePath, a
         /**
          * Get `scene-item-overrides` for a `scene-view`.
          * @param {string} id The `scene-view` ID.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSceneItemOverrides(id, options) {
+        getSceneItemOverrides(id, pageCursor, pageSize, options) {
             return localVarFp
-                .getSceneItemOverrides(id, options)
+                .getSceneItemOverrides(id, pageCursor, pageSize, options)
                 .then((request) => request(axios, basePath));
         },
         /**
@@ -4019,7 +4024,7 @@ export class SceneItemOverridesApi extends BaseAPI {
      */
     getSceneItemOverrides(requestParameters, options) {
         return SceneItemOverridesApiFp(this.configuration)
-            .getSceneItemOverrides(requestParameters.id, options)
+            .getSceneItemOverrides(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
             .then((request) => request(this.axios, this.basePath));
     }
     /**

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { AxiosResponse } from 'axios';
-import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, PartData, PartRevisionData, QueuedJob } from '../../index';
+import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, Part, PartData, PartRevisionData, QueuedJob } from '../../index';
 import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
 /** Create parts from file arguments. */
 export interface CreatePartFromFileReq extends BaseReq {
@@ -24,7 +24,7 @@ export interface CreatePartFromFileRes {
 }
 export interface QueuedTranslation {
     readonly req: CreatePartRequest | CreateGeometrySetRequest;
-    readonly res?: Failure | QueuedJob;
+    readonly res?: Failure | QueuedJob | Part;
 }
 /** Get part revision by supplied ID arguments. */
 export interface GetPartRevisionBySuppliedIdReq extends BaseReq {

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';
 }