@vertexvis/api-client-node 0.22.3 → 0.22.5

package/dist/cjs/api.d.ts

@@ -1312,6 +1312,108 @@ export interface CreateSceneAlterationRequestDataAttributes {
      */
     alterations: Array<SceneOperation>;
 }
+/**
+ *
+ * @export
+ * @interface CreateSceneAnnotationRequest
+ */
+export interface CreateSceneAnnotationRequest {
+    /**
+     *
+     * @type {CreateSceneAnnotationRequestData}
+     * @memberof CreateSceneAnnotationRequest
+     */
+    data: CreateSceneAnnotationRequestData;
+}
+/**
+ *
+ * @export
+ * @interface CreateSceneAnnotationRequestData
+ */
+export interface CreateSceneAnnotationRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof CreateSceneAnnotationRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {CreateSceneAnnotationRequestDataAttributes}
+     * @memberof CreateSceneAnnotationRequestData
+     */
+    attributes: CreateSceneAnnotationRequestDataAttributes;
+}
+/**
+ *
+ * @export
+ * @interface CreateSceneAnnotationRequestDataAttributes
+ */
+export interface CreateSceneAnnotationRequestDataAttributes {
+    /**
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
+     * @memberof CreateSceneAnnotationRequestDataAttributes
+     */
+    data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
+    /**
+     * A customer provided ID used for correlation.
+     * @type {string}
+     * @memberof CreateSceneAnnotationRequestDataAttributes
+     */
+    suppliedId?: string;
+}
+/**
+ *
+ * @export
+ * @interface CreateSceneAnnotationSetRequest
+ */
+export interface CreateSceneAnnotationSetRequest {
+    /**
+     *
+     * @type {CreateSceneAnnotationSetRequestData}
+     * @memberof CreateSceneAnnotationSetRequest
+     */
+    data: CreateSceneAnnotationSetRequestData;
+}
+/**
+ *
+ * @export
+ * @interface CreateSceneAnnotationSetRequestData
+ */
+export interface CreateSceneAnnotationSetRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof CreateSceneAnnotationSetRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {CreateSceneAnnotationSetRequestDataAttributes}
+     * @memberof CreateSceneAnnotationSetRequestData
+     */
+    attributes: CreateSceneAnnotationSetRequestDataAttributes;
+}
+/**
+ *
+ * @export
+ * @interface CreateSceneAnnotationSetRequestDataAttributes
+ */
+export interface CreateSceneAnnotationSetRequestDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSceneAnnotationSetRequestDataAttributes
+     */
+    name?: string;
+    /**
+     * A customer provided ID used for correlation.
+     * @type {string}
+     * @memberof CreateSceneAnnotationSetRequestDataAttributes
+     */
+    suppliedId?: string;
+}
 /**
  *
  * @export
@@ -4149,6 +4251,238 @@ export interface SceneAlterationList {
         [key: string]: Link;
     };
 }
+/**
+ *
+ * @export
+ * @interface SceneAnnotation
+ */
+export interface SceneAnnotation {
+    /**
+     *
+     * @type {SceneAnnotationData}
+     * @memberof SceneAnnotation
+     */
+    data: SceneAnnotationData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof SceneAnnotation
+     */
+    links?: {
+        [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
+ * @interface SceneAnnotationData
+ */
+export interface SceneAnnotationData {
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof SceneAnnotationData
+     */
+    id: string;
+    /**
+     *
+     * @type {SceneAnnotationDataAttributes}
+     * @memberof SceneAnnotationData
+     */
+    attributes: SceneAnnotationDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof SceneAnnotationData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface SceneAnnotationDataAttributes
+ */
+export interface SceneAnnotationDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationDataAttributes
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationDataAttributes
+     */
+    modifiedAt: string;
+    /**
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
+     * @memberof SceneAnnotationDataAttributes
+     */
+    data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationDataAttributes
+     */
+    suppliedId?: string;
+}
+/**
+ *
+ * @export
+ * @interface SceneAnnotationSet
+ */
+export interface SceneAnnotationSet {
+    /**
+     *
+     * @type {SceneAnnotationSetData}
+     * @memberof SceneAnnotationSet
+     */
+    data: SceneAnnotationSetData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof SceneAnnotationSet
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface SceneAnnotationSetData
+ */
+export interface SceneAnnotationSetData {
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationSetData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof SceneAnnotationSetData
+     */
+    id: string;
+    /**
+     *
+     * @type {SceneAnnotationSetDataAttributes}
+     * @memberof SceneAnnotationSetData
+     */
+    attributes: SceneAnnotationSetDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof SceneAnnotationSetData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface SceneAnnotationSetDataAttributes
+ */
+export interface SceneAnnotationSetDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationSetDataAttributes
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationSetDataAttributes
+     */
+    modifiedAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationSetDataAttributes
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SceneAnnotationSetDataAttributes
+     */
+    suppliedId?: string;
+}
 /**
  *
  * @export
@@ -5704,6 +6038,57 @@ export interface UpdatePartRevisionRequestDataRelationships {
      */
     defaultPartRendition?: PartRenditionRelationship;
 }
+/**
+ *
+ * @export
+ * @interface UpdateSceneAnnotationRequest
+ */
+export interface UpdateSceneAnnotationRequest {
+    /**
+     *
+     * @type {UpdateSceneAnnotationRequestData}
+     * @memberof UpdateSceneAnnotationRequest
+     */
+    data: UpdateSceneAnnotationRequestData;
+}
+/**
+ *
+ * @export
+ * @interface UpdateSceneAnnotationRequestData
+ */
+export interface UpdateSceneAnnotationRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof UpdateSceneAnnotationRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {UpdateSceneAnnotationRequestDataAttributes}
+     * @memberof UpdateSceneAnnotationRequestData
+     */
+    attributes: UpdateSceneAnnotationRequestDataAttributes;
+}
+/**
+ *
+ * @export
+ * @interface UpdateSceneAnnotationRequestDataAttributes
+ */
+export interface UpdateSceneAnnotationRequestDataAttributes {
+    /**
+     * The data describing how to render this annotation.
+     * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType}
+     * @memberof UpdateSceneAnnotationRequestDataAttributes
+     */
+    data?: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType;
+    /**
+     * A customer provided ID used for correlation.
+     * @type {string}
+     * @memberof UpdateSceneAnnotationRequestDataAttributes
+     */
+    suppliedId?: string | null;
+}
 /**
  *
  * @export
@@ -9463,6 +9848,227 @@ export declare class SceneAlterationsApi extends BaseAPI {
      */
     getSceneAlterations(requestParameters: SceneAlterationsApiGetSceneAlterationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SceneAlterationList, any>>;
 }
+/**
+ * SceneAnnotationsApi - axios parameter creator
+ * @export
+ */
+export declare const SceneAnnotationsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation-set&#x60; ID.
+     * @param {CreateSceneAnnotationRequest} createSceneAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSceneAnnotation: (id: string, createSceneAnnotationRequest: CreateSceneAnnotationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 &#x60;scene&#x60; ID.
+     * @param {CreateSceneAnnotationSetRequest} createSceneAnnotationSetRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSceneAnnotationSet: (id: string, createSceneAnnotationSetRequest: CreateSceneAnnotationSetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSceneAnnotation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation&#x60; ID.
+     * @param {UpdateSceneAnnotationRequest} updateSceneAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSceneAnnotation: (id: string, updateSceneAnnotationRequest: UpdateSceneAnnotationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SceneAnnotationsApi - functional programming interface
+ * @export
+ */
+export declare const SceneAnnotationsApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation-set&#x60; ID.
+     * @param {CreateSceneAnnotationRequest} createSceneAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSceneAnnotation(id: string, createSceneAnnotationRequest: CreateSceneAnnotationRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneAnnotation>>;
+    /**
+     * 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 &#x60;scene&#x60; ID.
+     * @param {CreateSceneAnnotationSetRequest} createSceneAnnotationSetRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSceneAnnotationSet(id: string, createSceneAnnotationSetRequest: CreateSceneAnnotationSetRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneAnnotationSet>>;
+    /**
+     * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSceneAnnotation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
+    /**
+     * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation&#x60; ID.
+     * @param {UpdateSceneAnnotationRequest} updateSceneAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSceneAnnotation(id: string, updateSceneAnnotationRequest: UpdateSceneAnnotationRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneAnnotation>>;
+};
+/**
+ * SceneAnnotationsApi - factory interface
+ * @export
+ */
+export declare const SceneAnnotationsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Create an annotation belonging to an annotation set. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation-set&#x60; ID.
+     * @param {CreateSceneAnnotationRequest} createSceneAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSceneAnnotation(id: string, createSceneAnnotationRequest: CreateSceneAnnotationRequest, options?: any): AxiosPromise<SceneAnnotation>;
+    /**
+     * 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 &#x60;scene&#x60; ID.
+     * @param {CreateSceneAnnotationSetRequest} createSceneAnnotationSetRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSceneAnnotationSet(id: string, createSceneAnnotationSetRequest: CreateSceneAnnotationSetRequest, options?: any): AxiosPromise<SceneAnnotationSet>;
+    /**
+     * Delete a scene annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSceneAnnotation(id: string, options?: any): AxiosPromise<void>;
+    /**
+     * Update the attributes of an annotation. **Preview:** This is a preview API and is subject to change.
+     * @param {string} id The &#x60;scene-annotation&#x60; ID.
+     * @param {UpdateSceneAnnotationRequest} updateSceneAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSceneAnnotation(id: string, updateSceneAnnotationRequest: UpdateSceneAnnotationRequest, options?: any): AxiosPromise<SceneAnnotation>;
+};
+/**
+ * Request parameters for createSceneAnnotation operation in SceneAnnotationsApi.
+ * @export
+ * @interface SceneAnnotationsApiCreateSceneAnnotationRequest
+ */
+export interface SceneAnnotationsApiCreateSceneAnnotationRequest {
+    /**
+     * The &#x60;scene-annotation-set&#x60; ID.
+     * @type {string}
+     * @memberof SceneAnnotationsApiCreateSceneAnnotation
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {CreateSceneAnnotationRequest}
+     * @memberof SceneAnnotationsApiCreateSceneAnnotation
+     */
+    readonly createSceneAnnotationRequest: CreateSceneAnnotationRequest;
+}
+/**
+ * Request parameters for createSceneAnnotationSet operation in SceneAnnotationsApi.
+ * @export
+ * @interface SceneAnnotationsApiCreateSceneAnnotationSetRequest
+ */
+export interface SceneAnnotationsApiCreateSceneAnnotationSetRequest {
+    /**
+     * The &#x60;scene&#x60; ID.
+     * @type {string}
+     * @memberof SceneAnnotationsApiCreateSceneAnnotationSet
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {CreateSceneAnnotationSetRequest}
+     * @memberof SceneAnnotationsApiCreateSceneAnnotationSet
+     */
+    readonly createSceneAnnotationSetRequest: CreateSceneAnnotationSetRequest;
+}
+/**
+ * Request parameters for deleteSceneAnnotation operation in SceneAnnotationsApi.
+ * @export
+ * @interface SceneAnnotationsApiDeleteSceneAnnotationRequest
+ */
+export interface SceneAnnotationsApiDeleteSceneAnnotationRequest {
+    /**
+     * The &#x60;scene-annotation&#x60; ID.
+     * @type {string}
+     * @memberof SceneAnnotationsApiDeleteSceneAnnotation
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for updateSceneAnnotation operation in SceneAnnotationsApi.
+ * @export
+ * @interface SceneAnnotationsApiUpdateSceneAnnotationRequest
+ */
+export interface SceneAnnotationsApiUpdateSceneAnnotationRequest {
+    /**
+     * The &#x60;scene-annotation&#x60; ID.
+     * @type {string}
+     * @memberof SceneAnnotationsApiUpdateSceneAnnotation
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {UpdateSceneAnnotationRequest}
+     * @memberof SceneAnnotationsApiUpdateSceneAnnotation
+     */
+    readonly updateSceneAnnotationRequest: UpdateSceneAnnotationRequest;
+}
+/**
+ * SceneAnnotationsApi - object-oriented interface
+ * @export
+ * @class SceneAnnotationsApi
+ * @extends {BaseAPI}
+ */
+export declare 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: SceneAnnotationsApiCreateSceneAnnotationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SceneAnnotation, any>>;
+    /**
+     * 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: SceneAnnotationsApiCreateSceneAnnotationSetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SceneAnnotationSet, any>>;
+    /**
+     * 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: SceneAnnotationsApiDeleteSceneAnnotationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * 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: SceneAnnotationsApiUpdateSceneAnnotationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SceneAnnotation, any>>;
+}
 /**
  * SceneItemOverridesApi - axios parameter creator
  * @export