@epilot/sdk 2.18.8 → 2.18.9

package/dist/{automation.d-DocUQr4m.d.cts → automation.d-DiWfPkLs.d.cts}

@@ -139,7 +139,7 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
             };
         }
-        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | TriggerEventAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction | FlowExecutionCancelAction | ForwardEmailAction | ReplyEmailAction;
+        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | TriggerEventAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction | FlowExecutionCancelAction | ForwardEmailAction | ReplyEmailAction | AssignEntityAction;
         export type AnyActionConfig = /**
          * example:
          * {
@@ -418,7 +418,29 @@ declare namespace Components {
          *   }
          * }
          */
-        ReplyEmailActionConfig;
+        ReplyEmailActionConfig | /**
+         * example:
+         * {
+         *   "id": "25jga0-gkasl26-0asg-908sgaj2",
+         *   "name": "Assign Entity",
+         *   "type": "assign-entity",
+         *   "config": {
+         *     "attribute": "assigned_to",
+         *     "write_mode": "replace",
+         *     "assignment_type": "direct",
+         *     "assignees": [
+         *       {
+         *         "type": "user",
+         *         "user_id": "90503",
+         *         "org_id": "66",
+         *         "display_name": "Jane Doe",
+         *         "email": "jane.doe@example.com"
+         *       }
+         *     ]
+         *   }
+         * }
+         */
+        AssignEntityActionConfig;
         export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | /**
          * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
          * - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
@@ -640,6 +662,214 @@ declare namespace Components {
              */
             target_unique?: string[];
         }
