@vizzly-testing/cli/dist/types/services/api-service.d.ts

Visual review platform for UI developers and designers

/**
 * ApiService class for direct API communication
 */
export class ApiService {
    constructor(options?: {});
    baseUrl: any;
    token: any;
    uploadAll: any;
    userAgent: string;
    /**
     * Make an API request
     * @param {string} endpoint - API endpoint
     * @param {Object} options - Fetch options
     * @returns {Promise<Object>} Response data
     */
    request(endpoint: string, options?: any): Promise<any>;
    /**
     * Get build information
     * @param {string} buildId - Build ID
     * @param {string} include - Optional include parameter (e.g., 'screenshots')
     * @returns {Promise<Object>} Build data
     */
    getBuild(buildId: string, include?: string): Promise<any>;
    /**
     * Get comparison information
     * @param {string} comparisonId - Comparison ID
     * @returns {Promise<Object>} Comparison data
     */
    getComparison(comparisonId: string): Promise<any>;
    /**
     * Get builds for a project
     * @param {Object} filters - Filter options
     * @returns {Promise<Array>} List of builds
     */
    getBuilds(filters?: any): Promise<any[]>;
    /**
     * Create a new build
     * @param {Object} metadata - Build metadata
     * @returns {Promise<Object>} Created build data
     */
    createBuild(metadata: any): Promise<any>;
    /**
     * Check if SHAs already exist on the server
     * @param {string[]} shas - Array of SHA256 hashes to check
     * @param {string} buildId - Build ID for screenshot record creation
     * @returns {Promise<Object>} Response with existing SHAs and screenshot data
     */
    checkShas(shas: string[], buildId: string): Promise<any>;
    /**
     * Upload a screenshot with SHA checking
     * @param {string} buildId - Build ID
     * @param {string} name - Screenshot name
     * @param {Buffer} buffer - Screenshot data
     * @param {Object} metadata - Additional metadata
     * @returns {Promise<Object>} Upload result
     */
    uploadScreenshot(buildId: string, name: string, buffer: Buffer, metadata?: any): Promise<any>;
    /**
     * Update build status
     * @param {string} buildId - Build ID
     * @param {string} status - Build status (pending|running|completed|failed)
     * @param {number} executionTimeMs - Execution time in milliseconds
     * @returns {Promise<Object>} Updated build data
     */
    updateBuildStatus(buildId: string, status: string, executionTimeMs?: number): Promise<any>;
    /**
     * Finalize a build (convenience method)
     * @param {string} buildId - Build ID
     * @param {boolean} success - Whether the build succeeded
     * @param {number} executionTimeMs - Execution time in milliseconds
     * @returns {Promise<Object>} Finalized build data
     */
    finalizeBuild(buildId: string, success?: boolean, executionTimeMs?: number): Promise<any>;
    /**
     * Get token context (organization and project info)
     * @returns {Promise<Object>} Token context data
     */
    getTokenContext(): Promise<any>;
    /**
     * Finalize a parallel build
     * @param {string} parallelId - Parallel ID to finalize
     * @returns {Promise<Object>} Finalization result
     */
    finalizeParallelBuild(parallelId: string): Promise<any>;
}