@epilot/sdk 2.20.1 → 2.20.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/automation-runtime.json +1 -1
- package/definitions/automation.json +344 -12
- package/definitions/event-catalog-runtime.json +1 -1
- package/definitions/event-catalog.json +431 -12
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +8 -8
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +2 -2
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +8 -8
- package/dist/apis/event-catalog.d.cts +2 -2
- package/dist/apis/event-catalog.d.ts +2 -2
- package/dist/apis/event-catalog.js +2 -2
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/automation-23XNDPBF.cjs +7 -0
- package/dist/automation-OMESM3H3.js +7 -0
- package/dist/{automation-runtime-RM5EOZH2.cjs → automation-runtime-KLCXZKEC.cjs} +2 -2
- package/dist/{automation-runtime-ORW5BVCD.js → automation-runtime-Y52HM57N.js} +1 -1
- package/dist/{automation.d-BnQFR6k8.d.cts → automation.d-D8JxyoFa.d.cts} +317 -21
- package/dist/{automation.d-BnQFR6k8.d.ts → automation.d-D8JxyoFa.d.ts} +317 -21
- package/dist/{chunk-L7RZB4SO.cjs → chunk-AUHRCKFN.cjs} +4 -4
- package/dist/chunk-EEKJGTAS.js +14 -0
- package/dist/{chunk-LWW6JFX2.js → chunk-GNKU7CBT.js} +4 -4
- package/dist/chunk-MPZICOVZ.cjs +14 -0
- package/dist/chunk-QW3ROE6H.js +14 -0
- package/dist/chunk-WOUASZJW.cjs +14 -0
- package/dist/event-catalog-4FVQZ65M.cjs +7 -0
- package/dist/event-catalog-PEOHXUJO.js +7 -0
- package/dist/{event-catalog-runtime-RH7542GL.cjs → event-catalog-runtime-AME244T7.cjs} +2 -2
- package/dist/{event-catalog-runtime-JUSLF3UR.js → event-catalog-runtime-Q3MKEDG4.js} +1 -1
- package/dist/{event-catalog.d-QIhhewVH.d.cts → event-catalog.d-Bd2wmtlZ.d.cts} +335 -179
- package/dist/{event-catalog.d-QIhhewVH.d.ts → event-catalog.d-Bd2wmtlZ.d.ts} +335 -179
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/docs/automation.md +237 -45
- package/docs/event-catalog.md +483 -64
- package/package.json +1 -1
- package/dist/automation-3HMHBP6P.cjs +0 -7
- package/dist/automation-GIJB3MOI.js +0 -7
- package/dist/chunk-ADSWGLIV.cjs +0 -14
- package/dist/chunk-FDS727SL.cjs +0 -14
- package/dist/chunk-LCE7N4ZL.js +0 -14
- package/dist/chunk-M4FO2MI4.js +0 -14
- package/dist/event-catalog-6ZSSF5JU.cjs +0 -7
- package/dist/event-catalog-RS4LJMY2.js +0 -7
|
@@ -557,7 +557,23 @@ declare namespace Components {
|
|
|
557
557
|
* ```
|
|
558
558
|
*
|
|
559
559
|
*/
|
|
560
|
-
EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | NewEmailThreadTrigger | FlowsTrigger
|
|
560
|
+
EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | NewEmailThreadTrigger | FlowsTrigger | /**
|
|
561
|
+
* Starts the flow when an Event Catalog event is published for the organization. The execution runs in the context of one entity from the event's entity graph (`entity_node_id`), and the event payload is available to conditions and actions as the `event` variable context.
|
|
562
|
+
*
|
|
563
|
+
* example:
|
|
564
|
+
* {
|
|
565
|
+
* "id": "12d4f45a-1883-4841-a94c-5928cb338a94",
|
|
566
|
+
* "type": "event_catalog",
|
|
567
|
+
* "configuration": {
|
|
568
|
+
* "event_name": "CustomerRequestSubmitted",
|
|
569
|
+
* "event_version": "1.1",
|
|
570
|
+
* "entity_node_id": "ticket",
|
|
571
|
+
* "entity_schema": "ticket",
|
|
572
|
+
* "ignore_automation_triggered": true
|
|
573
|
+
* }
|
|
574
|
+
* }
|
|
575
|
+
*/
|
|
576
|
+
EventCatalogTrigger;
|
|
561
577
|
export interface AnythingButCondition {
|
|
562
578
|
"anything-but"?: string[];
|
|
563
579
|
}
|
|
@@ -1275,14 +1291,14 @@ declare namespace Components {
|
|
|
1275
1291
|
* 2
|
|
1276
1292
|
*/
|
|
1277
1293
|
version?: number;
|
|
1278
|
-
trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask | TriggerEventMessaging
|
|
1279
|
-
|
|
1280
|
-
* Automation Executions triggered by workflow task automations will always carry information about the triggering workflow. This information is helpful in correlating workflow executions with all the triggered automation executions
|
|
1294
|
+
trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask | TriggerEventMessaging | /**
|
|
1295
|
+
* Set on executions started by an Event Catalog event (see EventCatalogTrigger). The full event payload is not stored inline (it may be up to 256 KB) but by reference in `payload_ref`; automation workers hydrate it before every action.
|
|
1281
1296
|
*
|
|
1282
1297
|
*/
|
|
1283
|
-
|
|
1298
|
+
TriggerEventEventCatalog;
|
|
1299
|
+
workflow_context?: WorkflowExecutionContext;
|
|
1284
1300
|
workflow_wait_context?: /**
|
|
1285
|
-
*
|
|
1301
|
+
* Correlation stamped when the triggering submission entity carried workflow wait claims from a journey link (AL-2521). Consumed by svc-workflows to resume a task waiting on this journey submission.
|
|
1286
1302
|
*
|
|
1287
1303
|
*/
|
|
1288
1304
|
WorkflowWaitContext;
|
|
@@ -1873,7 +1889,11 @@ declare namespace Components {
|
|
|
1873
1889
|
*/
|
|
1874
1890
|
id?: string;
|
|
1875
1891
|
origin?: "trigger" | "action";
|
|
1876
|
-
|
|
1892
|
+
/**
|
|
1893
|
+
* `event` reads the operand from the trigger's Event Catalog payload instead of an entity: `attribute` is then a dot path into the payload (e.g. `ticket.subject`). Only valid with `origin: trigger` on flows started by an EventCatalogTrigger.
|
|
1894
|
+
*
|
|
1895
|
+
*/
|
|
1896
|
+
originType?: "entity" | "workflow" | "journey_block" | "event";
|
|
1877
1897
|
schema?: string;
|
|
1878
1898
|
attribute?: string;
|
|
1879
1899
|
attributeType?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label" | "payment" | "relation_payment_method";
|
|
@@ -2226,7 +2246,7 @@ declare namespace Components {
|
|
|
2226
2246
|
schema?: string;
|
|
2227
2247
|
};
|
|
2228
2248
|
}
|
|
2229
|
-
export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity";
|
|
2249
|
+
export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity" | "relationsAdded" | "relationsRemoved" | "relationsSoftDeleted" | "relationsRestored" | "relationsDeleted";
|
|
2230
2250
|
/**
|
|
2231
2251
|
* - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
|
|
2232
2252
|
* - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
|
|
@@ -2634,6 +2654,63 @@ declare namespace Components {
|
|
|
2634
2654
|
details?: ErrorDetail[];
|
|
2635
2655
|
};
|
|
2636
2656
|
}
|
|
2657
|
+
/**
|
|
2658
|
+
* Starts the flow when an Event Catalog event is published for the organization. The execution runs in the context of one entity from the event's entity graph (`entity_node_id`), and the event payload is available to conditions and actions as the `event` variable context.
|
|
2659
|
+
*
|
|
2660
|
+
* example:
|
|
2661
|
+
* {
|
|
2662
|
+
* "id": "12d4f45a-1883-4841-a94c-5928cb338a94",
|
|
2663
|
+
* "type": "event_catalog",
|
|
2664
|
+
* "configuration": {
|
|
2665
|
+
* "event_name": "CustomerRequestSubmitted",
|
|
2666
|
+
* "event_version": "1.1",
|
|
2667
|
+
* "entity_node_id": "ticket",
|
|
2668
|
+
* "entity_schema": "ticket",
|
|
2669
|
+
* "ignore_automation_triggered": true
|
|
2670
|
+
* }
|
|
2671
|
+
* }
|
|
2672
|
+
*/
|
|
2673
|
+
export interface EventCatalogTrigger {
|
|
2674
|
+
/**
|
|
2675
|
+
* example:
|
|
2676
|
+
* 12d4f45a-1883-4841-a94c-5928cb338a94
|
|
2677
|
+
*/
|
|
2678
|
+
id?: string; // uuid
|
|
2679
|
+
type: "event_catalog";
|
|
2680
|
+
configuration: {
|
|
2681
|
+
/**
|
|
2682
|
+
* Name of the Event Catalog event that starts this flow
|
|
2683
|
+
* example:
|
|
2684
|
+
* CustomerRequestSubmitted
|
|
2685
|
+
*/
|
|
2686
|
+
event_name: string;
|
|
2687
|
+
/**
|
|
2688
|
+
* Event version (MAJOR.MINOR) this trigger is pinned to. Payloads published in a newer version are downgraded to this version before the flow runs, so field references in conditions and actions stay stable.
|
|
2689
|
+
*
|
|
2690
|
+
* example:
|
|
2691
|
+
* 1.1
|
|
2692
|
+
*/
|
|
2693
|
+
event_version: string;
|
|
2694
|
+
/**
|
|
2695
|
+
* Id of the cardinality-one node in the event's entity graph whose entity becomes the execution's main entity (the entity actions operate on).
|
|
2696
|
+
*
|
|
2697
|
+
* example:
|
|
2698
|
+
* ticket
|
|
2699
|
+
*/
|
|
2700
|
+
entity_node_id: string;
|
|
2701
|
+
/**
|
|
2702
|
+
* Schema of the entity behind `entity_node_id`, denormalized from the event definition at configuration time
|
|
2703
|
+
* example:
|
|
2704
|
+
* ticket
|
|
2705
|
+
*/
|
|
2706
|
+
entity_schema: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* When true (default), events that were emitted by an automation (`_trigger_source_type: automation`) do not start this flow. This prevents automation → event → automation chains unless explicitly enabled.
|
|
2709
|
+
*
|
|
2710
|
+
*/
|
|
2711
|
+
ignore_automation_triggered?: boolean;
|
|
2712
|
+
};
|
|
2713
|
+
}
|
|
2637
2714
|
/**
|
|
2638
2715
|
* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status
|
|
2639
2716
|
*/
|
|
@@ -3051,6 +3128,107 @@ declare namespace Components {
|
|
|
3051
3128
|
total: number;
|
|
3052
3129
|
results: AutomationExecution[];
|
|
3053
3130
|
}
|
|
3131
|
+
/**
|
|
3132
|
+
* One multi-hop graph query to run against entity-api's `POST /v1/entity:graph`. Every node
|
|
3133
|
+
* in `graph.nodes` is merged into the mapping's source context under its own `id`, so
|
|
3134
|
+
* listing multiple nodes here costs one entity-api call, not one per node. A node's value
|
|
3135
|
+
* overwrites any existing source-context key of the same name (the source entity, a 1-hop
|
|
3136
|
+
* relation, or another graph node).
|
|
3137
|
+
*
|
|
3138
|
+
*/
|
|
3139
|
+
export interface GraphContextEntry {
|
|
3140
|
+
seed: GraphSeed;
|
|
3141
|
+
graph: GraphDefinition;
|
|
3142
|
+
}
|
|
3143
|
+
export interface GraphDefinition {
|
|
3144
|
+
/**
|
|
3145
|
+
* List of node definitions in the graph
|
|
3146
|
+
*/
|
|
3147
|
+
nodes: GraphNode[];
|
|
3148
|
+
/**
|
|
3149
|
+
* List of edge definitions connecting nodes
|
|
3150
|
+
*/
|
|
3151
|
+
edges: GraphEdge[];
|
|
3152
|
+
}
|
|
3153
|
+
export interface GraphEdge {
|
|
3154
|
+
/**
|
|
3155
|
+
* Source node ID
|
|
3156
|
+
* example:
|
|
3157
|
+
* contact
|
|
3158
|
+
*/
|
|
3159
|
+
from: string;
|
|
3160
|
+
/**
|
|
3161
|
+
* Target node ID
|
|
3162
|
+
* example:
|
|
3163
|
+
* billing_account
|
|
3164
|
+
*/
|
|
3165
|
+
to: string;
|
|
3166
|
+
}
|
|
3167
|
+
export interface GraphNode {
|
|
3168
|
+
/**
|
|
3169
|
+
* Unique identifier for this node in the graph definition
|
|
3170
|
+
* example:
|
|
3171
|
+
* contact
|
|
3172
|
+
*/
|
|
3173
|
+
id: string;
|
|
3174
|
+
/**
|
|
3175
|
+
* Entity schema slug for this node
|
|
3176
|
+
* example:
|
|
3177
|
+
* contact
|
|
3178
|
+
*/
|
|
3179
|
+
schema: string;
|
|
3180
|
+
/**
|
|
3181
|
+
* "one": this node resolves to a single entity. "many" (default if unset): this node
|
|
3182
|
+
* resolves to an array of entities. The seed node always returns a single entity
|
|
3183
|
+
* regardless of this setting.
|
|
3184
|
+
*
|
|
3185
|
+
* example:
|
|
3186
|
+
* one
|
|
3187
|
+
*/
|
|
3188
|
+
cardinality?: "one" | "many";
|
|
3189
|
+
/**
|
|
3190
|
+
* Optional entity fields to include in the hydrated response for this node.
|
|
3191
|
+
*/
|
|
3192
|
+
fields?: string[];
|
|
3193
|
+
/**
|
|
3194
|
+
* Narrows this node's traversal results to entities matching every filter (AND
|
|
3195
|
+
* semantics). Useful for disambiguating among multiple entities reachable via the same
|
|
3196
|
+
* graph edge.
|
|
3197
|
+
*
|
|
3198
|
+
*/
|
|
3199
|
+
filter?: /* Entities are included in this node's result only if `attribute` exactly equals the literal `value`. */ GraphNodeFilter[];
|
|
3200
|
+
}
|
|
3201
|
+
/**
|
|
3202
|
+
* Entities are included in this node's result only if `attribute` exactly equals the literal `value`.
|
|
3203
|
+
*/
|
|
3204
|
+
export interface GraphNodeFilter {
|
|
3205
|
+
/**
|
|
3206
|
+
* Entity attribute name to match against.
|
|
3207
|
+
* example:
|
|
3208
|
+
* order_number
|
|
3209
|
+
*/
|
|
3210
|
+
attribute: string;
|
|
3211
|
+
/**
|
|
3212
|
+
* Literal value the attribute must exactly equal for the entity to be included in this node's result. Supports `{{handlebars}}` placeholders resolved against sourceContext when given as a string.
|
|
3213
|
+
* example:
|
|
3214
|
+
* OR-113
|
|
3215
|
+
*/
|
|
3216
|
+
value: /**
|
|
3217
|
+
* Literal value the attribute must exactly equal for the entity to be included in this node's result. Supports `{{handlebars}}` placeholders resolved against sourceContext when given as a string.
|
|
3218
|
+
* example:
|
|
3219
|
+
* OR-113
|
|
3220
|
+
*/
|
|
3221
|
+
(string | null) | number | boolean;
|
|
3222
|
+
}
|
|
3223
|
+
export interface GraphSeed {
|
|
3224
|
+
entity_id: string; // uuid
|
|
3225
|
+
/**
|
|
3226
|
+
* The node ID in the graph definition that corresponds to the seed entity
|
|
3227
|
+
* example:
|
|
3228
|
+
* contact
|
|
3229
|
+
*/
|
|
3230
|
+
node_id: string;
|
|
3231
|
+
}
|
|
3054
3232
|
export interface InformERPAction {
|
|
3055
3233
|
id?: /**
|
|
3056
3234
|
* example:
|
|
@@ -3506,6 +3684,27 @@ declare namespace Components {
|
|
|
3506
3684
|
* Relation tags (labels) to include in main entity linkback relation attribute
|
|
3507
3685
|
*/
|
|
3508
3686
|
linkback_relation_tags?: string[];
|
|
3687
|
+
/**
|
|
3688
|
+
* Multi-hop graph queries (executed via entity-api's `POST /v1/entity:graph`), each
|
|
3689
|
+
* merging every traversed node into the mapping's source context under its own node id,
|
|
3690
|
+
* so `mapping_attributes` (e.g. `_copy` / `_template`) can reference it alongside the
|
|
3691
|
+
* main entity, e.g. `{ "_copy": "order.line_items" }`.
|
|
3692
|
+
*
|
|
3693
|
+
* `seed.entity_id` and any node `filter[].value` may contain `{{handlebars}}`
|
|
3694
|
+
* placeholders (e.g. `{{trigger.entity._id}}`) that are resolved at execution time
|
|
3695
|
+
* against the mapping's source context. Resolution and graph execution happen in
|
|
3696
|
+
* entity-mapping-api; this API only accepts, validates and passes through this field.
|
|
3697
|
+
*
|
|
3698
|
+
*/
|
|
3699
|
+
graph_context?: /**
|
|
3700
|
+
* One multi-hop graph query to run against entity-api's `POST /v1/entity:graph`. Every node
|
|
3701
|
+
* in `graph.nodes` is merged into the mapping's source context under its own `id`, so
|
|
3702
|
+
* listing multiple nodes here costs one entity-api call, not one per node. A node's value
|
|
3703
|
+
* overwrites any existing source-context key of the same name (the source entity, a 1-hop
|
|
3704
|
+
* relation, or another graph node).
|
|
3705
|
+
*
|
|
3706
|
+
*/
|
|
3707
|
+
GraphContextEntry[];
|
|
3509
3708
|
}
|
|
3510
3709
|
export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
|
|
3511
3710
|
/**
|
|
@@ -3889,8 +4088,10 @@ declare namespace Components {
|
|
|
3889
4088
|
email_template_id?: string;
|
|
3890
4089
|
/**
|
|
3891
4090
|
* Language code for the email template
|
|
4091
|
+
* example:
|
|
4092
|
+
* de
|
|
3892
4093
|
*/
|
|
3893
|
-
language_code?:
|
|
4094
|
+
language_code?: string;
|
|
3894
4095
|
/**
|
|
3895
4096
|
* Controls how the reply email is sent.
|
|
3896
4097
|
* - reply_in_thread: Sends the email as a reply within the existing email thread (default).
|
|
@@ -4119,7 +4320,11 @@ declare namespace Components {
|
|
|
4119
4320
|
}
|
|
4120
4321
|
export interface SendEmailConfig {
|
|
4121
4322
|
email_template_id?: string;
|
|
4122
|
-
|
|
4323
|
+
/**
|
|
4324
|
+
* example:
|
|
4325
|
+
* de
|
|
4326
|
+
*/
|
|
4327
|
+
language_code?: string;
|
|
4123
4328
|
/**
|
|
4124
4329
|
* Send an email exclusively to the portal user if they are registered on the portal.
|
|
4125
4330
|
*/
|
|
@@ -4253,11 +4458,7 @@ declare namespace Components {
|
|
|
4253
4458
|
* 7791b04a-16d2-44a2-9af9-2d59c25c512f
|
|
4254
4459
|
*/
|
|
4255
4460
|
AutomationFlowId;
|
|
4256
|
-
workflow_context?:
|
|
4257
|
-
* Automation Executions triggered by workflow task automations will always carry information about the triggering workflow. This information is helpful in correlating workflow executions with all the triggered automation executions
|
|
4258
|
-
*
|
|
4259
|
-
*/
|
|
4260
|
-
WorkflowExecutionContext;
|
|
4461
|
+
workflow_context?: WorkflowExecutionContext;
|
|
4261
4462
|
/**
|
|
4262
4463
|
* Use workflow_context.workflow_exec_id instead
|
|
4263
4464
|
*/
|
|
@@ -4484,6 +4685,64 @@ declare namespace Components {
|
|
|
4484
4685
|
ActivityId;
|
|
4485
4686
|
operation_type: EntityOperation;
|
|
4486
4687
|
}
|
|
4688
|
+
/**
|
|
4689
|
+
* Set on executions started by an Event Catalog event (see EventCatalogTrigger). The full event payload is not stored inline (it may be up to 256 KB) but by reference in `payload_ref`; automation workers hydrate it before every action.
|
|
4690
|
+
*
|
|
4691
|
+
*/
|
|
4692
|
+
export interface TriggerEventEventCatalog {
|
|
4693
|
+
type: "event_catalog";
|
|
4694
|
+
/**
|
|
4695
|
+
* example:
|
|
4696
|
+
* 123
|
|
4697
|
+
*/
|
|
4698
|
+
org_id: string;
|
|
4699
|
+
entity_id: /**
|
|
4700
|
+
* example:
|
|
4701
|
+
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74
|
|
4702
|
+
*/
|
|
4703
|
+
EntityId;
|
|
4704
|
+
/**
|
|
4705
|
+
* Node id of the event's entity graph that was resolved to `entity_id`
|
|
4706
|
+
* example:
|
|
4707
|
+
* ticket
|
|
4708
|
+
*/
|
|
4709
|
+
entity_node_id: string;
|
|
4710
|
+
/**
|
|
4711
|
+
* Event Catalog event id (ULID) of the published event
|
|
4712
|
+
* example:
|
|
4713
|
+
* 01K3ZK8QZ7Y7Q2M8W1V3N4X5P6
|
|
4714
|
+
*/
|
|
4715
|
+
event_id: string;
|
|
4716
|
+
/**
|
|
4717
|
+
* example:
|
|
4718
|
+
* CustomerRequestSubmitted
|
|
4719
|
+
*/
|
|
4720
|
+
event_name: string;
|
|
4721
|
+
/**
|
|
4722
|
+
* Version the payload was delivered in (the version pinned on the trigger)
|
|
4723
|
+
* example:
|
|
4724
|
+
* 1.1
|
|
4725
|
+
*/
|
|
4726
|
+
event_version: string;
|
|
4727
|
+
/**
|
|
4728
|
+
* Version the event was originally published with, before downgrading to `event_version`
|
|
4729
|
+
* example:
|
|
4730
|
+
* 1.2
|
|
4731
|
+
*/
|
|
4732
|
+
published_version?: string;
|
|
4733
|
+
event_time?: string; // date-time
|
|
4734
|
+
/**
|
|
4735
|
+
* How the event was triggered in the catalog (api | automation | operation | portal_user)
|
|
4736
|
+
* example:
|
|
4737
|
+
* operation
|
|
4738
|
+
*/
|
|
4739
|
+
trigger_source_type?: string;
|
|
4740
|
+
/**
|
|
4741
|
+
* Opaque source reference from the catalog (e.g. activity id, automation execution id)
|
|
4742
|
+
*/
|
|
4743
|
+
trigger_source?: string;
|
|
4744
|
+
payload_ref?: /* S3 reference to the stored trigger event payload (`_downgrades` stripped, downgraded to the pinned version) */ TriggerEventPayloadRef;
|
|
4745
|
+
}
|
|
4487
4746
|
export interface TriggerEventFlowAutomationTask {
|
|
4488
4747
|
type?: "flow_automation_task";
|
|
4489
4748
|
/**
|
|
@@ -4537,6 +4796,21 @@ declare namespace Components {
|
|
|
4537
4796
|
*/
|
|
4538
4797
|
EntityId;
|
|
4539
4798
|
}
|
|
4799
|
+
/**
|
|
4800
|
+
* S3 reference to the stored trigger event payload (`_downgrades` stripped, downgraded to the pinned version)
|
|
4801
|
+
*/
|
|
4802
|
+
export interface TriggerEventPayloadRef {
|
|
4803
|
+
/**
|
|
4804
|
+
* example:
|
|
4805
|
+
* automation-trigger-payloads-prod
|
|
4806
|
+
*/
|
|
4807
|
+
bucket: string;
|
|
4808
|
+
/**
|
|
4809
|
+
* example:
|
|
4810
|
+
* trigger-payloads/123/6c8e5d9a-7f1b-4c2e-9d3a-0b1c2d3e4f5a.json
|
|
4811
|
+
*/
|
|
4812
|
+
key: string;
|
|
4813
|
+
}
|
|
4540
4814
|
export interface TriggerShareEntityAction {
|
|
4541
4815
|
id?: /**
|
|
4542
4816
|
* example:
|
|
@@ -5034,10 +5308,6 @@ declare namespace Components {
|
|
|
5034
5308
|
* The role this automation plays in the workflow.
|
|
5035
5309
|
*/
|
|
5036
5310
|
export type WorkflowContextRole = "trigger_workflow" | "run_task_automation";
|
|
5037
|
-
/**
|
|
5038
|
-
* Automation Executions triggered by workflow task automations will always carry information about the triggering workflow. This information is helpful in correlating workflow executions with all the triggered automation executions
|
|
5039
|
-
*
|
|
5040
|
-
*/
|
|
5041
5311
|
export interface WorkflowExecutionContext {
|
|
5042
5312
|
workflow_exec_id: string;
|
|
5043
5313
|
workflow_exec_task_id?: string;
|
|
@@ -5057,9 +5327,16 @@ declare namespace Components {
|
|
|
5057
5327
|
entity_schema?: string;
|
|
5058
5328
|
is_primary?: boolean;
|
|
5059
5329
|
}[];
|
|
5330
|
+
/**
|
|
5331
|
+
* Id of the user on whose behalf the workflow task triggered this automation — the caller of a user-initiated run, or the user whose task completion advanced the flow to the automation task. Action workers resolve it as the acting user for template variable resolution (user.*) and email thread assignment, matching the attribution of manually triggered executions. Absent when no human action led to the trigger (scheduler fires, journey-triggered flows).
|
|
5332
|
+
*
|
|
5333
|
+
* example:
|
|
5334
|
+
* 10006129
|
|
5335
|
+
*/
|
|
5336
|
+
trigger_user_id?: string;
|
|
5060
5337
|
}
|
|
5061
5338
|
/**
|
|
5062
|
-
*
|
|
5339
|
+
* Correlation stamped when the triggering submission entity carried workflow wait claims from a journey link (AL-2521). Consumed by svc-workflows to resume a task waiting on this journey submission.
|
|
5063
5340
|
*
|
|
5064
5341
|
*/
|
|
5065
5342
|
export interface WorkflowWaitContext {
|
|
@@ -5494,6 +5771,11 @@ declare namespace Paths {
|
|
|
5494
5771
|
* wfABCDEFGH
|
|
5495
5772
|
*/
|
|
5496
5773
|
export type TargetWorkflow = string;
|
|
5774
|
+
/**
|
|
5775
|
+
* example:
|
|
5776
|
+
* CustomerRequestSubmitted
|
|
5777
|
+
*/
|
|
5778
|
+
export type TriggerEventName = string;
|
|
5497
5779
|
/**
|
|
5498
5780
|
* example:
|
|
5499
5781
|
* 600945fe-212e-4b97-acf7-391d64648384
|
|
@@ -5518,6 +5800,11 @@ declare namespace Paths {
|
|
|
5518
5800
|
* wfABCDEFGH
|
|
5519
5801
|
*/
|
|
5520
5802
|
Parameters.TargetWorkflow;
|
|
5803
|
+
trigger_event_name?: /**
|
|
5804
|
+
* example:
|
|
5805
|
+
* CustomerRequestSubmitted
|
|
5806
|
+
*/
|
|
5807
|
+
Parameters.TriggerEventName;
|
|
5521
5808
|
include_flows?: Parameters.IncludeFlows;
|
|
5522
5809
|
}
|
|
5523
5810
|
namespace Responses {
|
|
@@ -5990,6 +6277,7 @@ type ErrorCode = Components.Schemas.ErrorCode;
|
|
|
5990
6277
|
type ErrorDetail = Components.Schemas.ErrorDetail;
|
|
5991
6278
|
type ErrorObject = Components.Schemas.ErrorObject;
|
|
5992
6279
|
type ErrorOutput = Components.Schemas.ErrorOutput;
|
|
6280
|
+
type EventCatalogTrigger = Components.Schemas.EventCatalogTrigger;
|
|
5993
6281
|
type ExecItem = Components.Schemas.ExecItem;
|
|
5994
6282
|
type ExecutionChain = Components.Schemas.ExecutionChain;
|
|
5995
6283
|
type ExecutionStatus = Components.Schemas.ExecutionStatus;
|
|
@@ -6004,6 +6292,12 @@ type ForwardEmailActionConfig = Components.Schemas.ForwardEmailActionConfig;
|
|
|
6004
6292
|
type ForwardEmailConfig = Components.Schemas.ForwardEmailConfig;
|
|
6005
6293
|
type FrontendSubmitTrigger = Components.Schemas.FrontendSubmitTrigger;
|
|
6006
6294
|
type GetExecutionsResp = Components.Schemas.GetExecutionsResp;
|
|
6295
|
+
type GraphContextEntry = Components.Schemas.GraphContextEntry;
|
|
6296
|
+
type GraphDefinition = Components.Schemas.GraphDefinition;
|
|
6297
|
+
type GraphEdge = Components.Schemas.GraphEdge;
|
|
6298
|
+
type GraphNode = Components.Schemas.GraphNode;
|
|
6299
|
+
type GraphNodeFilter = Components.Schemas.GraphNodeFilter;
|
|
6300
|
+
type GraphSeed = Components.Schemas.GraphSeed;
|
|
6007
6301
|
type InformERPAction = Components.Schemas.InformERPAction;
|
|
6008
6302
|
type InformERPActionConfig = Components.Schemas.InformERPActionConfig;
|
|
6009
6303
|
type InformERPConfig = Components.Schemas.InformERPConfig;
|
|
@@ -6055,9 +6349,11 @@ type TriggerEventActionConfig = Components.Schemas.TriggerEventActionConfig;
|
|
|
6055
6349
|
type TriggerEventConfig = Components.Schemas.TriggerEventConfig;
|
|
6056
6350
|
type TriggerEventEntityActivity = Components.Schemas.TriggerEventEntityActivity;
|
|
6057
6351
|
type TriggerEventEntityOperation = Components.Schemas.TriggerEventEntityOperation;
|
|
6352
|
+
type TriggerEventEventCatalog = Components.Schemas.TriggerEventEventCatalog;
|
|
6058
6353
|
type TriggerEventFlowAutomationTask = Components.Schemas.TriggerEventFlowAutomationTask;
|
|
6059
6354
|
type TriggerEventManual = Components.Schemas.TriggerEventManual;
|
|
6060
6355
|
type TriggerEventMessaging = Components.Schemas.TriggerEventMessaging;
|
|
6356
|
+
type TriggerEventPayloadRef = Components.Schemas.TriggerEventPayloadRef;
|
|
6061
6357
|
type TriggerShareEntityAction = Components.Schemas.TriggerShareEntityAction;
|
|
6062
6358
|
type TriggerShareEntityActionConfig = Components.Schemas.TriggerShareEntityActionConfig;
|
|
6063
6359
|
type TriggerShareEntityConfig = Components.Schemas.TriggerShareEntityConfig;
|
|
@@ -6073,4 +6369,4 @@ type WorkflowContextRole = Components.Schemas.WorkflowContextRole;
|
|
|
6073
6369
|
type WorkflowExecutionContext = Components.Schemas.WorkflowExecutionContext;
|
|
6074
6370
|
type WorkflowWaitContext = Components.Schemas.WorkflowWaitContext;
|
|
6075
6371
|
|
|
6076
|
-
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
|
|
6372
|
+
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 ResumeToken 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 JourneySubmitTrigger as aA, type MapEntityAction as aB, type MapEntityActionConfig as aC, type MapEntityConfig as aD, type MappingAttribute as aE, type MappingAttributeMode as aF, type MappingAttributeV2 as aG, type MappingConfigRef as aH, type MoveThreadAction as aI, type MoveThreadConfig as aJ, type NewEmailThreadTrigger as aK, type NumericCondition as aL, type OperationNode as aM, type OperationObjectNode as aN, type OrCondition as aO, type OrConditionForDiff as aP, type OrganizationId as aQ, type PatchBulkJobRequest as aR, type PrefixCondition as aS, type PrimitiveJSONValue as aT, type ReceivedEmailTrigger as aU, type RelationAttribute as aV, type ReplyEmailAction as aW, type ReplyEmailActionConfig as aX, type ReplyEmailConfig as aY, type ResumeReq as aZ, type ResumeResp as a_, type ErrorOutput as aa, type EventCatalogTrigger as ab, type ExecItem as ac, type ExecutionChain as ad, type ExecutionStatus as ae, type ExistsCondition as af, type FilterConditionOnEvent as ag, type FlowExecutionCancelAction as ah, type FlowExecutionCancelActionConfig as ai, type FlowExecutionCancelConfig as aj, type FlowsTrigger as ak, type ForwardEmailAction as al, type ForwardEmailActionConfig as am, type ForwardEmailConfig as an, type FrontendSubmitTrigger as ao, type GetExecutionsResp as ap, type GraphContextEntry as aq, type GraphDefinition as ar, type GraphEdge as as, type GraphNode as at, type GraphNodeFilter as au, type GraphSeed as av, type InformERPAction as aw, type InformERPActionConfig as ax, type InformERPConfig as ay, type JobId as az, type PathsDictionary as b, type RetryReq as b0, type RetryStrategy as b1, type SearchAutomationsResp as b2, type SearchExecutionsReq as b3, type SearchExecutionsResp as b4, type SendEmailAction as b5, type SendEmailActionConfig as b6, type SendEmailCondition as b7, type SendEmailConfig as b8, type SetValueMapper as b9, type WorkflowExecutionContext as bA, type WorkflowWaitContext as bB, type StartExecutionRequest as ba, type SuffixCondition as bb, type TriggerCondition as bc, type TriggerContext as bd, type TriggerEventAction as be, type TriggerEventActionConfig as bf, type TriggerEventConfig as bg, type TriggerEventEntityActivity as bh, type TriggerEventEntityOperation as bi, type TriggerEventEventCatalog as bj, type TriggerEventFlowAutomationTask as bk, type TriggerEventManual as bl, type TriggerEventMessaging as bm, type TriggerEventPayloadRef as bn, type TriggerShareEntityAction as bo, type TriggerShareEntityActionConfig as bp, type TriggerShareEntityConfig as bq, type TriggerWebhookAction as br, type TriggerWebhookActionConfig as bs, type TriggerWebhookConfig as bt, type TriggerWorkflowAction as bu, type TriggerWorkflowActionConfig as bv, type TriggerWorkflowCondition as bw, type TriggerWorkflowConfig as bx, type WildcardCondition as by, type WorkflowContextRole as bz, 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 };
|