@epilot/sdk 2.20.31 → 2.20.33

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.
Files changed (141) hide show
  1. package/definitions/automation.json +228 -7
  2. package/definitions/entity-runtime.json +1 -1
  3. package/definitions/entity.json +118 -3
  4. package/dist/apis/access-token.cjs +6 -6
  5. package/dist/apis/access-token.js +1 -1
  6. package/dist/apis/address-suggestions.cjs +6 -6
  7. package/dist/apis/address-suggestions.js +1 -1
  8. package/dist/apis/address.cjs +6 -6
  9. package/dist/apis/address.js +1 -1
  10. package/dist/apis/ai-agents.cjs +6 -6
  11. package/dist/apis/ai-agents.js +1 -1
  12. package/dist/apis/app.cjs +6 -6
  13. package/dist/apis/app.js +1 -1
  14. package/dist/apis/audit-logs.cjs +6 -6
  15. package/dist/apis/audit-logs.js +1 -1
  16. package/dist/apis/automation.cjs +6 -6
  17. package/dist/apis/automation.d.cts +2 -2
  18. package/dist/apis/automation.d.ts +2 -2
  19. package/dist/apis/automation.js +1 -1
  20. package/dist/apis/billing.cjs +6 -6
  21. package/dist/apis/billing.js +1 -1
  22. package/dist/apis/blueprint-manifest.cjs +6 -6
  23. package/dist/apis/blueprint-manifest.js +1 -1
  24. package/dist/apis/calendar.cjs +6 -6
  25. package/dist/apis/calendar.js +1 -1
  26. package/dist/apis/chat.cjs +6 -6
  27. package/dist/apis/chat.js +1 -1
  28. package/dist/apis/configuration-hub.cjs +6 -6
  29. package/dist/apis/configuration-hub.js +1 -1
  30. package/dist/apis/consent.cjs +6 -6
  31. package/dist/apis/consent.js +1 -1
  32. package/dist/apis/customer-portal.cjs +6 -6
  33. package/dist/apis/customer-portal.js +1 -1
  34. package/dist/apis/dashboard.cjs +6 -6
  35. package/dist/apis/dashboard.js +1 -1
  36. package/dist/apis/data-governance.cjs +6 -6
  37. package/dist/apis/data-governance.js +1 -1
  38. package/dist/apis/deduplication.cjs +6 -6
  39. package/dist/apis/deduplication.js +1 -1
  40. package/dist/apis/design.cjs +6 -6
  41. package/dist/apis/design.js +1 -1
  42. package/dist/apis/document.cjs +6 -6
  43. package/dist/apis/document.js +1 -1
  44. package/dist/apis/email-settings.cjs +6 -6
  45. package/dist/apis/email-settings.js +1 -1
  46. package/dist/apis/email-template.cjs +6 -6
  47. package/dist/apis/email-template.js +1 -1
  48. package/dist/apis/entity-mapping.cjs +6 -6
  49. package/dist/apis/entity-mapping.js +1 -1
  50. package/dist/apis/entity.cjs +8 -8
  51. package/dist/apis/entity.d.cts +2 -2
  52. package/dist/apis/entity.d.ts +2 -2
  53. package/dist/apis/entity.js +2 -2
  54. package/dist/apis/environments.cjs +6 -6
  55. package/dist/apis/environments.js +1 -1
  56. package/dist/apis/event-catalog.cjs +6 -6
  57. package/dist/apis/event-catalog.js +1 -1
  58. package/dist/apis/file.cjs +6 -6
  59. package/dist/apis/file.js +1 -1
  60. package/dist/apis/iban.cjs +6 -6
  61. package/dist/apis/iban.js +1 -1
  62. package/dist/apis/integration-toolkit.cjs +6 -6
  63. package/dist/apis/integration-toolkit.js +1 -1
  64. package/dist/apis/journey.cjs +6 -6
  65. package/dist/apis/journey.js +1 -1
  66. package/dist/apis/kanban.cjs +6 -6
  67. package/dist/apis/kanban.js +1 -1
  68. package/dist/apis/message.cjs +6 -6
  69. package/dist/apis/message.js +1 -1
  70. package/dist/apis/metering.cjs +6 -6
  71. package/dist/apis/metering.js +1 -1
  72. package/dist/apis/notes.cjs +6 -6
  73. package/dist/apis/notes.js +1 -1
  74. package/dist/apis/notification.cjs +6 -6
  75. package/dist/apis/notification.js +1 -1
  76. package/dist/apis/organization.cjs +6 -6
  77. package/dist/apis/organization.js +1 -1
  78. package/dist/apis/partner-directory.cjs +6 -6
  79. package/dist/apis/partner-directory.js +1 -1
  80. package/dist/apis/permissions.cjs +6 -6
  81. package/dist/apis/permissions.js +1 -1
  82. package/dist/apis/pricing-tier.cjs +6 -6
  83. package/dist/apis/pricing-tier.js +1 -1
  84. package/dist/apis/pricing.cjs +6 -6
  85. package/dist/apis/pricing.js +1 -1
  86. package/dist/apis/purpose.cjs +6 -6
  87. package/dist/apis/purpose.js +1 -1
  88. package/dist/apis/query.cjs +6 -6
  89. package/dist/apis/query.js +1 -1
  90. package/dist/apis/sandbox.cjs +6 -6
  91. package/dist/apis/sandbox.js +1 -1
  92. package/dist/apis/sharing.cjs +6 -6
  93. package/dist/apis/sharing.js +1 -1
  94. package/dist/apis/snapshot.cjs +6 -6
  95. package/dist/apis/snapshot.js +1 -1
  96. package/dist/apis/submission.cjs +6 -6
  97. package/dist/apis/submission.js +1 -1
  98. package/dist/apis/target.cjs +6 -6
  99. package/dist/apis/target.js +1 -1
  100. package/dist/apis/targeting.cjs +6 -6
  101. package/dist/apis/targeting.js +1 -1
  102. package/dist/apis/template-variables.cjs +6 -6
  103. package/dist/apis/template-variables.js +1 -1
  104. package/dist/apis/user.cjs +6 -6
  105. package/dist/apis/user.js +1 -1
  106. package/dist/apis/validation-rules.cjs +6 -6
  107. package/dist/apis/validation-rules.js +1 -1
  108. package/dist/apis/webhooks.cjs +6 -6
  109. package/dist/apis/webhooks.js +1 -1
  110. package/dist/apis/workflow-definition.cjs +6 -6
  111. package/dist/apis/workflow-definition.js +1 -1
  112. package/dist/apis/workflow.cjs +6 -6
  113. package/dist/apis/workflow.js +1 -1
  114. package/dist/automation-G2CKAQNB.cjs +7 -0
  115. package/dist/automation-UPTNUOYO.js +7 -0
  116. package/dist/{automation.d-2biAmiMc.d.cts → automation.d-B8g3nYp-.d.cts} +175 -7
  117. package/dist/{automation.d-2biAmiMc.d.ts → automation.d-B8g3nYp-.d.ts} +175 -7
  118. package/dist/chunk-KXNPNC4J.js +14 -0
  119. package/dist/chunk-XT2XPHUH.cjs +14 -0
  120. package/dist/{chunk-MCAD6CIA.js → chunk-YEFQY72W.js} +3 -3
  121. package/dist/{chunk-BY67WVUK.cjs → chunk-ZBFAP6AO.cjs} +3 -3
  122. package/dist/entity-3XUHHKA4.cjs +7 -0
  123. package/dist/entity-UEP5OY55.js +7 -0
  124. package/dist/entity-runtime-DYQQGB4F.cjs +5 -0
  125. package/dist/{entity-runtime-EBFSSNOM.js → entity-runtime-JRSXJKRV.js} +1 -1
  126. package/dist/{entity.d-GfKqzFGA.d.cts → entity.d-BHNaIrDi.d.cts} +215 -12
  127. package/dist/{entity.d-GfKqzFGA.d.ts → entity.d-BHNaIrDi.d.ts} +215 -12
  128. package/dist/index.cjs +10 -10
  129. package/dist/index.d.cts +2 -2
  130. package/dist/index.d.ts +2 -2
  131. package/dist/index.js +2 -2
  132. package/docs/automation.md +200 -3
  133. package/docs/entity.md +42 -22
  134. package/package.json +1 -1
  135. package/dist/automation-CDMOEYVP.cjs +0 -7
  136. package/dist/automation-XFMSH7Y3.js +0 -7
  137. package/dist/chunk-XHTYJNOZ.cjs +0 -14
  138. package/dist/chunk-ZQU37FR3.js +0 -14
  139. package/dist/entity-7LYDUHKF.js +0 -7
  140. package/dist/entity-X6CXO437.cjs +0 -7
  141. package/dist/entity-runtime-7INAS2AX.cjs +0 -5
