@gpt-platform/client 0.10.5 → 0.11.0

package/dist/namespaces/pipelines.d.ts

@@ -0,0 +1,120 @@
+import type { RequestOptions } from "../base-client";
+import type { RequestBuilder } from "../request-builder";
+/** Attributes for triggering a pipeline execution (client-side). */
+export interface TriggerPipelineAttributes {
+    /** Workspace context for execution. */
+    workspace_id: string;
+    /** Input data passed to the first pipeline node. */
+    input?: Record<string, unknown>;
+}
+/** Response from a successful pipeline trigger. */
+export interface PipelineTriggerResponse {
+    /** Pipeline execution UUID. Use pipelineExecutions.get() to poll status. */
+    execution_id: string;
+    /** Initial status — always "running" on success. */
+    status: string;
+}
+/** Attributes for dry-run validation. */
+export interface DryRunAttributes {
+    /** Workspace context for validation. */
+    workspace_id: string;
+}
+/** Response from pipeline dry-run validation. */
+export interface DryRunResponse {
+    /** Whether the pipeline is valid and ready to execute. */
+    valid: boolean;
+    /** Number of nodes in the pipeline graph. */
+    node_count?: number;
+    /** Number of agent nodes with resolvable agents. */
+    agent_count?: number;
+    /** Number of HITL checkpoint nodes. */
+    checkpoint_count?: number;
+    /** Validation errors (when valid is false). */
+    errors?: string[];
+}
+/** A pipeline resource (read-only on client API). */
+export interface Pipeline {
+    id: string;
+    name: string;
+    description: string | null;
+    application_id: string | null;
+    workspace_id: string | null;
+    trigger_type: "manual" | "event" | "schedule";
+    system_slug: string | null;
+    is_active: boolean;
+    inserted_at: string;
+    updated_at: string;
+}
+/**
+ * Creates the pipelines namespace for triggering and validating agent execution pipelines.
+ *
+ * Client users can trigger and validate pipelines — creation, update, and deletion
+ * are admin-only operations via the admin SDK.
+ *
+ * @param rb - The request builder used for API communication.
+ * @returns Pipelines namespace with trigger, dryRun, list, and get methods.
+ *
+ * @example
+ * ```typescript
+ * // Trigger a pipeline
+ * const { execution_id } = await client.pipelines.trigger("pipe-id", {
+ *   workspace_id: wsId,
+ *   input: { transcript: "..." },
+ * });
+ *
+ * // Validate before triggering
+ * const validation = await client.pipelines.dryRun("pipe-id", {
+ *   workspace_id: wsId,
+ * });
+ * if (!validation.valid) {
+ *   console.error("Pipeline not ready:", validation.errors);
+ * }
+ * ```
+ */
+export declare function createPipelinesNamespace(rb: RequestBuilder): {
+    /**
+     * List available pipelines.
+     *
+     * @param options - Optional request options.
+     * @returns Array of Pipeline resources.
+     */
+    list(options?: RequestOptions): Promise<Pipeline[]>;
+    /**
+     * Get a pipeline by ID.
+     *
+     * @param id - Pipeline UUID.
+     * @param options - Optional request options.
+     * @returns Pipeline resource.
+     */
+    get(id: string, options?: RequestOptions): Promise<Pipeline>;
+    /**
+     * Get a pipeline by its system slug.
+     *
+     * @param slug - Pipeline system_slug.
+     * @param options - Optional request options.
+     * @returns Pipeline resource.
+     */
+    getBySlug(slug: string, options?: RequestOptions): Promise<Pipeline>;
+    /**
+     * Trigger pipeline execution.
+     *
+     * @param id - Pipeline UUID.
+     * @param attributes - Execution parameters including workspace_id and optional input.
+     * @param options - Optional request options.
+     * @returns Trigger response with execution_id and status.
+     */
+    trigger(id: string, attributes: TriggerPipelineAttributes, options?: RequestOptions): Promise<PipelineTriggerResponse>;
+    /**
+     * Validate pipeline can execute without running it (dry-run).
+     *
+     * Checks: nodes exist, agents are resolvable, graph is valid, permissions OK.
+     * Use this for onboarding validation or pre-flight checks.
+     *
+     * @param id - Pipeline UUID.
+     * @param attributes - Validation parameters including workspace_id.
+     * @param options - Optional request options.
+     * @returns Validation result with validity flag and diagnostic info.
+     */
+    dryRun(id: string, attributes: DryRunAttributes, options?: RequestOptions): Promise<DryRunResponse>;
+};
+//# sourceMappingURL=pipelines.d.ts.map

package/dist/namespaces/pipelines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipelines.d.ts","sourceRoot":"","sources":["../../src/namespaces/pipelines.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,oEAAoE;AACpE,MAAM,WAAW,yBAAyB;IACxC,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED,mDAAmD;AACnD,MAAM,WAAW,uBAAuB;IACtC,4EAA4E;IAC5E,YAAY,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yCAAyC;AACzC,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,KAAK,EAAE,OAAO,CAAC;IACf,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,qDAAqD;AACrD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;IAC9C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,wBAAwB,CAAC,EAAE,EAAE,cAAc;IAEvD;;;;;OAKG;mBACkB,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAIzD;;;;;;OAMG;YACW,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIlE;;;;;;OAMG;oBACmB,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1E;;;;;;;OAOG;gBAEG,MAAM,cACE,yBAAyB,YAC3B,cAAc,GACvB,OAAO,CAAC,uBAAuB,CAAC;IAWnC;;;;;;;;;;OAUG;eAEG,MAAM,cACE,gBAAgB,YAClB,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC;EAU7B"}