@vertexvis/api-client-node 0.23.4 → 0.26.0

package/dist/cjs/api.d.ts

@@ -861,6 +861,57 @@ export interface CreateBatchRequest {
      */
     'vertexvis/batch:operations': Array<BatchOperation>;
 }
+/**
+ *
+ * @export
+ * @interface CreateDownloadRequest
+ */
+export interface CreateDownloadRequest {
+    /**
+     *
+     * @type {CreateDownloadRequestData}
+     * @memberof CreateDownloadRequest
+     */
+    data: CreateDownloadRequestData;
+}
+/**
+ *
+ * @export
+ * @interface CreateDownloadRequestData
+ */
+export interface CreateDownloadRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof CreateDownloadRequestData
+     */
+    type: string;
+    /**
+     *
+     * @type {CreateDownloadRequestDataAttributes}
+     * @memberof CreateDownloadRequestData
+     */
+    attributes: CreateDownloadRequestDataAttributes;
+}
+/**
+ *
+ * @export
+ * @interface CreateDownloadRequestDataAttributes
+ */
+export interface CreateDownloadRequestDataAttributes {
+    /**
+     * Specifies the duration for which this pre-signed request should be valid. After this time has expired, attempting to use the presigned request will fail. (Defaults to 1 hour, max value is 24 hours)
+     * @type {number}
+     * @memberof CreateDownloadRequestDataAttributes
+     */
+    expiry?: number;
+    /**
+     * Specifies the maximum time (in seconds) a cached response of a signed-url remains fresh and can be used without revalidation. (Defaults to 1 hour, can send up to 30 days)
+     * @type {number}
+     * @memberof CreateDownloadRequestDataAttributes
+     */
+    maxAge?: number;
+}
 /**
  *
  * @export
@@ -937,6 +988,75 @@ export interface CreateExportRequestDataRelationships {
      */
     state?: ExportStateRelationship;
 }
+/**
+ *
+ * @export
+ * @interface CreateFileCollectionRequest
+ */
+export interface CreateFileCollectionRequest {
+    /**
+     *
+     * @type {CreateFileCollectionRequestData}
+     * @memberof CreateFileCollectionRequest
+     */
+    data: CreateFileCollectionRequestData;
+}
+/**
+ *
+ * @export
+ * @interface CreateFileCollectionRequestData
+ */
+export interface CreateFileCollectionRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof CreateFileCollectionRequestData
+     */
+    type: CreateFileCollectionRequestDataTypeEnum;
+    /**
+     *
+     * @type {CreateFileCollectionRequestDataAttributes}
+     * @memberof CreateFileCollectionRequestData
+     */
+    attributes: CreateFileCollectionRequestDataAttributes;
+}
+export declare const CreateFileCollectionRequestDataTypeEnum: {
+    readonly FileCollection: "file-collection";
+};
+export declare type CreateFileCollectionRequestDataTypeEnum = (typeof CreateFileCollectionRequestDataTypeEnum)[keyof typeof CreateFileCollectionRequestDataTypeEnum];
+/**
+ *
+ * @export
+ * @interface CreateFileCollectionRequestDataAttributes
+ */
+export interface CreateFileCollectionRequestDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateFileCollectionRequestDataAttributes
+     */
+    name?: string;
+    /**
+     * ID provided for correlation with external systems, e.g. a PLM system.
+     * @type {string}
+     * @memberof CreateFileCollectionRequestDataAttributes
+     */
+    suppliedId?: string;
+    /**
+     * Number of seconds before expiration
+     * @type {number}
+     * @memberof CreateFileCollectionRequestDataAttributes
+     */
+    expiry?: number;
+    /**
+     * User supplied key-value pairs for a file-collection. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateFileCollectionRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+}
 /**
  *
  * @export
@@ -999,6 +1119,14 @@ export interface CreateFileRequestDataAttributes {
      * @memberof CreateFileRequestDataAttributes
      */
     expiry?: number;
+    /**
+     * User supplied key-value pairs for a file. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateFileRequestDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 /**
  *
@@ -1970,11 +2098,29 @@ export interface CreateStreamKeyRequestDataAttributes {
      */
     expiry?: number;
     /**
-     * Whether to exclude non-visible items in the view
+     * Whether to exclude non-visible items in the view.
      * @type {boolean}
      * @memberof CreateStreamKeyRequestDataAttributes
      */
     excludePrunedItems?: boolean;
