@vertexvis/api-client-node 0.26.0 → 0.30.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/api.js CHANGED
@@ -25,10 +25,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
25
25
  return (mod && mod.__esModule) ? mod : { "default": mod };
26
26
  };
27
27
  Object.defineProperty(exports, "__esModule", { value: true });
28
- exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateFileCollectionRequestDataTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByMetadataDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PropertyStringTypeTypeEnum = exports.PropertySetRelationshipDataTypeEnum = exports.PropertyLongTypeTypeEnum = exports.PropertyDoubleTypeTypeEnum = exports.PropertyDateTypeTypeEnum = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartInstanceRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.FileCollectionMetadataDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.CreateFileCollectionRequestDataTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
- exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRevisionInstancesApi = exports.PartRevisionInstancesApiFactory = exports.PartRevisionInstancesApiFp = exports.PartRevisionInstancesApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = exports.PartRenditionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.ModelViewsApi = exports.ModelViewsApiFactory = exports.ModelViewsApiFp = exports.ModelViewsApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.FileCollectionsApi = exports.FileCollectionsApiFactory = exports.FileCollectionsApiFp = exports.FileCollectionsApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = void 0;
30
- exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneSynchronizationsApi = exports.SceneSynchronizationsApiFactory = exports.SceneSynchronizationsApiFp = exports.SceneSynchronizationsApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAnnotationsApi = exports.SceneAnnotationsApiFactory = exports.SceneAnnotationsApiFp = exports.SceneAnnotationsApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PropertyEntriesApi = exports.PropertyEntriesApiFactory = exports.PropertyEntriesApiFp = exports.PropertyEntriesApiAxiosParamCreator = exports.PmiApi = exports.PmiApiFactory = exports.PmiApiFp = exports.PmiApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = void 0;
31
- exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = void 0;
28
+ exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateFileCollectionRequestDataTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SelectFileBySuppliedIdTypeEnum = exports.SelectFileByIdTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByMetadataDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PropertyStringTypeTypeEnum = exports.PropertySetRelationshipDataTypeEnum = exports.PropertyLongTypeTypeEnum = exports.PropertyDoubleTypeTypeEnum = exports.PropertyDateTypeTypeEnum = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartInstanceRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.FileJobArchiveOperationTypeEnum = exports.FileCollectionMetadataDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.CreateSearchSessionRequestDataTypeEnum = exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = exports.CreateFileJobRequestDataTypeEnum = exports.CreateFileCollectionRequestDataTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
+ exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.ModelViewsApi = exports.ModelViewsApiFactory = exports.ModelViewsApiFp = exports.ModelViewsApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.FileJobsApi = exports.FileJobsApiFactory = exports.FileJobsApiFp = exports.FileJobsApiAxiosParamCreator = exports.FileCollectionsApi = exports.FileCollectionsApiFactory = exports.FileCollectionsApiFp = exports.FileCollectionsApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = void 0;
30
+ exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneSynchronizationsApi = exports.SceneSynchronizationsApiFactory = exports.SceneSynchronizationsApiFp = exports.SceneSynchronizationsApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAnnotationsApi = exports.SceneAnnotationsApiFactory = exports.SceneAnnotationsApiFp = exports.SceneAnnotationsApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PropertyEntriesApi = exports.PropertyEntriesApiFactory = exports.PropertyEntriesApiFp = exports.PropertyEntriesApiAxiosParamCreator = exports.PmiApi = exports.PmiApiFactory = exports.PmiApiFp = exports.PmiApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRevisionInstancesApi = exports.PartRevisionInstancesApiFactory = exports.PartRevisionInstancesApiFp = exports.PartRevisionInstancesApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = exports.PartRenditionsApiAxiosParamCreator = void 0;
31
+ exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.SearchSessionsApi = exports.SearchSessionsApiFactory = exports.SearchSessionsApiFp = exports.SearchSessionsApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = void 0;
32
32
  const axios_1 = __importDefault(require("axios"));
33
33
  // Some imports not used depending on template conditions
34
34
  // @ts-ignore
@@ -69,6 +69,17 @@ exports.ClearTransformOpTypeEnum = {
69
69
  exports.CreateFileCollectionRequestDataTypeEnum = {
70
70
  FileCollection: 'file-collection',
71
71
  };
72
+ exports.CreateFileJobRequestDataTypeEnum = {
73
+ FileJob: 'file-job',
74
+ };
75
+ exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
76
+ AsSpecified: 'as-specified',
77
+ LatestIteration: 'latest-iteration',
78
+ LatestRevision: 'latest-revision',
79
+ };
80
+ exports.CreateSearchSessionRequestDataTypeEnum = {
81
+ SearchSession: 'search-session',
82
+ };
72
83
  exports.DeselectOperationTypeEnum = {
73
84
  Deselect: 'deselect',
74
85
  };
