@vertexvis/api-client-node 0.26.0 → 0.30.0

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/esm/api.js CHANGED
@@ -60,6 +60,14 @@ export const ClearTransformOpTypeEnum = {
60
60
  export const CreateFileCollectionRequestDataTypeEnum = {
61
61
  FileCollection: 'file-collection',
62
62
  };
63
+ export const CreateFileJobRequestDataTypeEnum = {
64
+ FileJob: 'file-job',
65
+ };
66
+ export const CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
67
+ AsSpecified: 'as-specified',
68
+ LatestIteration: 'latest-iteration',
69
+ LatestRevision: 'latest-revision',
70
+ };
63
71
  export const DeselectOperationTypeEnum = {
64
72
  Deselect: 'deselect',
65
73
  };
@@ -72,6 +80,9 @@ export const ExportStateRelationshipDataTypeEnum = {
72
80
  export const FileCollectionMetadataDataTypeEnum = {
73
81
  FileCollection: 'file-collection',
74
82
  };
83
+ export const FileJobArchiveOperationTypeEnum = {
84
+ FileArchiveOperation: 'file-archive-operation',
85
+ };
75
86
  export const FileRelationshipDataTypeEnum = {
76
87
  File: 'file',
77
88
  };
@@ -142,6 +153,12 @@ export const SceneViewRelationshipDataTypeEnum = {
142
153
  export const SceneViewStateRelationshipDataTypeEnum = {
143
154
  SceneViewState: 'scene-view-state',
144
155
  };
156
+ export const SelectFileByIdTypeEnum = {
157
+ FileById: 'file-by-id',
158
+ };
159
+ export const SelectFileBySuppliedIdTypeEnum = {
160
+ FileBySuppliedId: 'file-by-supplied-id',
161
+ };
145
162
  export const SelectOpTypeEnum = {
146
163
  Select: 'select',
147
164
  };
@@ -1639,6 +1656,41 @@ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
1639
1656
  options: localVarRequestOptions,
1640
1657
  };
1641
1658
  }),
1659
+ /**
1660
+ * Remove a file from a `file-collection`.
1661
+ * @param {string} id The `file-collection` ID.
1662
+ * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
1663
+ * @param {*} [options] Override http request option.
1664
+ * @throws {RequiredError}
1665
+ */
1666
+ removeFileCollectionFiles: (id, filterFileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1667
+ var _g;
1668
+ // verify required parameter 'id' is not null or undefined
1669
+ assertParamExists('removeFileCollectionFiles', 'id', id);
1670
+ const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1671
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1672
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1673
+ let baseOptions;
1674
+ if (configuration) {
1675
+ baseOptions = configuration.baseOptions;
1676
+ }
1677
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
1678
+ const localVarHeaderParameter = {};
1679
+ const localVarQueryParameter = {};
1680
+ // authentication OAuth2 required
1681
+ // oauth required
1682
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1683
+ if (filterFileId !== undefined) {
1684
+ localVarQueryParameter['filter[fileId]'] = filterFileId;
1685
+ }
1686
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1687
+ let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1688
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1689
+ return {
1690
+ url: toPathString(localVarUrlObj),
1691
+ options: localVarRequestOptions,
1692
+ };
1693
+ }),
1642
1694
  /**
1643
1695
  * Update a `file-collection`.
1644
1696
  * @param {string} id The `file-collection` ID.
@@ -1647,7 +1699,7 @@ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
1647
1699
  * @throws {RequiredError}
1648
1700
  */
1649
1701
  updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1650
- var _g;
1702
+ var _h;
1651
1703
  // verify required parameter 'id' is not null or undefined
1652
1704
  assertParamExists('updateFileCollection', 'id', id);
1653
1705
  // verify required parameter 'updateFileCollectionRequest' is not null or undefined
@@ -1667,7 +1719,7 @@ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
1667
1719
  yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1668
1720
  localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1669