+        export interface AssignEntityAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "assign-entity";
+            config?: AssignEntityConfig;
+            /**
+             * Whether to stop execution in a failed state if this action fails
+             */
+            allow_failure?: boolean;
+            /**
+             * Flag indicating whether the action was created automatically or manually
+             */
+            created_automatically?: boolean;
+            /**
+             * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
+             */
+            is_bulk_action?: boolean;
+            reason?: {
+                /**
+                 * Why the action has to be skipped/failed
+                 * example:
+                 * There are no registered portal users for the given emails, hence skipping the action
+                 */
+                message?: string;
+                /**
+                 * Extra metadata about the skipping reason - such as a certain condition not met, etc.
+                 */
+                payload?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
+            /**
+             * Id of a loop scope defined on the parent flow. When set, the action runs once per item resolved from the loop's source_path. All actions sharing the same loop_id must be contiguous in the actions array.
+             *
+             */
+            loop_id?: string;
+            execution_status?: ExecutionStatus;
+            started_at?: string;
+            updated_at?: string;
+            /**
+             * example:
+             * {}
+             */
+            outputs?: {
+                [name: string]: any;
+            };
+            error_output?: ErrorOutput;
+            retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
+            /**
+             * For looped actions, an archive of completed iterations. The action's own execution_status / outputs / error_output always reflect the current (latest) iteration. The previous iteration's state is pushed here before the action is reset for the next pass.
+             *
+             */
+            iterations?: /* A snapshot of a single completed pass through a looped action. */ AutomationActionIteration[];
+        }
+        /**
+         * example:
+         * {
+         *   "id": "25jga0-gkasl26-0asg-908sgaj2",
+         *   "name": "Assign Entity",
+         *   "type": "assign-entity",
+         *   "config": {
+         *     "attribute": "assigned_to",
+         *     "write_mode": "replace",
+         *     "assignment_type": "direct",
+         *     "assignees": [
+         *       {
+         *         "type": "user",
+         *         "user_id": "90503",
+         *         "org_id": "66",
+         *         "display_name": "Jane Doe",
+         *         "email": "jane.doe@example.com"
+         *       }
+         *     ]
+         *   }
+         * }
+         */
+        export interface AssignEntityActionConfig {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "assign-entity";
+            config?: AssignEntityConfig;
+            /**
+             * Whether to stop execution in a failed state if this action fails
+             */
+            allow_failure?: boolean;
+            /**
+             * Flag indicating whether the action was created automatically or manually
+             */
+            created_automatically?: boolean;
+            /**
+             * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
+             */
+            is_bulk_action?: boolean;
+            reason?: {
+                /**
+                 * Why the action has to be skipped/failed
+                 * example:
+                 * There are no registered portal users for the given emails, hence skipping the action
+                 */
+                message?: string;
+                /**
+                 * Extra metadata about the skipping reason - such as a certain condition not met, etc.
+                 */
+                payload?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
+            /**
+             * Id of a loop scope defined on the parent flow. When set, the action runs once per item resolved from the loop's source_path. All actions sharing the same loop_id must be contiguous in the actions array.
+             *
+             */
+            loop_id?: string;
+        }
+        export interface AssignEntityConfig {
+            /**
+             * Slug of the user-relation attribute on the triggering entity to write to.
+             */
+            attribute?: string;
+            /**
+             * Assignees to write into `attribute`, in the order given.
+             */
+            assignees?: /**
+             * A single assignee as stored in a user-relation attribute. Written through
+             * verbatim by the assign-entity worker. Note this object encoding differs
+             * deliberately from AssignThreadConfig, which stores bare id strings —
+             * each matches what its own target accepts.
+             *
+             */
+            EntityAssignee[];
+            /**
+             * How `assignees` combine with the attribute's current value.
+             * - replace: overwrite the attribute with `assignees` (default).
+             * - append: union with the existing assignees, de-duplicated, existing
+             *   entries first. Two assignees are duplicates when their `type` and
+             *   `org_id` both match and the identifier for that type matches:
+             *   `user_id` for user and partner_user, `group_id` for group,
+             *   `partner_id` for partner_organization. Scoping by `org_id` keeps
+             *   assignees from different organizations distinct even when their
+             *   identifiers coincide.
+             *
+             */
+            write_mode?: "replace" | "append";
+            /**
+             * How assignees are resolved.
+             * - direct: assign exactly the assignees listed (default, and the only
+             *   accepted value).
+             * Reserved for a future routing strategy; widening this enum later is
+             * backwards compatible and needs no migration of existing flows.
+             *
+             */
+            assignment_type?: "direct";
+            /**
+             * Which entity to assign to. Omit for the triggering entity (the
+             * default, and the behaviour of every flow saved before this field
+             * existed).
+             * - trigger: the entity that started the flow.
+             * - action: the entity produced by an earlier action, identified by
+             *   that action's `flow_action_id`.
+             *
+             */
+            source?: {
+                /**
+                 * The producing action's `flow_action_id` when origin is `action`, or the trigger id when origin is `trigger`. Note this is `flow_action_id` (stable across executions), not `id`.
+                 *
+                 */
+                id?: string;
+                origin?: "trigger" | "action";
+                /**
+                 * Entity schema recorded when the source was chosen, for display. The worker uses the schema on the resolved entity itself, since this value goes stale if the producing action's target changes.
+                 *
+                 */
+                schema?: string;
+            };
+        }
         export interface AssignThreadAction {
             id?: /**
              * example:
@@ -735,6 +965,17 @@ declare namespace Components {
              *
              */
             only_available_users?: boolean;
+            /**
+             * Sub-option of only_available_users: when a day off (weekend / whole
+             * day off with a known return) is what empties the candidate pool, hold
+             * the thread and retry when the soonest candidate is back — bounded to
+             * 7 retries over 7 days — before applying the fallback. Defaults to
+             * true; set false to skip the hold and fall straight through to the
+             * fallback. Out-of-office / vacation and non-availability reasons never
+             * hold regardless.
+             *
+             */
+            hold_until_available?: boolean;
             /**
              * Candidate condition for even_distribution: when true, only assign to
              * users whose skills (tags) match a label on the message. Opt-in;
@@ -1904,6 +2145,43 @@ declare namespace Components {
         export type DiffAdded = FilterConditionOnEvent;
         export type DiffDeleted = FilterConditionOnEvent;
         export type DiffUpdated = FilterConditionOnEvent;
+        /**
+         * A single assignee as stored in a user-relation attribute. Written through
+         * verbatim by the assign-entity worker. Note this object encoding differs
+         * deliberately from AssignThreadConfig, which stores bare id strings —
+         * each matches what its own target accepts.
+         *
+         */
+        export interface EntityAssignee {
+            /**
+             * Which kind of principal this assignee is. Required: it selects which
+             * of the identifier properties below applies, and forms part of the
+             * append-mode de-duplication key.
+             *
+             */
+            type: "user" | "partner_user" | "partner_organization" | "group";
+            /**
+             * Set for user and partner_user assignees.
+             */
+            user_id?: string;
+            /**
+             * Set for group assignees.
+             */
+            group_id?: string;
+            /**
+             * Organization the assignee belongs to.
+             */
+            org_id?: string;
+            /**
+             * Set for partner_user and partner_organization assignees.
+             */
+            partner_id?: string;
+            /**
+             * Label snapshotted at configuration time; may go stale after a rename.
+             */
+            display_name?: string;
+            email?: string;
+        }
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -3180,6 +3458,11 @@ declare namespace Components {
              * Schema of target entity
              */
             target_schema: string;
+            /**
+             * Resolve this action's target (contact/account) via the organization's global uniqueness criteria instead of per-action identifiers (target_unique / Unique switches). Forwarded to entity mapping by automation-workers.
+             *
+             */
+            use_uniqueness_criteria?: boolean;
             /**
              * Unique key for target entity (see upsertEntity of Entity API)
              */
@@ -4728,6 +5011,11 @@ declare namespace Components {
             workflow_exec_task_id?: string;
             workflow_role: /* The role this automation plays in the workflow. */ WorkflowContextRole;
             _execution_chain?: /* [Internal] Tracks execution chain for infinite loop prevention. This is an internal property and should not be used by external consumers. */ ExecutionChain;
+            /**
+             * [Internal] Ordered automation flow ids that led to the parent flow being started. The started execution appends its own flow id, so entity writes it performs carry the full chain and a loop running through a workflow can be detected. This is an internal property and should not be used by external consumers.
+             *
+             */
+            _automation_chain?: string[];
             /**
              * Additional entity contexts from the parent flow execution. Used when an automation is triggered from a workflow task to carry all flow contexts into the automation, not just the primary entity.
              *
@@ -5609,6 +5897,9 @@ type AnythingButCondition = Components.Schemas.AnythingButCondition;
 type ApiCallerContext = Components.Schemas.ApiCallerContext;
 type ApiSubmissionTrigger = Components.Schemas.ApiSubmissionTrigger;
 type AppendValueMapper = Components.Schemas.AppendValueMapper;
+type AssignEntityAction = Components.Schemas.AssignEntityAction;
+type AssignEntityActionConfig = Components.Schemas.AssignEntityActionConfig;
+type AssignEntityConfig = Components.Schemas.AssignEntityConfig;
 type AssignThreadAction = Components.Schemas.AssignThreadAction;
 type AssignThreadConfig = Components.Schemas.AssignThreadConfig;
 type AssignUsersToStep = Components.Schemas.AssignUsersToStep;
@@ -5640,6 +5931,7 @@ type CustomAction = Components.Schemas.CustomAction;
 type DiffAdded = Components.Schemas.DiffAdded;
 type DiffDeleted = Components.Schemas.DiffDeleted;
 type DiffUpdated = Components.Schemas.DiffUpdated;
+type EntityAssignee = Components.Schemas.EntityAssignee;
 type EntityId = Components.Schemas.EntityId;
 type EntityItemSnapshot = Components.Schemas.EntityItemSnapshot;
 type EntityManualTrigger = Components.Schemas.EntityManualTrigger;
@@ -5735,4 +6027,4 @@ type WildcardCondition = Components.Schemas.WildcardCondition;
 type WorkflowContextRole = Components.Schemas.WorkflowContextRole;
 type WorkflowExecutionContext = Components.Schemas.WorkflowExecutionContext;
 
-export { type EntityRef as $, type ActionCondition as A, type AutomationLoopState as B, type Client as C, type AutomationTrigger as D, type BulkTriggerJob as E, type BulkTriggerRequest as F, type CancellationReason as G, type CartCheckoutAction as H, type CartCheckoutActionConfig as I, type CartCheckoutConfig as J, type Comparison as K, type ConditionStatement as L, type CopyValueMapper as M, type CreateDocumentAction as N, type OperationMethods as O, Paths as P, type CreateDocumentActionConfig as Q, type CreateDocumentConfig as R, type CustomAction as S, type DiffAdded as T, type DiffDeleted as U, type DiffUpdated as V, type EntityId as W, type EntityItemSnapshot as X, type EntityManualTrigger as Y, type EntityOperation as Z, type EntityOperationTrigger as _, Components as a, type StartExecutionRequest as a$, type EntitySearchFilter as a0, type EntitySearchFilterValue as a1, type EqualsIgnoreCaseCondition as a2, type ErrorCode as a3, type ErrorDetail as a4, type ErrorObject as a5, type ErrorOutput as a6, type ExecItem as a7, type ExecutionChain as a8, type ExecutionStatus as a9, type NumericCondition as aA, type OperationNode as aB, type OperationObjectNode as aC, type OrCondition as aD, type OrConditionForDiff as aE, type OrganizationId as aF, type PatchBulkJobRequest as aG, type PrefixCondition as aH, type PrimitiveJSONValue as aI, type ReceivedEmailTrigger as aJ, type RelationAttribute as aK, type ReplyEmailAction as aL, type ReplyEmailActionConfig as aM, type ReplyEmailConfig as aN, type ResumeReq as aO, type ResumeResp as aP, type ResumeToken as aQ, type RetryReq as aR, type RetryStrategy as aS, type SearchAutomationsResp as aT, type SearchExecutionsReq as aU, type SearchExecutionsResp as aV, type SendEmailAction as aW, type SendEmailActionConfig as aX, type SendEmailCondition as aY, type SendEmailConfig as aZ, type SetValueMapper as a_, type ExistsCondition as aa, type FilterConditionOnEvent as ab, type FlowExecutionCancelAction as ac, type FlowExecutionCancelActionConfig as ad, type FlowExecutionCancelConfig as ae, type FlowsTrigger as af, type ForwardEmailAction as ag, type ForwardEmailActionConfig as ah, type ForwardEmailConfig as ai, type FrontendSubmitTrigger as aj, type GetExecutionsResp as ak, type InformERPAction as al, type InformERPActionConfig as am, type InformERPConfig as an, type JobId as ao, type JourneySubmitTrigger as ap, type MapEntityAction as aq, type MapEntityActionConfig as ar, type MapEntityConfig as as, type MappingAttribute as at, type MappingAttributeMode as au, type MappingAttributeV2 as av, type MappingConfigRef as aw, type MoveThreadAction as ax, type MoveThreadConfig as ay, type NewEmailThreadTrigger as az, type PathsDictionary as b, type SuffixCondition as b0, type TriggerCondition as b1, type TriggerContext as b2, type TriggerEventAction as b3, type TriggerEventActionConfig as b4, type TriggerEventConfig as b5, type TriggerEventEntityActivity as b6, type TriggerEventEntityOperation as b7, type TriggerEventFlowAutomationTask as b8, type TriggerEventManual as b9, type TriggerEventMessaging as ba, type TriggerShareEntityAction as bb, type TriggerShareEntityActionConfig as bc, type TriggerShareEntityConfig as bd, type TriggerWebhookAction as be, type TriggerWebhookActionConfig as bf, type TriggerWebhookConfig as bg, type TriggerWorkflowAction as bh, type TriggerWorkflowActionConfig as bi, type TriggerWorkflowCondition as bj, type TriggerWorkflowConfig as bk, type WildcardCondition as bl, type WorkflowContextRole as bm, type WorkflowExecutionContext as bn, type ActionSchedule as c, type ActionScheduleSource as d, type ActivityId as e, type ActivityTrigger as f, type AnyAction as g, type AnyActionConfig as h, type AnyTrigger as i, type AnythingButCondition as j, type ApiCallerContext as k, type ApiSubmissionTrigger as l, type AppendValueMapper as m, type AssignThreadAction as n, type AssignThreadConfig as o, type AssignUsersToStep as p, type AutomationAction as q, type AutomationActionConfig as r, type AutomationActionExecutionState as s, type AutomationActionId as t, type AutomationActionIteration as u, type AutomationExecution as v, type AutomationExecutionId as w, type AutomationFlow as x, type AutomationFlowId as y, type AutomationLoop as z };
+export { type EntityItemSnapshot as $, type ActionCondition as A, type AutomationFlow as B, type Client as C, type AutomationFlowId as D, type AutomationLoop as E, type AutomationLoopState as F, type AutomationTrigger as G, type BulkTriggerJob as H, type BulkTriggerRequest as I, type CancellationReason as J, type CartCheckoutAction as K, type CartCheckoutActionConfig as L, type CartCheckoutConfig as M, type Comparison as N, type OperationMethods as O, Paths as P, type ConditionStatement as Q, type CopyValueMapper as R, type CreateDocumentAction as S, type CreateDocumentActionConfig as T, type CreateDocumentConfig as U, type CustomAction as V, type DiffAdded as W, type DiffDeleted as X, type DiffUpdated as Y, type EntityAssignee as Z, type EntityId as _, Components as a, type SendEmailActionConfig as a$, type EntityManualTrigger as a0, type EntityOperation as a1, type EntityOperationTrigger as a2, type EntityRef as a3, type EntitySearchFilter as a4, type EntitySearchFilterValue as a5, type EqualsIgnoreCaseCondition as a6, type ErrorCode as a7, type ErrorDetail as a8, type ErrorObject as a9, type MappingConfigRef as aA, type MoveThreadAction as aB, type MoveThreadConfig as aC, type NewEmailThreadTrigger as aD, type NumericCondition as aE, type OperationNode as aF, type OperationObjectNode as aG, type OrCondition as aH, type OrConditionForDiff as aI, type OrganizationId as aJ, type PatchBulkJobRequest as aK, type PrefixCondition as aL, type PrimitiveJSONValue as aM, type ReceivedEmailTrigger as aN, type RelationAttribute as aO, type ReplyEmailAction as aP, type ReplyEmailActionConfig as aQ, type ReplyEmailConfig as aR, type ResumeReq as aS, type ResumeResp as aT, type ResumeToken as aU, type RetryReq as aV, type RetryStrategy as aW, type SearchAutomationsResp as aX, type SearchExecutionsReq as aY, type SearchExecutionsResp as aZ, type SendEmailAction as a_, type ErrorOutput as aa, type ExecItem as ab, type ExecutionChain as ac, type ExecutionStatus as ad, type ExistsCondition as ae, type FilterConditionOnEvent as af, type FlowExecutionCancelAction as ag, type FlowExecutionCancelActionConfig as ah, type FlowExecutionCancelConfig as ai, type FlowsTrigger as aj, type ForwardEmailAction as ak, type ForwardEmailActionConfig as al, type ForwardEmailConfig as am, type FrontendSubmitTrigger as an, type GetExecutionsResp as ao, type InformERPAction as ap, type InformERPActionConfig as aq, type InformERPConfig as ar, type JobId as as, type JourneySubmitTrigger as at, type MapEntityAction as au, type MapEntityActionConfig as av, type MapEntityConfig as aw, type MappingAttribute as ax, type MappingAttributeMode as ay, type MappingAttributeV2 as az, type PathsDictionary as b, type SendEmailCondition as b0, type SendEmailConfig as b1, type SetValueMapper as b2, type StartExecutionRequest as b3, type SuffixCondition as b4, type TriggerCondition as b5, type TriggerContext as b6, type TriggerEventAction as b7, type TriggerEventActionConfig as b8, type TriggerEventConfig as b9, type TriggerEventEntityActivity as ba, type TriggerEventEntityOperation as bb, type TriggerEventFlowAutomationTask as bc, type TriggerEventManual as bd, type TriggerEventMessaging as be, type TriggerShareEntityAction as bf, type TriggerShareEntityActionConfig as bg, type TriggerShareEntityConfig as bh, type TriggerWebhookAction as bi, type TriggerWebhookActionConfig as bj, type TriggerWebhookConfig as bk, type TriggerWorkflowAction as bl, type TriggerWorkflowActionConfig as bm, type TriggerWorkflowCondition as bn, type TriggerWorkflowConfig as bo, type WildcardCondition as bp, type WorkflowContextRole as bq, type WorkflowExecutionContext as br, type ActionSchedule as c, type ActionScheduleSource as d, type ActivityId as e, type ActivityTrigger as f, type AnyAction as g, type AnyActionConfig as h, type AnyTrigger as i, type AnythingButCondition as j, type ApiCallerContext as k, type ApiSubmissionTrigger as l, type AppendValueMapper as m, type AssignEntityAction as n, type AssignEntityActionConfig as o, type AssignEntityConfig as p, type AssignThreadAction as q, type AssignThreadConfig as r, type AssignUsersToStep as s, type AutomationAction as t, type AutomationActionConfig as u, type AutomationActionExecutionState as v, type AutomationActionId as w, type AutomationActionIteration as x, type AutomationExecution as y, type AutomationExecutionId as z };