@@ -81,6 +92,9 @@ exports.ExportStateRelationshipDataTypeEnum = {
81
92
  exports.FileCollectionMetadataDataTypeEnum = {
82
93
  FileCollection: 'file-collection',
83
94
  };
95
+ exports.FileJobArchiveOperationTypeEnum = {
96
+ FileArchiveOperation: 'file-archive-operation',
97
+ };
84
98
  exports.FileRelationshipDataTypeEnum = {
85
99
  File: 'file',
86
100
  };
@@ -151,6 +165,12 @@ exports.SceneViewRelationshipDataTypeEnum = {
151
165
  exports.SceneViewStateRelationshipDataTypeEnum = {
152
166
  SceneViewState: 'scene-view-state',
153
167
  };
168
+ exports.SelectFileByIdTypeEnum = {
169
+ FileById: 'file-by-id',
170
+ };
171
+ exports.SelectFileBySuppliedIdTypeEnum = {
172
+ FileBySuppliedId: 'file-by-supplied-id',
173
+ };
154
174
  exports.SelectOpTypeEnum = {
155
175
  Select: 'select',
156
176
  };
@@ -1664,6 +1684,41 @@ const FileCollectionsApiAxiosParamCreator = function (configuration) {
1664
1684
  options: localVarRequestOptions,
1665
1685
  };
1666
1686
  }),
1687
+ /**
1688
+ * Remove a file from a `file-collection`.
1689
+ * @param {string} id The `file-collection` ID.
1690
+ * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
1691
+ * @param {*} [options] Override http request option.
1692
+ * @throws {RequiredError}
1693
+ */
1694
+ removeFileCollectionFiles: (id, filterFileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1695
+ var _g;
1696
+ // verify required parameter 'id' is not null or undefined
1697
+ (0, common_1.assertParamExists)('removeFileCollectionFiles', 'id', id);
1698
+ const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1699
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1700
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1701
+ let baseOptions;
1702
+ if (configuration) {
1703
+ baseOptions = configuration.baseOptions;
1704
+ }
1705
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
1706
+ const localVarHeaderParameter = {};
1707
+ const localVarQueryParameter = {};
1708
+ // authentication OAuth2 required
1709
+ // oauth required
1710
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1711
+ if (filterFileId !== undefined) {
1712
+ localVarQueryParameter['filter[fileId]'] = filterFileId;
1713
+ }
1714
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1715
+ let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1716
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1717
+ return {
1718
+ url: (0, common_1.toPathString)(localVarUrlObj),
1719
+ options: localVarRequestOptions,
1720
+ };
1721
+ }),
1667
1722
  /**
1668
1723
  * Update a `file-collection`.
1669
1724
  * @param {string} id The `file-collection` ID.
@@ -1672,7 +1727,7 @@ const FileCollectionsApiAxiosParamCreator = function (configuration) {
1672
1727
  * @throws {RequiredError}
1673
1728
  */
1674
1729
  updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1675
- var _g;
1730
+ var _h;
1676
1731
  // verify required parameter 'id' is not null or undefined
1677
1732
  (0, common_1.assertParamExists)('updateFileCollection', 'id', id);
1678
1733
  // verify required parameter 'updateFileCollectionRequest' is not null or undefined
@@ -1692,7 +1747,7 @@ const FileCollectionsApiAxiosParamCreator = function (configuration) {
1692
1747
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1693
1748
  localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1694
1749
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1695
- let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1750
+ let headersFromBaseOptions = (_h = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _h !== void 0 ? _h : {};
1696
1751
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1697
1752
  localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFileCollectionRequest, localVarRequestOptions, configuration);
1698
1753
  return {
@@ -1787,6 +1842,19 @@ const FileCollectionsApiFp = function (configuration) {
1787
1842
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1788
1843
  });
1789
1844
  },