1721
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1670
- let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1722
+ let headersFromBaseOptions = (_h = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _h !== void 0 ? _h : {};
1671
1723
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1672
1724
  localVarRequestOptions.data = serializeDataIfNeeded(updateFileCollectionRequest, localVarRequestOptions, configuration);
1673
1725
  return {
@@ -1761,6 +1813,19 @@ export const FileCollectionsApiFp = function (configuration) {
1761
1813
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1762
1814
  });
1763
1815
  },
1816
+ /**
1817
+ * Remove a file from a `file-collection`.
1818
+ * @param {string} id The `file-collection` ID.
1819
+ * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
1820
+ * @param {*} [options] Override http request option.
1821
+ * @throws {RequiredError}
1822
+ */
1823
+ removeFileCollectionFiles(id, filterFileId, options) {
1824
+ return __awaiter(this, void 0, void 0, function* () {
1825
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.removeFileCollectionFiles(id, filterFileId, options);
1826
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1827
+ });
1828
+ },
1764
1829
  /**
1765
1830
  * Update a `file-collection`.
1766
1831
  * @param {string} id The `file-collection` ID.
@@ -1854,6 +1919,18 @@ export const FileCollectionsApiFactory = function (configuration, basePath, axio
1854
1919
  .listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
1855
1920
  .then((request) => request(axios, basePath));
1856
1921
  },
1922
+ /**
1923
+ * Remove a file from a `file-collection`.
1924
+ * @param {string} id The `file-collection` ID.
1925
+ * @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
1926
+ * @param {*} [options] Override http request option.
1927
+ * @throws {RequiredError}
1928
+ */
1929
+ removeFileCollectionFiles(id, filterFileId, options) {
1930
+ return localVarFp
1931
+ .removeFileCollectionFiles(id, filterFileId, options)
1932
+ .then((request) => request(axios, basePath));
1933
+ },
1857
1934
  /**
1858
1935
  * Update a `file-collection`.
1859
1936
  * @param {string} id The `file-collection` ID.
@@ -1947,6 +2024,18 @@ export class FileCollectionsApi extends BaseAPI {
1947
2024
  .listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
1948
2025
  .then((request) => request(this.axios, this.basePath));
1949
2026
  }
2027
+ /**
2028
+ * Remove a file from a `file-collection`.
2029
+ * @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
2030
+ * @param {*} [options] Override http request option.
2031
+ * @throws {RequiredError}
2032
+ * @memberof FileCollectionsApi
2033
+ */
2034
+ removeFileCollectionFiles(requestParameters, options) {
2035
+ return FileCollectionsApiFp(this.configuration)
2036
+ .removeFileCollectionFiles(requestParameters.id, requestParameters.filterFileId, options)
2037
+ .then((request) => request(this.axios, this.basePath));
2038
+ }
1950
2039
  /**
1951
2040
  * Update a `file-collection`.
1952
2041
  * @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
@@ -1960,6 +2049,174 @@ export class FileCollectionsApi extends BaseAPI {
1960
2049
  .then((request) => request(this.axios, this.basePath));
1961
2050
  }
1962
2051
  }
2052
+ /**
2053
+ * FileJobsApi - axios parameter creator
2054
+ * @export
2055
+ */
2056
+ export const FileJobsApiAxiosParamCreator = function (configuration) {
2057
+ return {
2058
+ /**
2059
+ * Create a `file-job`.
2060
+ * @param {CreateFileJobRequest} createFileJobRequest
2061
+ * @param {*} [options] Override http request option.
2062
+ * @throws {RequiredError}
2063
+ */
2064
+ createFileJob: (createFileJobRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
2065
+ var _a;
2066
+ // verify required parameter 'createFileJobRequest' is not null or undefined
2067
+ assertParamExists('createFileJob', 'createFileJobRequest', createFileJobRequest);
2068
+ const localVarPath = `/file-jobs`;
2069
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2070
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2071
+ let baseOptions;
2072
+ if (configuration) {
2073
+ baseOptions = configuration.baseOptions;
2074
+ }
2075
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
2076
+ const localVarHeaderParameter = {};
2077
+ const localVarQueryParameter = {};
2078
+ // authentication OAuth2 required
2079
+ // oauth required
2080
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
2081
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
2082
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2083
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
2084
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2085
+ localVarRequestOptions.data = serializeDataIfNeeded(createFileJobRequest, localVarRequestOptions, configuration);
2086
+ return {
2087
+ url: toPathString(localVarUrlObj),
2088
+ options: localVarRequestOptions,
2089
+ };
2090
+ }),
2091
+ /**
2092
+ * Get the status and result of a `file-job`.
2093
+ * @param {string} id The ID of a file job.
2094
+ * @param {*} [options] Override http request option.
2095
+ * @throws {RequiredError}
2096
+ */
2097
+ getFileJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
2098
+ var _b;
2099
+ // verify required parameter 'id' is not null or undefined
2100
+ assertParamExists('getFileJob', 'id', id);
2101
+ const localVarPath = `/file-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
2102
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2103
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2104
+ let baseOptions;
2105
+ if (configuration) {
2106
+ baseOptions = configuration.baseOptions;
2107
+ }
2108
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2109
+ const localVarHeaderParameter = {};
2110
+ const localVarQueryParameter = {};
2111
+ // authentication OAuth2 required
2112
+ // oauth required
2113
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
2114
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2115
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
2116
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2117
+ return {
2118
+ url: toPathString(localVarUrlObj),
2119
+ options: localVarRequestOptions,
2120
+ };
2121
+ }),
2122
+ };
2123
+ };
2124
+ /**
2125
+ * FileJobsApi - functional programming interface
2126
+ * @export
2127
+ */
2128
+ export const FileJobsApiFp = function (configuration) {
2129
+ const localVarAxiosParamCreator = FileJobsApiAxiosParamCreator(configuration);
2130
+ return {
2131
+ /**
2132
+ * Create a `file-job`.
2133
+ * @param {CreateFileJobRequest} createFileJobRequest
2134
+ * @param {*} [options] Override http request option.
2135
+ * @throws {RequiredError}
2136
+ */
2137
+ createFileJob(createFileJobRequest, options) {
2138
+ return __awaiter(this, void 0, void 0, function* () {
2139
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileJob(createFileJobRequest, options);
2140
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2141
+ });
2142
+ },
2143
+ /**
2144
+ * Get the status and result of a `file-job`.
2145
+ * @param {string} id The ID of a file job.
2146
+ * @param {*} [options] Override http request option.
2147
+ * @throws {RequiredError}
2148
+ */
2149
+ getFileJob(id, options) {
2150
+ return __awaiter(this, void 0, void 0, function* () {
2151
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileJob(id, options);
2152
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2153
+ });
2154
+ },
2155
+ };
2156
+ };
2157
+ /**
2158
+ * FileJobsApi - factory interface
2159
+ * @export
2160
+ */
2161
+ export const FileJobsApiFactory = function (configuration, basePath, axios) {
2162
+ const localVarFp = FileJobsApiFp(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 localVarFp
2172
+ .createFileJob(createFileJobRequest, options)
2173
+ .then((request) => request(axios, basePath));
2174
+ },
2175
+ /**
2176
+ * Get the status and result of a `file-job`.
2177
+ * @param {string} id The ID of a file job.
2178
+ * @param {*} [options] Override http request option.
2179
+ * @throws {RequiredError}
2180
+ */
2181
+ getFileJob(id, options) {
2182
+ return localVarFp
2183
+ .getFileJob(id, options)
2184
+ .then((request) => request(axios, basePath));
2185
+ },
2186
+ };
2187
+ };
2188
+ /**
2189
+ * FileJobsApi - object-oriented interface
2190
+ * @export
2191
+ * @class FileJobsApi
2192
+ * @extends {BaseAPI}
2193
+ */
2194
+ export class FileJobsApi extends BaseAPI {
2195
+ /**
2196
+ * Create a `file-job`.
2197
+ * @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
2198
+ * @param {*} [options] Override http request option.
2199
+ * @throws {RequiredError}
2200
+ * @memberof FileJobsApi
2201
+ */
2202
+ createFileJob(requestParameters, options) {
2203
+ return FileJobsApiFp(this.configuration)
2204
+ .createFileJob(requestParameters.createFileJobRequest, options)
2205
+ .then((request) => request(this.axios, this.basePath));
2206
+ }
2207
+ /**
2208
+ * Get the status and result of a `file-job`.
2209
+ * @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
2210
+ * @param {*} [options] Override http request option.
2211
+ * @throws {RequiredError}
2212
+ * @memberof FileJobsApi
2213
+ */
2214
+ getFileJob(requestParameters, options) {
2215
+ return FileJobsApiFp(this.configuration)
2216
+ .getFileJob(requestParameters.id, options)
2217
+ .then((request) => request(this.axios, this.basePath));
2218
+ }
2219
+ }
1963
2220
  /**
1964
2221
  * FilesApi - axios parameter creator
1965
2222
  * @export
@@ -3561,7 +3818,7 @@ export class Oauth2Api extends BaseAPI {
3561
3818
  export const PartRenditionsApiAxiosParamCreator = function (configuration) {
3562
3819
  return {
3563
3820
  /**
3564
- *
3821
+ * Creates a part-rendition associated with a part-revision
3565
3822
  * @param {string} id The `part-revision` ID.
3566
3823
  * @param {CreatePartRenditionRequest} createPartRenditionRequest
3567
3824
  * @param {*} [options] Override http request option.
@@ -3681,7 +3938,7 @@ export const PartRenditionsApiFp = function (configuration) {
3681
3938
  const localVarAxiosParamCreator = PartRenditionsApiAxiosParamCreator(configuration);
3682
3939
  return {
3683
3940
  /**
3684
- *
3941
+ * Creates a part-rendition associated with a part-revision
3685
3942
  * @param {string} id The `part-revision` ID.
3686
3943
  * @param {CreatePartRenditionRequest} createPartRenditionRequest
3687
3944
  * @param {*} [options] Override http request option.
@@ -3730,7 +3987,7 @@ export const PartRenditionsApiFactory = function (configuration, basePath, axios
3730
3987
  const localVarFp = PartRenditionsApiFp(configuration);
3731
3988
  return {
3732
3989
  /**
3733
- *
3990
+ * Creates a part-rendition associated with a part-revision
3734
3991
  * @param {string} id The `part-revision` ID.
3735
3992
  * @param {CreatePartRenditionRequest} createPartRenditionRequest
3736
3993
  * @param {*} [options] Override http request option.
@@ -3776,7 +4033,7 @@ export const PartRenditionsApiFactory = function (configuration, basePath, axios
3776
4033
  */
3777
4034
  export class PartRenditionsApi extends BaseAPI {
3778
4035
  /**
3779
- *
4036
+ * Creates a part-rendition associated with a part-revision
3780
4037
  * @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
3781
4038
  * @param {*} [options] Override http request option.
3782
4039
  * @throws {RequiredError}
@@ -3819,7 +4076,7 @@ export class PartRenditionsApi extends BaseAPI {
3819
4076
  export const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
3820
4077
  return {
3821
4078
  /**
3822
- * 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.
4079
+ * 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.
3823
4080
  * @param {string} [filterParent] Parent ID to filter on.
3824
4081
  * @param {string} [pageCursor] The cursor for the next page of items.
3825
4082
  * @param {number} [pageSize] The number of items to return.
@@ -3868,7 +4125,7 @@ export const PartRevisionInstancesApiFp = function (configuration) {
3868
4125
  const localVarAxiosParamCreator = PartRevisionInstancesApiAxiosParamCreator(configuration);
3869
4126
  return {
3870
4127
  /**
3871
- * 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.
4128
+ * 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.
3872
4129
  * @param {string} [filterParent] Parent ID to filter on.
3873
4130
  * @param {string} [pageCursor] The cursor for the next page of items.
3874
4131
  * @param {number} [pageSize] The number of items to return.
@@ -3891,7 +4148,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
3891
4148
  const localVarFp = PartRevisionInstancesApiFp(configuration);
3892
4149
  return {
3893
4150
  /**
3894
- * 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.
4151
+ * 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.
3895
4152
  * @param {string} [filterParent] Parent ID to filter on.
3896
4153
  * @param {string} [pageCursor] The cursor for the next page of items.
3897
4154
  * @param {number} [pageSize] The number of items to return.
@@ -3913,7 +4170,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
3913
4170
  */
3914
4171
  export class PartRevisionInstancesApi extends BaseAPI {
3915
4172
  /**
3916
- * 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.
4173
+ * 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.
3917
4174
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
3918
4175
  * @param {*} [options] Override http request option.
3919
4176
  * @throws {RequiredError}
@@ -4157,7 +4414,7 @@ export const PartRevisionsApiAxiosParamCreator = function (configuration) {
4157
4414
  };
4158
4415
  }),
4159
4416
  /**
4160
- * 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.
4417
+ * 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.
4161
4418
  * @param {string} id The `part-revision` ID.
4162
4419
  * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
4163
4420
  * @param {*} [options] Override http request option.
@@ -4278,7 +4535,7 @@ export const PartRevisionsApiFp = function (configuration) {
4278
4535
  });
4279
4536
  },
4280
4537
  /**
4281
- * 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.
4538
+ * 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.
4282
4539
  * @param {string} id The `part-revision` ID.
4283
4540
  * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
4284
4541
  * @param {*} [options] Override http request option.
@@ -4371,7 +4628,7 @@ export const PartRevisionsApiFactory = function (configuration, basePath, axios)
4371
4628
  .then((request) => request(axios, basePath));
4372
4629
  },
4373
4630
  /**
4374
- * 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.
4631
+ * 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.
4375
4632
  * @param {string} id The `part-revision` ID.
4376
4633
  * @param {UpdatePartRevisionRequest} updatePartRevisionRequest
4377
4634
  * @param {*} [options] Override http request option.
@@ -4452,7 +4709,7 @@ export class PartRevisionsApi extends BaseAPI {
4452
4709
  .then((request) => request(this.axios, this.basePath));
4453
4710
  }
4454
4711
  /**
4455
- * 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.
4712
+ * 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.
4456
4713
  * @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
4457
4714
  * @param {*} [options] Override http request option.
4458
4715
  * @throws {RequiredError}
@@ -4471,7 +4728,7 @@ export class PartRevisionsApi extends BaseAPI {
4471
4728
  export const PartsApiAxiosParamCreator = function (configuration) {
4472
4729
  return {
4473
4730
  /**
4474
- * 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.
4731
+ * 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.
4475
4732
  * @param {CreatePartRequest} createPartRequest
4476
4733
  * @param {*} [options] Override http request option.
4477
4734
  * @throws {RequiredError}
@@ -4650,7 +4907,7 @@ export const PartsApiFp = function (configuration) {
4650
4907
  const localVarAxiosParamCreator = PartsApiAxiosParamCreator(configuration);
4651
4908
  return {
4652
4909
  /**
4653
- * 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.
4910
+ * 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.
4654
4911
  * @param {CreatePartRequest} createPartRequest
4655
4912
  * @param {*} [options] Override http request option.
4656
4913
  * @throws {RequiredError}
@@ -4722,7 +4979,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
4722
4979
  const localVarFp = PartsApiFp(configuration);
4723
4980
  return {
4724
4981
  /**
4725
- * 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.
4982
+ * 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.
4726
4983
  * @param {CreatePartRequest} createPartRequest
4727
4984
  * @param {*} [options] Override http request option.
4728
4985
  * @throws {RequiredError}
@@ -4789,7 +5046,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
4789
5046
  */
4790
5047
  export class PartsApi extends BaseAPI {
4791
5048
  /**
4792
- * 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.
5049
+ * 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.
4793
5050
  * @param {PartsApiCreatePartRequest} requestParameters Request parameters.
4794
5051
  * @param {*} [options] Override http request option.
4795
5052
  * @throws {RequiredError}
@@ -4969,7 +5226,7 @@ export class PmiApi extends BaseAPI {
4969
5226
  export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
4970
5227
  return {
4971
5228
  /**
4972
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5229
+ * Get `property-entries` by a resource ID
4973
5230
  * @param {string} [pageCursor] The cursor for the next page of items.
4974
5231
  * @param {number} [pageSize] The number of items to return.
4975
5232
  * @param {string} [filterResourceId] A resource ID to filter on
@@ -5013,7 +5270,7 @@ export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
5013
5270
  };
5014
5271
  }),
5015
5272
  /**
5016
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5273
+ * Upsert property-entries for a provided resource.
5017
5274
  * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
5018
5275
  * @param {*} [options] Override http request option.
5019
5276
  * @throws {RequiredError}
@@ -5055,7 +5312,7 @@ export const PropertyEntriesApiFp = function (configuration) {
5055
5312
  const localVarAxiosParamCreator = PropertyEntriesApiAxiosParamCreator(configuration);
5056
5313
  return {
5057
5314
  /**
5058
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5315
+ * Get `property-entries` by a resource ID
5059
5316
  * @param {string} [pageCursor] The cursor for the next page of items.
5060
5317
  * @param {number} [pageSize] The number of items to return.
5061
5318
  * @param {string} [filterResourceId] A resource ID to filter on
@@ -5070,7 +5327,7 @@ export const PropertyEntriesApiFp = function (configuration) {
5070
5327
  });
5071
5328
  },
5072
5329
  /**
5073
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5330
+ * Upsert property-entries for a provided resource.
5074
5331
  * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
5075
5332
  * @param {*} [options] Override http request option.
5076
5333
  * @throws {RequiredError}
@@ -5091,7 +5348,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
5091
5348
  const localVarFp = PropertyEntriesApiFp(configuration);
5092
5349
  return {
5093
5350
  /**
5094
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5351
+ * Get `property-entries` by a resource ID
5095
5352
  * @param {string} [pageCursor] The cursor for the next page of items.
5096
5353
  * @param {number} [pageSize] The number of items to return.
5097
5354
  * @param {string} [filterResourceId] A resource ID to filter on
@@ -5105,7 +5362,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
5105
5362
  .then((request) => request(axios, basePath));
5106
5363
  },
5107
5364
  /**
5108
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5365
+ * Upsert property-entries for a provided resource.
5109
5366
  * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
5110
5367
  * @param {*} [options] Override http request option.
5111
5368
  * @throws {RequiredError}
@@ -5125,7 +5382,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
5125
5382
  */
5126
5383
  export class PropertyEntriesApi extends BaseAPI {
5127
5384
  /**
5128
- * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
5385
+ * Get `property-entries` by a resource ID
5129
5386
  * @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
5130
5387
  * @param {*} [options] Override http request option.
5131
5388
  * @throws {RequiredError}
@@ -5137,7 +5394,7 @@ export class PropertyEntriesApi extends BaseAPI {
5137
5394
  .then((request) => request(this.axios, this.basePath));
5138
5395
  }
5139
5396
  /**
5140
- * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
5397
+ * Upsert property-entries for a provided resource.
5141
5398
  * @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
5142
5399
  * @param {*} [options] Override http request option.
5143
5400
  * @throws {RequiredError}
@@ -1 +1 @@
1
- export declare const version = "0.26.0";
1
+ export declare const version = "0.30.0";
@@ -1 +1 @@
1
- export const version = '0.26.0';
1
+ export const version = '0.30.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertexvis/api-client-node",
3
- "version": "0.26.0",
3
+ "version": "0.30.0",
4
4
  "description": "The Vertex REST API client for Node.js.",
5
5
  "license": "MIT",
6
6
  "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -68,5 +68,6 @@
68
68
  "test:func": "yarn clean-build && node dist/functional-test.js",
69
69
  "verify": "yarn clean-build && yarn test --coverage && node dist/cjs/verify.js",
70
70
  "watch": "jest --watch"
71
- }
71
+ },
72
+ "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
72
73
  }