@vertexvis/api-client-node 0.16.0 → 0.17.2

package/dist/cjs/api.d.ts

@@ -511,6 +511,13 @@ export interface BoundingBox {
      */
     max: Vector3;
 }
+/**
+ * Describes the options for configuring a CAD file export.
+ * @export
+ * @interface CADExportConfig
+ */
+export interface CADExportConfig extends ExportConfig {
+}
 /**
  * Fit camera in 3D space based on items in scene.
  * @export
@@ -814,6 +821,76 @@ export interface CreateBatchRequest {
      */
     'vertexvis/batch:operations': Array<BatchOperation>;
 }
+/**
+ *
+ * @export
+ * @interface CreateExportRequest
+ */
+export interface CreateExportRequest {
+    /**
+     *
+     * @type {CreateExportRequestData}
+     * @memberof CreateExportRequest
+     */
+    data: CreateExportRequestData;
+}
+/**
+ *
+ * @export
+ * @interface CreateExportRequestData
+ */
+export interface CreateExportRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof CreateExportRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {CreateExportRequestDataAttributes}
+     * @memberof CreateExportRequestData
+     */
+    attributes: CreateExportRequestDataAttributes;
+    /**
+     *
+     * @type {CreateExportRequestDataRelationships}
+     * @memberof CreateExportRequestData
+     */
+    relationships: CreateExportRequestDataRelationships;
+}
+/**
+ *
+ * @export
+ * @interface CreateExportRequestDataAttributes
+ */
+export interface CreateExportRequestDataAttributes {
+    /**
+     * Specifies the export format and options to configure the export.
+     * @type {CADExportConfig}
+     * @memberof CreateExportRequestDataAttributes
+     */
+    config: CADExportConfig;
+}
+/**
+ *
+ * @export
+ * @interface CreateExportRequestDataRelationships
+ */
+export interface CreateExportRequestDataRelationships {
+    /**
+     *
+     * @type {ExportRelationship}
+     * @memberof CreateExportRequestDataRelationships
+     */
+    source: ExportRelationship;
+    /**
+     *
+     * @type {ExportStateRelationship}
+     * @memberof CreateExportRequestDataRelationships
+     */
+    state?: ExportStateRelationship;
+}
 /**
  *
  * @export
@@ -1779,6 +1856,164 @@ export interface Dimensions {
      */
     width: number;
 }
+/**
+ *
+ * @export
+ * @interface Export
+ */
+export interface Export {
+    /**
+     *
+     * @type {ExportData}
+     * @memberof Export
+     */
+    data: ExportData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof Export
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ * Describes the options for configuring a file export.
+ * @export
+ * @interface ExportConfig
+ */
+export interface ExportConfig {
+    /**
+     *
+     * @type {string}
+     * @memberof ExportConfig
+     */
+    format: string;
+}
+/**
+ *
+ * @export
+ * @interface ExportData
+ */
+export interface ExportData {
+    /**
+     *
+     * @type {string}
+     * @memberof ExportData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof ExportData
+     */
+    id: string;
+    /**
+     *
+     * @type {ExportDataAttributes}
+     * @memberof ExportData
+     */
+    attributes: ExportDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof ExportData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface ExportDataAttributes
+ */
+export interface ExportDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof ExportDataAttributes
+     */
+    created: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExportDataAttributes
+     */
+    downloadUrl: string;
+}
+/**
+ * Relationship to an `export`.
+ * @export
+ * @interface ExportRelationship
+ */
+export interface ExportRelationship {
+    /**
+     *
+     * @type {ExportRelationshipData}
+     * @memberof ExportRelationship
+     */
+    data: ExportRelationshipData;
+}
+/**
+ *
+ * @export
+ * @interface ExportRelationshipData
+ */
+export interface ExportRelationshipData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof ExportRelationshipData
+     */
+    type: ExportRelationshipDataTypeEnum;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof ExportRelationshipData
+     */
+    id: string;
+}
+export declare const ExportRelationshipDataTypeEnum: {
+    readonly Scene: "scene";
+};
+export declare type ExportRelationshipDataTypeEnum = typeof ExportRelationshipDataTypeEnum[keyof typeof ExportRelationshipDataTypeEnum];
+/**
+ * Relationship to an `export`.
+ * @export
+ * @interface ExportStateRelationship
+ */
+export interface ExportStateRelationship {
+    /**
+     *
+     * @type {ExportStateRelationshipData}
+     * @memberof ExportStateRelationship
+     */
+    data: ExportStateRelationshipData;
+}
+/**
+ *
+ * @export
+ * @interface ExportStateRelationshipData
+ */
+export interface ExportStateRelationshipData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof ExportStateRelationshipData
+     */
+    type: ExportStateRelationshipDataTypeEnum;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof ExportStateRelationshipData
+     */
+    id: string;
+}
+export declare const ExportStateRelationshipDataTypeEnum: {
+    readonly SceneViewState: "scene-view-state";
+};
+export declare type ExportStateRelationshipDataTypeEnum = typeof ExportStateRelationshipDataTypeEnum[keyof typeof ExportStateRelationshipDataTypeEnum];
 /**
  *
  * @export
@@ -1808,6 +2043,25 @@ export interface Failure {
         [key: string]: Link;
     };
 }
+/**
+ *
+ * @export
+ * @interface FeatureLines
+ */
+export interface FeatureLines {
+    /**
+     *
+     * @type {Color3}
+     * @memberof FeatureLines
+     */
+    color: Color3;
+    /**
+     *
+     * @type {number}
+     * @memberof FeatureLines
+     */
+    width: number;
+}
 /**
  *
  * @export
@@ -4024,6 +4278,12 @@ export interface SceneViewStateDataAttributes {
      * @memberof SceneViewStateDataAttributes
      */
     thumbnails?: Array<ThumbnailData>;
