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

Official JavaScript/TypeScript SDK for Buildx low-code platform

import { BuildxObject, ErrorResponse, SuccessResponse, BuildxConfig } from "../types/index";
/**
 * Buildx Objects service for Buildx
 * Handles Buildx-specific objects (users, roles, etc.)
 *
 * @example
 * ```typescript
 * const buildxObjects = buildx.buildxObjects();
 *
 * // Get Buildx collection
 * const collection = await buildxObjects.getCollection('users');
 *
 * // Get Buildx document
 * const doc = await buildxObjects.getDocument('users', 'user-id');
 *
 * // Query Buildx objects
 * const objects = await buildxObjects.query('users', { limit: 10 });
 * ```
 */
export declare class BuildxObjects {
    private baseService;
    constructor(config: BuildxConfig);
    updateConfig(config: BuildxConfig): void;
    /**
     * Get Buildx collection
     */
    getCollection(type: string, projectId?: string): Promise<any | ErrorResponse>;
    /**
     * Get Buildx document by ID
     */
    getDocument(type: string, id: string, projectId?: string): Promise<BuildxObject | ErrorResponse>;
    /**
     * Query Buildx objects
     */
    query(type: string, options?: any, projectId?: string): Promise<BuildxObject[] | ErrorResponse>;
    /**
     * Create Buildx object
     */
    create(type: string, data: any, projectId?: string): Promise<BuildxObject | ErrorResponse>;
    /**
     * Update Buildx object
     */
    update(type: string, id: string, data: any, projectId?: string): Promise<BuildxObject | ErrorResponse>;
    /**
     * Delete Buildx object
     */
    deleteObject(type: string, id: string, projectId?: string): Promise<SuccessResponse | ErrorResponse>;
}