@ptkl/sdk 1.14.0 → 1.15.0

package/dist/v0.10/api/workflow.d.ts

@@ -1,6 +1,6 @@
 import { AxiosResponse } from 'axios';
 import PlatformBaseClient from "./platformBaseClient";
-import { WorkflowModel, WorkflowCreatePayload, WorkflowUpdatePayload, WorkflowListResponse } from '../types/workflow';
+import { WorkflowModel, WorkflowCreatePayload, WorkflowUpdatePayload, WorkflowListResponse, WorkflowInstallPayload, WorkflowHistoryQuery, WorkflowHistoryListResponse, WorkflowHistoryEntry, WorkflowStatsQuery, WorkflowStats, WorkflowRunningQuery, WorkflowRunningListResponse, WorkflowRunningExecution, WorkflowControlResponse, WorkflowRestartOptions, WorkflowRestartResponse, WorkflowNodeControlOptions, WorkflowErrorListResponse } from '../types/workflow';
 export default class Workflow extends PlatformBaseClient {
     create(data: WorkflowCreatePayload): Promise<AxiosResponse<WorkflowModel>>;
     update(id: string, data: WorkflowUpdatePayload): Promise<AxiosResponse<WorkflowModel>>;
@@ -9,4 +9,28 @@ export default class Workflow extends PlatformBaseClient {
     delete(id: string): Promise<AxiosResponse<void>>;
     trigger(id: string, event: string, data: any): Promise<AxiosResponse<any, any>>;
     publish(event: string, data: any): Promise<AxiosResponse<any, any>>;
+    /**
+     * Install (create + publish) a workflow in one call.
+     * Rejects if a workflow with the same name + integrator already exists.
+     */
+    install(data: WorkflowInstallPayload): Promise<AxiosResponse<WorkflowModel>>;
+    getHistory(query?: WorkflowHistoryQuery): Promise<AxiosResponse<WorkflowHistoryListResponse>>;
+    getHistoryEntry(executionUuid: string): Promise<AxiosResponse<WorkflowHistoryEntry>>;
+    getStats(query?: WorkflowStatsQuery): Promise<AxiosResponse<WorkflowStats>>;
+    getRunning(query?: WorkflowRunningQuery): Promise<AxiosResponse<WorkflowRunningListResponse>>;
+    getRunningEntry(executionUuid: string): Promise<AxiosResponse<WorkflowRunningExecution>>;
+    pause(executionUuid: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    resume(executionUuid: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    kill(executionUuid: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    /**
+     * Restart a failed/killed workflow execution from history.
+     * `clearState: true` discards prior node state instead of a smart resume.
+     */
+    restart(executionUuid: string, options?: WorkflowRestartOptions): Promise<AxiosResponse<WorkflowRestartResponse>>;
+    pauseNode(executionUuid: string, nodeId: number, options?: WorkflowNodeControlOptions): Promise<AxiosResponse<WorkflowControlResponse>>;
+    resumeNode(executionUuid: string, nodeId: number, options?: WorkflowNodeControlOptions): Promise<AxiosResponse<WorkflowControlResponse>>;
+    killNode(executionUuid: string, nodeId: number, options?: WorkflowNodeControlOptions): Promise<AxiosResponse<WorkflowControlResponse>>;
+    getErrors(): Promise<AxiosResponse<WorkflowErrorListResponse>>;
+    removeError(id: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    removeAllErrors(): Promise<AxiosResponse<WorkflowControlResponse>>;
 }