+    /**
+     *
+     * @type {FeatureLines}
+     * @memberof SceneViewStateDataAttributes
+     */
+    featureLines?: FeatureLines;
 }
 /**
  *
@@ -5860,6 +6120,158 @@ export declare class BatchesApi extends BaseAPI {
      */
     getQueuedBatch(requestParameters: BatchesApiGetQueuedBatchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
 }
+/**
+ * ExportsApi - axios parameter creator
+ * @export
+ */
+export declare const ExportsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {CreateExportRequest} createExportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExport: (createExportRequest: CreateExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an `export` by ID.
+     * @param {string} id The &#x60;export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {string} id The &#x60;queued-export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedExport: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ExportsApi - functional programming interface
+ * @export
+ */
+export declare const ExportsApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {CreateExportRequest} createExportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExport(createExportRequest: CreateExportRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
+    /**
+     * Get an `export` by ID.
+     * @param {string} id The &#x60;export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Export>>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {string} id The &#x60;queued-export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedExport(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
+};
+/**
+ * ExportsApi - factory interface
+ * @export
+ */
+export declare const ExportsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {CreateExportRequest} createExportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExport(createExportRequest: CreateExportRequest, options?: any): AxiosPromise<QueuedJob>;
+    /**
+     * Get an `export` by ID.
+     * @param {string} id The &#x60;export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport(id: string, options?: any): AxiosPromise<Export>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {string} id The &#x60;queued-export&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuedExport(id: string, options?: any): AxiosPromise<QueuedJob>;
+};
+/**
+ * Request parameters for createExport operation in ExportsApi.
+ * @export
+ * @interface ExportsApiCreateExportRequest
+ */
+export interface ExportsApiCreateExportRequest {
+    /**
+     *
+     * @type {CreateExportRequest}
+     * @memberof ExportsApiCreateExport
+     */
+    readonly createExportRequest: CreateExportRequest;
+}
+/**
+ * Request parameters for getExport operation in ExportsApi.
+ * @export
+ * @interface ExportsApiGetExportRequest
+ */
+export interface ExportsApiGetExportRequest {
+    /**
+     * The &#x60;export&#x60; ID.
+     * @type {string}
+     * @memberof ExportsApiGetExport
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getQueuedExport operation in ExportsApi.
+ * @export
+ * @interface ExportsApiGetQueuedExportRequest
+ */
+export interface ExportsApiGetQueuedExportRequest {
+    /**
+     * The &#x60;queued-export&#x60; ID.
+     * @type {string}
+     * @memberof ExportsApiGetQueuedExport
+     */
+    readonly id: string;
+}
+/**
+ * ExportsApi - object-oriented interface
+ * @export
+ * @class ExportsApi
+ * @extends {BaseAPI}
+ */
+export declare class ExportsApi extends BaseAPI {
+    /**
+     * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
+     * @param {ExportsApiCreateExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    createExport(requestParameters: ExportsApiCreateExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
+    /**
+     * Get an `export` by ID.
+     * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    getExport(requestParameters: ExportsApiGetExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Export, any>>;
+    /**
+     * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
+     * @param {ExportsApiGetQueuedExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExportsApi
+     */
+    getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
+}
 /**
  * FilesApi - axios parameter creator
  * @export