@vertexvis/api-client-node 0.20.6 → 0.20.8

package/README.md

@@ -62,6 +62,13 @@ yarn build
 
 # Format code
 yarn format
+```
+
+## Publishing
+
+```bash
+# Generate latest
+yarn generate
 
 # Generate using latest OpenAPI spec, version, and open GitHub PR
 yarn push:version [patch|minor|major (default: patch)]

package/dist/cjs/api.d.ts

@@ -1126,6 +1126,12 @@ export interface CreatePartRequestDataAttributes {
      * @memberof CreatePartRequestDataAttributes
      */
     name?: string;
+    /**
+     * Optional name to be used for the part revision.
+     * @type {string}
+     * @memberof CreatePartRequestDataAttributes
+     */
+    revisionName?: string;
     /**
      * Metadata key used to extract an ID used for correlation.
      * @type {string}
@@ -1485,6 +1491,14 @@ export interface CreateSceneRequestDataAttributes {
      * @memberof CreateSceneRequestDataAttributes
      */
     worldOrientation?: Orientation;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateSceneRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 /**
  *
@@ -3113,6 +3127,12 @@ export interface PartRevisionDataAttributes {
      * @memberof PartRevisionDataAttributes
      */
     suppliedId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartRevisionDataAttributes
+     */
+    name?: string;
 }
 /**
  *
@@ -3502,6 +3522,122 @@ export interface QueuedJobList {
         [key: string]: Link;
     };
 }
+/**
+ *
+ * @export
+ * @interface QueuedTranslationJob
+ */
+export interface QueuedTranslationJob {
+    /**
+     *
+     * @type {QueuedTranslationJobData}
+     * @memberof QueuedTranslationJob
+     */
+    data: QueuedTranslationJobData;
+    /**
+     *
+     * @type {Array<GeometrySetData | PartRevisionData>}
+     * @memberof QueuedTranslationJob
+     */
+    included?: Array<GeometrySetData | PartRevisionData>;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof QueuedTranslationJob
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface QueuedTranslationJobData
+ */
+export interface QueuedTranslationJobData {
+    /**
+     *
+     * @type {string}
+     * @memberof QueuedTranslationJobData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof QueuedTranslationJobData
+     */
+    id: string;
+    /**
+     *
+     * @type {QueuedTranslationJobDataAttributes}
+     * @memberof QueuedTranslationJobData
+     */
+    attributes: QueuedTranslationJobDataAttributes;
+    /**
+     *
+     * @type {QueuedTranslationJobDataRelationships}
+     * @memberof QueuedTranslationJobData
+     */
+    relationships?: QueuedTranslationJobDataRelationships;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof QueuedTranslationJobData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface QueuedTranslationJobDataAttributes
+ */
+export interface QueuedTranslationJobDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof QueuedTranslationJobDataAttributes
+     */
+    status: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueuedTranslationJobDataAttributes
+     */
+    created: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueuedTranslationJobDataAttributes
+     */
+    completed?: string;
+    /**
+     *
+     * @type {Set<ApiError>}
+     * @memberof QueuedTranslationJobDataAttributes
+     */
+    errors?: Set<ApiError>;
+}
+/**
+ *
+ * @export
+ * @interface QueuedTranslationJobDataRelationships
+ */
+export interface QueuedTranslationJobDataRelationships {
+    /**
+     *
+     * @type {GeometrySetRelationship}
+     * @memberof QueuedTranslationJobDataRelationships
+     */
+    geometrySet?: GeometrySetRelationship;
+    /**
+     *
+     * @type {PartRevisionRelationship}
+     * @memberof QueuedTranslationJobDataRelationships
+     */
+    partRevision?: PartRevisionRelationship;
+}
 /**
  *
  * @export
@@ -3787,6 +3923,14 @@ export interface SceneDataAttributes {
      * @memberof SceneDataAttributes
      */
     sceneItemCount?: number;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof SceneDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 /**
  *
@@ -5206,6 +5350,14 @@ export interface UpdateSceneRequestDataAttributes {
      * @memberof UpdateSceneRequestDataAttributes
      */
     worldOrientation?: Orientation;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof UpdateSceneRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 export declare const UpdateSceneRequestDataAttributesStateEnum: {
     readonly Draft: "draft";
@@ -8526,7 +8678,7 @@ export declare const SceneItemsApiAxiosParamCreator: (configuration?: Configurat
     /**
      * Get a `scene-item` by ID.
      * @param {string} id The &#x60;scene-item&#x60; ID.
-     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -8589,7 +8741,7 @@ export declare const SceneItemsApiFp: (configuration?: Configuration | undefined
     /**
      * Get a `scene-item` by ID.
      * @param {string} id The &#x60;scene-item&#x60; ID.
-     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -8652,7 +8804,7 @@ export declare const SceneItemsApiFactory: (configuration?: Configuration | unde
     /**
      * Get a `scene-item` by ID.
      * @param {string} id The &#x60;scene-item&#x60; ID.
-     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -8749,7 +8901,7 @@ export interface SceneItemsApiGetSceneItemRequest {
      */
     readonly id: string;
     /**
-     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @type {string}
      * @memberof SceneItemsApiGetSceneItem
      */
@@ -9229,7 +9381,7 @@ export declare const SceneViewsApiAxiosParamCreator: (configuration?: Configurat
      * Get a `scene-item` within a view by ID.
      * @param {string} id The &#x60;scene-view&#x60; ID.
      * @param {string} itemId The &#x60;scene-item&#x60; ID.
-     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {string} [include] Comma-separated list of relationships to include in response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9293,7 +9445,7 @@ export declare const SceneViewsApiFp: (configuration?: Configuration | undefined
      * Get a `scene-item` within a view by ID.
      * @param {string} id The &#x60;scene-view&#x60; ID.
      * @param {string} itemId The &#x60;scene-item&#x60; ID.
-     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {string} [include] Comma-separated list of relationships to include in response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9357,7 +9509,7 @@ export declare const SceneViewsApiFactory: (configuration?: Configuration | unde
      * Get a `scene-item` within a view by ID.
      * @param {string} id The &#x60;scene-view&#x60; ID.
      * @param {string} itemId The &#x60;scene-item&#x60; ID.
-     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {string} [include] Comma-separated list of relationships to include in response.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9470,7 +9622,7 @@ export interface SceneViewsApiGetViewSceneItemRequest {
      */
     readonly itemId: string;
     /**
-     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @type {string}
      * @memberof SceneViewsApiGetViewSceneItem
      */
@@ -9619,7 +9771,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
     /**
      * Get a `scene` by ID.
      * @param {string} id The &#x60;scene&#x60; ID.
-     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
+     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -9630,10 +9782,11 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [filterName] Comma-separated list of names to filter on.
      * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
      * @param {string} id The &#x60;scene&#x60; ID.
@@ -9681,7 +9834,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
     /**
      * Get a `scene` by ID.
      * @param {string} id The &#x60;scene&#x60; ID.
-     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
+     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -9692,10 +9845,11 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [filterName] Comma-separated list of names to filter on.
      * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
+    getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
     /**
      * Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
      * @param {string} id The &#x60;scene&#x60; ID.
@@ -9743,7 +9897,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
     /**
      * Get a `scene` by ID.
      * @param {string} id The &#x60;scene&#x60; ID.
-     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
+     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -9754,10 +9908,11 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
      * @param {number} [pageSize] The number of items to return.
      * @param {string} [filterName] Comma-separated list of names to filter on.
      * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneList>;
+    getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: any): AxiosPromise<SceneList>;
     /**
      * Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
      * @param {string} id The &#x60;scene&#x60; ID.
@@ -9828,7 +9983,7 @@ export interface ScenesApiGetSceneRequest {
      */
     readonly id: string;
     /**
-     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
+     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
      * @type {string}
      * @memberof ScenesApiGetScene
      */
@@ -9864,6 +10019,12 @@ export interface ScenesApiGetScenesRequest {
      * @memberof ScenesApiGetScenes
      */
     readonly filterSuppliedId?: string;
+    /**
+     * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
+     * @type {string}
+     * @memberof ScenesApiGetScenes
+     */
+    readonly fieldsScene?: string;
 }
 /**
  * Request parameters for renderScene operation in ScenesApi.
@@ -10178,6 +10339,13 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
      * @throws {RequiredError}
      */
     getQueuedTranslation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+     * @param {string} id The &#x60;queued-translation&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get `queued-translation`s.
      * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10214,6 +10382,13 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getQueuedTranslation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
+    /**
+     * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+     * @param {string} id The &#x60;queued-translation&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedTranslationJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedTranslationJob>>;
     /**
      * Get `queued-translation`s.
      * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10250,6 +10425,13 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
      * @throws {RequiredError}
      */
     getQueuedTranslation(id: string, options?: any): AxiosPromise<QueuedJob>;
+    /**
+     * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+     * @param {string} id The &#x60;queued-translation&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
     /**
      * Get `queued-translation`s.
      * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10299,6 +10481,19 @@ export interface TranslationInspectionsApiGetQueuedTranslationRequest {
      */
     readonly id: string;
 }
+/**
+ * Request parameters for getQueuedTranslationJob operation in TranslationInspectionsApi.
+ * @export
+ * @interface TranslationInspectionsApiGetQueuedTranslationJobRequest
+ */
+export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
+    /**
+     * The &#x60;queued-translation&#x60; ID.
+     * @type {string}
+     * @memberof TranslationInspectionsApiGetQueuedTranslationJob
+     */
+    readonly id: string;
+}
 /**
  * Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
  * @export
@@ -10355,6 +10550,14 @@ export declare class TranslationInspectionsApi extends BaseAPI {
      * @memberof TranslationInspectionsApi
      */
     getQueuedTranslation(requestParameters: TranslationInspectionsApiGetQueuedTranslationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
+    /**
+     * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
+     * @param {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TranslationInspectionsApi
+     */
+    getQueuedTranslationJob(requestParameters: TranslationInspectionsApiGetQueuedTranslationJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedTranslationJob, any>>;
     /**
      * Get `queued-translation`s.
      * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.