@epilot/sdk 2.20.85 → 2.20.86
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 +294 -17
- package/definitions/workflow-definition.json +686 -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/chat.cjs +6 -6
- package/dist/apis/chat.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 +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/external-values.cjs +6 -6
- package/dist/apis/external-values.js +1 -1
- 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/identity.cjs +6 -6
- package/dist/apis/identity.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/phone-integration.cjs +6 -6
- package/dist/apis/phone-integration.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.d.cts +2 -2
- package/dist/apis/workflow-definition.d.ts +2 -2
- 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-KNJZDJD7.cjs +7 -0
- package/dist/automation-RKVFGJTO.js +7 -0
- package/dist/{automation-runtime-KLCXZKEC.cjs → automation-runtime-7LXZ343U.cjs} +2 -2
- package/dist/{automation-runtime-Y52HM57N.js → automation-runtime-JZKABTGP.js} +1 -1
- package/dist/{automation.d-B8g3nYp-.d.cts → automation.d-cTvIBxDI.d.cts} +514 -26
- package/dist/{automation.d-B8g3nYp-.d.ts → automation.d-cTvIBxDI.d.ts} +514 -26
- package/dist/{chunk-7T4BNWMN.js → chunk-2AWPRVIH.js} +3 -3
- package/dist/{chunk-WOUASZJW.cjs → chunk-EIT2JFPB.cjs} +1 -1
- package/dist/{chunk-QW3ROE6H.js → chunk-JKCBMHOZ.js} +1 -1
- package/dist/{chunk-ZSZ4IWLQ.cjs → chunk-NMY7ACYO.cjs} +3 -3
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/workflow-definition-46NTR2N5.cjs +7 -0
- package/dist/workflow-definition-BSY2BNM2.js +7 -0
- package/dist/{workflow-definition.d-CweGhhBU.d.ts → workflow-definition.d-Be0CM3Py.d.cts} +574 -10
- package/dist/{workflow-definition.d-CweGhhBU.d.cts → workflow-definition.d-Be0CM3Py.d.ts} +574 -10
- package/docs/automation.md +267 -26
- package/docs/workflow-definition.md +840 -138
- package/package.json +1 -1
- package/dist/automation-G2CKAQNB.cjs +0 -7
- package/dist/automation-UPTNUOYO.js +0 -7
- package/dist/workflow-definition-MSO4JDA3.js +0 -7
- package/dist/workflow-definition-XTWO4RMY.cjs +0 -7
|
@@ -586,7 +586,39 @@ declare namespace Components {
|
|
|
586
586
|
* ```
|
|
587
587
|
*
|
|
588
588
|
*/
|
|
589
|
-
EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger |
|
|
589
|
+
EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | /**
|
|
590
|
+
* Starts the flow for every email sent from epilot: emails and replies sent from the inbox,
|
|
591
|
+
* including replies sent from a draft, and emails sent by automations or Flows, except sends
|
|
592
|
+
* that skip creating entities. The sent email is the execution's entity. The outgoing
|
|
593
|
+
* counterpart of `received_email`.
|
|
594
|
+
*
|
|
595
|
+
* Only a Flow's trigger can use it: the flow must have exactly one action, of type
|
|
596
|
+
* `trigger-workflow`. Any other flow with this trigger is rejected.
|
|
597
|
+
*
|
|
598
|
+
* An email that failed to send, or a bulk email, does not start the flow. Neither does an email
|
|
599
|
+
* whose automation chain already contains the flow, so a Flow isn't started again by emails its
|
|
600
|
+
* own run sends, also not through other Flows.
|
|
601
|
+
*
|
|
602
|
+
* Every other sent email starts the flow, so a busy mailbox can reach the hot-flow limit; raise
|
|
603
|
+
* the flow's `max_executions` if needed.
|
|
604
|
+
*
|
|
605
|
+
* example:
|
|
606
|
+
* {
|
|
607
|
+
* "id": "12d4f45a-1883-4841-a94c-5928cb338a94",
|
|
608
|
+
* "type": "sent_email",
|
|
609
|
+
* "configuration": {}
|
|
610
|
+
* }
|
|
611
|
+
*/
|
|
612
|
+
SentEmailTrigger | /**
|
|
613
|
+
* Starts the flow when an email starts a new thread. The thread is the execution's entity.
|
|
614
|
+
*
|
|
615
|
+
* For outbound threads, an email that failed to send or a bulk email does not start the flow,
|
|
616
|
+
* and neither does an email whose automation chain already contains the flow. A flow that
|
|
617
|
+
* sends emails itself (a send-email, reply-email or forward-email action) is not started for
|
|
618
|
+
* outbound threads at all, because its own emails could start it again.
|
|
619
|
+
*
|
|
620
|
+
*/
|
|
621
|
+
NewEmailThreadTrigger | FlowsTrigger | /**
|
|
590
622
|
* 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.
|
|
591
623
|
*
|
|
592
624
|
* example:
|
|
@@ -860,16 +892,27 @@ declare namespace Components {
|
|
|
860
892
|
*/
|
|
861
893
|
attribute?: string;
|
|
862
894
|
/**
|
|
863
|
-
* Assignees to write into `attribute`, in the order given.
|
|
895
|
+
* Assignees to write into `attribute`, in the order given. Variable
|
|
896
|
+
* entries are resolved at execution time and expand to zero or more
|
|
897
|
+
* assignees.
|
|
898
|
+
*
|
|
864
899
|
*/
|
|
865
|
-
assignees?: /**
|
|
900
|
+
assignees?: (/**
|
|
866
901
|
* A single assignee as stored in a user-relation attribute. Written through
|
|
867
902
|
* verbatim by the assign-entity worker. Note this object encoding differs
|
|
868
903
|
* deliberately from AssignThreadConfig, which stores bare id strings —
|
|
869
904
|
* each matches what its own target accepts.
|
|
870
905
|
*
|
|
871
906
|
*/
|
|
872
|
-
EntityAssignee
|
|
907
|
+
EntityAssignee | /**
|
|
908
|
+
* An assignee resolved at execution time from a user-relation attribute of an
|
|
909
|
+
* entity in the automation context, e.g. `{{submission._owners}}`. Resolves
|
|
910
|
+
* against the entity being assigned or the triggering entity, whichever has
|
|
911
|
+
* the given schema slug. The attribute may hold user ids, `{ org_id, user_id }`
|
|
912
|
+
* owners, groups or partner organizations. Direct assignment only.
|
|
913
|
+
*
|
|
914
|
+
*/
|
|
915
|
+
EntityAssigneeVariable)[];
|
|
873
916
|
/**
|
|
874
917
|
* How `assignees` combine with the attribute's current value.
|
|
875
918
|
* - replace: overwrite the attribute with `assignees` (default).
|
|
@@ -880,25 +923,45 @@ declare namespace Components {
|
|
|
880
923
|
* `partner_id` for partner_organization. Scoping by `org_id` keeps
|
|
881
924
|
* assignees from different organizations distinct even when their
|
|
882
925
|
* identifiers coincide.
|
|
883
|
-
* Honoured in `
|
|
926
|
+
* Honoured in every `assignment_type`; in `sequential` and
|
|
927
|
+
* `even_distribution` the selected user (or the fallback assignees)
|
|
928
|
+
* take the place of `assignees`.
|
|
884
929
|
*
|
|
885
930
|
*/
|
|
886
931
|
write_mode?: "replace" | "append";
|
|
887
932
|
/**
|
|
888
933
|
* How assignees are resolved. Omitted means `direct`.
|
|
889
934
|
* - direct: assign exactly the assignees listed in `assignees`.
|
|
890
|
-
* - sequential: round-robin over the
|
|
891
|
-
* selecting one user per execution. `assignees` is ignored
|
|
892
|
-
*
|
|
893
|
-
*
|
|
894
|
-
* matching entities wins; ties are resolved by the rotation.
|
|
935
|
+
* - sequential: round-robin over the users in `candidate_pool`,
|
|
936
|
+
* selecting one user per execution. `assignees` is ignored.
|
|
937
|
+
* - even_distribution: the user in `candidate_pool` with the fewest
|
|
938
|
+
* matching entities wins; ties are broken at random.
|
|
895
939
|
* `workload_filter` narrows what counts as load.
|
|
896
940
|
*
|
|
897
941
|
*/
|
|
898
942
|
assignment_type?: "direct" | "sequential" | "even_distribution";
|
|
899
943
|
/**
|
|
900
|
-
*
|
|
901
|
-
* ignored in `direct`.
|
|
944
|
+
* Users and groups whose members form the candidate set for
|
|
945
|
+
* `sequential` and `even_distribution`; ignored in `direct`. Groups
|
|
946
|
+
* expand to their members and a user reached through several entries
|
|
947
|
+
* is a candidate once. Partner entries are ignored.
|
|
948
|
+
* `even_distribution` supports at most 200 distinct users once groups
|
|
949
|
+
* are expanded; beyond that the run fails.
|
|
950
|
+
* When absent or empty, `candidate_group` is used instead.
|
|
951
|
+
*
|
|
952
|
+
*/
|
|
953
|
+
candidate_pool?: /**
|
|
954
|
+
* A single assignee as stored in a user-relation attribute. Written through
|
|
955
|
+
* verbatim by the assign-entity worker. Note this object encoding differs
|
|
956
|
+
* deliberately from AssignThreadConfig, which stores bare id strings —
|
|
957
|
+
* each matches what its own target accepts.
|
|
958
|
+
*
|
|
959
|
+
*/
|
|
960
|
+
EntityAssignee[] | null;
|
|
961
|
+
/**
|
|
962
|
+
* Deprecated: use `candidate_pool`. The group whose members form the
|
|
963
|
+
* candidates, read only when `candidate_pool` is absent or empty. Must
|
|
964
|
+
* be `type: group`; ignored in `direct`.
|
|
902
965
|
*
|
|
903
966
|
*/
|
|
904
967
|
candidate_group?: {
|
|
@@ -962,6 +1025,8 @@ declare namespace Components {
|
|
|
962
1025
|
* only assign to users whose skills (tags) match a label on the entity
|
|
963
1026
|
* being assigned. Opt-in; defaults to false. An entity carrying no
|
|
964
1027
|
* namespaced label matches nobody, so the fallback applies.
|
|
1028
|
+
* When `required_skills` is non-empty, that filter runs first and this
|
|
1029
|
+
* matching narrows its result.
|
|
965
1030
|
*
|
|
966
1031
|
*/
|
|
967
1032
|
match_user_skills?: boolean;
|
|
@@ -978,6 +1043,130 @@ declare namespace Components {
|
|
|
978
1043
|
*
|
|
979
1044
|
*/
|
|
980
1045
|
required_skill_categories?: string[];
|
|
1046
|
+
/**
|
|
1047
|
+
* Candidate condition for `sequential` and `even_distribution`: skills a
|
|
1048
|
+
* user must have, as classification ids (`family:label`, e.g.
|
|
1049
|
+
* `role:project-manager`), checked against the user's skills (tags) only,
|
|
1050
|
+
* case-insensitively; the entity's labels play no part, so an unlabelled
|
|
1051
|
+
* entity can still be assigned. Applied whenever non-empty; independent of
|
|
1052
|
+
* `match_user_skills`.
|
|
1053
|
+
*
|
|
1054
|
+
* example:
|
|
1055
|
+
* [
|
|
1056
|
+
* "role:project-manager"
|
|
1057
|
+
* ]
|
|
1058
|
+
*/
|
|
1059
|
+
required_skills?: [
|
|
1060
|
+
string?,
|
|
1061
|
+
string?,
|
|
1062
|
+
string?,
|
|
1063
|
+
string?,
|
|
1064
|
+
string?,
|
|
1065
|
+
string?,
|
|
1066
|
+
string?,
|
|
1067
|
+
string?,
|
|
1068
|
+
string?,
|
|
1069
|
+
string?,
|
|
1070
|
+
string?,
|
|
1071
|
+
string?,
|
|
1072
|
+
string?,
|
|
1073
|
+
string?,
|
|
1074
|
+
string?,
|
|
1075
|
+
string?,
|
|
1076
|
+
string?,
|
|
1077
|
+
string?,
|
|
1078
|
+
string?,
|
|
1079
|
+
string?,
|
|
1080
|
+
string?,
|
|
1081
|
+
string?,
|
|
1082
|
+
string?,
|
|
1083
|
+
string?,
|
|
1084
|
+
string?,
|
|
1085
|
+
string?,
|
|
1086
|
+
string?,
|
|
1087
|
+
string?,
|
|
1088
|
+
string?,
|
|
1089
|
+
string?,
|
|
1090
|
+
string?,
|
|
1091
|
+
string?,
|
|
1092
|
+
string?,
|
|
1093
|
+
string?,
|
|
1094
|
+
string?,
|
|
1095
|
+
string?,
|
|
1096
|
+
string?,
|
|
1097
|
+
string?,
|
|
1098
|
+
string?,
|
|
1099
|
+
string?,
|
|
1100
|
+
string?,
|
|
1101
|
+
string?,
|
|
1102
|
+
string?,
|
|
1103
|
+
string?,
|
|
1104
|
+
string?,
|
|
1105
|
+
string?,
|
|
1106
|
+
string?,
|
|
1107
|
+
string?,
|
|
1108
|
+
string?,
|
|
1109
|
+
string?,
|
|
1110
|
+
string?,
|
|
1111
|
+
string?,
|
|
1112
|
+
string?,
|
|
1113
|
+
string?,
|
|
1114
|
+
string?,
|
|
1115
|
+
string?,
|
|
1116
|
+
string?,
|
|
1117
|
+
string?,
|
|
1118
|
+
string?,
|
|
1119
|
+
string?,
|
|
1120
|
+
string?,
|
|
1121
|
+
string?,
|
|
1122
|
+
string?,
|
|
1123
|
+
string?,
|
|
1124
|
+
string?,
|
|
1125
|
+
string?,
|
|
1126
|
+
string?,
|
|
1127
|
+
string?,
|
|
1128
|
+
string?,
|
|
1129
|
+
string?,
|
|
1130
|
+
string?,
|
|
1131
|
+
string?,
|
|
1132
|
+
string?,
|
|
1133
|
+
string?,
|
|
1134
|
+
string?,
|
|
1135
|
+
string?,
|
|
1136
|
+
string?,
|
|
1137
|
+
string?,
|
|
1138
|
+
string?,
|
|
1139
|
+
string?,
|
|
1140
|
+
string?,
|
|
1141
|
+
string?,
|
|
1142
|
+
string?,
|
|
1143
|
+
string?,
|
|
1144
|
+
string?,
|
|
1145
|
+
string?,
|
|
1146
|
+
string?,
|
|
1147
|
+
string?,
|
|
1148
|
+
string?,
|
|
1149
|
+
string?,
|
|
1150
|
+
string?,
|
|
1151
|
+
string?,
|
|
1152
|
+
string?,
|
|
1153
|
+
string?,
|
|
1154
|
+
string?,
|
|
1155
|
+
string?,
|
|
1156
|
+
string?,
|
|
1157
|
+
string?,
|
|
1158
|
+
string?,
|
|
1159
|
+
string?
|
|
1160
|
+
];
|
|
1161
|
+
/**
|
|
1162
|
+
* How strictly `required_skills` is matched. Independent of
|
|
1163
|
+
* `skill_match_mode`.
|
|
1164
|
+
* - require_all: a user must have every required skill (default).
|
|
1165
|
+
* - prefer: users with the most required skills are eligible; a user
|
|
1166
|
+
* with none of them is never eligible (the fallback then applies).
|
|
1167
|
+
*
|
|
1168
|
+
*/
|
|
1169
|
+
required_skills_match_mode?: "require_all" | "prefer";
|
|
981
1170
|
/**
|
|
982
1171
|
* How strictly required skill categories are matched (applies with
|
|
983
1172
|
* match_user_skills and required skill categories set).
|
|
@@ -991,7 +1180,7 @@ declare namespace Components {
|
|
|
991
1180
|
skill_match_mode?: "require_all" | "prefer";
|
|
992
1181
|
/**
|
|
993
1182
|
* What to do when no assignable principal resolves, e.g. an empty or
|
|
994
|
-
* fully ineligible `
|
|
1183
|
+
* fully ineligible `candidate_pool`.
|
|
995
1184
|
* - leave_unassigned: write nothing at all, leaving the attribute as it
|
|
996
1185
|
* was. Not the same as writing an empty array, which would clear an
|
|
997
1186
|
* existing assignment.
|
|
@@ -1183,6 +1372,20 @@ declare namespace Components {
|
|
|
1183
1372
|
*
|
|
1184
1373
|
*/
|
|
1185
1374
|
fallback_assignees?: string[];
|
|
1375
|
+
/**
|
|
1376
|
+
* How the resolved assignees combine with the thread's current assignees.
|
|
1377
|
+
* Applies in every `assignment_type`, after routing and fallback have
|
|
1378
|
+
* picked the user(s).
|
|
1379
|
+
* - append: add the resolved assignees and remove those in `remove`,
|
|
1380
|
+
* keeping everyone else (default).
|
|
1381
|
+
* - replace: the thread ends up assigned to exactly the resolved
|
|
1382
|
+
* assignees (`add` minus `remove` for direct; the picked user or the
|
|
1383
|
+
* fallback assignees otherwise). Existing user and group assignees
|
|
1384
|
+
* not in that list are removed.
|
|
1385
|
+
* Ignored when nothing is written (e.g. `leave_unassigned` fallback).
|
|
1386
|
+
*
|
|
1387
|
+
*/
|
|
1388
|
+
write_mode?: "append" | "replace";
|
|
1186
1389
|
}
|
|
1187
1390
|
/**
|
|
1188
1391
|
* example:
|
|
@@ -1731,6 +1934,22 @@ declare namespace Components {
|
|
|
1731
1934
|
* Entity ID of the report file entity
|
|
1732
1935
|
*/
|
|
1733
1936
|
report_file_entity_id?: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Error that moved the job into the `failed` status. Cleared when the job is restarted.
|
|
1939
|
+
* example:
|
|
1940
|
+
* ThrottlingException: Throughput exceeds the current capacity of your table or index.
|
|
1941
|
+
*/
|
|
1942
|
+
last_error?: string;
|
|
1943
|
+
/**
|
|
1944
|
+
* How many times the job was restarted after failing or being cancelled
|
|
1945
|
+
* example:
|
|
1946
|
+
* 1
|
|
1947
|
+
*/
|
|
1948
|
+
restart_count?: number;
|
|
1949
|
+
/**
|
|
1950
|
+
* Time of the last restart of the job
|
|
1951
|
+
*/
|
|
1952
|
+
restarted_at?: string; // date-time
|
|
1734
1953
|
/**
|
|
1735
1954
|
* Query configuration for loading entities
|
|
1736
1955
|
*/
|
|
@@ -1786,9 +2005,20 @@ declare namespace Components {
|
|
|
1786
2005
|
has_more?: boolean;
|
|
1787
2006
|
};
|
|
1788
2007
|
/**
|
|
1789
|
-
* List of entities & their automation execution id & status
|
|
2008
|
+
* List of entities & their automation execution id & status.
|
|
2009
|
+
*
|
|
2010
|
+
* In API responses the list is bounded to a few MB (see `execution_summary_truncated`); use
|
|
2011
|
+
* `execution_stats` for complete counts.
|
|
2012
|
+
*
|
|
1790
2013
|
*/
|
|
1791
2014
|
execution_summary?: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
|
|
2015
|
+
execution_stats?: /* Number of execution items of a bulk trigger job per execution status. Always complete. */ ExecutionStats;
|
|
2016
|
+
/**
|
|
2017
|
+
* True when `execution_summary` does not contain all execution items of the job (the response was bounded,
|
|
2018
|
+
* or the summary was not requested).
|
|
2019
|
+
*
|
|
2020
|
+
*/
|
|
2021
|
+
execution_summary_truncated?: boolean;
|
|
1792
2022
|
}
|
|
1793
2023
|
export type BulkTriggerRequest = {
|
|
1794
2024
|
flow_id: /**
|
|
@@ -2394,6 +2624,22 @@ declare namespace Components {
|
|
|
2394
2624
|
display_name?: string;
|
|
2395
2625
|
email?: string;
|
|
2396
2626
|
}
|
|
2627
|
+
/**
|
|
2628
|
+
* An assignee resolved at execution time from a user-relation attribute of an
|
|
2629
|
+
* entity in the automation context, e.g. `{{submission._owners}}`. Resolves
|
|
2630
|
+
* against the entity being assigned or the triggering entity, whichever has
|
|
2631
|
+
* the given schema slug. The attribute may hold user ids, `{ org_id, user_id }`
|
|
2632
|
+
* owners, groups or partner organizations. Direct assignment only.
|
|
2633
|
+
*
|
|
2634
|
+
*/
|
|
2635
|
+
export interface EntityAssigneeVariable {
|
|
2636
|
+
/**
|
|
2637
|
+
* Expression of the form `{{schema.attribute}}`.
|
|
2638
|
+
* example:
|
|
2639
|
+
* {{submission._owners}}
|
|
2640
|
+
*/
|
|
2641
|
+
variable: string;
|
|
2642
|
+
}
|
|
2397
2643
|
/**
|
|
2398
2644
|
* example:
|
|
2399
2645
|
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74
|
|
@@ -2875,7 +3121,7 @@ declare namespace Components {
|
|
|
2875
3121
|
*/
|
|
2876
3122
|
event_version: string;
|
|
2877
3123
|
/**
|
|
2878
|
-
* Id of the
|
|
3124
|
+
* Id of the node in the event's entity graph whose entity becomes the execution's main entity (the entity actions operate on). A repeatable (cardinality many) node may be chosen too: the first entity in the list becomes the main entity, and an event with an empty list does not start the flow.
|
|
2879
3125
|
*
|
|
2880
3126
|
* example:
|
|
2881
3127
|
* ticket
|
|
@@ -2938,6 +3184,26 @@ declare namespace Components {
|
|
|
2938
3184
|
*/
|
|
2939
3185
|
depth?: number;
|
|
2940
3186
|
}
|
|
3187
|
+
/**
|
|
3188
|
+
* Number of execution items of a bulk trigger job per execution status. Always complete.
|
|
3189
|
+
*/
|
|
3190
|
+
export interface ExecutionStats {
|
|
3191
|
+
/**
|
|
3192
|
+
* example:
|
|
3193
|
+
* 60582
|
|
3194
|
+
*/
|
|
3195
|
+
total: number;
|
|
3196
|
+
pending?: number;
|
|
3197
|
+
starting?: number;
|
|
3198
|
+
in_progress?: number;
|
|
3199
|
+
success?: number;
|
|
3200
|
+
failed?: number;
|
|
3201
|
+
cancelled?: number;
|
|
3202
|
+
skipped?: number;
|
|
3203
|
+
paused?: number;
|
|
3204
|
+
scheduled?: number;
|
|
3205
|
+
hot?: number;
|
|
3206
|
+
}
|
|
2941
3207
|
export type ExecutionStatus = "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot";
|
|
2942
3208
|
export interface ExistsCondition {
|
|
2943
3209
|
exists?: boolean;
|
|
@@ -3650,6 +3916,87 @@ declare namespace Components {
|
|
|
3650
3916
|
source_id: string; // uuid
|
|
3651
3917
|
};
|
|
3652
3918
|
}
|
|
3919
|
+
export interface LabelEmailAction {
|
|
3920
|
+
id?: /**
|
|
3921
|
+
* example:
|
|
3922
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
3923
|
+
*/
|
|
3924
|
+
AutomationActionId;
|
|
3925
|
+
flow_action_id?: /**
|
|
3926
|
+
* example:
|
|
3927
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
3928
|
+
*/
|
|
3929
|
+
AutomationActionId;
|
|
3930
|
+
name?: string;
|
|
3931
|
+
type?: "label-email";
|
|
3932
|
+
config?: LabelEmailConfig;
|
|
3933
|
+
/**
|
|
3934
|
+
* Whether to stop execution in a failed state if this action fails
|
|
3935
|
+
*/
|
|
3936
|
+
allow_failure?: boolean;
|
|
3937
|
+
/**
|
|
3938
|
+
* Flag indicating whether the action was created automatically or manually
|
|
3939
|
+
*/
|
|
3940
|
+
created_automatically?: boolean;
|
|
3941
|
+
/**
|
|
3942
|
+
* Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
|
|
3943
|
+
*/
|
|
3944
|
+
is_bulk_action?: boolean;
|
|
3945
|
+
reason?: {
|
|
3946
|
+
/**
|
|
3947
|
+
* Why the action has to be skipped/failed
|
|
3948
|
+
* example:
|
|
3949
|
+
* There are no registered portal users for the given emails, hence skipping the action
|
|
3950
|
+
*/
|
|
3951
|
+
message?: string;
|
|
3952
|
+
/**
|
|
3953
|
+
* Extra metadata about the skipping reason - such as a certain condition not met, etc.
|
|
3954
|
+
*/
|
|
3955
|
+
payload?: {
|
|
3956
|
+
[name: string]: any;
|
|
3957
|
+
};
|
|
3958
|
+
};
|
|
3959
|
+
/**
|
|
3960
|
+
* Condition Id to be checked before executing the action
|
|
3961
|
+
*/
|
|
3962
|
+
condition_id?: string;
|
|
3963
|
+
/**
|
|
3964
|
+
* Schedule Id which indicates the schedule of the action
|
|
3965
|
+
*/
|
|
3966
|
+
schedule_id?: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* 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.
|
|
3969
|
+
*
|
|
3970
|
+
*/
|
|
3971
|
+
loop_id?: string;
|
|
3972
|
+
execution_status?: ExecutionStatus;
|
|
3973
|
+
started_at?: string;
|
|
3974
|
+
updated_at?: string;
|
|
3975
|
+
/**
|
|
3976
|
+
* example:
|
|
3977
|
+
* {}
|
|
3978
|
+
*/
|
|
3979
|
+
outputs?: {
|
|
3980
|
+
[name: string]: any;
|
|
3981
|
+
};
|
|
3982
|
+
error_output?: ErrorOutput;
|
|
3983
|
+
retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
|
|
3984
|
+
/**
|
|
3985
|
+
* 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.
|
|
3986
|
+
*
|
|
3987
|
+
*/
|
|
3988
|
+
iterations?: /* A snapshot of a single completed pass through a looped action. */ AutomationActionIteration[];
|
|
3989
|
+
}
|
|
3990
|
+
export interface LabelEmailConfig {
|
|
3991
|
+
/**
|
|
3992
|
+
* Message label slugs to add, exactly as stored in the message entity's `_tags`. Labels already on the message are kept.
|
|
3993
|
+
*
|
|
3994
|
+
*/
|
|
3995
|
+
add: [
|
|
3996
|
+
string,
|
|
3997
|
+
...string[]
|
|
3998
|
+
];
|
|
3999
|
+
}
|
|
3653
4000
|
export interface MapEntityAction {
|
|
3654
4001
|
id?: /**
|
|
3655
4002
|
* example:
|
|
@@ -4079,6 +4426,15 @@ declare namespace Components {
|
|
|
4079
4426
|
*/
|
|
4080
4427
|
target_inbox_id?: string;
|
|
4081
4428
|
}
|
|
4429
|
+
/**
|
|
4430
|
+
* Starts the flow when an email starts a new thread. The thread is the execution's entity.
|
|
4431
|
+
*
|
|
4432
|
+
* For outbound threads, an email that failed to send or a bulk email does not start the flow,
|
|
4433
|
+
* and neither does an email whose automation chain already contains the flow. A flow that
|
|
4434
|
+
* sends emails itself (a send-email, reply-email or forward-email action) is not started for
|
|
4435
|
+
* outbound threads at all, because its own emails could start it again.
|
|
4436
|
+
*
|
|
4437
|
+
*/
|
|
4082
4438
|
export interface NewEmailThreadTrigger {
|
|
4083
4439
|
/**
|
|
4084
4440
|
* example:
|
|
@@ -4134,8 +4490,20 @@ declare namespace Components {
|
|
|
4134
4490
|
*/
|
|
4135
4491
|
export type OrganizationId = string;
|
|
4136
4492
|
export interface PatchBulkJobRequest {
|
|
4137
|
-
|
|
4138
|
-
|
|
4493
|
+
/**
|
|
4494
|
+
* * APPROVE: Start the approved bulk job. Requires the `task_token` of the job.
|
|
4495
|
+
* * CANCEL: Cancel the bulk job. Executions that already started keep running.
|
|
4496
|
+
* * RESTART: Restart a `failed` or `cancelled` bulk job and continue where it left off.
|
|
4497
|
+
* Entities whose executions were not started yet are triggered, executions that already
|
|
4498
|
+
* started or finished are left untouched. If the entities were not fully loaded yet, they are
|
|
4499
|
+
* loaded again from scratch. A job that was never approved goes back to `approval`.
|
|
4500
|
+
*
|
|
4501
|
+
*/
|
|
4502
|
+
action: "APPROVE" | "CANCEL" | "RESTART";
|
|
4503
|
+
/**
|
|
4504
|
+
* Task token of the job. Required for the APPROVE action.
|
|
4505
|
+
*/
|
|
4506
|
+
task_token?: string;
|
|
4139
4507
|
}
|
|
4140
4508
|
export interface PrefixCondition {
|
|
4141
4509
|
prefix?: string;
|
|
@@ -4712,6 +5080,43 @@ declare namespace Components {
|
|
|
4712
5080
|
body?: string;
|
|
4713
5081
|
attachment_entity_ids?: string[];
|
|
4714
5082
|
}
|
|
5083
|
+
/**
|
|
5084
|
+
* Starts the flow for every email sent from epilot: emails and replies sent from the inbox,
|
|
5085
|
+
* including replies sent from a draft, and emails sent by automations or Flows, except sends
|
|
5086
|
+
* that skip creating entities. The sent email is the execution's entity. The outgoing
|
|
5087
|
+
* counterpart of `received_email`.
|
|
5088
|
+
*
|
|
5089
|
+
* Only a Flow's trigger can use it: the flow must have exactly one action, of type
|
|
5090
|
+
* `trigger-workflow`. Any other flow with this trigger is rejected.
|
|
5091
|
+
*
|
|
5092
|
+
* An email that failed to send, or a bulk email, does not start the flow. Neither does an email
|
|
5093
|
+
* whose automation chain already contains the flow, so a Flow isn't started again by emails its
|
|
5094
|
+
* own run sends, also not through other Flows.
|
|
5095
|
+
*
|
|
5096
|
+
* Every other sent email starts the flow, so a busy mailbox can reach the hot-flow limit; raise
|
|
5097
|
+
* the flow's `max_executions` if needed.
|
|
5098
|
+
*
|
|
5099
|
+
* example:
|
|
5100
|
+
* {
|
|
5101
|
+
* "id": "12d4f45a-1883-4841-a94c-5928cb338a94",
|
|
5102
|
+
* "type": "sent_email",
|
|
5103
|
+
* "configuration": {}
|
|
5104
|
+
* }
|
|
5105
|
+
*/
|
|
5106
|
+
export interface SentEmailTrigger {
|
|
5107
|
+
/**
|
|
5108
|
+
* example:
|
|
5109
|
+
* 12d4f45a-1883-4841-a94c-5928cb338a94
|
|
5110
|
+
*/
|
|
5111
|
+
id?: string; // uuid
|
|
5112
|
+
type: "sent_email";
|
|
5113
|
+
/**
|
|
5114
|
+
* The trigger has no options yet.
|
|
5115
|
+
*/
|
|
5116
|
+
configuration: {
|
|
5117
|
+
[key: string]: any;
|
|
5118
|
+
};
|
|
5119
|
+
}
|
|
4715
5120
|
export interface SetValueMapper {
|
|
4716
5121
|
mode: /**
|
|
4717
5122
|
* - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property.
|
|
@@ -5085,7 +5490,13 @@ declare namespace Components {
|
|
|
5085
5490
|
caller?: ApiCallerContext;
|
|
5086
5491
|
}
|
|
5087
5492
|
export interface TriggerEventMessaging {
|
|
5088
|
-
|
|
5493
|
+
/**
|
|
5494
|
+
* The trigger that started the execution:
|
|
5495
|
+
* - new_email_thread: the execution entity is the thread.
|
|
5496
|
+
* - sent_email: the execution entity is the sent email (`message_id`).
|
|
5497
|
+
*
|
|
5498
|
+
*/
|
|
5499
|
+
type?: "new_email_thread" | "sent_email";
|
|
5089
5500
|
/**
|
|
5090
5501
|
* example:
|
|
5091
5502
|
* 123
|
|
@@ -5240,6 +5651,21 @@ declare namespace Components {
|
|
|
5240
5651
|
loop_id?: string;
|
|
5241
5652
|
}
|
|
5242
5653
|
export interface TriggerShareEntityConfig {
|
|
5654
|
+
/**
|
|
5655
|
+
* Whether the action shares the entity with partners or unshares it from them.
|
|
5656
|
+
* Unsharing removes the entity together with all of its related resources from the partners.
|
|
5657
|
+
*
|
|
5658
|
+
*/
|
|
5659
|
+
operation?: "share" | "unshare";
|
|
5660
|
+
/**
|
|
5661
|
+
* Only used when `operation` is `unshare`. When true, the entity is unshared from every partner
|
|
5662
|
+
* it is currently shared with and `partner_org_ids` is ignored.
|
|
5663
|
+
*
|
|
5664
|
+
*/
|
|
5665
|
+
unshare_all_partners?: boolean;
|
|
5666
|
+
/**
|
|
5667
|
+
* Partner organizations to share the entity with, or to unshare it from
|
|
5668
|
+
*/
|
|
5243
5669
|
partner_org_ids?: string[];
|
|
5244
5670
|
}
|
|
5245
5671
|
export interface TriggerWebhookAction {
|
|
@@ -5622,7 +6048,7 @@ declare namespace Components {
|
|
|
5622
6048
|
*/
|
|
5623
6049
|
_automation_chain?: string[];
|
|
5624
6050
|
/**
|
|
5625
|
-
*
|
|
6051
|
+
* The contexts of the workflow execution whose task started this automation, as they were when the task ran: every entity that run works on, the one flagged is_primary being its main context. Any action of the automation may read them, e.g. assign-entity to find an entity of a given schema. Sent only for automations started by a workflow task.
|
|
5626
6052
|
*
|
|
5627
6053
|
*/
|
|
5628
6054
|
entity_contexts?: {
|
|
@@ -5630,6 +6056,25 @@ declare namespace Components {
|
|
|
5630
6056
|
entity_schema?: string;
|
|
5631
6057
|
is_primary?: boolean;
|
|
5632
6058
|
}[];
|
|
6059
|
+
/**
|
|
6060
|
+
* The task's input settings, as the flow author configured them on the workflow task (input_context.with_relations and input_context.also_pass in the workflow definition), resolved to entities for this run. The automation's own entity is the task's main input and is not repeated here. Present only when the task configures these settings; when absent, every action keeps the legacy behaviour: the automation's entity comes with all of its direct relations, and a started workflow also receives every entity in entity_contexts.
|
|
6061
|
+
*
|
|
6062
|
+
*/
|
|
6063
|
+
resolved_input?: {
|
|
6064
|
+
/**
|
|
6065
|
+
* Whether the automation's entity brings its direct relations along. Every action honours it: when false, the relations are not loaded, and a started workflow does not receive them as contexts.
|
|
6066
|
+
*
|
|
6067
|
+
*/
|
|
6068
|
+
with_relations: boolean;
|
|
6069
|
+
/**
|
|
6070
|
+
* Entities a start-workflow (trigger-workflow) action passes to the workflow it starts, on top of the automation's entity and, when with_relations is true, its relations. With resolved_input present, the started workflow receives exactly these: the entities in entity_contexts are not passed on.
|
|
6071
|
+
*
|
|
6072
|
+
*/
|
|
6073
|
+
also_pass: {
|
|
6074
|
+
entity_id: string;
|
|
6075
|
+
entity_schema?: string;
|
|
6076
|
+
}[];
|
|
6077
|
+
};
|
|
5633
6078
|
/**
|
|
5634
6079
|
* 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).
|
|
5635
6080
|
*
|
|
@@ -5637,6 +6082,22 @@ declare namespace Components {
|
|
|
5637
6082
|
* 10006129
|
|
5638
6083
|
*/
|
|
5639
6084
|
trigger_user_id?: string;
|
|
6085
|
+
/**
|
|
6086
|
+
* [Internal] The person who ran the workflow task's automation, set by the workflows service only when a user (not the engine) runs it. org_id is that user's own organization, which differs from the flow's for partner users. Used to attribute what the automation does, e.g. who closed the flow. Not for external consumers: a start request carrying it under any token other than a platform service's is refused with 403 and nothing is stored.
|
|
6087
|
+
*
|
|
6088
|
+
*/
|
|
6089
|
+
run_by?: {
|
|
6090
|
+
/**
|
|
6091
|
+
* example:
|
|
6092
|
+
* 10006129
|
|
6093
|
+
*/
|
|
6094
|
+
user_id: string;
|
|
6095
|
+
/**
|
|
6096
|
+
* example:
|
|
6097
|
+
* 739224
|
|
6098
|
+
*/
|
|
6099
|
+
org_id?: string;
|
|
6100
|
+
};
|
|
5640
6101
|
}
|
|
5641
6102
|
/**
|
|
5642
6103
|
* Correlation stamped when the triggering submission entity carried workflow wait claims from a journey link. Consumed by svc-workflows to resume a task waiting on this journey submission.
|
|
@@ -5802,6 +6263,7 @@ declare namespace Paths {
|
|
|
5802
6263
|
}
|
|
5803
6264
|
namespace GetBulkJob {
|
|
5804
6265
|
namespace Parameters {
|
|
6266
|
+
export type IncludeExecutionSummary = boolean;
|
|
5805
6267
|
export type JobId = /**
|
|
5806
6268
|
* Job ID for tracking the status of bulk trigger automation executions
|
|
5807
6269
|
* example:
|
|
@@ -5812,6 +6274,9 @@ declare namespace Paths {
|
|
|
5812
6274
|
export interface PathParameters {
|
|
5813
6275
|
job_id: Parameters.JobId;
|
|
5814
6276
|
}
|
|
6277
|
+
export interface QueryParameters {
|
|
6278
|
+
include_execution_summary?: Parameters.IncludeExecutionSummary;
|
|
6279
|
+
}
|
|
5815
6280
|
namespace Responses {
|
|
5816
6281
|
export type $200 = Components.Schemas.BulkTriggerJob;
|
|
5817
6282
|
export type $403 = /**
|
|
@@ -6239,17 +6704,26 @@ interface OperationMethods {
|
|
|
6239
6704
|
/**
|
|
6240
6705
|
* getBulkJob - getBulkJob
|
|
6241
6706
|
*
|
|
6242
|
-
* Get the status of a bulk job that triggers multiple automation executions
|
|
6707
|
+
* Get the status of a bulk job that triggers multiple automation executions.
|
|
6708
|
+
*
|
|
6709
|
+
* `execution_stats` always holds the complete counts per execution status. `execution_summary` is bounded
|
|
6710
|
+
* to a few MB for very large jobs (`execution_summary_truncated: true`) and can be left out entirely with
|
|
6711
|
+
* `include_execution_summary=false`.
|
|
6712
|
+
*
|
|
6243
6713
|
*/
|
|
6244
6714
|
'getBulkJob'(
|
|
6245
|
-
parameters?: Parameters<Paths.GetBulkJob.PathParameters> | null,
|
|
6715
|
+
parameters?: Parameters<Paths.GetBulkJob.QueryParameters & Paths.GetBulkJob.PathParameters> | null,
|
|
6246
6716
|
data?: any,
|
|
6247
6717
|
config?: AxiosRequestConfig
|
|
6248
6718
|
): OperationResponse<Paths.GetBulkJob.Responses.$200>
|
|
6249
6719
|
/**
|
|
6250
6720
|
* patchBulkJob - patchBulkJob
|
|
6251
6721
|
*
|
|
6252
|
-
* Approve / Cancel bulk job that triggers multiple automation executions
|
|
6722
|
+
* Approve / Cancel / Restart a bulk job that triggers multiple automation executions.
|
|
6723
|
+
*
|
|
6724
|
+
* A `failed` or `cancelled` job can be restarted with the `RESTART` action: it continues where it left off,
|
|
6725
|
+
* only triggering the entities whose executions were not started yet.
|
|
6726
|
+
*
|
|
6253
6727
|
*/
|
|
6254
6728
|
'patchBulkJob'(
|
|
6255
6729
|
parameters?: Parameters<Paths.PatchBulkJob.PathParameters> | null,
|
|
@@ -6434,17 +6908,26 @@ interface PathsDictionary {
|
|
|
6434
6908
|
/**
|
|
6435
6909
|
* getBulkJob - getBulkJob
|
|
6436
6910
|
*
|
|
6437
|
-
* Get the status of a bulk job that triggers multiple automation executions
|
|
6911
|
+
* Get the status of a bulk job that triggers multiple automation executions.
|
|
6912
|
+
*
|
|
6913
|
+
* `execution_stats` always holds the complete counts per execution status. `execution_summary` is bounded
|
|
6914
|
+
* to a few MB for very large jobs (`execution_summary_truncated: true`) and can be left out entirely with
|
|
6915
|
+
* `include_execution_summary=false`.
|
|
6916
|
+
*
|
|
6438
6917
|
*/
|
|
6439
6918
|
'get'(
|
|
6440
|
-
parameters?: Parameters<Paths.GetBulkJob.PathParameters> | null,
|
|
6919
|
+
parameters?: Parameters<Paths.GetBulkJob.QueryParameters & Paths.GetBulkJob.PathParameters> | null,
|
|
6441
6920
|
data?: any,
|
|
6442
6921
|
config?: AxiosRequestConfig
|
|
6443
6922
|
): OperationResponse<Paths.GetBulkJob.Responses.$200>
|
|
6444
6923
|
/**
|
|
6445
6924
|
* patchBulkJob - patchBulkJob
|
|
6446
6925
|
*
|
|
6447
|
-
* Approve / Cancel bulk job that triggers multiple automation executions
|
|
6926
|
+
* Approve / Cancel / Restart a bulk job that triggers multiple automation executions.
|
|
6927
|
+
*
|
|
6928
|
+
* A `failed` or `cancelled` job can be restarted with the `RESTART` action: it continues where it left off,
|
|
6929
|
+
* only triggering the entities whose executions were not started yet.
|
|
6930
|
+
*
|
|
6448
6931
|
*/
|
|
6449
6932
|
'patch'(
|
|
6450
6933
|
parameters?: Parameters<Paths.PatchBulkJob.PathParameters> | null,
|
|
@@ -6568,6 +7051,7 @@ type DiffAdded = Components.Schemas.DiffAdded;
|
|
|
6568
7051
|
type DiffDeleted = Components.Schemas.DiffDeleted;
|
|
6569
7052
|
type DiffUpdated = Components.Schemas.DiffUpdated;
|
|
6570
7053
|
type EntityAssignee = Components.Schemas.EntityAssignee;
|
|
7054
|
+
type EntityAssigneeVariable = Components.Schemas.EntityAssigneeVariable;
|
|
6571
7055
|
type EntityId = Components.Schemas.EntityId;
|
|
6572
7056
|
type EntityItemSnapshot = Components.Schemas.EntityItemSnapshot;
|
|
6573
7057
|
type EntityManualTrigger = Components.Schemas.EntityManualTrigger;
|
|
@@ -6584,6 +7068,7 @@ type ErrorOutput = Components.Schemas.ErrorOutput;
|
|
|
6584
7068
|
type EventCatalogTrigger = Components.Schemas.EventCatalogTrigger;
|
|
6585
7069
|
type ExecItem = Components.Schemas.ExecItem;
|
|
6586
7070
|
type ExecutionChain = Components.Schemas.ExecutionChain;
|
|
7071
|
+
type ExecutionStats = Components.Schemas.ExecutionStats;
|
|
6587
7072
|
type ExecutionStatus = Components.Schemas.ExecutionStatus;
|
|
6588
7073
|
type ExistsCondition = Components.Schemas.ExistsCondition;
|
|
6589
7074
|
type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;
|
|
@@ -6611,6 +7096,8 @@ type JourneyContextUsage = Components.Schemas.JourneyContextUsage;
|
|
|
6611
7096
|
type JourneyContextUsagesReq = Components.Schemas.JourneyContextUsagesReq;
|
|
6612
7097
|
type JourneyContextUsagesResp = Components.Schemas.JourneyContextUsagesResp;
|
|
6613
7098
|
type JourneySubmitTrigger = Components.Schemas.JourneySubmitTrigger;
|
|
7099
|
+
type LabelEmailAction = Components.Schemas.LabelEmailAction;
|
|
7100
|
+
type LabelEmailConfig = Components.Schemas.LabelEmailConfig;
|
|
6614
7101
|
type MapEntityAction = Components.Schemas.MapEntityAction;
|
|
6615
7102
|
type MapEntityActionConfig = Components.Schemas.MapEntityActionConfig;
|
|
6616
7103
|
type MapEntityConfig = Components.Schemas.MapEntityConfig;
|
|
@@ -6648,6 +7135,7 @@ type SendEmailActionConfig = Components.Schemas.SendEmailActionConfig;
|
|
|
6648
7135
|
type SendEmailCondition = Components.Schemas.SendEmailCondition;
|
|
6649
7136
|
type SendEmailConfig = Components.Schemas.SendEmailConfig;
|
|
6650
7137
|
type SendEmailInputs = Components.Schemas.SendEmailInputs;
|
|
7138
|
+
type SentEmailTrigger = Components.Schemas.SentEmailTrigger;
|
|
6651
7139
|
type SetValueMapper = Components.Schemas.SetValueMapper;
|
|
6652
7140
|
type StartExecutionRequest = Components.Schemas.StartExecutionRequest;
|
|
6653
7141
|
type SuffixCondition = Components.Schemas.SuffixCondition;
|
|
@@ -6678,4 +7166,4 @@ type WorkflowContextRole = Components.Schemas.WorkflowContextRole;
|
|
|
6678
7166
|
type WorkflowExecutionContext = Components.Schemas.WorkflowExecutionContext;
|
|
6679
7167
|
type WorkflowWaitContext = Components.Schemas.WorkflowWaitContext;
|
|
6680
7168
|
|
|
6681
|
-
export { type
|
|
7169
|
+
export { type EntityAssigneeVariable as $, type ActionCondition as A, type AutomationExecutionId as B, type Client as C, type AutomationFlow as D, type AutomationFlowId as E, type AutomationLoop as F, type AutomationLoopState as G, type AutomationTrigger as H, type BulkTriggerJob as I, type BulkTriggerRequest as J, type CancellationReason as K, type CartCheckoutAction as L, type CartCheckoutActionConfig as M, type CartCheckoutConfig as N, type OperationMethods as O, Paths as P, type Comparison as Q, type ConditionStatement as R, type CopyValueMapper as S, type CreateDocumentAction as T, type CreateDocumentActionConfig as U, type CreateDocumentConfig as V, type CustomAction as W, type DiffAdded as X, type DiffDeleted as Y, type DiffUpdated as Z, type EntityAssignee as _, Components as a, type PrefixCondition as a$, type EntityId as a0, type EntityItemSnapshot as a1, type EntityManualTrigger as a2, type EntityOperation as a3, type EntityOperationTrigger as a4, type EntityRef as a5, type EntitySearchFilter as a6, type EntitySearchFilterValue as a7, type EqualsIgnoreCaseCondition as a8, type ErrorCode as a9, type InformERPAction as aA, type InformERPActionConfig as aB, type InformERPConfig as aC, type JobId as aD, type JourneyContextUsage as aE, type JourneyContextUsagesReq as aF, type JourneyContextUsagesResp as aG, type JourneySubmitTrigger as aH, type LabelEmailAction as aI, type LabelEmailConfig as aJ, type MapEntityAction as aK, type MapEntityActionConfig as aL, type MapEntityConfig as aM, type MappingAttribute as aN, type MappingAttributeMode as aO, type MappingAttributeV2 as aP, type MappingConfigRef as aQ, type MoveThreadAction as aR, type MoveThreadConfig as aS, type NewEmailThreadTrigger as aT, type NumericCondition as aU, type OperationNode as aV, type OperationObjectNode as aW, type OrCondition as aX, type OrConditionForDiff as aY, type OrganizationId as aZ, type PatchBulkJobRequest as a_, type ErrorDetail as aa, type ErrorObject as ab, type ErrorOutput as ac, type EventCatalogTrigger as ad, type ExecItem as ae, type ExecutionChain as af, type ExecutionStats as ag, type ExecutionStatus as ah, type ExistsCondition as ai, type FilterConditionOnEvent as aj, type FlowExecutionCancelAction as ak, type FlowExecutionCancelActionConfig as al, type FlowExecutionCancelConfig as am, type FlowExecutionCancelInputs as an, type FlowsTrigger as ao, type ForwardEmailAction as ap, type ForwardEmailActionConfig as aq, type ForwardEmailConfig as ar, type FrontendSubmitTrigger as as, type GetExecutionsResp as at, type GraphContextEntry as au, type GraphDefinition as av, type GraphEdge as aw, type GraphNode as ax, type GraphNodeFilter as ay, type GraphSeed as az, type PathsDictionary as b, type PrimitiveJSONValue as b0, type ReceivedEmailTrigger as b1, type RelationAttribute as b2, type ReplyEmailAction as b3, type ReplyEmailActionConfig as b4, type ReplyEmailConfig as b5, type ResumeReq as b6, type ResumeResp as b7, type ResumeToken as b8, type RetryReq as b9, type TriggerShareEntityActionConfig as bA, type TriggerShareEntityConfig as bB, type TriggerWebhookAction as bC, type TriggerWebhookActionConfig as bD, type TriggerWebhookConfig as bE, type TriggerWorkflowAction as bF, type TriggerWorkflowActionConfig as bG, type TriggerWorkflowCondition as bH, type TriggerWorkflowConfig as bI, type WildcardCondition as bJ, type WorkflowContextRole as bK, type WorkflowExecutionContext as bL, type WorkflowWaitContext as bM, type RetryStrategy as ba, type SearchAutomationsResp as bb, type SearchExecutionsReq as bc, type SearchExecutionsResp as bd, type SendEmailAction as be, type SendEmailActionConfig as bf, type SendEmailCondition as bg, type SendEmailConfig as bh, type SendEmailInputs as bi, type SentEmailTrigger as bj, type SetValueMapper as bk, type StartExecutionRequest as bl, type SuffixCondition as bm, type TriggerCondition as bn, type TriggerContext as bo, type TriggerEventAction as bp, type TriggerEventActionConfig as bq, type TriggerEventConfig as br, type TriggerEventEntityActivity as bs, type TriggerEventEntityOperation as bt, type TriggerEventEventCatalog as bu, type TriggerEventFlowAutomationTask as bv, type TriggerEventManual as bw, type TriggerEventMessaging as bx, type TriggerEventPayloadRef as by, type TriggerShareEntityAction as bz, type ActionInputs as c, type ActionSchedule as d, type ActionScheduleSource as e, type ActivityId as f, type ActivityTrigger as g, type AnyAction as h, type AnyActionConfig as i, type AnyTrigger as j, type AnythingButCondition as k, type ApiCallerContext as l, type ApiSubmissionTrigger as m, type AppendValueMapper as n, type AssignEntityAction as o, type AssignEntityActionConfig as p, type AssignEntityConfig as q, type AssignThreadAction as r, type AssignThreadConfig as s, type AssignUsersToStep as t, type AutomationAction as u, type AutomationActionConfig as v, type AutomationActionExecutionState as w, type AutomationActionId as x, type AutomationActionIteration as y, type AutomationExecution as z };
|