+    /**
+     * An optional supplied ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateId`.
+     * @type {string}
+     * @memberof CreateStreamKeyRequestDataAttributes
+     */
+    sceneViewStateSuppliedId?: string;
+    /**
+     * An optional ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateSuppliedId`.
+     * @type {string}
+     * @memberof CreateStreamKeyRequestDataAttributes
+     */
+    sceneViewStateId?: string;
+    /**
+     * Optionally enables or disables the creation of a search session for the view.
+     * @type {boolean}
+     * @memberof CreateStreamKeyRequestDataAttributes
+     */
+    withSearchSession?: boolean;
 }
 /**
  *
@@ -2189,6 +2335,73 @@ export interface Dimensions {
      */
     width: number;
 }
+/**
+ *
+ * @export
+ * @interface DownloadUrl
+ */
+export interface DownloadUrl {
+    /**
+     *
+     * @type {DownloadUrlData}
+     * @memberof DownloadUrl
+     */
+    data: DownloadUrlData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof DownloadUrl
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface DownloadUrlData
+ */
+export interface DownloadUrlData {
+    /**
+     *
+     * @type {string}
+     * @memberof DownloadUrlData
+     */
+    type: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof DownloadUrlData
+     */
+    id: string;
+    /**
+     *
+     * @type {DownloadUrlDataAttributes}
+     * @memberof DownloadUrlData
+     */
+    attributes: DownloadUrlDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof DownloadUrlData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface DownloadUrlDataAttributes
+ */
+export interface DownloadUrlDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof DownloadUrlDataAttributes
+     */
+    downloadUrl: string;
+}
 /**
  *
  * @export
@@ -2395,6 +2608,131 @@ export interface FeatureLines {
      */
     width: number;
 }
+/**
+ *
+ * @export
+ * @interface FileCollectionList
+ */
+export interface FileCollectionList {
+    /**
+     *
+     * @type {Array<FileCollectionMetadataData>}
+     * @memberof FileCollectionList
+     */
+    data: Array<FileCollectionMetadataData>;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof FileCollectionList
+     */
+    links: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface FileCollectionMetadata
+ */
+export interface FileCollectionMetadata {
+    /**
+     *
+     * @type {FileCollectionMetadataData}
+     * @memberof FileCollectionMetadata
+     */
+    data: FileCollectionMetadataData;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof FileCollectionMetadata
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+/**
+ *
+ * @export
+ * @interface FileCollectionMetadataData
+ */
+export interface FileCollectionMetadataData {
+    /**
+     *
+     * @type {string}
+     * @memberof FileCollectionMetadataData
+     */
+    type: FileCollectionMetadataDataTypeEnum;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof FileCollectionMetadataData
+     */
+    id: string;
+    /**
+     *
+     * @type {FileCollectionMetadataDataAttributes}
+     * @memberof FileCollectionMetadataData
+     */
+    attributes: FileCollectionMetadataDataAttributes;
+    /**
+     *
+     * @type {{ [key: string]: Link; }}
+     * @memberof FileCollectionMetadataData
+     */
+    links?: {
+        [key: string]: Link;
+    };
+}
+export declare const FileCollectionMetadataDataTypeEnum: {
+    readonly FileCollection: "file-collection";
+};
+export declare type FileCollectionMetadataDataTypeEnum = (typeof FileCollectionMetadataDataTypeEnum)[keyof typeof FileCollectionMetadataDataTypeEnum];
+/**
+ *
+ * @export
+ * @interface FileCollectionMetadataDataAttributes
+ */
+export interface FileCollectionMetadataDataAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof FileCollectionMetadataDataAttributes
+     */
+    name?: string;
+    /**
+     * ID provided for correlation with external systems, e.g. a PLM system.
+     * @type {string}
+     * @memberof FileCollectionMetadataDataAttributes
+     */
+    suppliedId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FileCollectionMetadataDataAttributes
+     */
+    created: string;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof FileCollectionMetadataDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+}
+/**
+ *
+ * @export
+ * @interface FileIdList
+ */
+export interface FileIdList {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileIdList
+     */
+    data: Array<string>;
+}
 /**
  *
  * @export
@@ -2518,6 +2856,14 @@ export interface FileMetadataDataAttributes {
      * @memberof FileMetadataDataAttributes
      */
     size?: number;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof FileMetadataDataAttributes
+     */
+    metadata?: {
+        [key: string]: string;
+    };
 }
 /**
  * Relationship to a `file`.
@@ -4174,12 +4520,6 @@ export interface PropertyEntryList {
  * @interface PropertyKeyType
  */
 export interface PropertyKeyType {
-    /**
-     * The key category
-     * @type {string}
-     * @memberof PropertyKeyType
-     */
-    category: PropertyKeyTypeCategoryEnum;
     /**
      *
      * @type {string}
@@ -4187,12 +4527,6 @@ export interface PropertyKeyType {
      */
     name: string;
 }
