tsonik
Version:
A TypeScript client library for the Iconik API based on Swagger documentation
36 lines • 1.59 kB
TypeScript
import { BaseResource } from './base';
import { Tsonik } from '../client';
import { ApiResponse, PaginatedResponse } from '../types';
import { FileSet, AssetFileSetsListParams, CreateFileSetRequest, DeleteFileSetOptions, FileSetFilesListParams, FileSetFile } from '../types/filesets';
/**
* FileSet resource for managing file sets in Iconik
*/
export declare class FileSetResource extends BaseResource {
constructor(client: Tsonik);
/**
* Get all file sets for a specific asset
*/
getAssetFilesets(assetId: string, params?: AssetFileSetsListParams): Promise<ApiResponse<PaginatedResponse<FileSet>>>;
/**
* Get a specific file set for an asset by ID
*/
getAssetFileset(assetId: string, fileSetId: string): Promise<ApiResponse<FileSet>>;
/**
* Create a new file set for an asset
*/
createAssetFileset(assetId: string, filesetData: CreateFileSetRequest): Promise<ApiResponse<FileSet>>;
/**
* Delete a file set for an asset
*/
deleteAssetFileset(assetId: string, fileSetId: string, options?: DeleteFileSetOptions): Promise<ApiResponse<FileSet | void>>;
/**
* Get files from a file set
*
* @param assetId - The ID of the asset
* @param fileSetId - The ID of the file set
* @param options - Optional parameters for the request
* @returns Promise with the response containing file set files
*/
getFileSetFiles(assetId: string, fileSetId: string, options?: FileSetFilesListParams): Promise<ApiResponse<PaginatedResponse<FileSetFile>>>;
}
//# sourceMappingURL=filesets.d.ts.map