@vertexvis/api-client-node 0.22.3 → 0.22.4

package/dist/esm/api.js

@@ -4060,6 +4060,325 @@ export class SceneAlterationsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * SceneAnnotationsApi - axios parameter creator
+ * @export
+ */
+export const SceneAnnotationsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation-set` ID.
+         * @param {CreateSceneAnnotationRequest} createSceneAnnotationRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSceneAnnotation: (id, createSceneAnnotationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('createSceneAnnotation', 'id', id);
+            // verify required parameter 'createSceneAnnotationRequest' is not null or undefined
+            assertParamExists('createSceneAnnotation', 'createSceneAnnotationRequest', createSceneAnnotationRequest);
+            const localVarPath = `/scene-annotation-sets/{id}/scene-annotations`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createSceneAnnotationRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Create an annotation set that is associated with a scene. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene` ID.
+         * @param {CreateSceneAnnotationSetRequest} createSceneAnnotationSetRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSceneAnnotationSet: (id, createSceneAnnotationSetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('createSceneAnnotationSet', 'id', id);
+            // verify required parameter 'createSceneAnnotationSetRequest' is not null or undefined
+            assertParamExists('createSceneAnnotationSet', 'createSceneAnnotationSetRequest', createSceneAnnotationSetRequest);
+            const localVarPath = `/scenes/{id}/scene-annotation-sets`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createSceneAnnotationSetRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSceneAnnotation: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _c;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteSceneAnnotation', 'id', id);
+            const localVarPath = `/scene-annotations/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation` ID.
+         * @param {UpdateSceneAnnotationRequest} updateSceneAnnotationRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateSceneAnnotation: (id, updateSceneAnnotationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _d;
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('updateSceneAnnotation', 'id', id);
+            // verify required parameter 'updateSceneAnnotationRequest' is not null or undefined
+            assertParamExists('updateSceneAnnotation', 'updateSceneAnnotationRequest', updateSceneAnnotationRequest);
+            const localVarPath = `/scene-annotations/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(updateSceneAnnotationRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * SceneAnnotationsApi - functional programming interface
+ * @export
+ */
+export const SceneAnnotationsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = SceneAnnotationsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation-set` ID.
+         * @param {CreateSceneAnnotationRequest} createSceneAnnotationRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSceneAnnotation(id, createSceneAnnotationRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createSceneAnnotation(id, createSceneAnnotationRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Create an annotation set that is associated with a scene. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene` ID.
+         * @param {CreateSceneAnnotationSetRequest} createSceneAnnotationSetRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSceneAnnotationSet(id, createSceneAnnotationSetRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createSceneAnnotationSet(id, createSceneAnnotationSetRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSceneAnnotation(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteSceneAnnotation(id, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation` ID.
+         * @param {UpdateSceneAnnotationRequest} updateSceneAnnotationRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateSceneAnnotation(id, updateSceneAnnotationRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateSceneAnnotation(id, updateSceneAnnotationRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * SceneAnnotationsApi - factory interface
+ * @export
+ */
+export const SceneAnnotationsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = SceneAnnotationsApiFp(configuration);
+    return {
+        /**
+         * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation-set` ID.
+         * @param {CreateSceneAnnotationRequest} createSceneAnnotationRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSceneAnnotation(id, createSceneAnnotationRequest, options) {
+            return localVarFp
+                .createSceneAnnotation(id, createSceneAnnotationRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Create an annotation set that is associated with a scene. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene` ID.
+         * @param {CreateSceneAnnotationSetRequest} createSceneAnnotationSetRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSceneAnnotationSet(id, createSceneAnnotationSetRequest, options) {
+            return localVarFp
+                .createSceneAnnotationSet(id, createSceneAnnotationSetRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation` ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSceneAnnotation(id, options) {
+            return localVarFp
+                .deleteSceneAnnotation(id, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+         * @param {string} id The `scene-annotation` ID.
+         * @param {UpdateSceneAnnotationRequest} updateSceneAnnotationRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateSceneAnnotation(id, updateSceneAnnotationRequest, options) {
+            return localVarFp
+                .updateSceneAnnotation(id, updateSceneAnnotationRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * SceneAnnotationsApi - object-oriented interface
+ * @export
+ * @class SceneAnnotationsApi
+ * @extends {BaseAPI}
+ */
+export class SceneAnnotationsApi extends BaseAPI {
+    /**
+     * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+     * @param {SceneAnnotationsApiCreateSceneAnnotationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SceneAnnotationsApi
+     */
+    createSceneAnnotation(requestParameters, options) {
+        return SceneAnnotationsApiFp(this.configuration)
+            .createSceneAnnotation(requestParameters.id, requestParameters.createSceneAnnotationRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Create an annotation set that is associated with a scene. **Preview:** This is a preview API and is subject to change.
+     * @param {SceneAnnotationsApiCreateSceneAnnotationSetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SceneAnnotationsApi
+     */
+    createSceneAnnotationSet(requestParameters, options) {
+        return SceneAnnotationsApiFp(this.configuration)
+            .createSceneAnnotationSet(requestParameters.id, requestParameters.createSceneAnnotationSetRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {SceneAnnotationsApiDeleteSceneAnnotationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SceneAnnotationsApi
+     */
+    deleteSceneAnnotation(requestParameters, options) {
+        return SceneAnnotationsApiFp(this.configuration)
+            .deleteSceneAnnotation(requestParameters.id, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {SceneAnnotationsApiUpdateSceneAnnotationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SceneAnnotationsApi
+     */
+    updateSceneAnnotation(requestParameters, options) {
+        return SceneAnnotationsApiFp(this.configuration)
+            .updateSceneAnnotation(requestParameters.id, requestParameters.updateSceneAnnotationRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * SceneItemOverridesApi - axios parameter creator
  * @export

package/dist/esm/client/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.22.3";
+export declare const version = "0.22.4";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.22.3';
+export const version = '0.22.4';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.22.3",
+  "version": "0.22.4",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",