-export declare const PropertyKeyTypeCategoryEnum: {
-    readonly Vendor: "vendor";
-    readonly Vertex: "vertex";
-    readonly User: "user";
-};
-export declare type PropertyKeyTypeCategoryEnum = (typeof PropertyKeyTypeCategoryEnum)[keyof typeof PropertyKeyTypeCategoryEnum];
 /**
  *
  * @export
@@ -4407,15 +4741,76 @@ export declare type QueryByIdDataAttributesTypeEnum = (typeof QueryByIdDataAttri
 /**
  *
  * @export
- * @interface QueuedJob
+ * @interface QueryByMetadata
  */
-export interface QueuedJob {
+export interface QueryByMetadata {
     /**
      *
-     * @type {QueuedJobData}
-     * @memberof QueuedJob
+     * @type {QueryByMetadataData}
+     * @memberof QueryByMetadata
      */
-    data: QueuedJobData;
+    data: QueryByMetadataData;
+}
+/**
+ *
+ * @export
+ * @interface QueryByMetadataData
+ */
+export interface QueryByMetadataData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof QueryByMetadataData
+     */
+    type: QueryByMetadataDataTypeEnum;
+    /**
+     *
+     * @type {QueryByMetadataDataAttributes}
+     * @memberof QueryByMetadataData
+     */
+    attributes: QueryByMetadataDataAttributes;
+}
+export declare const QueryByMetadataDataTypeEnum: {
+    readonly QueryByMetadata: "query-by-metadata";
+};
+export declare type QueryByMetadataDataTypeEnum = (typeof QueryByMetadataDataTypeEnum)[keyof typeof QueryByMetadataDataTypeEnum];
+/**
+ *
+ * @export
+ * @interface QueryByMetadataDataAttributes
+ */
+export interface QueryByMetadataDataAttributes {
+    /**
+     *
+     * @type {boolean}
+     * @memberof QueryByMetadataDataAttributes
+     */
+    exactMatch?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryByMetadataDataAttributes
+     */
+    filter: string;
+    /**
+     * Query `metadata`.
+     * @type {Array<string>}
+     * @memberof QueryByMetadataDataAttributes
+     */
+    keys: Array<string>;
+}
+/**
+ *
+ * @export
+ * @interface QueuedJob
+ */
+export interface QueuedJob {
+    /**
+     *
+     * @type {QueuedJobData}
+     * @memberof QueuedJob
+     */
+    data: QueuedJobData;
     /**
      *
      * @type {{ [key: string]: Link; }}
@@ -5568,10 +5963,10 @@ export interface SceneList {
 export interface SceneOperation {
     /**
      * Query `scene-items`. Use `query-by-collection` to combine multiple queries.
-     * @type {QueryById | QueryByCollection | QueryAll}
+     * @type {QueryById | QueryByCollection | QueryAll | QueryByMetadata}
      * @memberof SceneOperation
      */
-    query: QueryById | QueryByCollection | QueryAll;
+    query: QueryById | QueryByCollection | QueryAll | QueryByMetadata;
     /**
      * List of operations to perform on `scene-items` matching the query.
      * @type {Array<ChangeVisibilityOp | ChangeMaterialOp | ClearMaterialOp | ChangeTransformOp | ClearTransformOp | SelectOp | DeselectOperation | ClearRenOp | ViewDefaultRenOp | ViewRenByIdOp | ViewRenBySuppliedIdOp | ViewRepByIdOp | ViewRepByPredefinedIdOp | ClearRepOp>}
@@ -6270,6 +6665,18 @@ export interface StreamKeyDataAttributes {
      * @memberof StreamKeyDataAttributes
      */
     excludePrunedItems?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof StreamKeyDataAttributes
+     */
+    sceneViewStateSuppliedId?: string;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof StreamKeyDataAttributes
+     */
+    sceneViewStateId?: string;
 }
 /**
  *
@@ -6495,6 +6902,55 @@ export interface UpdateApplicationRequestDataAttributes {
      */
     redirect_uris?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface UpdateFileCollectionRequest
