buildx-connect/dist/services/Projects.d.ts

Official JavaScript/TypeScript SDK for Buildx low-code platform

import { Project, ErrorResponse, SuccessResponse, BuildxConfig } from "../types/index";
/**
 * Projects service for Buildx
 * Handles project management operations
 *
 * @example
 * ```typescript
 * const projects = buildx.projects();
 *
 * // List all projects
 * const projectList = await projects.list();
 *
 * // Create a new project
 * const newProject = await projects.create({
 *   name: 'My Project',
 *   description: 'A new project'
 * });
 *
 * // Get project by ID
 * const project = await projects.get('project-id');
 * ```
 */
export declare class Projects {
    private baseService;
    constructor(config: BuildxConfig);
    updateConfig(config: BuildxConfig): void;
    /**
     * List all projects
     */
    list(): Promise<Project[] | ErrorResponse>;
    /**
     * Get project by ID
     */
    get(projectId: string): Promise<Project | ErrorResponse>;
    /**
     * Create a new project
     */
    create(projectData: Partial<Project>): Promise<Project | ErrorResponse>;
    /**
     * Update project
     */
    update(projectId: string, projectData: Partial<Project>): Promise<Project | ErrorResponse>;
    /**
     * Delete project
     */
    deleteById(projectId: string): Promise<SuccessResponse | ErrorResponse>;
    /**
     * Backup project
     */
    backup(projectId: string): Promise<SuccessResponse | ErrorResponse>;
    /**
     * Restore project from backup
     */
    restore(projectId: string, file: File): Promise<SuccessResponse | ErrorResponse>;
}