buildx-connect
Version:
Official JavaScript/TypeScript SDK for Buildx low-code platform
42 lines (41 loc) • 1.24 kB
TypeScript
import { ErrorResponse, BuildxConfig } from "../types/index";
/**
* Flows service for Buildx
* Handles flow types and running flows
*
* @example
* ```typescript
* const flows = buildx.flows();
*
* // Get flow types
* const types = await flows.getTypes();
*
* // Run a flow
* const result = await flows.run('flow-id', 'session-id', 'root', { arg1: 'value' });
* ```
*/
export declare class Flows {
private baseService;
constructor(config: BuildxConfig);
updateConfig(config: BuildxConfig): void;
/**
* Get all flow types
*/
getTypes(): Promise<any | ErrorResponse>;
/**
* Run a flow
*/
run(flowId: string, sessionId?: string | null, state?: any, args?: any, projectId?: string): Promise<any | ErrorResponse>;
/**
* Get GPT flow code suggestions
*/
getGptFlowSuggestions(instruction: string, projectId?: string): Promise<any | ErrorResponse>;
/**
* Get GPT collection suggestions
*/
getGptCollectionSuggestions(instruction: string, projectId?: string): Promise<any | ErrorResponse>;
/**
* Get GPT lifecycle suggestions
*/
getGptLifecycleSuggestions(instruction: string, projectId?: string): Promise<any | ErrorResponse>;
}