+ */
+export interface UpdateFileCollectionRequest {
+    /**
+     *
+     * @type {UpdateFileCollectionRequestData}
+     * @memberof UpdateFileCollectionRequest
+     */
+    data: UpdateFileCollectionRequestData;
+}
+/**
+ *
+ * @export
+ * @interface UpdateFileCollectionRequestData
+ */
+export interface UpdateFileCollectionRequestData {
+    /**
+     * Resource object type.
+     * @type {string}
+     * @memberof UpdateFileCollectionRequestData
+     */
+    type: UpdateFileCollectionRequestDataTypeEnum;
+    /**
+     *
+     * @type {UpdateFileCollectionRequestDataAttributes}
+     * @memberof UpdateFileCollectionRequestData
+     */
+    attributes: UpdateFileCollectionRequestDataAttributes;
+}
+export declare const UpdateFileCollectionRequestDataTypeEnum: {
+    readonly FileCollection: "file-collection";
+};
+export declare type UpdateFileCollectionRequestDataTypeEnum = (typeof UpdateFileCollectionRequestDataTypeEnum)[keyof typeof UpdateFileCollectionRequestDataTypeEnum];
+/**
+ *
+ * @export
+ * @interface UpdateFileCollectionRequestDataAttributes
+ */
+export interface UpdateFileCollectionRequestDataAttributes {
+    /**
+     * Number of seconds before expiration
+     * @type {number}
+     * @memberof UpdateFileCollectionRequestDataAttributes
+     */
+    expiry?: number;
+}
 /**
  *
  * @export
@@ -8626,11 +9082,393 @@ export declare class ExportsApi extends BaseAPI {
      */
     getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
 }
