@epilot/sdk 2.8.9 → 2.9.0

package/docs/automation.md

@@ -56,9 +56,7 @@ const { data } = await automationClient.searchFlows(...)
 - [`AnyAction`](#anyaction)
 - [`AnyActionConfig`](#anyactionconfig)
 - [`AutomationActionConfig`](#automationactionconfig)
-- [`AutomationLoop`](#automationloop)
 - [`AutomationActionExecutionState`](#automationactionexecutionstate)
-- [`AutomationActionIteration`](#automationactioniteration)
 - [`RetryStrategy`](#retrystrategy)
 - [`AutomationAction`](#automationaction)
 - [`ErrorOutput`](#erroroutput)
@@ -126,7 +124,6 @@ const { data } = await automationClient.searchFlows(...)
 - [`ActionSchedule`](#actionschedule)
 - [`AutomationExecutionId`](#automationexecutionid)
 - [`AutomationExecution`](#automationexecution)
-- [`AutomationLoopState`](#automationloopstate)
 - [`WorkflowExecutionContext`](#workflowexecutioncontext)
 - [`ExecutionChain`](#executionchain)
 - [`TriggerEventManual`](#triggereventmanual)
@@ -314,9 +311,7 @@ const { data } = await client.getExecutions({
       "trigger_context": {},
       "version": 2,
       "trigger_event": {},
-      "workflow_context": {},
-      "loops": [],
-      "loop_state": {}
+      "workflow_context": {}
     }
   ]
 }
@@ -390,7 +385,6 @@ const { data } = await client.startExecution(
       "id": "string",
       "schedule_id": "string",
       "evaluationResult": true,
-      "error_output": {},
       "statements": []
     }
   ],
@@ -417,14 +411,12 @@ const { data } = await client.startExecution(
       "reason": {},
       "condition_id": "string",
       "schedule_id": "string",
-      "loop_id": "string",
       "execution_status": "pending",
       "started_at": "string",
       "updated_at": "string",
       "outputs": {},
       "error_output": {},
-      "retry_strategy": "RETRY_AND_RESUME",
-      "iterations": []
+      "retry_strategy": "RETRY_AND_RESUME"
     },
     {
       "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
@@ -438,14 +430,12 @@ const { data } = await client.startExecution(
       "reason": {},
       "condition_id": "string",
       "schedule_id": "string",
-      "loop_id": "string",
       "execution_status": "pending",
       "started_at": "string",
       "updated_at": "string",
       "outputs": {},
       "error_output": {},
-      "retry_strategy": "RETRY_AND_RESUME",
-      "iterations": []
+      "retry_strategy": "RETRY_AND_RESUME"
     }
   ],
   "resume_token": "eyJraWQiOiJrZXkifQ==",
@@ -473,16 +463,7 @@ const { data } = await client.startExecution(
     "entity_contexts": [
       {}
     ]
-  },
-  "loops": [
-    {
-      "id": "loop_contracts",
-      "source_path": "submission.steps[0]['Contracts']",
-      "source_type": "journey-multi-select",
-      "length": 0
-    }
-  ],
-  "loop_state": {}
+  }
 }
 ```
 
@@ -691,7 +672,6 @@ const { data } = await client.getExecution({
       "id": "string",
       "schedule_id": "string",
       "evaluationResult": true,
-      "error_output": {},
       "statements": []
     }
   ],
@@ -718,14 +698,12 @@ const { data } = await client.getExecution({
       "reason": {},
       "condition_id": "string",
       "schedule_id": "string",
-      "loop_id": "string",
       "execution_status": "pending",
       "started_at": "string",
       "updated_at": "string",
       "outputs": {},
       "error_output": {},
-      "retry_strategy": "RETRY_AND_RESUME",
-      "iterations": []
+      "retry_strategy": "RETRY_AND_RESUME"
     },
     {
       "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
@@ -739,14 +717,12 @@ const { data } = await client.getExecution({
       "reason": {},
       "condition_id": "string",
       "schedule_id": "string",
-      "loop_id": "string",
       "execution_status": "pending",
       "started_at": "string",
       "updated_at": "string",
       "outputs": {},
       "error_output": {},
-      "retry_strategy": "RETRY_AND_RESUME",
-      "iterations": []
+      "retry_strategy": "RETRY_AND_RESUME"
     }
   ],
   "resume_token": "eyJraWQiOiJrZXkifQ==",
@@ -774,16 +750,7 @@ const { data } = await client.getExecution({
     "entity_contexts": [
       {}
     ]
-  },
-  "loops": [
-    {
-      "id": "loop_contracts",
-      "source_path": "submission.steps[0]['Contracts']",
-      "source_type": "journey-multi-select",
-      "length": 0
-    }
-  ],
-  "loop_state": {}
+  }
 }
 ```
 
@@ -832,7 +799,6 @@ const { data } = await client.cancelExecution({
       "id": "string",
       "schedule_id": "string",
       "evaluationResult": true,
-      "error_output": {},
       "statements": []
     }
   ],
@@ -859,14 +825,12 @@ const { data } = await client.cancelExecution({
       "reason": {},
       "condition_id": "string",
       "schedule_id": "string",
-      "loop_id": "string",
       "execution_status": "pending",
       "started_at": "string",
       "updated_at": "string",
       "outputs": {},
       "error_output": {},
-      "retry_strategy": "RETRY_AND_RESUME",
-      "iterations": []
+      "retry_strategy": "RETRY_AND_RESUME"
     },
     {
       "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
@@ -880,14 +844,12 @@ const { data } = await client.cancelExecution({
       "reason": {},
       "condition_id": "string",
       "schedule_id": "string",
-      "loop_id": "string",
       "execution_status": "pending",
       "started_at": "string",
       "updated_at": "string",
       "outputs": {},
       "error_output": {},
-      "retry_strategy": "RETRY_AND_RESUME",
-      "iterations": []
+      "retry_strategy": "RETRY_AND_RESUME"
     }
   ],
   "resume_token": "eyJraWQiOiJrZXkifQ==",
@@ -915,16 +877,7 @@ const { data } = await client.cancelExecution({
     "entity_contexts": [
       {}
     ]
-  },
-  "loops": [
-    {
-      "id": "loop_contracts",
-      "source_path": "submission.steps[0]['Contracts']",
-      "source_type": "journey-multi-select",
-      "length": 0
-    }
-  ],
-  "loop_state": {}
+  }
 }
 ```
 
@@ -1020,11 +973,7 @@ const { data } = await client.resumeExecutionWithToken(
       "workflow_role": "trigger_workflow",
       "_execution_chain": {},
       "entity_contexts": []
-    },
-    "loops": [
-      {}
-    ],
-    "loop_state": {}
+    }
   },
   "resumedAction": {
     "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
@@ -1049,7 +998,6 @@ const { data } = await client.resumeExecutionWithToken(
     },
     "condition_id": "string",
     "schedule_id": "string",
-    "loop_id": "string",
     "execution_status": "pending",
     "started_at": "string",
     "updated_at": "string",
@@ -1059,10 +1007,7 @@ const { data } = await client.resumeExecutionWithToken(
       "error_reason": "string",
       "error_info": {}
     },
-    "retry_strategy": "RETRY_AND_RESUME",
-    "iterations": [
-      {}
-    ]
+    "retry_strategy": "RETRY_AND_RESUME"
   }
 }
 ```
@@ -1207,11 +1152,6 @@ type AutomationFlow = {
     id?: string
     schedule_id?: string
     evaluationResult?: boolean
-    error_output?: {
-      error_code: { ... }
-      error_reason: { ... }
-      error_info?: { ... }
-    }
     statements?: Array<{
       id?: { ... }
       source?: { ... }
@@ -1226,6 +1166,11 @@ type AutomationFlow = {
     timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months"
     timeRelation?: "after" | "before"
     source: {
+      id: { ... }
+      origin: { ... }
+      schema?: { ... }
+      attribute?: { ... }
+    }
   // ...
 }
 ```
@@ -1299,7 +1244,6 @@ type SearchAutomationsResp = {
       id?: { ... }
       schedule_id?: { ... }
       evaluationResult?: { ... }
-      error_output?: { ... }
       statements?: { ... }
     }>
     schedules?: Array<{
@@ -1310,12 +1254,6 @@ type SearchAutomationsResp = {
       timeRelation?: { ... }
       source: { ... }
     }>
-    loops?: Array<{
-      id: { ... }
-      source_path: { ... }
-      source_type?: { ... }
-      length?: { ... }
-    }>
     actions: Array<{
       type?: { ... }
       config?: { ... }
@@ -1341,6 +1279,13 @@ type SearchAutomationsResp = {
       type?: { ... }
       config?: { ... }
     } | {
+      type?: { ... }
+      config?: { ... }
+    } | {
+      type?: { ... }
+      config?: { ... }
+    } | {
+      id?: { ... }
   // ...
 }
 ```
@@ -1580,7 +1525,6 @@ type AnyActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 } | {
   id?: string
   flow_action_id?: string
@@ -1611,7 +1555,6 @@ type AnyActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 } | {
   id?: string
   flow_action_id?: string
@@ -1629,6 +1572,8 @@ type AnyActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
+} | {
+  id?: string
   // ...
 }
 ```
@@ -1651,20 +1596,6 @@ type AutomationActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
-}
-```
-
-### `AutomationLoop`
-
-A loop scope on an automation flow.
-
-```ts
-type AutomationLoop = {
-  id: string
-  source_path: string
-  source_type?: "journey-multi-select" | "previous-action-outputs" | "entity-relation"
-  length?: number
 }
 ```
 
@@ -1684,39 +1615,6 @@ type AutomationActionExecutionState = {
     }
   }
   retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS"
-  iterations?: Array<{
-    index: number
-    execution_status: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
-    started_at?: string // date-time
-    ended_at?: string // date-time
-    outputs?: Record<string, unknown>
-    error_output?: {
-      error_code: { ... }
-      error_reason: { ... }
-      error_info?: { ... }
-    }
-  }>
-}
-```
-
-### `AutomationActionIteration`
-
-A snapshot of a single completed pass through a looped action.
-
-```ts
-type AutomationActionIteration = {
-  index: number
-  execution_status: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
-  started_at?: string // date-time
-  ended_at?: string // date-time
-  outputs?: Record<string, unknown>
-  error_output?: {
-    error_code: "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
-    error_reason: string
-    error_info?: {
-      details?: { ... }
-    }
-  }
 }
 ```
 
@@ -1746,7 +1644,6 @@ type AutomationAction = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
   execution_status?: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
   started_at?: string
   updated_at?: string
@@ -1759,18 +1656,6 @@ type AutomationAction = {
     }
   }
   retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP" | "RETRY_ALL_PARENT_CONDITION_ACTIONS"
-  iterations?: Array<{
-    index: number
-    execution_status: "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot"
-    started_at?: string // date-time
-    ended_at?: string // date-time
-    outputs?: Record<string, unknown>
-    error_output?: {
-      error_code: { ... }
-      error_reason: { ... }
-      error_info?: { ... }
-    }
-  }>
 }
 ```
 
@@ -1860,7 +1745,6 @@ type CartCheckoutActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2017,7 +1901,6 @@ type MapEntityActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2328,7 +2211,6 @@ type SendEmailActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2384,7 +2266,6 @@ type ForwardEmailActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2445,7 +2326,6 @@ type ReplyEmailActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2541,7 +2421,6 @@ type CreateDocumentActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2599,7 +2478,6 @@ type TriggerWorkflowActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2679,7 +2557,6 @@ type TriggerShareEntityActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2750,7 +2627,6 @@ type TriggerWebhookActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2801,7 +2677,6 @@ type InformERPActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2849,7 +2724,6 @@ type TriggerEventActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2900,7 +2774,6 @@ type FlowExecutionCancelActionConfig = {
   }
   condition_id?: string
   schedule_id?: string
-  loop_id?: string
 }
 ```
 
@@ -2972,13 +2845,6 @@ type ActionCondition = {
   id?: string
   schedule_id?: string
   evaluationResult?: boolean
-  error_output?: {
-    error_code: "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
-    error_reason: string
-    error_info?: {
-      details?: { ... }
-    }
-  }
   statements?: Array<{
     id?: string // uuid
     source?: {
@@ -3062,11 +2928,6 @@ type AutomationExecution = {
     id?: string
     schedule_id?: string
     evaluationResult?: boolean
-    error_output?: {
-      error_code: { ... }
-      error_reason: { ... }
-      error_info?: { ... }
-    }
     statements?: Array<{
       id?: { ... }
       source?: { ... }
@@ -3138,19 +2999,15 @@ type AutomationExecution = {
     config?: {
       template_id?: { ... }
       filename?: { ... }
+    }
+  } | {
+    type?: "send-email"
+    config?: {
+      email_template_id?: { ... }
   // ...
 }
 ```
 
-### `AutomationLoopState`
-
-```ts
-type AutomationLoopState = {
-  current_index: number
-  total: number
-}
-```
-
 ### `WorkflowExecutionContext`
 
 ```ts
@@ -3311,7 +3168,6 @@ type GetExecutionsResp = {
       id?: { ... }
       schedule_id?: { ... }
       evaluationResult?: { ... }
-      error_output?: { ... }
       statements?: { ... }
     }>
     schedules?: Array<{
@@ -3364,14 +3220,12 @@ type GetExecutionsResp = {
       reason?: { ... }
       condition_id?: { ... }
       schedule_id?: { ... }
-      loop_id?: { ... }
       execution_status?: { ... }
       started_at?: { ... }
       updated_at?: { ... }
       outputs?: { ... }
       error_output?: { ... }
       retry_strategy?: { ... }
-      iterations?: { ... }
     } | {
       type?: { ... }
       config?: { ... }
@@ -3385,6 +3239,9 @@ type GetExecutionsResp = {
     resume_token?: string
     trigger_context?: Record<string, string>
     version?: number
+    trigger_event?: {
+      type?: { ... }
+      org_id: { ... }
   // ...
 }
 ```
@@ -4261,7 +4118,6 @@ type ResumeResp = {
       id?: { ... }
       schedule_id?: { ... }
       evaluationResult?: { ... }
-      error_output?: { ... }
       statements?: { ... }
     }>
     schedules?: Array<{
@@ -4314,14 +4170,12 @@ type ResumeResp = {
       reason?: { ... }
       condition_id?: { ... }
       schedule_id?: { ... }
-      loop_id?: { ... }
       execution_status?: { ... }
       started_at?: { ... }
       updated_at?: { ... }
       outputs?: { ... }
       error_output?: { ... }
       retry_strategy?: { ... }
-      iterations?: { ... }
     } | {
       type?: { ... }
       config?: { ... }
@@ -4336,6 +4190,9 @@ type ResumeResp = {
     trigger_context?: Record<string, string>
     version?: number
     trigger_event?: {
+      type?: { ... }
+      org_id: { ... }
+      entity_id: { ... }
   // ...
 }
 ```