@vertexvis/api-client-node 0.23.0 → 0.23.2

package/dist/cjs/api.d.ts

@@ -993,6 +993,12 @@ export interface CreateFileRequestDataAttributes {
      * @memberof CreateFileRequestDataAttributes
      */
     rootFileName?: string;
+    /**
+     * Number of seconds before the file is deleted.
+     * @type {number}
+     * @memberof CreateFileRequestDataAttributes
+     */
+    expiry?: number;
 }
 /**
  *
@@ -1626,6 +1632,12 @@ export interface CreateSceneItemRequestDataAttributes {
     metadata?: {
         [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
+    /**
+     * Specifies which metadata keys should be copied from the source item. Sending null will  default to all keys. Sending an empty string will copy none of the sources\' metadata.  Sending an array of [\"KEY1\", \"KEY2] will include KEY1 and KEY2 from the source in the scene item creation. This is marked experimental since future releases are expected to prevent copying metadata entirely.
+     * @type {Array<string>}
+     * @memberof CreateSceneItemRequestDataAttributes
+     */
+    experimentalSourceMetadataKeys?: Array<string>;
 }
 /**
  *
@@ -3015,6 +3027,100 @@ export interface MetadataStringType {
      */
     value: string;
 }
+/**
+ *
+ * @export
+ * @interface ModelView
+ */
+export interface ModelView {
+    /**
+     *
+     * @type {ModelViewData}
+     * @memberof ModelView
+     */
+    data: ModelViewData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof ModelView
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface ModelViewData
+ */
+export interface ModelViewData {
+    /**
+     *
+     * @type {string}
+     * @memberof ModelViewData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof ModelViewData
+     */
+    id: string;
+    /**
+     *
+     * @type {CreateAccountRequestDataAttributes}
+     * @memberof ModelViewData
+     */
+    attributes: CreateAccountRequestDataAttributes;
+    /**
+     *
+     * @type {ModelViewDataRelationships}
+     * @memberof ModelViewData
+     */
+    relationships: ModelViewDataRelationships;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof ModelViewData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface ModelViewDataRelationships
+ */
+export interface ModelViewDataRelationships {
+    /**
+     *
+     * @type {PartRevisionRelationship}
+     * @memberof ModelViewDataRelationships
+     */
+    partRevision: PartRevisionRelationship;
+}
+/**
+ *
+ * @export
+ * @interface ModelViewList
+ */
+export interface ModelViewList {
+    /**
+     *
+     * @type {Array<ModelViewData>}
+     * @memberof ModelViewList
+     */
+    data: Array<ModelViewData>;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof ModelViewList
+     */
+    links: {
+        [key: string]: Link;
+    };
+}
 /**
  *
  * @export
@@ -3732,6 +3838,60 @@ export interface PerspectiveCamera {
      */
     fovY?: number;
 }
+/**
+ *
+ * @export
+ * @interface PmiAnnotationData
+ */
+export interface PmiAnnotationData {
+    /**
+     *
+     * @type {string}
+     * @memberof PmiAnnotationData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof PmiAnnotationData
+     */
+    id: string;
+    /**
+     *
+     * @type {CreateAccountRequestDataAttributes}
+     * @memberof PmiAnnotationData
+     */
+    attributes: CreateAccountRequestDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof PmiAnnotationData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface PmiAnnotationList
+ */
+export interface PmiAnnotationList {
+    /**
+     *
+     * @type {Array<PmiAnnotationData>}
+     * @memberof PmiAnnotationList
+     */
+    data: Array<PmiAnnotationData>;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof PmiAnnotationList
+     */
+    links: {
+        [key: string]: Link;
+    };
+}
 /**
  * 2D point.
  * @export
@@ -5971,6 +6131,51 @@ export interface UpdateApplicationRequestDataAttributes {
      */
     redirect_uris?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface UpdateFileRequest
+ */
+export interface UpdateFileRequest {
+    /**
+     *
+     * @type {UpdateFileRequestData}
+     * @memberof UpdateFileRequest
+     */
+    data: UpdateFileRequestData;
+}
+/**
+ *
+ * @export
+ * @interface UpdateFileRequestData
+ */
+export interface UpdateFileRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof UpdateFileRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {UpdateFileRequestDataAttributes}
+     * @memberof UpdateFileRequestData
+     */
+    attributes: UpdateFileRequestDataAttributes;
+}
+/**
+ *
+ * @export
+ * @interface UpdateFileRequestDataAttributes
+ */
+export interface UpdateFileRequestDataAttributes {
+    /**
+     * Number of seconds before the file is deleted.
+     * @type {number}
+     * @memberof UpdateFileRequestDataAttributes
+     */
+    expiry?: number | null;
+}
 /**
  * An operation that updates items with the specified revision to the default rendition.
  * @export
@@ -8026,6 +8231,14 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration |
      * @throws {RequiredError}
      */
     getFiles: (pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a `file`.
+     * @param {string} id The &#x60;file&#x60; ID.
+     * @param {UpdateFileRequest} updateFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFile: (id: string, updateFileRequest: UpdateFileRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
      * @param {string} id The &#x60;file&#x60; ID.
@@ -8070,6 +8283,14 @@ export declare const FilesApiFp: (configuration?: Configuration | undefined) =>
      * @throws {RequiredError}
      */
     getFiles(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileList>>;
+    /**
+     * Update a `file`.
+     * @param {string} id The &#x60;file&#x60; ID.
+     * @param {UpdateFileRequest} updateFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFile(id: string, updateFileRequest: UpdateFileRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileMetadata>>;
     /**
      * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
      * @param {string} id The &#x60;file&#x60; ID.
@@ -8114,6 +8335,14 @@ export declare const FilesApiFactory: (configuration?: Configuration | undefined
      * @throws {RequiredError}
      */
     getFiles(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<FileList>;
+    /**
+     * Update a `file`.
+     * @param {string} id The &#x60;file&#x60; ID.
+     * @param {UpdateFileRequest} updateFileRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFile(id: string, updateFileRequest: UpdateFileRequest, options?: any): AxiosPromise<FileMetadata>;
     /**
      * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
      * @param {string} id The &#x60;file&#x60; ID.
@@ -8187,6 +8416,25 @@ export interface FilesApiGetFilesRequest {
      */
     readonly filterSuppliedId?: string;
 }
+/**
+ * Request parameters for updateFile operation in FilesApi.
+ * @export
+ * @interface FilesApiUpdateFileRequest
+ */
+export interface FilesApiUpdateFileRequest {
+    /**
+     * The &#x60;file&#x60; ID.
+     * @type {string}
+     * @memberof FilesApiUpdateFile
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {UpdateFileRequest}
+     * @memberof FilesApiUpdateFile
+     */
+    readonly updateFileRequest: UpdateFileRequest;
+}
 /**
  * Request parameters for uploadFile operation in FilesApi.
  * @export
@@ -8245,6 +8493,14 @@ export declare class FilesApi extends BaseAPI {
      * @memberof FilesApi
      */
     getFiles(requestParameters?: FilesApiGetFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileList, any>>;
+    /**
+     * Update a `file`.
+     * @param {FilesApiUpdateFileRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    updateFile(requestParameters: FilesApiUpdateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileMetadata, any>>;
     /**
      * Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
      * @param {FilesApiUploadFileRequest} requestParameters Request parameters.
@@ -8579,6 +8835,212 @@ export declare class HitsApi extends BaseAPI {
      */
     createSceneViewHit(requestParameters: HitsApiCreateSceneViewHitRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Hit, any>>;
 }
+/**
+ * ModelViewsApi - axios parameter creator
+ * @export
+ */
+export declare const ModelViewsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Get the details of a `model-view`.
+     * @param {string} id The &#x60;model-view&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getModelView: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a paged list of `model-views` for a part revision.
+     * @param {string} id The &#x60;part-revision&#x60; ID.
+     * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartRevisionModelViews: (id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a paged list of `model-views` for a scene item.
+     * @param {string} id The &#x60;scene-item&#x60; ID.
+     * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSceneItemModelViews: (id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ModelViewsApi - functional programming interface
+ * @export
+ */
+export declare const ModelViewsApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Get the details of a `model-view`.
+     * @param {string} id The &#x60;model-view&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getModelView(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ModelView>>;
+    /**
+     * Get a paged list of `model-views` for a part revision.
+     * @param {string} id The &#x60;part-revision&#x60; ID.
+     * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartRevisionModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ModelViewList>>;
+    /**
+     * Get a paged list of `model-views` for a scene item.
+     * @param {string} id The &#x60;scene-item&#x60; ID.
+     * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSceneItemModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ModelViewList>>;
+};
+/**
+ * ModelViewsApi - factory interface
+ * @export
+ */
+export declare const ModelViewsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Get the details of a `model-view`.
+     * @param {string} id The &#x60;model-view&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getModelView(id: string, options?: any): AxiosPromise<ModelView>;
+    /**
+     * Get a paged list of `model-views` for a part revision.
+     * @param {string} id The &#x60;part-revision&#x60; ID.
+     * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartRevisionModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<ModelViewList>;
+    /**
+     * Get a paged list of `model-views` for a scene item.
+     * @param {string} id The &#x60;scene-item&#x60; ID.
+     * @param {boolean} [filterHasAnnotations] Filter model views that contain or do not contain annotations.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSceneItemModelViews(id: string, filterHasAnnotations?: boolean | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<ModelViewList>;
+};
+/**
+ * Request parameters for getModelView operation in ModelViewsApi.
+ * @export
+ * @interface ModelViewsApiGetModelViewRequest
+ */
+export interface ModelViewsApiGetModelViewRequest {
+    /**
+     * The &#x60;model-view&#x60; ID.
+     * @type {string}
+     * @memberof ModelViewsApiGetModelView
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getPartRevisionModelViews operation in ModelViewsApi.
+ * @export
+ * @interface ModelViewsApiGetPartRevisionModelViewsRequest
+ */
+export interface ModelViewsApiGetPartRevisionModelViewsRequest {
+    /**
+     * The &#x60;part-revision&#x60; ID.
+     * @type {string}
+     * @memberof ModelViewsApiGetPartRevisionModelViews
+     */
+    readonly id: string;
+    /**
+     * Filter model views that contain or do not contain annotations.
+     * @type {boolean}
+     * @memberof ModelViewsApiGetPartRevisionModelViews
+     */
+    readonly filterHasAnnotations?: boolean;
+    /**
+     * The cursor for the next page of items.
+     * @type {string}
+     * @memberof ModelViewsApiGetPartRevisionModelViews
+     */
+    readonly pageCursor?: string;
+    /**
+     * The number of items to return.
+     * @type {number}
+     * @memberof ModelViewsApiGetPartRevisionModelViews
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for getSceneItemModelViews operation in ModelViewsApi.
+ * @export
+ * @interface ModelViewsApiGetSceneItemModelViewsRequest
+ */
+export interface ModelViewsApiGetSceneItemModelViewsRequest {
+    /**
+     * The &#x60;scene-item&#x60; ID.
+     * @type {string}
+     * @memberof ModelViewsApiGetSceneItemModelViews
+     */
+    readonly id: string;
+    /**
+     * Filter model views that contain or do not contain annotations.
+     * @type {boolean}
+     * @memberof ModelViewsApiGetSceneItemModelViews
+     */
+    readonly filterHasAnnotations?: boolean;
+    /**
+     * The cursor for the next page of items.
+     * @type {string}
+     * @memberof ModelViewsApiGetSceneItemModelViews
+     */
+    readonly pageCursor?: string;
+    /**
+     * The number of items to return.
+     * @type {number}
+     * @memberof ModelViewsApiGetSceneItemModelViews
+     */
+    readonly pageSize?: number;
+}
+/**
+ * ModelViewsApi - object-oriented interface
+ * @export
+ * @class ModelViewsApi
+ * @extends {BaseAPI}
+ */
+export declare class ModelViewsApi extends BaseAPI {
+    /**
+     * Get the details of a `model-view`.
+     * @param {ModelViewsApiGetModelViewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelViewsApi
+     */
+    getModelView(requestParameters: ModelViewsApiGetModelViewRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelView, any>>;
+    /**
+     * Get a paged list of `model-views` for a part revision.
+     * @param {ModelViewsApiGetPartRevisionModelViewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelViewsApi
+     */
+    getPartRevisionModelViews(requestParameters: ModelViewsApiGetPartRevisionModelViewsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelViewList, any>>;
+    /**
+     * Get a paged list of `model-views` for a scene item.
+     * @param {ModelViewsApiGetSceneItemModelViewsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelViewsApi
+     */
+    getSceneItemModelViews(requestParameters: ModelViewsApiGetSceneItemModelViewsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelViewList, any>>;
+}
 /**
  * Oauth2Api - axios parameter creator
  * @export
@@ -9709,6 +10171,92 @@ export declare class PartsApi extends BaseAPI {
      */
     getQueuedPartDeletion(requestParameters: PartsApiGetQueuedPartDeletionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
 }
+/**
+ * PmiApi - axios parameter creator
+ * @export
+ */
+export declare const PmiApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * List `pmi-annotation`s.
+     * @param {string} [filterModelViewId] Filter annotations belonging to a model view.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPmiAnnotations: (filterModelViewId?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PmiApi - functional programming interface
+ * @export
+ */
+export declare const PmiApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * List `pmi-annotation`s.
+     * @param {string} [filterModelViewId] Filter annotations belonging to a model view.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPmiAnnotations(filterModelViewId?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<PmiAnnotationList>>;
+};
+/**
+ * PmiApi - factory interface
+ * @export
+ */
+export declare const PmiApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * List `pmi-annotation`s.
+     * @param {string} [filterModelViewId] Filter annotations belonging to a model view.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPmiAnnotations(filterModelViewId?: string | undefined, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<PmiAnnotationList>;
+};
+/**
+ * Request parameters for getPmiAnnotations operation in PmiApi.
+ * @export
+ * @interface PmiApiGetPmiAnnotationsRequest
+ */
+export interface PmiApiGetPmiAnnotationsRequest {
+    /**
+     * Filter annotations belonging to a model view.
+     * @type {string}
+     * @memberof PmiApiGetPmiAnnotations
+     */
+    readonly filterModelViewId?: string;
+    /**
+     * The cursor for the next page of items.
+     * @type {string}
+     * @memberof PmiApiGetPmiAnnotations
+     */
+    readonly pageCursor?: string;
+    /**
+     * The number of items to return.
+     * @type {number}
+     * @memberof PmiApiGetPmiAnnotations
+     */
+    readonly pageSize?: number;
+}
+/**
+ * PmiApi - object-oriented interface
+ * @export
+ * @class PmiApi
+ * @extends {BaseAPI}
+ */
+export declare class PmiApi extends BaseAPI {
+    /**
+     * List `pmi-annotation`s.
+     * @param {PmiApiGetPmiAnnotationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PmiApi
+     */
+    getPmiAnnotations(requestParameters?: PmiApiGetPmiAnnotationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PmiAnnotationList, any>>;
+}
 /**
  * SceneAlterationsApi - axios parameter creator
  * @export