+/**
+ * FileCollectionsApi - axios parameter creator
+ * @export
+ */
+export declare const FileCollectionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Add files to a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {FileIdList} fileIdList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFileCollectionFiles: (id: string, fileIdList: FileIdList, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a `file-collection`.
+     * @param {CreateFileCollectionRequest} createFileCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFileCollection: (createFileCollectionRequest: CreateFileCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFileCollection: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a `file-collection` by ID.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFileCollection: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List the files in a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @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}
+     */
+    listFileCollectionFiles: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List `file-collection`s by supplied ID.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFileCollections: (pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFileCollection: (id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FileCollectionsApi - functional programming interface
+ * @export
+ */
+export declare const FileCollectionsApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Add files to a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {FileIdList} fileIdList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFileCollectionFiles(id: string, fileIdList: FileIdList, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
+    /**
+     * Create a `file-collection`.
+     * @param {CreateFileCollectionRequest} createFileCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFileCollection(createFileCollectionRequest: CreateFileCollectionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
+    /**
+     * Delete a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFileCollection(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
+    /**
+     * Get a `file-collection` by ID.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFileCollection(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionMetadata>>;
+    /**
+     * List the files in a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @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}
+     */
+    listFileCollectionFiles(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileList>>;
+    /**
+     * List `file-collection`s by supplied ID.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<FileCollectionList>>;
+    /**
+     * Update a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFileCollection(id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
+};
+/**
+ * FileCollectionsApi - factory interface
+ * @export
+ */
+export declare const FileCollectionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Add files to a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {FileIdList} fileIdList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFileCollectionFiles(id: string, fileIdList: FileIdList, options?: any): AxiosPromise<FileCollectionMetadata>;
+    /**
+     * Create a `file-collection`.
+     * @param {CreateFileCollectionRequest} createFileCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFileCollection(createFileCollectionRequest: CreateFileCollectionRequest, options?: any): AxiosPromise<FileCollectionMetadata>;
+    /**
+     * Delete a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFileCollection(id: string, options?: any): AxiosPromise<void>;
+    /**
+     * Get a `file-collection` by ID.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFileCollection(id: string, options?: any): AxiosPromise<FileCollectionMetadata>;
+    /**
+     * List the files in a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @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}
+     */
+    listFileCollectionFiles(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<FileList>;
+    /**
+     * List `file-collection`s by supplied ID.
+     * @param {string} [pageCursor] The cursor for the next page of items.
+     * @param {number} [pageSize] The number of items to return.
+     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFileCollections(pageCursor?: string | undefined, pageSize?: number | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<FileCollectionList>;
+    /**
+     * Update a `file-collection`.
+     * @param {string} id The &#x60;file-collection&#x60; ID.
+     * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFileCollection(id: string, updateFileCollectionRequest: UpdateFileCollectionRequest, options?: any): AxiosPromise<void>;
+};
+/**
+ * Request parameters for addFileCollectionFiles operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiAddFileCollectionFilesRequest
+ */
+export interface FileCollectionsApiAddFileCollectionFilesRequest {
+    /**
+     * The &#x60;file-collection&#x60; ID.
+     * @type {string}
+     * @memberof FileCollectionsApiAddFileCollectionFiles
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {FileIdList}
+     * @memberof FileCollectionsApiAddFileCollectionFiles
+     */
+    readonly fileIdList: FileIdList;
+}
+/**
+ * Request parameters for createFileCollection operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiCreateFileCollectionRequest
+ */
+export interface FileCollectionsApiCreateFileCollectionRequest {
+    /**
+     *
+     * @type {CreateFileCollectionRequest}
+     * @memberof FileCollectionsApiCreateFileCollection
+     */
+    readonly createFileCollectionRequest: CreateFileCollectionRequest;
+}
+/**
+ * Request parameters for deleteFileCollection operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiDeleteFileCollectionRequest
+ */
+export interface FileCollectionsApiDeleteFileCollectionRequest {
+    /**
+     * The &#x60;file-collection&#x60; ID.
+     * @type {string}
+     * @memberof FileCollectionsApiDeleteFileCollection
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getFileCollection operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiGetFileCollectionRequest
+ */
+export interface FileCollectionsApiGetFileCollectionRequest {
+    /**
+     * The &#x60;file-collection&#x60; ID.
+     * @type {string}
+     * @memberof FileCollectionsApiGetFileCollection
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for listFileCollectionFiles operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiListFileCollectionFilesRequest
+ */
+export interface FileCollectionsApiListFileCollectionFilesRequest {
+    /**
+     * The &#x60;file-collection&#x60; ID.
+     * @type {string}
+     * @memberof FileCollectionsApiListFileCollectionFiles
+     */
+    readonly id: string;
+    /**
+     * The cursor for the next page of items.
+     * @type {string}
+     * @memberof FileCollectionsApiListFileCollectionFiles
+     */
+    readonly pageCursor?: string;
+    /**
+     * The number of items to return.
+     * @type {number}
+     * @memberof FileCollectionsApiListFileCollectionFiles
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listFileCollections operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiListFileCollectionsRequest
+ */
+export interface FileCollectionsApiListFileCollectionsRequest {
+    /**
+     * The cursor for the next page of items.
+     * @type {string}
+     * @memberof FileCollectionsApiListFileCollections
+     */
+    readonly pageCursor?: string;
+    /**
+     * The number of items to return.
+     * @type {number}
+     * @memberof FileCollectionsApiListFileCollections
+     */
+    readonly pageSize?: number;
+    /**
+     * Comma-separated list of supplied IDs to filter on.
+     * @type {string}
+     * @memberof FileCollectionsApiListFileCollections
+     */
+    readonly filterSuppliedId?: string;
+}
+/**
+ * Request parameters for updateFileCollection operation in FileCollectionsApi.
+ * @export
+ * @interface FileCollectionsApiUpdateFileCollectionRequest
+ */
+export interface FileCollectionsApiUpdateFileCollectionRequest {
+    /**
+     * The &#x60;file-collection&#x60; ID.
+     * @type {string}
+     * @memberof FileCollectionsApiUpdateFileCollection
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {UpdateFileCollectionRequest}
+     * @memberof FileCollectionsApiUpdateFileCollection
+     */
+    readonly updateFileCollectionRequest: UpdateFileCollectionRequest;
+}
+/**
+ * FileCollectionsApi - object-oriented interface
+ * @export
+ * @class FileCollectionsApi
+ * @extends {BaseAPI}
+ */
+export declare class FileCollectionsApi extends BaseAPI {
+    /**
+     * Add files to a `file-collection`.
+     * @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    addFileCollectionFiles(requestParameters: FileCollectionsApiAddFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
+    /**
+     * Create a `file-collection`.
+     * @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    createFileCollection(requestParameters: FileCollectionsApiCreateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
+    /**
+     * Delete a `file-collection`.
+     * @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    deleteFileCollection(requestParameters: FileCollectionsApiDeleteFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Get a `file-collection` by ID.
+     * @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    getFileCollection(requestParameters: FileCollectionsApiGetFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionMetadata, any>>;
+    /**
+     * List the files in a `file-collection`.
+     * @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    listFileCollectionFiles(requestParameters: FileCollectionsApiListFileCollectionFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileList, any>>;
+    /**
+     * List `file-collection`s by supplied ID.
+     * @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    listFileCollections(requestParameters?: FileCollectionsApiListFileCollectionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileCollectionList, any>>;
+    /**
+     * Update a `file-collection`.
+     * @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FileCollectionsApi
+     */
+    updateFileCollection(requestParameters: FileCollectionsApiUpdateFileCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}
 /**
  * FilesApi - axios parameter creator
  * @export
  */
 export declare const FilesApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Create a download uri for a `file` by ID.
+     * @param {string} id The &#x60;file&#x60; ID.
+     * @param {CreateDownloadRequest} createDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDownloadUrl: (id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
      * @param {CreateFileRequest} createFileRequest
@@ -8683,6 +9521,14 @@ export declare const FilesApiAxiosParamCreator: (configuration?: Configuration |
  * @export
  */
 export declare const FilesApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Create a download uri for a `file` by ID.
+     * @param {string} id The &#x60;file&#x60; ID.
+     * @param {CreateDownloadRequest} createDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<DownloadUrl>>;
     /**
      * Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
      * @param {CreateFileRequest} createFileRequest
@@ -8735,6 +9581,14 @@ export declare const FilesApiFp: (configuration?: Configuration | undefined) =>
  * @export
  */
 export declare const FilesApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Create a download uri for a `file` by ID.
+     * @param {string} id The &#x60;file&#x60; ID.
+     * @param {CreateDownloadRequest} createDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDownloadUrl(id: string, createDownloadRequest: CreateDownloadRequest, options?: any): AxiosPromise<DownloadUrl>;
     /**
      * Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
      * @param {CreateFileRequest} createFileRequest
@@ -8782,6 +9636,25 @@ export declare const FilesApiFactory: (configuration?: Configuration | undefined
      */
     uploadFile(id: string, body: any, options?: any): AxiosPromise<void>;
 };
+/**
+ * Request parameters for createDownloadUrl operation in FilesApi.
+ * @export
+ * @interface FilesApiCreateDownloadUrlRequest
+ */
+export interface FilesApiCreateDownloadUrlRequest {
+    /**
+     * The &#x60;file&#x60; ID.
+     * @type {string}
+     * @memberof FilesApiCreateDownloadUrl
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {CreateDownloadRequest}
+     * @memberof FilesApiCreateDownloadUrl
+     */
+    readonly createDownloadRequest: CreateDownloadRequest;
+}
 /**
  * Request parameters for createFile operation in FilesApi.
  * @export
@@ -8891,6 +9764,14 @@ export interface FilesApiUploadFileRequest {
  * @extends {BaseAPI}
  */
 export declare class FilesApi extends BaseAPI {
+    /**
+     * Create a download uri for a `file` by ID.
+     * @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilesApi
+     */
+    createDownloadUrl(requestParameters: FilesApiCreateDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadUrl, any>>;
     /**
      * Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
      * @param {FilesApiCreateFileRequest} requestParameters Request parameters.