@vertexvis/api-client-node 0.22.4 → 0.22.6

package/dist/cjs/api.d.ts

@@ -1351,11 +1351,11 @@ export interface CreateSceneAnnotationRequestData {
  */
 export interface CreateSceneAnnotationRequestDataAttributes {
     /**
-     * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb.
-     * @type {string}
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
      * @memberof CreateSceneAnnotationRequestDataAttributes
      */
-    data: string;
+    data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
     /**
      * A customer provided ID used for correlation.
      * @type {string}
@@ -4272,6 +4272,68 @@ export interface SceneAnnotation {
         [key: string]: Link;
     };
 }
+/**
+ * A type that describes a callout annotation.
+ * @export
+ * @interface SceneAnnotationCalloutDataType
+ */
+export interface SceneAnnotationCalloutDataType {
+    /**
+     * The type of annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    type: string;
+    /**
+     *
+     * @type {Vector3}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    position: Vector3;
+    /**
+     * An optional icon to display for this annotation. See [documentation](https://github.com/Vertexvis/vertex-web-sdk/tree/master/packages/viewer/src/components/viewer-icon#properties) for possible values.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    icon?: string;
+    /**
+     * A hex color value.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    primaryColor?: string;
+    /**
+     * A hex color value.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    accentColor?: string;
+}
+/**
+ * A type that describes a custom user provided annotation.
+ * @export
+ * @interface SceneAnnotationCustomDataType
+ */
+export interface SceneAnnotationCustomDataType {
+    /**
+     * The type of annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCustomDataType
+     */
+    type: string;
+    /**
+     * The type of annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCustomDataType
+     */
+    jsonType: string;
+    /**
+     * An encoded JSON string associated with the custom annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCustomDataType
+     */
+    json: string;
+}
 /**
  *
  * @export
@@ -4324,11 +4386,11 @@ export interface SceneAnnotationDataAttributes {
      */
     modifiedAt: string;
     /**
-     * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb.
-     * @type {string}
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
      * @memberof SceneAnnotationDataAttributes
      */
-    data: string;
+    data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
     /**
      *
      * @type {string}
@@ -6015,11 +6077,11 @@ export interface UpdateSceneAnnotationRequestData {
  */
 export interface UpdateSceneAnnotationRequestDataAttributes {
     /**
-     * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb.
-     * @type {string}
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
      * @memberof UpdateSceneAnnotationRequestDataAttributes
      */
-    data?: string;
+    data?: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
     /**
      * A customer provided ID used for correlation.
      * @type {string}

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

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

package/dist/cjs/client/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.22.4';
+exports.version = '0.22.6';

package/dist/cjs/client/vertex-client.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneAnnotationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
 import { BasePath } from './index';
 /**
  * Static `build` function arguments.
@@ -80,6 +80,7 @@ export declare class VertexClient {
     partRevisions: PartRevisionsApi;
     parts: PartsApi;
     sceneAlterations: SceneAlterationsApi;
+    sceneAnnotations: SceneAnnotationsApi;
     sceneItemOverrides: SceneItemOverridesApi;
     sceneItems: SceneItemsApi;
     scenes: ScenesApi;

package/dist/cjs/client/vertex-client.js

@@ -86,6 +86,7 @@ class VertexClient {
         this.partRevisions = new index_1.PartRevisionsApi(this.config, undefined, axiosInst);
         this.parts = new index_1.PartsApi(this.config, undefined, axiosInst);
         this.sceneAlterations = new index_1.SceneAlterationsApi(this.config, undefined, axiosInst);
+        this.sceneAnnotations = new index_1.SceneAnnotationsApi(this.config, undefined, axiosInst);
         this.sceneItemOverrides = new index_1.SceneItemOverridesApi(this.config, undefined, axiosInst);
         this.sceneItems = new index_1.SceneItemsApi(this.config, undefined, axiosInst);
         this.scenes = new index_1.ScenesApi(this.config, undefined, axiosInst);

package/dist/esm/api.d.ts

@@ -1351,11 +1351,11 @@ export interface CreateSceneAnnotationRequestData {
  */
 export interface CreateSceneAnnotationRequestDataAttributes {
     /**
-     * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb.
-     * @type {string}
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
      * @memberof CreateSceneAnnotationRequestDataAttributes
      */
-    data: string;
+    data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
     /**
      * A customer provided ID used for correlation.
      * @type {string}
@@ -4272,6 +4272,68 @@ export interface SceneAnnotation {
         [key: string]: Link;
     };
 }
+/**
+ * A type that describes a callout annotation.
+ * @export
+ * @interface SceneAnnotationCalloutDataType
+ */
+export interface SceneAnnotationCalloutDataType {
+    /**
+     * The type of annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    type: string;
+    /**
+     *
+     * @type {Vector3}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    position: Vector3;
+    /**
+     * An optional icon to display for this annotation. See [documentation](https://github.com/Vertexvis/vertex-web-sdk/tree/master/packages/viewer/src/components/viewer-icon#properties) for possible values.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    icon?: string;
+    /**
+     * A hex color value.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    primaryColor?: string;
+    /**
+     * A hex color value.
+     * @type {string}
+     * @memberof SceneAnnotationCalloutDataType
+     */
+    accentColor?: string;
+}
+/**
+ * A type that describes a custom user provided annotation.
+ * @export
+ * @interface SceneAnnotationCustomDataType
+ */
+export interface SceneAnnotationCustomDataType {
+    /**
+     * The type of annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCustomDataType
+     */
+    type: string;
+    /**
+     * The type of annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCustomDataType
+     */
+    jsonType: string;
+    /**
+     * An encoded JSON string associated with the custom annotation.
+     * @type {string}
+     * @memberof SceneAnnotationCustomDataType
+     */
+    json: string;
+}
 /**
  *
  * @export
@@ -4324,11 +4386,11 @@ export interface SceneAnnotationDataAttributes {
      */
     modifiedAt: string;
     /**
-     * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb.
-     * @type {string}
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
      * @memberof SceneAnnotationDataAttributes
      */
-    data: string;
+    data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
     /**
      *
      * @type {string}
@@ -6015,11 +6077,11 @@ export interface UpdateSceneAnnotationRequestData {
  */
 export interface UpdateSceneAnnotationRequestDataAttributes {
     /**
-     * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb.
-     * @type {string}
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
      * @memberof UpdateSceneAnnotationRequestDataAttributes
      */
-    data?: string;
+    data?: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
     /**
      * A customer provided ID used for correlation.
      * @type {string}

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

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

package/dist/esm/client/version.js

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

package/dist/esm/client/vertex-client.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneAnnotationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
 import { BasePath } from './index';
 /**
  * Static `build` function arguments.
@@ -80,6 +80,7 @@ export declare class VertexClient {
     partRevisions: PartRevisionsApi;
     parts: PartsApi;
     sceneAlterations: SceneAlterationsApi;
+    sceneAnnotations: SceneAnnotationsApi;
     sceneItemOverrides: SceneItemOverridesApi;
     sceneItems: SceneItemsApi;
     scenes: ScenesApi;

package/dist/esm/client/vertex-client.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 var _a;
 import axios from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi, } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneAnnotationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi, } from '../index';
 import { createToken, isFailure, nowEpochMs, prettyJson, } from './index';
 import { version } from './version';
 const TenMinsInMs = 600000;
@@ -80,6 +80,7 @@ export class VertexClient {
         this.partRevisions = new PartRevisionsApi(this.config, undefined, axiosInst);
         this.parts = new PartsApi(this.config, undefined, axiosInst);
         this.sceneAlterations = new SceneAlterationsApi(this.config, undefined, axiosInst);
+        this.sceneAnnotations = new SceneAnnotationsApi(this.config, undefined, axiosInst);
         this.sceneItemOverrides = new SceneItemOverridesApi(this.config, undefined, axiosInst);
         this.sceneItems = new SceneItemsApi(this.config, undefined, axiosInst);
         this.scenes = new ScenesApi(this.config, undefined, axiosInst);

package/package.json

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