package/dist/index.cjs CHANGED
@@ -108,7 +108,7 @@ var _chunkK2UZPY6Ucjs = require('./chunk-K2UZPY6U.cjs');
108
108
  var _chunkANN2QTMYcjs = require('./chunk-ANN2QTMY.cjs');
109
109
 
110
110
 
111
- var _chunkXHTYJNOZcjs = require('./chunk-XHTYJNOZ.cjs');
111
+ var _chunkXT2XPHUHcjs = require('./chunk-XT2XPHUH.cjs');
112
112
 
113
113
 
114
114
  var _chunkPNVSKDMVcjs = require('./chunk-PNVSKDMV.cjs');
@@ -161,7 +161,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
161
161
 
162
162
 
163
163
 
164
- var _chunkBY67WVUKcjs = require('./chunk-BY67WVUK.cjs');
164
+ var _chunkZBFAP6AOcjs = require('./chunk-ZBFAP6AO.cjs');
165
165
 
166
166
 
167
167
  var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -228,7 +228,7 @@ var resolveClient = (params) => {
228
228
  }
229
229
  if (!entry.instance) {
230
230
  const definition = entry.loader();
231
- entry.instance = _chunkBY67WVUKcjs.createApiClient.call(void 0, {
231
+ entry.instance = _chunkZBFAP6AOcjs.createApiClient.call(void 0, {
232
232
  definition,
233
233
  token: state.token,
234
234
  headers: state.globalHeaders,
@@ -261,7 +261,7 @@ var resetAllClients = (registry) => {
261
261
  };
262
262
 
263
263
  // src/apis/_registry.ts
264
- var expandDef = (mod) => _chunkBY67WVUKcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
264
+ var expandDef = (mod) => _chunkZBFAP6AOcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
265
265
  var registerBuiltinApis = (registry) => {
266
266
  registerApi({
267
267
  registry,
@@ -371,7 +371,7 @@ var registerBuiltinApis = (registry) => {
371
371
  registerApi({
372
372
  registry,
373
373
  name: "entity",
374
- loader: () => expandDef(_chunkXHTYJNOZcjs.require_entity_runtime.call(void 0, ))
374
+ loader: () => expandDef(_chunkXT2XPHUHcjs.require_entity_runtime.call(void 0, ))
375
375
  });
376
376
  registerApi({
377
377
  registry,
@@ -609,9 +609,9 @@ var createSDK = () => {
609
609
  const available = [...registry.keys()].join(", ");
610
610
  throw new Error(`Unknown API: "${name}". Available: ${available}`);
611
611
  }
612
- return _chunkBY67WVUKcjs.createApiHandle.call(void 0, {
612
+ return _chunkZBFAP6AOcjs.createApiHandle.call(void 0, {
613
613
  resolveClient: () => resolveClient({ registry, name, state }),
614
- createClient: () => _chunkBY67WVUKcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
614
+ createClient: () => _chunkZBFAP6AOcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
615
615
  apiName: name
616
616
  });
617
617
  };
@@ -659,9 +659,9 @@ var createSDK = () => {
659
659
  return interceptorUse;
660
660
  }
661
661
  case "help":
662
- return (apiName) => _chunkBY67WVUKcjs.help.call(void 0, apiName);
662
+ return (apiName) => _chunkZBFAP6AOcjs.help.call(void 0, apiName);
663
663
  case "openapi":
664
- return (apiName) => _chunkBY67WVUKcjs.openapi.call(void 0, apiName);
664
+ return (apiName) => _chunkZBFAP6AOcjs.openapi.call(void 0, apiName);
665
665
  case "then":
666
666
  case "catch":
667
667
  case "finally":
@@ -691,4 +691,4 @@ var epilot = createSDK();
691
691
 
692
692
 
693
693
 
694
- exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkBY67WVUKcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkBY67WVUKcjs.help; exports.openapi = _chunkBY67WVUKcjs.openapi;
694
+ exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkZBFAP6AOcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkZBFAP6AOcjs.help; exports.openapi = _chunkZBFAP6AOcjs.openapi;
package/dist/index.d.cts CHANGED
@@ -9,7 +9,7 @@ import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.cjs';
9
9
  import { C as Client$3 } from './ai-agents.d-B3TkP4mo.cjs';
10
10
  import { C as Client$4 } from './app.d-CqXqNLxq.cjs';
11
11
  import { C as Client$5 } from './audit-logs.d-BRToFqeX.cjs';
12
- import { C as Client$6 } from './automation.d-2biAmiMc.cjs';
12
+ import { C as Client$6 } from './automation.d-B8g3nYp-.cjs';
13
13
  import { C as Client$7 } from './billing.d-DA3sViEF.cjs';
14
14
  import { C as Client$8 } from './blueprint-manifest.d-B8YKYzSJ.cjs';
15
15
  import { C as Client$9 } from './calendar.d-mk-ltGpk.cjs';
@@ -24,7 +24,7 @@ import { C as Client$h } from './design.d-CYHbiaq_.cjs';
24
24
  import { C as Client$i } from './document.d-B0zC-R8x.cjs';
25
25
  import { C as Client$j } from './email-settings.d-DViLYaOl.cjs';
26
26
  import { C as Client$k } from './email-template.d-gtQkdaXM.cjs';
27
- import { C as Client$l } from './entity.d-GfKqzFGA.cjs';
27
+ import { C as Client$l } from './entity.d-BHNaIrDi.cjs';
28
28
  import { C as Client$m } from './entity-mapping.d-8MtWa2_L.cjs';
29
29
  import { C as Client$n } from './environments.d-qL1urwAq.cjs';
30
30
  import { C as Client$o } from './event-catalog.d-CCE1qmBN.cjs';
package/dist/index.d.ts CHANGED
@@ -9,7 +9,7 @@ import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.js';
9
9
  import { C as Client$3 } from './ai-agents.d-B3TkP4mo.js';
10
10
  import { C as Client$4 } from './app.d-CqXqNLxq.js';
11
11
  import { C as Client$5 } from './audit-logs.d-BRToFqeX.js';
12
- import { C as Client$6 } from './automation.d-2biAmiMc.js';
12
+ import { C as Client$6 } from './automation.d-B8g3nYp-.js';
13
13
  import { C as Client$7 } from './billing.d-DA3sViEF.js';
14
14
  import { C as Client$8 } from './blueprint-manifest.d-B8YKYzSJ.js';
15
15
  import { C as Client$9 } from './calendar.d-mk-ltGpk.js';
@@ -24,7 +24,7 @@ import { C as Client$h } from './design.d-CYHbiaq_.js';
24
24
  import { C as Client$i } from './document.d-B0zC-R8x.js';
25
25
  import { C as Client$j } from './email-settings.d-DViLYaOl.js';
26
26
  import { C as Client$k } from './email-template.d-gtQkdaXM.js';
27
- import { C as Client$l } from './entity.d-GfKqzFGA.js';
27
+ import { C as Client$l } from './entity.d-BHNaIrDi.js';
28
28
  import { C as Client$m } from './entity-mapping.d-8MtWa2_L.js';
29
29
  import { C as Client$n } from './environments.d-qL1urwAq.js';
30
30
  import { C as Client$o } from './event-catalog.d-CCE1qmBN.js';
package/dist/index.js CHANGED
@@ -108,7 +108,7 @@ import {
108
108
  } from "./chunk-SBSIGQDU.js";
109
109
  import {
110
110
  require_entity_runtime
111
- } from "./chunk-ZQU37FR3.js";
111
+ } from "./chunk-KXNPNC4J.js";
112
112
  import {
113
113
  require_billing_runtime
114
114
  } from "./chunk-5SAISAQY.js";
@@ -161,7 +161,7 @@ import {
161
161
  expand,
162
162
  help,
163
163
  openapi
164
- } from "./chunk-MCAD6CIA.js";
164
+ } from "./chunk-YEFQY72W.js";
165
165
  import {
166
166
  __require
167
167
  } from "./chunk-YPSWSI3M.js";
@@ -53,6 +53,9 @@ const { data } = await automationClient.searchFlows(...)
53
53
  - [`AutomationFlow`](#automationflow)
54
54
  - [`WorkflowContextRole`](#workflowcontextrole)
55
55
  - [`SearchAutomationsResp`](#searchautomationsresp)
56
+ - [`JourneyContextUsagesReq`](#journeycontextusagesreq)
57
+ - [`JourneyContextUsage`](#journeycontextusage)
58
+ - [`JourneyContextUsagesResp`](#journeycontextusagesresp)
56
59
  - [`AnyTrigger`](#anytrigger)
57
60
  - [`AnyAction`](#anyaction)
58
61
  - [`AnyActionConfig`](#anyactionconfig)
@@ -154,6 +157,9 @@ const { data } = await automationClient.searchFlows(...)
154
157
  - [`SearchExecutionsReq`](#searchexecutionsreq)
155
158
  - [`SearchExecutionsResp`](#searchexecutionsresp)
156
159
  - [`StartExecutionRequest`](#startexecutionrequest)
160
+ - [`ActionInputs`](#actioninputs)
161
+ - [`SendEmailInputs`](#sendemailinputs)
162
+ - [`FlowExecutionCancelInputs`](#flowexecutioncancelinputs)
157
163
  - [`PatchBulkJobRequest`](#patchbulkjobrequest)
158
164
  - [`BulkTriggerRequest`](#bulktriggerrequest)
159
165
  - [`EntityRef`](#entityref)
@@ -328,6 +334,7 @@ const { data } = await client.getExecutions({
328
334
  "conditions": [],
329
335
  "schedules": [],
330
336
  "actions": [],
337
+ "action_inputs": {},
331
338
  "resume_token": "eyJraWQiOiJrZXkifQ==",
332
339
  "trigger_context": {},
333
340
  "version": 2,
@@ -378,7 +385,23 @@ const { data } = await client.startExecution(
378
385
  trigger_user_id: '10006129'
379
386
  },
380
387
  flow_execution_id: 'string',
381
- flow_automation_task_id: 'string'
388
+ flow_automation_task_id: 'string',
389
+ action_inputs: {
390
+ 'cancel-flow-execution': {
391
+ selected_reasons: [
392
+ {
393
+ id: '_6kITMwkv_0Uo4i7fO7Ja',
394
+ title: 'Process completed successfully'
395
+ }
396
+ ],
397
+ extra_description: 'string'
398
+ },
399
+ 'send-email': {
400
+ subject: 'string',
401
+ body: 'string',
402
+ attachment_entity_ids: ['string']
403
+ }
404
+ }
382
405
  },
383
406
  )
384
407
  ```
@@ -472,6 +495,17 @@ const { data } = await client.startExecution(
472
495
  "iterations": []
473
496
  }
474
497
  ],
498
+ "action_inputs": {
499
+ "cancel-flow-execution": {
500
+ "selected_reasons": [],
501
+ "extra_description": "string"
502
+ },
503
+ "send-email": {
504
+ "subject": "string",
505
+ "body": "string",
506
+ "attachment_entity_ids": ["string"]
507
+ }
508
+ },
475
509
  "resume_token": "eyJraWQiOiJrZXkifQ==",
476
510
  "trigger_context": {
477
511
  "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -566,6 +600,7 @@ const { data } = await client.searchExecutions(
566
600
  "conditions": [],
567
601
  "schedules": [],
568
602
  "actions": [],
603
+ "action_inputs": {},
569
604
  "resume_token": "eyJraWQiOiJrZXkifQ==",
570
605
  "trigger_context": {},
571
606
  "version": 2,
@@ -846,6 +881,17 @@ const { data } = await client.getExecution({
846
881
  "iterations": []
847
882
  }
848
883
  ],
884
+ "action_inputs": {
885
+ "cancel-flow-execution": {
886
+ "selected_reasons": [],
887
+ "extra_description": "string"
888
+ },
889
+ "send-email": {
890
+ "subject": "string",
891
+ "body": "string",
892
+ "attachment_entity_ids": ["string"]
893
+ }
894
+ },
849
895
  "resume_token": "eyJraWQiOiJrZXkifQ==",
850
896
  "trigger_context": {
851
897
  "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -998,6 +1044,17 @@ const { data } = await client.cancelExecution({
998
1044
  "iterations": []
999
1045
  }
1000
1046
  ],
1047
+ "action_inputs": {
1048
+ "cancel-flow-execution": {
1049
+ "selected_reasons": [],
1050
+ "extra_description": "string"
1051
+ },
1052
+ "send-email": {
1053
+ "subject": "string",
1054
+ "body": "string",
1055
+ "attachment_entity_ids": ["string"]
1056
+ }
1057
+ },
1001
1058
  "resume_token": "eyJraWQiOiJrZXkifQ==",
1002
1059
  "trigger_context": {
1003
1060
  "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -1120,6 +1177,10 @@ const { data } = await client.resumeExecutionWithToken(
1120
1177
  {},
1121
1178
  {}
1122
1179
  ],
1180
+ "action_inputs": {
1181
+ "cancel-flow-execution": {},
1182
+ "send-email": {}
1183
+ },
1123
1184
  "resume_token": "eyJraWQiOiJrZXkifQ==",
1124
1185
  "trigger_context": {
1125
1186
  "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -1472,6 +1533,72 @@ type SearchAutomationsResp = {
1472
1533
  }
1473
1534
  ```
1474
1535
 
1536
+ ### `JourneyContextUsagesReq`
1537
+
1538
+ ```ts
1539
+ type JourneyContextUsagesReq = {
1540
+ journey_id: string // uuid
1541
+ param_keys: string[]
1542
+ param_ids?: string[]
1543
+ }
1544
+ ```
1545
+
1546
+ ### `JourneyContextUsage`
1547
+
1548
+ ```ts
1549
+ type JourneyContextUsage = {
1550
+ kind: "automation"
1551
+ resource: {
1552
+ type: "automation_flow"
1553
+ id: string
1554
+ name?: string
1555
+ }
1556
+ location?: {
1557
+ action_id?: string
1558
+ action_type?: string
1559
+ }
1560
+ matched_as: {
1561
+ dialect: "name"
1562
+ token: string
1563
+ at: string
1564
+ }
1565
+ link_hint: {
1566
+ route: "automation-flow"
1567
+ params: Record<string, string>
1568
+ }
1569
+ }
1570
+ ```
1571
+
1572
+ ### `JourneyContextUsagesResp`
1573
+
1574
+ ```ts
1575
+ type JourneyContextUsagesResp = {
1576
+ usages: Array<{
1577
+ kind: "automation"
1578
+ resource: {
1579
+ type: { ... }
1580
+ id: { ... }
1581
+ name?: { ... }
1582
+ }
1583
+ location?: {
1584
+ action_id?: { ... }
1585
+ action_type?: { ... }
1586
+ }
1587
+ matched_as: {
1588
+ dialect: { ... }
1589
+ token: { ... }
1590
+ at: { ... }
1591
+ }
1592
+ link_hint: {
1593
+ route: { ... }
1594
+ params: { ... }
1595
+ }
1596
+ }>
1597
+ status: "ok" | "partial"
1598
+ scanned: number
1599
+ }
1600
+ ```
1601
+
1475
1602
  ### `AnyTrigger`
1476
1603
 
1477
1604
  ```ts
@@ -2840,6 +2967,7 @@ type ForwardEmailActionConfig = {
2840
2967
  }>
2841
2968
  include_attachments?: boolean
2842
2969
  subject_prefix?: string
2970
+ language_code?: "de" | "en"
2843
2971
  mark_as_done?: boolean
2844
2972
  mark_as_read?: boolean
2845
2973
  }
@@ -2868,6 +2996,7 @@ type ForwardEmailAction = {
2868
2996
  }>
2869
2997
  include_attachments?: boolean
2870
2998
  subject_prefix?: string
2999
+ language_code?: "de" | "en"
2871
3000
  mark_as_done?: boolean
2872
3001
  mark_as_read?: boolean
2873
3002
  }
@@ -2884,6 +3013,7 @@ type ForwardEmailConfig = {
2884
3013
  }>
2885
3014
  include_attachments?: boolean
2886
3015
  subject_prefix?: string
3016
+ language_code?: "de" | "en"
2887
3017
  mark_as_done?: boolean
2888
3018
  mark_as_read?: boolean
2889
3019
  }
@@ -2963,6 +3093,8 @@ type SendEmailConfig = {
2963
3093
  source_filter?: {
2964
3094
  limit?: { ... }
2965
3095
  filename_regex?: { ... }
3096
+ filename?: { ... }
3097
+ filename_pattern?: { ... }
2966
3098
  attribute?: { ... }
2967
3099
  relation_tag?: { ... }
2968
3100
  tag?: { ... }
@@ -3391,7 +3523,7 @@ type FlowExecutionCancelAction = {
3391
3523
 
3392
3524
  ### `FlowExecutionCancelConfig`
3393
3525
 
3394
- Configuration for cancelling a flow execution with selected reasons
3526
+ Configuration for cancelling a flow execution. The selected reasons are optional; a semi-automated step lets the person running it choose them when the execution starts.
3395
3527
 
3396
3528
  ```ts
3397
3529
  type FlowExecutionCancelConfig = {
@@ -3647,7 +3779,7 @@ type WorkflowExecutionContext = {
3647
3779
 
3648
3780
  ### `WorkflowWaitContext`
3649
3781
 
3650
- 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.
3782
+ 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.
3651
3783
 
3652
3784
 
3653
3785
  ```ts
@@ -4055,6 +4187,71 @@ type StartExecutionRequest = {
4055
4187
  }
4056
4188
  flow_execution_id?: string
4057
4189
  flow_automation_task_id?: string
4190
+ action_inputs?: {
4191
+ cancel-flow-execution?: {
4192
+ selected_reasons: { ... }
4193
+ extra_description?: { ... }
4194
+ }
4195
+ send-email?: {
4196
+ subject?: { ... }
4197
+ body?: { ... }
4198
+ attachment_entity_ids?: { ... }
4199
+ }
4200
+ }
4201
+ }
4202
+ ```
4203
+
4204
+ ### `ActionInputs`
4205
+
4206
+ Internal. Run-time inputs for the actions of this execution, keyed by
4207
+ action type. An action reads the entry for its own type and treats it
4208
+ as replacing the matching configured values; an action whose type has
4209
+ no entry runs entirely from its configuration.
4210
+
4211
+ Only the workflows service may set this fi
4212
+
4213
+ ```ts
4214
+ type ActionInputs = {
4215
+ cancel-flow-execution?: {
4216
+ selected_reasons: Array<{
4217
+ id: { ... }
4218
+ title: { ... }
4219
+ }>
4220
+ extra_description?: string
4221
+ }
4222
+ send-email?: {
4223
+ subject?: string
4224
+ body?: string
4225
+ attachment_entity_ids?: string[]
4226
+ }
4227
+ }
4228
+ ```
4229
+
4230
+ ### `SendEmailInputs`
4231
+
4232
+ Adjustments a person made to an email before sending it, replacing the rendered values the template produced. The template itself is untouched.
4233
+
4234
+ `attachment_entity_ids` is a request, not an instruction: the worker keeps only the ids that are genuinely files of the entity this execution runs on, so a
4235
+
4236
+ ```ts
4237
+ type SendEmailInputs = {
4238
+ subject?: string
4239
+ body?: string
4240
+ attachment_entity_ids?: string[]
4241
+ }
4242
+ ```
4243
+
4244
+ ### `FlowExecutionCancelInputs`
4245
+
4246
+ The cancellation reasons a person chose when running a semi-automated cancel step, replacing `selected_reasons` from the action's configuration.
4247
+
4248
+ ```ts
4249
+ type FlowExecutionCancelInputs = {
4250
+ selected_reasons: Array<{
4251
+ id: string
4252
+ title: string
4253
+ }>
4254
+ extra_description?: string
4058
4255
  }
4059
4256
  ```
4060
4257
 
package/docs/entity.md CHANGED
@@ -493,7 +493,10 @@ const { data } = await client.getSchema({
493
493
  "widget_widths": {
494
494
  "address_map": "full_width",
495
495
  "recent_communications": "one_third_width"
496
- }
496
+ },
497
+ "custom_tabs": [
498
+ {}
499
+ ]
497
500
  },
498
501
  "capabilities": [
499
502
  {
@@ -502,6 +505,7 @@ const { data } = await client.getSchema({
502
505
  "title": "Messaging",
503
506
  "attributes": [],
504
507
  "overridable_attribute": false,
508
+ "managed_fields": ["status"],
505
509
  "_purpose": ["taxonomy-slug:classification-slug"],
506
510
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
507
511
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -654,7 +658,10 @@ const { data } = await client.putSchema(
654
658
  widget_widths: {
655
659
  address_map: 'full_width',
656
660
  recent_communications: 'one_third_width'
657
- }
661
+ },
662
+ custom_tabs: [
663
+ { /* ... */ }
664
+ ]
658
665
  },
659
666
  capabilities: [
660
667
  {
@@ -663,6 +670,7 @@ const { data } = await client.putSchema(
663
670
  title: 'Messaging',
664
671
  attributes: [ /* ... */ ],
665
672
  overridable_attribute: false,
673
+ managed_fields: ['status'],
666
674
  _purpose: ['taxonomy-slug:classification-slug'],
667
675
  _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
668
676
  app_id: '123e4567-e89b-12d3-a456-426614174000',
@@ -816,7 +824,10 @@ const { data } = await client.putSchema(
816
824
  "widget_widths": {
817
825
  "address_map": "full_width",
818
826
  "recent_communications": "one_third_width"
819
- }
827
+ },
828
+ "custom_tabs": [
829
+ {}
830
+ ]
820
831
  },
821
832
  "capabilities": [
822
833
  {
@@ -825,6 +836,7 @@ const { data } = await client.putSchema(
825
836
  "title": "Messaging",
826
837
  "attributes": [],
827
838
  "overridable_attribute": false,
839
+ "managed_fields": ["status"],
828
840
  "_purpose": ["taxonomy-slug:classification-slug"],
829
841
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
830
842
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -1202,6 +1214,7 @@ const { data } = await client.listAvailableCapabilities({
1202
1214
  "title": "Messaging",
1203
1215
  "attributes": [],
1204
1216
  "overridable_attribute": false,
1217
+ "managed_fields": ["status"],
1205
1218
  "_purpose": ["taxonomy-slug:classification-slug"],
1206
1219
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
1207
1220
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -2192,7 +2205,7 @@ const { data } = await client.deleteEntity({
2192
2205
 
2193
2206
  ### `autocomplete`
2194
2207
 
2195
- Autocomplete entity attributes
2208
+ Autocomplete entity attributes.
2196
2209
 
2197
2210
  `GET /v1/entity:autocomplete`
2198
2211
 
@@ -2203,6 +2216,7 @@ const { data } = await client.autocomplete({
2203
2216
  attribute: 'example',
2204
2217
  slug: 'example',
2205
2218
  size: 1,
2219
+ from: 1,
2206
2220
  })
2207
2221
  ```
2208
2222
 
@@ -4849,6 +4863,7 @@ const { data } = await client.createSchemaCapability(
4849
4863
  /* ... 33 more */
4850
4864
  ],
4851
4865
  overridable_attribute: false,
4866
+ managed_fields: ['status'],
4852
4867
  _purpose: ['taxonomy-slug:classification-slug'],
4853
4868
  _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
4854
4869
  app_id: '123e4567-e89b-12d3-a456-426614174000',
@@ -4985,6 +5000,7 @@ const { data } = await client.createSchemaCapability(
4985
5000
  }
4986
5001
  ],
4987
5002
  "overridable_attribute": false,
5003
+ "managed_fields": ["status"],
4988
5004
  "_purpose": ["taxonomy-slug:classification-slug"],
4989
5005
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
4990
5006
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5136,6 +5152,7 @@ const { data } = await client.getSchemaCapability({
5136
5152
  }
5137
5153
  ],
5138
5154
  "overridable_attribute": false,
5155
+ "managed_fields": ["status"],
5139
5156
  "_purpose": ["taxonomy-slug:classification-slug"],
5140
5157
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
5141
5158
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5283,6 +5300,7 @@ const { data } = await client.putSchemaCapability(
5283
5300
  /* ... 33 more */
5284
5301
  ],
5285
5302
  overridable_attribute: false,
5303
+ managed_fields: ['status'],
5286
5304
  _purpose: ['taxonomy-slug:classification-slug'],
5287
5305
  _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
5288
5306
  app_id: '123e4567-e89b-12d3-a456-426614174000',
@@ -5419,6 +5437,7 @@ const { data } = await client.putSchemaCapability(
5419
5437
  }
5420
5438
  ],
5421
5439
  "overridable_attribute": false,
5440
+ "managed_fields": ["status"],
5422
5441
  "_purpose": ["taxonomy-slug:classification-slug"],
5423
5442
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
5424
5443
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5570,6 +5589,7 @@ const { data } = await client.deleteSchemaCapability({
5570
5589
  }
5571
5590
  ],
5572
5591
  "overridable_attribute": false,
5592
+ "managed_fields": ["status"],
5573
5593
  "_purpose": ["taxonomy-slug:classification-slug"],
5574
5594
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
5575
5595
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -6133,6 +6153,15 @@ type EntitySchema = {
6133
6153
  widget_order?: string[]
6134
6154
  widget_visibility?: Record<string, boolean>
6135
6155
  widget_widths?: Record<string, "one_third_width" | "half_width" | "two_third_width" | "full_width">
6156
+ custom_tabs?: Array<{
6157
+ id: { ... }
6158
+ slug: { ... }
6159
+ title: { ... }
6160
+ order: { ... }
6161
+ icon?: { ... }
6162
+ type: { ... }
6163
+ widgets?: { ... }
6164
+ }>
6136
6165
  }
6137
6166
  capabilities: Array<{
6138
6167
  id?: string
@@ -6151,15 +6180,6 @@ type EntitySchema = {
6151
6180
  deprecated?: { ... }
6152
6181
  overridable_attribute?: { ... }
6153
6182
  default_value?: { ... }
6154
- group?: { ... }
6155
- order?: { ... }
6156
- layout?: { ... }
6157
- hide_label?: { ... }
6158
- icon?: { ... }
6159
- render_condition?: { ... }
6160
- data_classification?: { ... }
6161
- _purpose?: { ... }
6162
- _manifest?: { ... }
6163
6183
  // ...
6164
6184
  }
6165
6185
  ```
@@ -6251,6 +6271,15 @@ type EntitySchemaItem = {
6251
6271
  widget_order?: string[]
6252
6272
  widget_visibility?: Record<string, boolean>
6253
6273
  widget_widths?: Record<string, "one_third_width" | "half_width" | "two_third_width" | "full_width">
6274
+ custom_tabs?: Array<{
6275
+ id: { ... }
6276
+ slug: { ... }
6277
+ title: { ... }
6278
+ order: { ... }
6279
+ icon?: { ... }
6280
+ type: { ... }
6281
+ widgets?: { ... }
6282
+ }>
6254
6283
  }
6255
6284
  capabilities: Array<{
6256
6285
  id?: string
@@ -6258,15 +6287,6 @@ type EntitySchemaItem = {
6258
6287
  title?: string
6259
6288
  attributes?: Array<{
6260
6289
  id?: { ... }
6261
- name: { ... }
6262
- label: { ... }
6263
- placeholder?: { ... }
6264
- hidden?: { ... }
6265
- show_in_table?: { ... }
6266
- sortable?: { ... }
6267
- required?: { ... }
6268
- readonly?: { ... }
6269
- deprecated?: { ... }
6270
6290
  // ...
6271
6291
  }
6272
6292
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/sdk",
3
- "version": "2.20.31",
3
+ "version": "2.20.33",
4
4
  "description": "JavaScript/TypeScript SDK for epilot APIs",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",