Skip to main content

actionPlan

@codebolt/codeboltjs

Variable: actionPlan

const actionPlan: {
  addGroupToActionPlan: (planId: string, group: ActionPlanGroup) => Promise<any>;
  addTaskToActionPlan: (planId: string, task: ActionPlanTask) => Promise<any>;
  createActionPlan: (payload: {
     agentId?: string;
     agentName?: string;
     description?: string;
     name: string;
     planId?: string;
     status?: string;
  }) => Promise<any>;
  getActionPlanDetail: (planId: string) => Promise<any>;
  getAllPlans: () => Promise<any>;
  getPlanDetail: (planId: string) => Promise<any>;
  startTaskStep: (planId: string, taskId: string) => Promise<any>;
  startTaskStepWithListener: (planId: string, taskId: string, onResponse: (response: TaskStepResponse) => void) => () => void;
  updateActionPlan: (planId: string, updateData: ActionPlanUpdateData) => Promise<any>;
};

Defined in: packages/codeboltjs/src/modules/actionPlan.ts:19

Type Declaration​

NameTypeDescriptionDefined in
addGroupToActionPlan()(planId: string, group: ActionPlanGroup) => Promise<any>Add a group to an action planpackages/codeboltjs/src/modules/actionPlan.ts:130
addTaskToActionPlan()(planId: string, task: ActionPlanTask) => Promise<any>Add a task to an action planpackages/codeboltjs/src/modules/actionPlan.ts:113
createActionPlan()(payload: { agentId?: string; agentName?: string; description?: string; name: string; planId?: string; status?: string; }) => Promise<any>Create a new action planpackages/codeboltjs/src/modules/actionPlan.ts:72
getActionPlanDetail()(planId: string) => Promise<any>Get action plan detail by ID (alternative method)packages/codeboltjs/src/modules/actionPlan.ts:56
getAllPlans()() => Promise<any>Get all action planspackages/codeboltjs/src/modules/actionPlan.ts:25
getPlanDetail()(planId: string) => Promise<any>Get action plan detail by IDpackages/codeboltjs/src/modules/actionPlan.ts:40
startTaskStep()(planId: string, taskId: string) => Promise<any>Start/execute a task step in an action planpackages/codeboltjs/src/modules/actionPlan.ts:147
startTaskStepWithListener()(planId: string, taskId: string, onResponse: (response: TaskStepResponse) => void) => () => voidStart/execute a task step in an action plan with event listenerpackages/codeboltjs/src/modules/actionPlan.ts:165
updateActionPlan()(planId: string, updateData: ActionPlanUpdateData) => Promise<any>Update an existing action planpackages/codeboltjs/src/modules/actionPlan.ts:96