1845
+ /**
1846
+ * Remove a file from a `file-collection`.
1847
+ * @param {string} id The `file-collection` ID.
1848
+ * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
1849
+ * @param {*} [options] Override http request option.
1850
+ * @throws {RequiredError}
1851
+ */
1852
+ removeFileCollectionFiles(id, filterFileId, options) {
1853
+ return __awaiter(this, void 0, void 0, function* () {
1854
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.removeFileCollectionFiles(id, filterFileId, options);
1855
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1856
+ });
1857
+ },
1790
1858
  /**
1791
1859
  * Update a `file-collection`.
1792
1860
  * @param {string} id The `file-collection` ID.
@@ -1881,6 +1949,18 @@ const FileCollectionsApiFactory = function (configuration, basePath, axios) {
1881
1949
  .listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
1882
1950
  .then((request) => request(axios, basePath));
1883
1951
  },
1952
+ /**
1953
+ * Remove a file from a `file-collection`.
1954
+ * @param {string} id The `file-collection` ID.
1955
+ * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
1956
+ * @param {*} [options] Override http request option.
1957
+ * @throws {RequiredError}
1958
+ */
1959
+ removeFileCollectionFiles(id, filterFileId, options) {
1960
+ return localVarFp
1961
+ .removeFileCollectionFiles(id, filterFileId, options)
1962
+ .then((request) => request(axios, basePath));
1963
+ },
1884
1964
  /**
1885
1965
  * Update a `file-collection`.
1886
1966
  * @param {string} id The `file-collection` ID.
@@ -1975,6 +2055,18 @@ class FileCollectionsApi extends base_1.BaseAPI {
1975
2055
  .listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
1976
2056
  .then((request) => request(this.axios, this.basePath));
1977
2057
  }
2058
+ /**
2059
+ * Remove a file from a `file-collection`.
2060
+ * @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
2061
+ * @param {*} [options] Override http request option.
2062
+ * @throws {RequiredError}
2063
+ * @memberof FileCollectionsApi
2064
+ */
2065
+ removeFileCollectionFiles(requestParameters, options) {
2066
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
2067
+ .removeFileCollectionFiles(requestParameters.id, requestParameters.filterFileId, options)
2068
+ .then((request) => request(this.axios, this.basePath));
2069
+ }
1978
2070
  /**
1979
2071
  * Update a `file-collection`.
1980
2072
  * @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
@@ -1989,6 +2081,178 @@ class FileCollectionsApi extends base_1.BaseAPI {
1989
2081
  }
1990
2082
  }
1991
2083
  exports.FileCollectionsApi = FileCollectionsApi;
2084
+ /**
2085
+ * FileJobsApi - axios parameter creator
2086
+ * @export
2087
+ */
2088
+ const FileJobsApiAxiosParamCreator = function (configuration) {
2089
+ return {
2090
+ /**
2091
+ * Create a `file-job`.
2092
+ * @param {CreateFileJobRequest} createFileJobRequest
2093
+ * @param {*} [options] Override http request option.
2094
+ * @throws {RequiredError}
2095
+ */
2096
+ createFileJob: (createFileJobRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
2097
+ var _a;
2098
+ // verify required parameter 'createFileJobRequest' is not null or undefined
2099
+ (0, common_1.assertParamExists)('createFileJob', 'createFileJobRequest', createFileJobRequest);
2100
+ const localVarPath = `/file-jobs`;
2101
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2102
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2103
+ let baseOptions;
2104
+ if (configuration) {
2105
+ baseOptions = configuration.baseOptions;
2106
+ }
2107
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
2108
+ const localVarHeaderParameter = {};
2109
+ const localVarQueryParameter = {};
2110
+ // authentication OAuth2 required
2111
+ // oauth required
2112
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
2113
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
2114
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2115
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
2116
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2117
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createFileJobRequest, localVarRequestOptions, configuration);
2118
+ return {
2119
+ url: (0, common_1.toPathString)(localVarUrlObj),
2120
+ options: localVarRequestOptions,
2121
+ };
2122
+ }),
2123
+ /**
2124
+ * Get the status and result of a `file-job`.
2125
+ * @param {string} id The ID of a file job.
2126
+ * @param {*} [options] Override http request option.
2127
+ * @throws {RequiredError}
2128
+ */
2129
+ getFileJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
2130
+ var _b;
2131
+ // verify required parameter 'id' is not null or undefined
2132
+ (0, common_1.assertParamExists)('getFileJob', 'id', id);
2133
+ const localVarPath = `/file-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
2134
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2135
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2136
+ let baseOptions;
2137
+ if (configuration) {
2138
+ baseOptions = configuration.baseOptions;
2139
+ }
2140
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2141
+ const localVarHeaderParameter = {};
2142
+ const localVarQueryParameter = {};
2143
+ // authentication OAuth2 required
2144
+ // oauth required
2145
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
2146
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2147
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
2148
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2149
+ return {
2150
+ url: (0, common_1.toPathString)(localVarUrlObj),
2151
+ options: localVarRequestOptions,
2152
+ };
2153
+ }),
2154
+ };
2155
+ };
2156
+ exports.FileJobsApiAxiosParamCreator = FileJobsApiAxiosParamCreator;
2157
+ /**
2158
+ * FileJobsApi - functional programming interface
2159
+ * @export
2160
+ */
2161
+ const FileJobsApiFp = function (configuration) {
2162
+ const localVarAxiosParamCreator = (0, exports.FileJobsApiAxiosParamCreator)(configuration);
2163
+ return {
2164
+ /**
2165
+ * Create a `file-job`.
2166
+ * @param {CreateFileJobRequest} createFileJobRequest
2167
+ * @param {*} [options] Override http request option.
2168
+ * @throws {RequiredError}
2169
+ */
2170
+ createFileJob(createFileJobRequest, options) {
2171
+ return __awaiter(this, void 0, void 0, function* () {
2172
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileJob(createFileJobRequest, options);
2173
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2174
+ });
2175
+ },
2176
+ /**
2177
+ * Get the status and result of a `file-job`.
2178
+ * @param {string} id The ID of a file job.
2179
+ * @param {*} [options] Override http request option.
2180
+ * @throws {RequiredError}
2181
+ */
2182
+ getFileJob(id, options) {
2183
+ return __awaiter(this, void 0, void 0, function* () {
2184
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileJob(id, options);
2185
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2186
+ });
2187
+ },
2188
+ };
2189
+ };
2190
+ exports.FileJobsApiFp = FileJobsApiFp;
2191
+ /**
2192
+ * FileJobsApi - factory interface
2193
+ * @export
2194
+ */
2195
+ const FileJobsApiFactory = function (configuration, basePath, axios) {
2196
+ const localVarFp = (0, exports.FileJobsApiFp)(configuration);
2197
+ return {
2198
+ /**
2199
+ * Create a `file-job`.
2200
+ * @param {CreateFileJobRequest} createFileJobRequest
2201
+ * @param {*} [options] Override http request option.
2202
+ * @throws {RequiredError}
2203
+ */
2204
+ createFileJob(createFileJobRequest, options) {
2205
+ return localVarFp
2206
+ .createFileJob(createFileJobRequest, options)
2207
+ .then((request) => request(axios, basePath));
2208
+ },
2209
+ /**
2210
+ * Get the status and result of a `file-job`.
2211
+ * @param {string} id The ID of a file job.
2212
+ * @param {*} [options] Override http request option.
2213
+ * @throws {RequiredError}
2214
+ */
2215
+ getFileJob(id, options) {
2216
+ return localVarFp
2217
+ .getFileJob(id, options)
2218
+ .then((request) => request(axios, basePath));
2219
+ },
2220
+ };
2221
+ };
2222
+ exports.FileJobsApiFactory = FileJobsApiFactory;
2223
+ /**
2224
+ * FileJobsApi - object-oriented interface
2225
+ * @export
2226
+ * @class FileJobsApi
2227
+ * @extends {BaseAPI}
2228
+ */
2229
+ class FileJobsApi extends base_1.BaseAPI {
2230
+ /**
2231
+ * Create a `file-job`.
2232
+ * @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
2233
+ * @param {*} [options] Override http request option.
2234
+ * @throws {RequiredError}
2235
+ * @memberof FileJobsApi
2236
+ */
2237
+ createFileJob(requestParameters, options) {
2238
+ return (0, exports.FileJobsApiFp)(this.configuration)
2239
+ .createFileJob(requestParameters.createFileJobRequest, options)
2240
+ .then((request) => request(this.axios, this.basePath));
2241
+ }
2242
+ /**
2243
+ * Get the status and result of a `file-job`.
2244
+ * @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
2245
+ * @param {*} [options] Override http request option.
2246
+ * @throws {RequiredError}
2247
+ * @memberof FileJobsApi
2248
+ */
2249
+ getFileJob(requestParameters, options) {
2250
+ return (0, exports.FileJobsApiFp)(this.configuration)
2251
+ .getFileJob(requestParameters.id, options)
2252
+ .then((request) => request(this.axios, this.basePath));
2253
+ }
2254
+ }
2255
+ exports.FileJobsApi = FileJobsApi;
1992
2256
  /**
1993
2257
  * FilesApi - axios parameter creator
1994
2258
  * @export
@@ -3610,7 +3874,7 @@ exports.Oauth2Api = Oauth2Api;
3610
3874
  const PartRenditionsApiAxiosParamCreator = function (configuration) {
3611
3875
  return {
3612
3876
  /**
3613
- *
3877
+ * Creates a part-rendition associated with a part-revision
3614
3878
  * @param {string} id The `part-revision` ID.
3615
3879
  * @param {CreatePartRenditionRequest} createPartRenditionRequest
3616
3880
  * @param {*} [options] Override http request option.
@@ -3731,7 +3995,7 @@ const PartRenditionsApiFp = function (configuration) {
3731
3995
  const localVarAxiosParamCreator = (0, exports.PartRenditionsApiAxiosParamCreator)(configuration);
3732
3996
  return {
3733
3997
  /**
3734
- *
3998
+ * Creates a part-rendition associated with a part-revision
3735
3999
  * @param {string} id The `part-revision` ID.
3736
4000
  * @param {CreatePartRenditionRequest} createPartRenditionRequest
3737
4001
  * @param {*} [options] Override http request option.
@@ -3781,7 +4045,7 @@ const PartRenditionsApiFactory = function (configuration, basePath, axios) {
3781
4045
  const localVarFp = (0, exports.PartRenditionsApiFp)(configuration);
3782
4046
  return {
3783
4047
  /**
3784
- *
4048
+ * Creates a part-rendition associated with a part-revision
3785
4049
  * @param {string} id The `part-revision` ID.
3786
4050
  * @param {CreatePartRenditionRequest} createPartRenditionRequest
3787
4051
  * @param {*} [options] Override http request option.
@@ -3828,7 +4092,7 @@ exports.PartRenditionsApiFactory = PartRenditionsApiFactory;
3828
4092
  */
3829
4093
  class PartRenditionsApi extends base_1.BaseAPI {
3830
4094
  /**
3831
- *
4095
+ * Creates a part-rendition associated with a part-revision
3832
4096
  * @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
3833
4097
  * @param {*} [options] Override http request option.
3834
4098
  * @throws {RequiredError}
@@ -3872,7 +4136,7 @@ exports.PartRenditionsApi = PartRenditionsApi;
3872
4136
  const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
3873
4137
  return {
3874
4138
  /**
3875
- * 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.
4139
+ * 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.
3876
4140
  * @param {string} [filterParent] Parent ID to filter on.
3877
4141
  * @param {string} [pageCursor] The cursor for the next page of items.
3878
4142
  * @param {number} [pageSize] The number of items to return.
@@ -3922,7 +4186,7 @@ const PartRevisionInstancesApiFp = function (configuration) {
3922
4186
  const localVarAxiosParamCreator = (0, exports.PartRevisionInstancesApiAxiosParamCreator)(configuration);
3923
4187
  return {
3924
4188
  /**
3925
- * 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.
4189
+ * 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.
3926
4190
  * @param {string} [filterParent] Parent ID to filter on.
3927
4191
  * @param {string} [pageCursor] The cursor for the next page of items.
3928
4192
  * @param {number} [pageSize] The number of items to return.
@@ -3946,7 +4210,7 @@ const PartRevisionInstancesApiFactory = function (configuration, basePath, axios
3946
4210
  const localVarFp = (0, exports.PartRevisionInstancesApiFp)(configuration);
3947
4211
  return {
3948
4212
  /**
3949
- * 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.
4213
+ * 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.
3950
4214
  * @param {string} [filterParent] Parent ID to filter on.
3951
4215
  * @param {string} [pageCursor] The cursor for the next page of items.
3952
4216
  * @param {number} [pageSize] The number of items to return.
@@ -3969,7 +4233,7 @@ exports.PartRevisionInstancesApiFactory = PartRevisionInstancesApiFactory;
3969
4233
  */
3970
4234
  class PartRevisionInstancesApi extends base_1.BaseAPI {
3971
4235
  /**
3972
- * 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.
4236
+ * 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.
3973
4237
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
3974
4238
  * @param {*} [options] Override http request option.
3975
4239
  * @throws {RequiredError}
@@ -4214,7 +4478,7 @@ const PartRevisionsApiAxiosParamCreator = function (configuration) {
4214
4478
  };
4215
4479
  }),
4216
4480
  /**
4217
- * 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.
4481
+ * 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.
4218
4482
  * @param {string} id The `part-revision` ID.
4219
4483
  * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
4220
4484
  * @param {*} [options] Override http request option.
@@ -4336,7 +4600,7 @@ const PartRevisionsApiFp = function (configuration) {
4336
4600
  });
4337
4601
  },
4338
4602
  /**
4339
- * 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.
4603
+ * 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.
4340
4604
  * @param {string} id The `part-revision` ID.
4341
4605
  * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
4342
4606
  * @param {*} [options] Override http request option.
@@ -4430,7 +4694,7 @@ const PartRevisionsApiFactory = function (configuration, basePath, axios) {
4430
4694
  .then((request) => request(axios, basePath));
4431
4695
  },
4432
4696
  /**
4433
- * 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.
4697
+ * 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.
4434
4698
  * @param {string} id The `part-revision` ID.
4435
4699
  * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
4436
4700
  * @param {*} [options] Override http request option.
@@ -4512,7 +4776,7 @@ class PartRevisionsApi extends base_1.BaseAPI {
4512
4776
  .then((request) => request(this.axios, this.basePath));
4513
4777
  }
4514
4778
  /**
4515
- * 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.
4779
+ * 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.
4516
4780
  * @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
4517
4781
  * @param {*} [options] Override http request option.
4518
4782
  * @throws {RequiredError}
@@ -4532,7 +4796,7 @@ exports.PartRevisionsApi = PartRevisionsApi;
4532
4796
  const PartsApiAxiosParamCreator = function (configuration) {
4533
4797
  return {
4534
4798
  /**
4535
- * 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.
4799
+ * 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.
4536
4800
  * @param {CreatePartRequest} createPartRequest
4537
4801
  * @param {*} [options] Override http request option.
4538
4802
  * @throws {RequiredError}
@@ -4712,7 +4976,7 @@ const PartsApiFp = function (configuration) {
4712
4976
  const localVarAxiosParamCreator = (0, exports.PartsApiAxiosParamCreator)(configuration);
4713
4977
  return {
4714
4978
  /**
4715
- * 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.
4979
+ * 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.
4716
4980
  * @param {CreatePartRequest} createPartRequest
4717
4981
  * @param {*} [options] Override http request option.
4718
4982
  * @throws {RequiredError}
@@ -4785,7 +5049,7 @@ const PartsApiFactory = function (configuration, basePath, axios) {
4785
5049
  const localVarFp = (0, exports.PartsApiFp)(configuration);
4786
5050
  return {
4787
5051
  /**
4788
- * 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.
5052
+ * 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.
4789
5053
  * @param {CreatePartRequest} createPartRequest
4790
5054
  * @param {*} [options] Override http request option.
4791
5055
  * @throws {RequiredError}
@@ -4853,7 +5117,7 @@ exports.PartsApiFactory = PartsApiFactory;
4853
5117
  */
4854
5118
  class PartsApi extends base_1.BaseAPI {
4855
5119
  /**
4856
- * 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.
5120
+ * 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.
4857
5121
  * @param {PartsApiCreatePartRequest} requestParameters Request parameters.
4858
5122
  * @param {*} [options] Override http request option.
4859
5123
  * @throws {RequiredError}
@@ -5038,7 +5302,7 @@ exports.PmiApi = PmiApi;
5038
5302
  const PropertyEntriesApiAxiosParamCreator = function (configuration) {
5039
5303
  return {
5040
5304
  /**
5041
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5305
+ * Get `property-entries` by a resource ID
5042
5306
  * @param {string} [pageCursor] The cursor for the next page of items.
5043
5307
  * @param {number} [pageSize] The number of items to return.
5044
5308
  * @param {string} [filterResourceId] A resource ID to filter on
@@ -5082,7 +5346,7 @@ const PropertyEntriesApiAxiosParamCreator = function (configuration) {
5082
5346
  };
5083
5347
  }),
5084
5348
  /**
5085
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5349
+ * Upsert property-entries for a provided resource.
5086
5350
  * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
5087
5351
  * @param {*} [options] Override http request option.
5088
5352
  * @throws {RequiredError}
@@ -5125,7 +5389,7 @@ const PropertyEntriesApiFp = function (configuration) {
5125
5389
  const localVarAxiosParamCreator = (0, exports.PropertyEntriesApiAxiosParamCreator)(configuration);
5126
5390
  return {
5127
5391
  /**
5128
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5392
+ * Get `property-entries` by a resource ID
5129
5393
  * @param {string} [pageCursor] The cursor for the next page of items.
5130
5394
  * @param {number} [pageSize] The number of items to return.
5131
5395
  * @param {string} [filterResourceId] A resource ID to filter on
@@ -5140,7 +5404,7 @@ const PropertyEntriesApiFp = function (configuration) {
5140
5404
  });
5141
5405
  },
5142
5406
  /**
5143
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5407
+ * Upsert property-entries for a provided resource.
5144
5408
  * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
5145
5409
  * @param {*} [options] Override http request option.
5146
5410
  * @throws {RequiredError}
@@ -5162,7 +5426,7 @@ const PropertyEntriesApiFactory = function (configuration, basePath, axios) {
5162
5426
  const localVarFp = (0, exports.PropertyEntriesApiFp)(configuration);
5163
5427
  return {
5164
5428
  /**
5165
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5429
+ * Get `property-entries` by a resource ID
5166
5430
  * @param {string} [pageCursor] The cursor for the next page of items.
5167
5431
  * @param {number} [pageSize] The number of items to return.
5168
5432
  * @param {string} [filterResourceId] A resource ID to filter on
@@ -5176,7 +5440,7 @@ const PropertyEntriesApiFactory = function (configuration, basePath, axios) {
5176
5440
  .then((request) => request(axios, basePath));
5177
5441
  },
5178
5442
  /**
5179
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5443
+ * Upsert property-entries for a provided resource.
5180
5444
  * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
5181
5445
  * @param {*} [options] Override http request option.
5182
5446
  * @throws {RequiredError}
@@ -5197,7 +5461,7 @@ exports.PropertyEntriesApiFactory = PropertyEntriesApiFactory;
5197
5461
  */
5198
5462
  class PropertyEntriesApi extends base_1.BaseAPI {
5199
5463
  /**
5200
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5464
+ * Get `property-entries` by a resource ID
5201
5465
  * @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
5202
5466
  * @param {*} [options] Override http request option.
5203
5467
  * @throws {RequiredError}
@@ -5209,7 +5473,7 @@ class PropertyEntriesApi extends base_1.BaseAPI {
5209
5473
  .then((request) => request(this.axios, this.basePath));
5210
5474
  }
5211
5475
  /**
5212
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5476
+ * Upsert property-entries for a provided resource.
5213
5477
  * @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
5214
5478
  * @param {*} [options] Override http request option.
5215
5479
  * @throws {RequiredError}
@@ -8705,6 +8969,178 @@ class ScenesApi extends base_1.BaseAPI {
8705
8969
  }
8706
8970
  }
8707
8971
  exports.ScenesApi = ScenesApi;
8972
+ /**
8973
+ * SearchSessionsApi - axios parameter creator
8974
+ * @export
8975
+ */
8976
+ const SearchSessionsApiAxiosParamCreator = function (configuration) {
8977
+ return {
8978
+ /**
8979
+ * Create a `search-session`.
8980
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
8981
+ * @param {*} [options] Override http request option.
8982
+ * @throws {RequiredError}
8983
+ */
8984
+ createSearchSession: (createSearchSessionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
8985
+ var _a;
8986
+ // verify required parameter 'createSearchSessionRequest' is not null or undefined
8987
+ (0, common_1.assertParamExists)('createSearchSession', 'createSearchSessionRequest', createSearchSessionRequest);
8988
+ const localVarPath = `/search-sessions`;
8989
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8990
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8991
+ let baseOptions;
8992
+ if (configuration) {
8993
+ baseOptions = configuration.baseOptions;
8994
+ }
8995
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
8996
+ const localVarHeaderParameter = {};
8997
+ const localVarQueryParameter = {};
8998
+ // authentication OAuth2 required
8999
+ // oauth required
9000
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
9001
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
9002
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9003
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
9004
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9005
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createSearchSessionRequest, localVarRequestOptions, configuration);
9006
+ return {
9007
+ url: (0, common_1.toPathString)(localVarUrlObj),
9008
+ options: localVarRequestOptions,
9009
+ };
9010
+ }),
9011
+ /**
9012
+ * Get a `search-session`.
9013
+ * @param {string} id The `search-session` ID.
9014
+ * @param {*} [options] Override http request option.
9015
+ * @throws {RequiredError}
9016
+ */
9017
+ getSearchSession: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
9018
+ var _b;
9019
+ // verify required parameter 'id' is not null or undefined
9020
+ (0, common_1.assertParamExists)('getSearchSession', 'id', id);
9021
+ const localVarPath = `/search-sessions/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
9022
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9023
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
9024
+ let baseOptions;
9025
+ if (configuration) {
9026
+ baseOptions = configuration.baseOptions;
9027
+ }
9028
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
9029
+ const localVarHeaderParameter = {};
9030
+ const localVarQueryParameter = {};
9031
+ // authentication OAuth2 required
9032
+ // oauth required
9033
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
9034
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9035
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
9036
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9037
+ return {
9038
+ url: (0, common_1.toPathString)(localVarUrlObj),
9039
+ options: localVarRequestOptions,
9040
+ };
9041
+ }),
9042
+ };
9043
+ };
9044
+ exports.SearchSessionsApiAxiosParamCreator = SearchSessionsApiAxiosParamCreator;
9045
+ /**
9046
+ * SearchSessionsApi - functional programming interface
9047
+ * @export
9048
+ */
9049
+ const SearchSessionsApiFp = function (configuration) {
9050
+ const localVarAxiosParamCreator = (0, exports.SearchSessionsApiAxiosParamCreator)(configuration);
9051
+ return {
9052
+ /**
9053
+ * Create a `search-session`.
9054
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9055
+ * @param {*} [options] Override http request option.
9056
+ * @throws {RequiredError}
9057
+ */
9058
+ createSearchSession(createSearchSessionRequest, options) {
9059
+ return __awaiter(this, void 0, void 0, function* () {
9060
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createSearchSession(createSearchSessionRequest, options);
9061
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
9062
+ });
9063
+ },
9064
+ /**
9065
+ * Get a `search-session`.
9066
+ * @param {string} id The `search-session` ID.
9067
+ * @param {*} [options] Override http request option.
9068
+ * @throws {RequiredError}
9069
+ */
9070
+ getSearchSession(id, options) {
9071
+ return __awaiter(this, void 0, void 0, function* () {
9072
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSearchSession(id, options);
9073
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
9074
+ });
9075
+ },
9076
+ };
9077
+ };
9078
+ exports.SearchSessionsApiFp = SearchSessionsApiFp;
9079
+ /**
9080
+ * SearchSessionsApi - factory interface
9081
+ * @export
9082
+ */
9083
+ const SearchSessionsApiFactory = function (configuration, basePath, axios) {
9084
+ const localVarFp = (0, exports.SearchSessionsApiFp)(configuration);
9085
+ return {
9086
+ /**
9087
+ * Create a `search-session`.
9088
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9089
+ * @param {*} [options] Override http request option.
9090
+ * @throws {RequiredError}
9091
+ */
9092
+ createSearchSession(createSearchSessionRequest, options) {
9093
+ return localVarFp
9094
+ .createSearchSession(createSearchSessionRequest, options)
9095
+ .then((request) => request(axios, basePath));
9096
+ },
9097
+ /**
9098
+ * Get a `search-session`.
9099
+ * @param {string} id The `search-session` ID.
9100
+ * @param {*} [options] Override http request option.
9101
+ * @throws {RequiredError}
9102
+ */
9103
+ getSearchSession(id, options) {
9104
+ return localVarFp
9105
+ .getSearchSession(id, options)
9106
+ .then((request) => request(axios, basePath));
9107
+ },
9108
+ };
9109
+ };
9110
+ exports.SearchSessionsApiFactory = SearchSessionsApiFactory;
9111
+ /**
9112
+ * SearchSessionsApi - object-oriented interface
9113
+ * @export
9114
+ * @class SearchSessionsApi
9115
+ * @extends {BaseAPI}
9116
+ */
9117
+ class SearchSessionsApi extends base_1.BaseAPI {
9118
+ /**
9119
+ * Create a `search-session`.
9120
+ * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
9121
+ * @param {*} [options] Override http request option.
9122
+ * @throws {RequiredError}
9123
+ * @memberof SearchSessionsApi
9124
+ */
9125
+ createSearchSession(requestParameters, options) {
9126
+ return (0, exports.SearchSessionsApiFp)(this.configuration)
9127
+ .createSearchSession(requestParameters.createSearchSessionRequest, options)
9128
+ .then((request) => request(this.axios, this.basePath));
9129
+ }
9130
+ /**
9131
+ * Get a `search-session`.
9132
+ * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
9133
+ * @param {*} [options] Override http request option.
9134
+ * @throws {RequiredError}
9135
+ * @memberof SearchSessionsApi
9136
+ */
9137
+ getSearchSession(requestParameters, options) {
9138
+ return (0, exports.SearchSessionsApiFp)(this.configuration)
9139
+ .getSearchSession(requestParameters.id, options)
9140
+ .then((request) => request(this.axios, this.basePath));
9141
+ }
9142
+ }
9143
+ exports.SearchSessionsApi = SearchSessionsApi;
8708
9144
  /**
8709
9145
  * StreamKeysApi - axios parameter creator
8710
9146
  * @export