dood-stream-client
Version:
đ A feature-rich client for the DoodStream API with caching, logging, and error handling
68 lines (67 loc) âĸ 2.17 kB
TypeScript
import { HttpClient } from "./http-client";
import { FileListResponse, FileStatusResponse, FileInfoResponse, FileImageResponse, BooleanResponse } from "../interfaces/api-responses";
import { FileListParams, FileStatusParams, FileInfoParams, FileImageParams, FileRenameParams, FileMoveParams, FileSearchParams } from "../interfaces/api-params";
/**
* đ File-related API functionality
*/
export declare class FileApi {
/**
* đ HTTP client for making requests
*/
private client;
/**
* Create a new File API instance
*
* @param client - HTTP client
*/
constructor(client: HttpClient);
/**
* đ List files
*
* @param params - File list parameters (pagination, folder, etc.)
* @returns Promise with file list response
*/
list(params?: FileListParams): Promise<FileListResponse>;
/**
* â
Check file status
*
* @param params - File status parameters
* @returns Promise with file status response
*/
checkStatus(params: FileStatusParams): Promise<FileStatusResponse>;
/**
* âšī¸ Get file information
*
* @param params - File info parameters
* @returns Promise with file info response
*/
getInfo(params: FileInfoParams): Promise<FileInfoResponse>;
/**
* đŧī¸ Get file images (thumbnail, splash, etc.)
*
* @param params - File image parameters
* @returns Promise with file image response
*/
getImages(params: FileImageParams): Promise<FileImageResponse>;
/**
* đ Rename a file
*
* @param params - File rename parameters
* @returns Promise with boolean response
*/
rename(params: FileRenameParams): Promise<BooleanResponse>;
/**
* đ Move a file to a different folder
*
* @param params - File move parameters
* @returns Promise with boolean response
*/
move(params: FileMoveParams): Promise<BooleanResponse>;
/**
* đ Search for files
*
* @param params - File search parameters
* @returns Promise with file list response
*/
search(params: FileSearchParams): Promise<FileListResponse>;
}