@vertexvis/api-client-node 0.26.0 → 0.30.2

package/dist/esm/api.js

@@ -60,6 +60,17 @@ export const ClearTransformOpTypeEnum = {
 export const CreateFileCollectionRequestDataTypeEnum = {
     FileCollection: 'file-collection',
 };
+export const CreateFileJobRequestDataTypeEnum = {
+    FileJob: 'file-job',
+};
+export const CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
+    AsSpecified: 'as-specified',
+    LatestIteration: 'latest-iteration',
+    LatestRevision: 'latest-revision',
+};
+export const CreateSearchSessionRequestDataTypeEnum = {
+    SearchSession: 'search-session',
+};
 export const DeselectOperationTypeEnum = {
     Deselect: 'deselect',
 };
@@ -72,6 +83,9 @@ export const ExportStateRelationshipDataTypeEnum = {
 export const FileCollectionMetadataDataTypeEnum = {
     FileCollection: 'file-collection',
 };
+export const FileJobArchiveOperationTypeEnum = {
+    FileArchiveOperation: 'file-archive-operation',
+};
 export const FileRelationshipDataTypeEnum = {
     File: 'file',
 };
@@ -142,6 +156,12 @@ export const SceneViewRelationshipDataTypeEnum = {
 export const SceneViewStateRelationshipDataTypeEnum = {
     SceneViewState: 'scene-view-state',
 };
+export const SelectFileByIdTypeEnum = {
+    FileById: 'file-by-id',
+};
+export const SelectFileBySuppliedIdTypeEnum = {
+    FileBySuppliedId: 'file-by-supplied-id',
+};
 export const SelectOpTypeEnum = {
     Select: 'select',
 };
@@ -1639,6 +1659,41 @@ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Remove a file from a `file-collection`.
+         * @param {string} id The `file-collection` ID.
+         * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        removeFileCollectionFiles: (id, filterFileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _g;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('removeFileCollectionFiles', 'id', id);
+            const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            if (filterFileId !== undefined) {
+                localVarQueryParameter['filter[fileId]'] = filterFileId;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Update a `file-collection`.
          * @param {string} id The `file-collection` ID.
@@ -1647,7 +1702,7 @@ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
          * @throws {RequiredError}
          */
         updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            var _g;
+            var _h;
             // verify required parameter 'id' is not null or undefined
             assertParamExists('updateFileCollection', 'id', id);
             // verify required parameter 'updateFileCollectionRequest' is not null or undefined
@@ -1667,7 +1722,7 @@ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
             yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
             localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
             setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
+            let headersFromBaseOptions = (_h = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _h !== void 0 ? _h : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             localVarRequestOptions.data = serializeDataIfNeeded(updateFileCollectionRequest, localVarRequestOptions, configuration);
             return {
@@ -1761,6 +1816,19 @@ export const FileCollectionsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Remove a file from a `file-collection`.
+         * @param {string} id The `file-collection` ID.
+         * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        removeFileCollectionFiles(id, filterFileId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.removeFileCollectionFiles(id, filterFileId, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Update a `file-collection`.
          * @param {string} id The `file-collection` ID.
@@ -1854,6 +1922,18 @@ export const FileCollectionsApiFactory = function (configuration, basePath, axio
                 .listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Remove a file from a `file-collection`.
+         * @param {string} id The `file-collection` ID.
+         * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        removeFileCollectionFiles(id, filterFileId, options) {
+            return localVarFp
+                .removeFileCollectionFiles(id, filterFileId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Update a `file-collection`.
          * @param {string} id The `file-collection` ID.
@@ -1947,6 +2027,18 @@ export class FileCollectionsApi extends BaseAPI {
             .listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Remove a file from a `file-collection`.
+     * @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    removeFileCollectionFiles(requestParameters, options) {
+        return FileCollectionsApiFp(this.configuration)
+            .removeFileCollectionFiles(requestParameters.id, requestParameters.filterFileId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Update a `file-collection`.
      * @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
@@ -1960,6 +2052,174 @@ export class FileCollectionsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * FileJobsApi - axios parameter creator
+ * @export
+ */
+export const FileJobsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Create a `file-job`.
+         * @param {CreateFileJobRequest} createFileJobRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createFileJob: (createFileJobRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // verify required parameter 'createFileJobRequest' is not null or undefined
+            assertParamExists('createFileJob', 'createFileJobRequest', createFileJobRequest);
+            const localVarPath = `/file-jobs`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createFileJobRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get the status and result of a `file-job`.
+         * @param {string} id The ID of a file job.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFileJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getFileJob', 'id', id);
+            const localVarPath = `/file-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * FileJobsApi - functional programming interface
+ * @export
+ */
+export const FileJobsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = FileJobsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Create a `file-job`.
+         * @param {CreateFileJobRequest} createFileJobRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createFileJob(createFileJobRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileJob(createFileJobRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Get the status and result of a `file-job`.
+         * @param {string} id The ID of a file job.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFileJob(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileJob(id, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * FileJobsApi - factory interface
+ * @export
+ */
+export const FileJobsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = FileJobsApiFp(configuration);
+    return {
+        /**
+         * Create a `file-job`.
+         * @param {CreateFileJobRequest} createFileJobRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createFileJob(createFileJobRequest, options) {
+            return localVarFp
+                .createFileJob(createFileJobRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Get the status and result of a `file-job`.
+         * @param {string} id The ID of a file job.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFileJob(id, options) {
+            return localVarFp
+                .getFileJob(id, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * FileJobsApi - object-oriented interface
+ * @export
+ * @class FileJobsApi
+ * @extends {BaseAPI}
+ */
+export class FileJobsApi extends BaseAPI {
+    /**
+     * Create a `file-job`.
+     * @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileJobsApi
+     */
+    createFileJob(requestParameters, options) {
+        return FileJobsApiFp(this.configuration)
+            .createFileJob(requestParameters.createFileJobRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get the status and result of a `file-job`.
+     * @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileJobsApi
+     */
+    getFileJob(requestParameters, options) {
+        return FileJobsApiFp(this.configuration)
+            .getFileJob(requestParameters.id, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * FilesApi - axios parameter creator
  * @export
@@ -3561,7 +3821,7 @@ export class Oauth2Api extends BaseAPI {
 export const PartRenditionsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         *
+         * Creates a part-rendition associated with a part-revision
          * @param {string} id The `part-revision` ID.
          * @param {CreatePartRenditionRequest} createPartRenditionRequest
          * @param {*} [options] Override http request option.
@@ -3681,7 +3941,7 @@ export const PartRenditionsApiFp = function (configuration) {
     const localVarAxiosParamCreator = PartRenditionsApiAxiosParamCreator(configuration);
     return {
         /**
-         *
+         * Creates a part-rendition associated with a part-revision
          * @param {string} id The `part-revision` ID.
          * @param {CreatePartRenditionRequest} createPartRenditionRequest
          * @param {*} [options] Override http request option.
@@ -3730,7 +3990,7 @@ export const PartRenditionsApiFactory = function (configuration, basePath, axios
     const localVarFp = PartRenditionsApiFp(configuration);
     return {
         /**
-         *
+         * Creates a part-rendition associated with a part-revision
          * @param {string} id The `part-revision` ID.
          * @param {CreatePartRenditionRequest} createPartRenditionRequest
          * @param {*} [options] Override http request option.
@@ -3776,7 +4036,7 @@ export const PartRenditionsApiFactory = function (configuration, basePath, axios
  */
 export class PartRenditionsApi extends BaseAPI {
     /**
-     *
+     * Creates a part-rendition associated with a part-revision
      * @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3819,7 +4079,7 @@ export class PartRenditionsApi extends BaseAPI {
 export const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+         * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
          * @param {string} [filterParent] Parent ID to filter on.
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
@@ -3868,7 +4128,7 @@ export const PartRevisionInstancesApiFp = function (configuration) {
     const localVarAxiosParamCreator = PartRevisionInstancesApiAxiosParamCreator(configuration);
     return {
         /**
-         * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+         * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
          * @param {string} [filterParent] Parent ID to filter on.
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
@@ -3891,7 +4151,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
     const localVarFp = PartRevisionInstancesApiFp(configuration);
     return {
         /**
-         * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+         * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
          * @param {string} [filterParent] Parent ID to filter on.
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
@@ -3913,7 +4173,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
  */
 export class PartRevisionInstancesApi extends BaseAPI {
     /**
-     * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+     * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
      * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -4157,7 +4417,7 @@ export const PartRevisionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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.
+         * 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.
@@ -4278,7 +4538,7 @@ export const PartRevisionsApiFp = function (configuration) {
             });
         },
         /**
-         * 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.
+         * 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.
@@ -4371,7 +4631,7 @@ export const PartRevisionsApiFactory = function (configuration, basePath, axios)
                 .then((request) => request(axios, basePath));
         },
         /**
-         * 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.
+         * 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.
@@ -4452,7 +4712,7 @@ export class PartRevisionsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * 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.
+     * 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}
@@ -4471,7 +4731,7 @@ export class PartRevisionsApi extends BaseAPI {
 export const PartsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * 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.
+         * 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}
@@ -4650,7 +4910,7 @@ export const PartsApiFp = function (configuration) {
     const localVarAxiosParamCreator = PartsApiAxiosParamCreator(configuration);
     return {
         /**
-         * 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.
+         * 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}
@@ -4722,7 +4982,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = PartsApiFp(configuration);
     return {
         /**
-         * 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.
+         * 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}
@@ -4789,7 +5049,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
  */
 export class PartsApi extends BaseAPI {
     /**
-     * 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.
+     * 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}
@@ -4969,7 +5229,7 @@ export class PmiApi extends BaseAPI {
 export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+         * Get `property-entries` by a resource ID
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterResourceId] A resource ID to filter on
@@ -5013,7 +5273,7 @@ export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+         * Upsert property-entries for a provided resource.
          * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5055,7 +5315,7 @@ export const PropertyEntriesApiFp = function (configuration) {
     const localVarAxiosParamCreator = PropertyEntriesApiAxiosParamCreator(configuration);
     return {
         /**
-         * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+         * Get `property-entries` by a resource ID
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterResourceId] A resource ID to filter on
@@ -5070,7 +5330,7 @@ export const PropertyEntriesApiFp = function (configuration) {
             });
         },
         /**
-         * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+         * Upsert property-entries for a provided resource.
          * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5091,7 +5351,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
     const localVarFp = PropertyEntriesApiFp(configuration);
     return {
         /**
-         * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+         * Get `property-entries` by a resource ID
          * @param {string} [pageCursor] The cursor for the next page of items.
          * @param {number} [pageSize] The number of items to return.
          * @param {string} [filterResourceId] A resource ID to filter on
@@ -5105,7 +5365,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
                 .then((request) => request(axios, basePath));
         },
         /**
-         * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+         * Upsert property-entries for a provided resource.
          * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -5125,7 +5385,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
  */
 export class PropertyEntriesApi extends BaseAPI {
     /**
-     * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+     * Get `property-entries` by a resource ID
      * @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -5137,7 +5397,7 @@ export class PropertyEntriesApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+     * Upsert property-entries for a provided resource.
      * @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -8600,6 +8860,174 @@ export class ScenesApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * SearchSessionsApi - axios parameter creator
+ * @export
+ */
+export const SearchSessionsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Create a `search-session`.
+         * @param {CreateSearchSessionRequest} createSearchSessionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSearchSession: (createSearchSessionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // verify required parameter 'createSearchSessionRequest' is not null or undefined
+            assertParamExists('createSearchSession', 'createSearchSessionRequest', createSearchSessionRequest);
+            const localVarPath = `/search-sessions`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createSearchSessionRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Get a `search-session`.
+         * @param {string} id The `search-session` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSession: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getSearchSession', 'id', id);
+            const localVarPath = `/search-sessions/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * SearchSessionsApi - functional programming interface
+ * @export
+ */
+export const SearchSessionsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = SearchSessionsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Create a `search-session`.
+         * @param {CreateSearchSessionRequest} createSearchSessionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSearchSession(createSearchSessionRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createSearchSession(createSearchSessionRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Get a `search-session`.
+         * @param {string} id The `search-session` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSession(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getSearchSession(id, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * SearchSessionsApi - factory interface
+ * @export
+ */
+export const SearchSessionsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = SearchSessionsApiFp(configuration);
+    return {
+        /**
+         * Create a `search-session`.
+         * @param {CreateSearchSessionRequest} createSearchSessionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSearchSession(createSearchSessionRequest, options) {
+            return localVarFp
+                .createSearchSession(createSearchSessionRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Get a `search-session`.
+         * @param {string} id The `search-session` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSession(id, options) {
+            return localVarFp
+                .getSearchSession(id, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * SearchSessionsApi - object-oriented interface
+ * @export
+ * @class SearchSessionsApi
+ * @extends {BaseAPI}
+ */
+export class SearchSessionsApi extends BaseAPI {
+    /**
+     * Create a `search-session`.
+     * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchSessionsApi
+     */
+    createSearchSession(requestParameters, options) {
+        return SearchSessionsApiFp(this.configuration)
+            .createSearchSession(requestParameters.createSearchSessionRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get a `search-session`.
+     * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchSessionsApi
+     */
+    getSearchSession(requestParameters, options) {
+        return SearchSessionsApiFp(this.configuration)
+            .getSearchSession(requestParameters.id, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * StreamKeysApi - axios parameter creator
  * @export