@epilot/sdk 2.20.61 → 2.20.63

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 (178) hide show
  1. package/definitions/app.json +17 -44
  2. package/definitions/customer-portal-runtime.json +1 -1
  3. package/definitions/customer-portal.json +566 -14
  4. package/definitions/email-settings-runtime.json +1 -1
  5. package/definitions/email-settings.json +98 -36
  6. package/definitions/integration-toolkit-runtime.json +1 -1
  7. package/definitions/integration-toolkit.json +656 -2
  8. package/dist/apis/access-token.cjs +6 -6
  9. package/dist/apis/access-token.js +1 -1
  10. package/dist/apis/address-suggestions.cjs +6 -6
  11. package/dist/apis/address-suggestions.js +1 -1
  12. package/dist/apis/address.cjs +6 -6
  13. package/dist/apis/address.js +1 -1
  14. package/dist/apis/ai-agents.cjs +6 -6
  15. package/dist/apis/ai-agents.js +1 -1
  16. package/dist/apis/app.cjs +6 -6
  17. package/dist/apis/app.d.cts +2 -2
  18. package/dist/apis/app.d.ts +2 -2
  19. package/dist/apis/app.js +1 -1
  20. package/dist/apis/audit-logs.cjs +6 -6
  21. package/dist/apis/audit-logs.js +1 -1
  22. package/dist/apis/automation.cjs +6 -6
  23. package/dist/apis/automation.js +1 -1
  24. package/dist/apis/billing.cjs +6 -6
  25. package/dist/apis/billing.js +1 -1
  26. package/dist/apis/blueprint-manifest.cjs +6 -6
  27. package/dist/apis/blueprint-manifest.js +1 -1
  28. package/dist/apis/calendar.cjs +6 -6
  29. package/dist/apis/calendar.js +1 -1
  30. package/dist/apis/chat.cjs +6 -6
  31. package/dist/apis/chat.js +1 -1
  32. package/dist/apis/configuration-hub.cjs +6 -6
  33. package/dist/apis/configuration-hub.js +1 -1
  34. package/dist/apis/consent.cjs +6 -6
  35. package/dist/apis/consent.js +1 -1
  36. package/dist/apis/customer-portal.cjs +8 -8
  37. package/dist/apis/customer-portal.d.cts +2 -2
  38. package/dist/apis/customer-portal.d.ts +2 -2
  39. package/dist/apis/customer-portal.js +2 -2
  40. package/dist/apis/dashboard.cjs +6 -6
  41. package/dist/apis/dashboard.js +1 -1
  42. package/dist/apis/data-governance.cjs +6 -6
  43. package/dist/apis/data-governance.js +1 -1
  44. package/dist/apis/deduplication.cjs +6 -6
  45. package/dist/apis/deduplication.js +1 -1
  46. package/dist/apis/design.cjs +6 -6
  47. package/dist/apis/design.js +1 -1
  48. package/dist/apis/document.cjs +6 -6
  49. package/dist/apis/document.js +1 -1
  50. package/dist/apis/email-settings.cjs +8 -8
  51. package/dist/apis/email-settings.d.cts +2 -2
  52. package/dist/apis/email-settings.d.ts +2 -2
  53. package/dist/apis/email-settings.js +2 -2
  54. package/dist/apis/email-template.cjs +6 -6
  55. package/dist/apis/email-template.js +1 -1
  56. package/dist/apis/entity-mapping.cjs +6 -6
  57. package/dist/apis/entity-mapping.js +1 -1
  58. package/dist/apis/entity.cjs +6 -6
  59. package/dist/apis/entity.js +1 -1
  60. package/dist/apis/environments.cjs +6 -6
  61. package/dist/apis/environments.js +1 -1
  62. package/dist/apis/event-catalog.cjs +6 -6
  63. package/dist/apis/event-catalog.js +1 -1
  64. package/dist/apis/external-values.cjs +6 -6
  65. package/dist/apis/external-values.js +1 -1
  66. package/dist/apis/file.cjs +6 -6
  67. package/dist/apis/file.js +1 -1
  68. package/dist/apis/iban.cjs +6 -6
  69. package/dist/apis/iban.js +1 -1
  70. package/dist/apis/identity.cjs +6 -6
  71. package/dist/apis/identity.js +1 -1
  72. package/dist/apis/integration-toolkit.cjs +61 -9
  73. package/dist/apis/integration-toolkit.d.cts +2 -2
  74. package/dist/apis/integration-toolkit.d.ts +2 -2
  75. package/dist/apis/integration-toolkit.js +55 -3
  76. package/dist/apis/journey.cjs +6 -6
  77. package/dist/apis/journey.js +1 -1
  78. package/dist/apis/kanban.cjs +6 -6
  79. package/dist/apis/kanban.js +1 -1
  80. package/dist/apis/message.cjs +6 -6
  81. package/dist/apis/message.js +1 -1
  82. package/dist/apis/metering.cjs +6 -6
  83. package/dist/apis/metering.js +1 -1
  84. package/dist/apis/notes.cjs +6 -6
  85. package/dist/apis/notes.js +1 -1
  86. package/dist/apis/notification.cjs +6 -6
  87. package/dist/apis/notification.js +1 -1
  88. package/dist/apis/organization.cjs +6 -6
  89. package/dist/apis/organization.js +1 -1
  90. package/dist/apis/partner-directory.cjs +6 -6
  91. package/dist/apis/partner-directory.js +1 -1
  92. package/dist/apis/permissions.cjs +6 -6
  93. package/dist/apis/permissions.js +1 -1
  94. package/dist/apis/phone-integration.cjs +6 -6
  95. package/dist/apis/phone-integration.js +1 -1
  96. package/dist/apis/pricing-tier.cjs +6 -6
  97. package/dist/apis/pricing-tier.js +1 -1
  98. package/dist/apis/pricing.cjs +6 -6
  99. package/dist/apis/pricing.js +1 -1
  100. package/dist/apis/purpose.cjs +6 -6
  101. package/dist/apis/purpose.js +1 -1
  102. package/dist/apis/query.cjs +6 -6
  103. package/dist/apis/query.js +1 -1
  104. package/dist/apis/sandbox.cjs +6 -6
  105. package/dist/apis/sandbox.js +1 -1
  106. package/dist/apis/sharing.cjs +6 -6
  107. package/dist/apis/sharing.js +1 -1
  108. package/dist/apis/snapshot.cjs +6 -6
  109. package/dist/apis/snapshot.js +1 -1
  110. package/dist/apis/submission.cjs +6 -6
  111. package/dist/apis/submission.js +1 -1
  112. package/dist/apis/target.cjs +6 -6
  113. package/dist/apis/target.js +1 -1
  114. package/dist/apis/targeting.cjs +6 -6
  115. package/dist/apis/targeting.js +1 -1
  116. package/dist/apis/template-variables.cjs +6 -6
  117. package/dist/apis/template-variables.js +1 -1
  118. package/dist/apis/user.cjs +6 -6
  119. package/dist/apis/user.js +1 -1
  120. package/dist/apis/validation-rules.cjs +6 -6
  121. package/dist/apis/validation-rules.js +1 -1
  122. package/dist/apis/webhooks.cjs +6 -6
  123. package/dist/apis/webhooks.js +1 -1
  124. package/dist/apis/workflow-definition.cjs +6 -6
  125. package/dist/apis/workflow-definition.js +1 -1
  126. package/dist/apis/workflow.cjs +6 -6
  127. package/dist/apis/workflow.js +1 -1
  128. package/dist/app-CKQAJ7EE.js +7 -0
  129. package/dist/app-ERJHXY64.cjs +7 -0
  130. package/dist/{app.d-DbOr4uIC.d.cts → app.d-CZELwNO3.d.cts} +51 -27
  131. package/dist/{app.d-DbOr4uIC.d.ts → app.d-CZELwNO3.d.ts} +51 -27
  132. package/dist/{chunk-7HQ3GMYQ.js → chunk-2R4YLMDG.js} +1 -1
  133. package/dist/{chunk-6LYUL3EY.cjs → chunk-FUF6LZXH.cjs} +7 -7
  134. package/dist/chunk-I6IC54PD.js +14 -0
  135. package/dist/chunk-O2XK4VD5.js +14 -0
  136. package/dist/chunk-QDPZZUG3.cjs +14 -0
  137. package/dist/{chunk-OEDN6Y5U.js → chunk-SYTRHMOU.js} +7 -7
  138. package/dist/chunk-UP3ZIQHB.cjs +14 -0
  139. package/dist/{chunk-AWJHA3GG.cjs → chunk-YDFQ3LWN.cjs} +1 -1
  140. package/dist/customer-portal-2OT5REK6.cjs +7 -0
  141. package/dist/customer-portal-AO2K6VW2.js +7 -0
  142. package/dist/{customer-portal-runtime-ZTLLE6CR.cjs → customer-portal-runtime-ATHDYPZM.cjs} +2 -2
  143. package/dist/{customer-portal-runtime-CNW7NSCT.js → customer-portal-runtime-XISRWE3I.js} +1 -1
  144. package/dist/{customer-portal.d-COI3Xe4x.d.cts → customer-portal.d-CTIzvirI.d.cts} +652 -17
  145. package/dist/{customer-portal.d-COI3Xe4x.d.ts → customer-portal.d-CTIzvirI.d.ts} +652 -17
  146. package/dist/email-settings-42GUPANV.js +7 -0
  147. package/dist/email-settings-FCKYGFHW.cjs +7 -0
  148. package/dist/{email-settings-runtime-IW2AT2RB.cjs → email-settings-runtime-6ISOWOVN.cjs} +2 -2
  149. package/dist/{email-settings-runtime-YJYEC5AH.js → email-settings-runtime-7V5AFW3C.js} +1 -1
  150. package/dist/{email-settings.d-DX_nzlZk.d.cts → email-settings.d-dCUXyPAZ.d.cts} +131 -26
  151. package/dist/{email-settings.d-DX_nzlZk.d.ts → email-settings.d-dCUXyPAZ.d.ts} +131 -26
  152. package/dist/index.cjs +14 -14
  153. package/dist/index.d.cts +4 -4
  154. package/dist/index.d.ts +4 -4
  155. package/dist/index.js +4 -4
  156. package/dist/integration-toolkit-FI32O7II.cjs +7 -0
  157. package/dist/integration-toolkit-MHULDW3E.js +7 -0
  158. package/dist/{integration-toolkit-runtime-3PM3MBEF.cjs → integration-toolkit-runtime-CPJT7YCA.cjs} +2 -2
  159. package/dist/{integration-toolkit-runtime-3LKW4ORQ.js → integration-toolkit-runtime-ZEH6X2OD.js} +1 -1
  160. package/dist/{integration-toolkit.d-oORkWs_H.d.cts → integration-toolkit.d-l5cgwHLa.d.cts} +658 -3
  161. package/dist/{integration-toolkit.d-oORkWs_H.d.ts → integration-toolkit.d-l5cgwHLa.d.ts} +658 -3
  162. package/docs/app.md +10 -39
  163. package/docs/customer-portal.md +440 -73
  164. package/docs/email-settings.md +49 -25
  165. package/docs/integration-toolkit.md +423 -7
  166. package/package.json +1 -1
  167. package/dist/app-R2RDF74T.js +0 -7
  168. package/dist/app-YIP3MOGW.cjs +0 -7
  169. package/dist/chunk-DQ346MRA.js +0 -14
  170. package/dist/chunk-FBRDBE4Y.cjs +0 -14
  171. package/dist/chunk-MBWCGRCK.js +0 -14
  172. package/dist/chunk-Y7KWK5H2.cjs +0 -14
  173. package/dist/customer-portal-TSJKBA37.js +0 -7
  174. package/dist/customer-portal-WOO2QDPR.cjs +0 -7
  175. package/dist/email-settings-DGZKA6CU.js +0 -7
  176. package/dist/email-settings-VGU7323R.cjs +0 -7
  177. package/dist/integration-toolkit-AB3GZDWM.cjs +0 -7
  178. package/dist/integration-toolkit-L745CJ5G.js +0 -7
@@ -28,6 +28,9 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
28
28
  - [`acknowledgeTracking`](#acknowledgetracking)
29
29
  - [`triggerErp`](#triggererp)
30
30
  - [`processErpUpdatesEventsV3`](#processerpupdateseventsv3)
31
+ - [`queryErpUpdateEvents`](#queryerpupdateevents)
32
+ - [`getErpUpdateEvent`](#geterpupdateevent)
33
+ - [`listErpUpdateCorrelations`](#listerpupdatecorrelations)
31
34
  - [`simulateMappingV2`](#simulatemappingv2)
32
35
  - [`simulateDirect`](#simulatedirect)
33
36
  - [`simulateMapping`](#simulatemapping)
@@ -138,6 +141,14 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
138
141
  - [`ErpUpdatesEventsV2Request`](#erpupdateseventsv2request)
139
142
  - [`ErpEventV3`](#erpeventv3)
140
143
  - [`ErpUpdatesEventsV3Request`](#erpupdateseventsv3request)
144
+ - [`ErpUpdateProcessedEntity`](#erpupdateprocessedentity)
145
+ - [`ErpUpdateProcessingError`](#erpupdateprocessingerror)
146
+ - [`ErpUpdateEventStatus`](#erpupdateeventstatus)
147
+ - [`CorrelationUseCaseCounts`](#correlationusecasecounts)
148
+ - [`CorrelationStatus`](#correlationstatus)
149
+ - [`CorrelationWaitResult`](#correlationwaitresult)
150
+ - [`CorrelationWaitBadRequest`](#correlationwaitbadrequest)
151
+ - [`CorrelationStatusList`](#correlationstatuslist)
141
152
  - [`TriggerErpActionRequest`](#triggererpactionrequest)
142
153
  - [`TriggerWebhookResp`](#triggerwebhookresp)
143
154
  - [`IntegrationEditableFields`](#integrationeditablefields)
@@ -418,6 +429,8 @@ const { data } = await client.processErpUpdatesEventsV3(
418
429
  integration_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
419
430
  correlation_id: 'string',
420
431
  group_id: 'customer-42',
432
+ interactive: true,
433
+ correlation_complete: true,
421
434
  events: [
422
435
  {},
423
436
  {}
@@ -431,10 +444,13 @@ const { data } = await client.processErpUpdatesEventsV3(
431
444
 
432
445
  ```json
433
446
  {
447
+ "correlation_id": "string",
434
448
  "results": [
435
449
  {
436
450
  "event_id": "string",
437
451
  "status": "success",
452
+ "interactive": true,
453
+ "lane": "interactive",
438
454
  "message": "string"
439
455
  }
440
456
  ]
@@ -445,6 +461,194 @@ const { data } = await client.processErpUpdatesEventsV3(
445
461
 
446
462
  ---
447
463
 
464
+ ### `queryErpUpdateEvents`
465
+
466
+ Waits for the events of one correlation — the long poll behind interactive
467
+ registration — and returns the correlation's summary.
468
+
469
+ `GET /v3/erp/updates/events`
470
+
471
+ ```ts
472
+ const { data } = await client.queryErpUpdateEvents({
473
+ correlation_id: 'example',
474
+ wait: 1,
475
+ wait_for_entities: ['...'],
476
+ wait_for_use_cases: ['...'],
477
+ })
478
+ ```
479
+
480
+ <details>
481
+ <summary>Response</summary>
482
+
483
+ ```json
484
+ {
485
+ "correlation_id": "string",
486
+ "integration_id": "string",
487
+ "closed": true,
488
+ "closed_at": "1970-01-01T00:00:00.000Z",
489
+ "events_received": 0,
490
+ "events_done": 0,
491
+ "late_events": 0,
492
+ "first_ingested_at": "1970-01-01T00:00:00.000Z",
493
+ "last_done_at": "1970-01-01T00:00:00.000Z",
494
+ "use_cases": [
495
+ {
496
+ "use_case_slug": "string",
497
+ "received": 0,
498
+ "done": 0,
499
+ "error": 0
500
+ }
501
+ ],
502
+ "entities": [
503
+ {
504
+ "slug": "contact",
505
+ "_id": "string",
506
+ "operation": "created",
507
+ "unique_ids": {
508
+ "reenumber": "4711"
509
+ }
510
+ }
511
+ ],
512
+ "errors": [
513
+ {
514
+ "code": "string",
515
+ "message": "string",
516
+ "event_id": "string",
517
+ "occurred_at": "1970-01-01T00:00:00.000Z"
518
+ }
519
+ ],
520
+ "completion": "requirements_met"
521
+ }
522
+ ```
523
+
524
+ </details>
525
+
526
+ ---
527
+
528
+ ### `getErpUpdateEvent`
529
+
530
+ Returns one interactive event's processing record, without waiting.
531
+
532
+ `GET /v3/erp/updates/events/{event_id}`
533
+
534
+ ```ts
535
+ const { data } = await client.getErpUpdateEvent({
536
+ event_id: 'example',
537
+ })
538
+ ```
539
+
540
+ <details>
541
+ <summary>Response</summary>
542
+
543
+ ```json
544
+ {
545
+ "event_id": "string",
546
+ "correlation_id": "string",
547
+ "integration_id": "string",
548
+ "status": "accepted",
549
+ "lane": "interactive",
550
+ "use_case_id": "string",
551
+ "use_case_slug": "string",
552
+ "event_name": "string",
553
+ "ingested_at": "1970-01-01T00:00:00.000Z",
554
+ "mapped_at": "1970-01-01T00:00:00.000Z",
555
+ "done_at": "1970-01-01T00:00:00.000Z",
556
+ "writes_total": 0,
557
+ "writes_done": 0,
558
+ "entities": [
559
+ {
560
+ "slug": "contact",
561
+ "_id": "string",
562
+ "operation": "created",
563
+ "unique_ids": {
564
+ "reenumber": "4711"
565
+ }
566
+ }
567
+ ],
568
+ "errors": [
569
+ {
570
+ "code": "string",
571
+ "message": "string",
572
+ "event_id": "string",
573
+ "occurred_at": "1970-01-01T00:00:00.000Z"
574
+ }
575
+ ]
576
+ }
577
+ ```
578
+
579
+ </details>
580
+
581
+ ---
582
+
583
+ ### `listErpUpdateCorrelations`
584
+
585
+ Lists the organization's interactive correlations, newest first by the time
586
+ their first event was ingested, with the same summary the correlation wait
587
+ returns.
588
+
589
+ `GET /v3/erp/updates/correlations`
590
+
591
+ ```ts
592
+ const { data } = await client.listErpUpdateCorrelations({
593
+ integration_id: 'example',
594
+ limit: 1,
595
+ cursor: 'example',
596
+ })
597
+ ```
598
+
599
+ <details>
600
+ <summary>Response</summary>
601
+
602
+ ```json
603
+ {
604
+ "results": [
605
+ {
606
+ "correlation_id": "string",
607
+ "integration_id": "string",
608
+ "closed": true,
609
+ "closed_at": "1970-01-01T00:00:00.000Z",
610
+ "events_received": 0,
611
+ "events_done": 0,
612
+ "late_events": 0,
613
+ "first_ingested_at": "1970-01-01T00:00:00.000Z",
614
+ "last_done_at": "1970-01-01T00:00:00.000Z",
615
+ "use_cases": [
616
+ {
617
+ "use_case_slug": "string",
618
+ "received": 0,
619
+ "done": 0,
620
+ "error": 0
621
+ }
622
+ ],
623
+ "entities": [
624
+ {
625
+ "slug": "contact",
626
+ "_id": "string",
627
+ "operation": "created",
628
+ "unique_ids": {
629
+ "reenumber": "4711"
630
+ }
631
+ }
632
+ ],
633
+ "errors": [
634
+ {
635
+ "code": "string",
636
+ "message": "string",
637
+ "event_id": "string",
638
+ "occurred_at": "1970-01-01T00:00:00.000Z"
639
+ }
640
+ ]
641
+ }
642
+ ],
643
+ "next_cursor": "string",
644
+ "horizon_days": 7
645
+ }
646
+ ```
647
+
648
+ </details>
649
+
650
+ ---
651
+
448
652
  ### `simulateMappingV2`
449
653
 
450
654
  Test v2.0 mapping configuration by transforming a payload using the provided mapping rules without persisting data.
@@ -457,6 +661,7 @@ const { data } = await client.simulateMappingV2(
457
661
  {
458
662
  event_configuration: {
459
663
  direct: true,
664
+ interactive: 'on_request',
460
665
  entities: [
461
666
  { /* ... */ }
462
667
  ],
@@ -556,6 +761,7 @@ const { data } = await client.simulateDirect(
556
761
  {
557
762
  event_configuration: {
558
763
  direct: true,
764
+ interactive: 'on_request',
559
765
  entities: [
560
766
  { /* ... */ }
561
767
  ],
@@ -1283,6 +1489,7 @@ const { data } = await client.createUseCase(
1283
1489
  type: 'inbound',
1284
1490
  configuration: {
1285
1491
  direct: true,
1492
+ interactive: 'on_request',
1286
1493
  entities: [
1287
1494
  { /* ... */ }
1288
1495
  ],
@@ -1311,6 +1518,7 @@ const { data } = await client.createUseCase(
1311
1518
  "updated_at": "1970-01-01T00:00:00.000Z",
1312
1519
  "configuration": {
1313
1520
  "direct": true,
1521
+ "interactive": "on_request",
1314
1522
  "entities": [
1315
1523
  {}
1316
1524
  ],
@@ -1355,6 +1563,7 @@ const { data } = await client.getUseCase({
1355
1563
  "updated_at": "1970-01-01T00:00:00.000Z",
1356
1564
  "configuration": {
1357
1565
  "direct": true,
1566
+ "interactive": "on_request",
1358
1567
  "entities": [
1359
1568
  {}
1360
1569
  ],
@@ -1389,6 +1598,7 @@ const { data } = await client.updateUseCase(
1389
1598
  type: 'inbound',
1390
1599
  configuration: {
1391
1600
  direct: true,
1601
+ interactive: 'on_request',
1392
1602
  entities: [
1393
1603
  { /* ... */ }
1394
1604
  ],
@@ -1417,6 +1627,7 @@ const { data } = await client.updateUseCase(
1417
1627
  "updated_at": "1970-01-01T00:00:00.000Z",
1418
1628
  "configuration": {
1419
1629
  "direct": true,
1630
+ "interactive": "on_request",
1420
1631
  "entities": [
1421
1632
  {}
1422
1633
  ],
@@ -4713,10 +4924,205 @@ type ErpUpdatesEventsV3Request = {
4713
4924
  integration_id: string // uuid
4714
4925
  correlation_id?: string
4715
4926
  group_id?: string
4927
+ interactive?: boolean
4928
+ correlation_complete?: boolean
4716
4929
  events: unknown | unknown[]
4717
4930
  }
4718
4931
  ```
4719
4932
 
4933
+ ### `ErpUpdateProcessedEntity`
4934
+
4935
+ An entity an interactive event wrote.
4936
+
4937
+ ```ts
4938
+ type ErpUpdateProcessedEntity = {
4939
+ slug: string
4940
+ _id: string
4941
+ operation: "created" | "updated" | "deleted" | "unchanged"
4942
+ unique_ids: Record<string, string>
4943
+ }
4944
+ ```
4945
+
4946
+ ### `ErpUpdateProcessingError`
4947
+
4948
+ A failure nothing will retry.
4949
+
4950
+ ```ts
4951
+ type ErpUpdateProcessingError = {
4952
+ code: string
4953
+ message: string
4954
+ event_id?: string
4955
+ occurred_at: string // date-time
4956
+ }
4957
+ ```
4958
+
4959
+ ### `ErpUpdateEventStatus`
4960
+
4961
+ One interactive event's processing record.
4962
+
4963
+ ```ts
4964
+ type ErpUpdateEventStatus = {
4965
+ event_id: string
4966
+ correlation_id?: string
4967
+ integration_id?: string
4968
+ status: "accepted" | "processing" | "done" | "partial" | "error"
4969
+ lane: "interactive" | "priority" | "default" | "deferred"
4970
+ use_case_id?: string
4971
+ use_case_slug?: string
4972
+ event_name?: string
4973
+ ingested_at: string // date-time
4974
+ mapped_at?: string // date-time
4975
+ done_at?: string // date-time
4976
+ writes_total: number
4977
+ writes_done: number
4978
+ entities: Array<{
4979
+ slug: string
4980
+ _id: string
4981
+ operation: "created" | "updated" | "deleted" | "unchanged"
4982
+ unique_ids: Record<string, string>
4983
+ }>
4984
+ errors: Array<{
4985
+ code: string
4986
+ message: string
4987
+ event_id?: string
4988
+ occurred_at: string // date-time
4989
+ }>
4990
+ }
4991
+ ```
4992
+
4993
+ ### `CorrelationUseCaseCounts`
4994
+
4995
+ How many of a correlation's events belong to one use case, and how they ended.
4996
+
4997
+ ```ts
4998
+ type CorrelationUseCaseCounts = {
4999
+ use_case_slug: string
5000
+ received: number
5001
+ done: number
5002
+ error: number
5003
+ }
5004
+ ```
5005
+
5006
+ ### `CorrelationStatus`
5007
+
5008
+ One correlation's summary.
5009
+
5010
+ ```ts
5011
+ type CorrelationStatus = {
5012
+ correlation_id: string
5013
+ integration_id?: string
5014
+ closed: boolean
5015
+ closed_at?: string // date-time
5016
+ events_received: number
5017
+ events_done: number
5018
+ late_events: number
5019
+ first_ingested_at?: string // date-time
5020
+ last_done_at?: string // date-time
5021
+ use_cases: Array<{
5022
+ use_case_slug: string
5023
+ received: number
5024
+ done: number
5025
+ error: number
5026
+ }>
5027
+ entities: Array<{
5028
+ slug: string
5029
+ _id: string
5030
+ operation: "created" | "updated" | "deleted" | "unchanged"
5031
+ unique_ids: Record<string, string>
5032
+ }>
5033
+ errors: Array<{
5034
+ code: string
5035
+ message: string
5036
+ event_id?: string
5037
+ occurred_at: string // date-time
5038
+ }>
5039
+ }
5040
+ ```
5041
+
5042
+ ### `CorrelationWaitResult`
5043
+
5044
+ ```ts
5045
+ type CorrelationWaitResult = {
5046
+ correlation_id: string
5047
+ integration_id?: string
5048
+ closed: boolean
5049
+ closed_at?: string // date-time
5050
+ events_received: number
5051
+ events_done: number
5052
+ late_events: number
5053
+ first_ingested_at?: string // date-time
5054
+ last_done_at?: string // date-time
5055
+ use_cases: Array<{
5056
+ use_case_slug: string
5057
+ received: number
5058
+ done: number
5059
+ error: number
5060
+ }>
5061
+ entities: Array<{
5062
+ slug: string
5063
+ _id: string
5064
+ operation: "created" | "updated" | "deleted" | "unchanged"
5065
+ unique_ids: Record<string, string>
5066
+ }>
5067
+ errors: Array<{
5068
+ code: string
5069
+ message: string
5070
+ event_id?: string
5071
+ occurred_at: string // date-time
5072
+ }>
5073
+ completion: "requirements_met" | "complete" | "timeout" | "error"
5074
+ }
5075
+ ```
5076
+
5077
+ ### `CorrelationWaitBadRequest`
5078
+
5079
+ ```ts
5080
+ type CorrelationWaitBadRequest = {
5081
+ message: string
5082
+ slug?: string
5083
+ rejected_key?: string
5084
+ allowed_keys?: string[]
5085
+ }
5086
+ ```
5087
+
5088
+ ### `CorrelationStatusList`
5089
+
5090
+ ```ts
5091
+ type CorrelationStatusList = {
5092
+ results: Array<{
5093
+ correlation_id: string
5094
+ integration_id?: string
5095
+ closed: boolean
5096
+ closed_at?: string // date-time
5097
+ events_received: number
5098
+ events_done: number
5099
+ late_events: number
5100
+ first_ingested_at?: string // date-time
5101
+ last_done_at?: string // date-time
5102
+ use_cases: Array<{
5103
+ use_case_slug: { ... }
5104
+ received: { ... }
5105
+ done: { ... }
5106
+ error: { ... }
5107
+ }>
5108
+ entities: Array<{
5109
+ slug: { ... }
5110
+ _id: { ... }
5111
+ operation: { ... }
5112
+ unique_ids: { ... }
5113
+ }>
5114
+ errors: Array<{
5115
+ code: { ... }
5116
+ message: { ... }
5117
+ event_id?: { ... }
5118
+ occurred_at: { ... }
5119
+ }>
5120
+ }>
5121
+ next_cursor: string
5122
+ horizon_days: number
5123
+ }
5124
+ ```
5125
+
4720
5126
  ### `TriggerErpActionRequest`
4721
5127
 
4722
5128
  ```ts
@@ -5340,6 +5746,7 @@ type IntegrationWithUseCases = {
5340
5746
  updated_at: string // date-time
5341
5747
  configuration?: {
5342
5748
  direct?: { ... }
5749
+ interactive?: { ... }
5343
5750
  entities?: { ... }
5344
5751
  meter_readings?: { ... }
5345
5752
  }
@@ -5502,6 +5909,7 @@ type UpsertIntegrationWithUseCasesRequest = {
5502
5909
  type: "inbound"
5503
5910
  configuration?: {
5504
5911
  direct?: { ... }
5912
+ interactive?: { ... }
5505
5913
  entities?: { ... }
5506
5914
  meter_readings?: { ... }
5507
5915
  }
@@ -5527,7 +5935,6 @@ type UpsertIntegrationWithUseCasesRequest = {
5527
5935
  type: "file_proxy"
5528
5936
  configuration?: {
5529
5937
  direction?: { ... }
5530
- upload?: { ... }
5531
5938
  // ...
5532
5939
  }
5533
5940
  ```
@@ -5539,6 +5946,7 @@ Configuration for inbound use cases (ERP to epilot)
5539
5946
  ```ts
5540
5947
  type InboundIntegrationEventConfiguration = {
5541
5948
  direct?: boolean
5949
+ interactive?: "disabled" | "on_request" | "always"
5542
5950
  entities?: Array<{
5543
5951
  entity_schema: string
5544
5952
  unique_ids: string[]
@@ -6132,6 +6540,7 @@ type EmbeddedUseCaseRequest = {
6132
6540
  type: "inbound"
6133
6541
  configuration?: {
6134
6542
  direct?: boolean
6543
+ interactive?: "disabled" | "on_request" | "always"
6135
6544
  entities?: Array<{
6136
6545
  entity_schema: { ... }
6137
6546
  unique_ids: { ... }
@@ -6222,7 +6631,6 @@ type EmbeddedUseCaseRequest = {
6222
6631
  body?: { ... }
6223
6632
  response_type: { ... }
6224
6633
  }>
6225
- response?: {
6226
6634
  // ...
6227
6635
  }
6228
6636
  ```
@@ -6251,6 +6659,7 @@ type EmbeddedInboundUseCaseRequest = {
6251
6659
  type: "inbound"
6252
6660
  configuration?: {
6253
6661
  direct?: boolean
6662
+ interactive?: "disabled" | "on_request" | "always"
6254
6663
  entities?: Array<{
6255
6664
  entity_schema: { ... }
6256
6665
  unique_ids: { ... }
@@ -6439,6 +6848,7 @@ type InboundUseCase = {
6439
6848
  updated_at: string // date-time
6440
6849
  configuration?: {
6441
6850
  direct?: boolean
6851
+ interactive?: "disabled" | "on_request" | "always"
6442
6852
  entities?: Array<{
6443
6853
  entity_schema: { ... }
6444
6854
  unique_ids: { ... }
@@ -6631,6 +7041,7 @@ type UseCase = {
6631
7041
  updated_at: string // date-time
6632
7042
  configuration?: {
6633
7043
  direct?: boolean
7044
+ interactive?: "disabled" | "on_request" | "always"
6634
7045
  entities?: Array<{
6635
7046
  entity_schema: { ... }
6636
7047
  unique_ids: { ... }
@@ -6717,7 +7128,6 @@ type UseCase = {
6717
7128
  params?: Array<{
6718
7129
  name: { ... }
6719
7130
  required: { ... }
6720
- description?: { ... }
6721
7131
  // ...
6722
7132
  }
6723
7133
  ```
@@ -6732,6 +7142,7 @@ type CreateUseCaseRequest = {
6732
7142
  type: "inbound"
6733
7143
  configuration?: {
6734
7144
  direct?: boolean
7145
+ interactive?: "disabled" | "on_request" | "always"
6735
7146
  entities?: Array<{
6736
7147
  entity_schema: { ... }
6737
7148
  unique_ids: { ... }
@@ -6824,7 +7235,6 @@ type CreateUseCaseRequest = {
6824
7235
  filename?: { ... }
6825
7236
  content_type?: { ... }
6826
7237
  }
6827
- prevent_indirect_serving?: boolean
6828
7238
  // ...
6829
7239
  }
6830
7240
  ```
@@ -6849,6 +7259,7 @@ type CreateInboundUseCaseRequest = {
6849
7259
  type: "inbound"
6850
7260
  configuration?: {
6851
7261
  direct?: boolean
7262
+ interactive?: "disabled" | "on_request" | "always"
6852
7263
  entities?: Array<{
6853
7264
  entity_schema: { ... }
6854
7265
  unique_ids: { ... }
@@ -7007,6 +7418,7 @@ type UpdateUseCaseRequest = {
7007
7418
  type?: "inbound"
7008
7419
  configuration?: {
7009
7420
  direct?: boolean
7421
+ interactive?: "disabled" | "on_request" | "always"
7010
7422
  entities?: Array<{
7011
7423
  entity_schema: { ... }
7012
7424
  unique_ids: { ... }
@@ -7098,7 +7510,6 @@ type UpdateUseCaseRequest = {
7098
7510
  response?: {
7099
7511
  body: { ... }
7100
7512
  encoding: { ... }
7101
- filename?: { ... }
7102
7513
  // ...
7103
7514
  }
7104
7515
  ```
@@ -7125,6 +7536,7 @@ type UpdateInboundUseCaseRequest = {
7125
7536
  type?: "inbound"
7126
7537
  configuration?: {
7127
7538
  direct?: boolean
7539
+ interactive?: "disabled" | "on_request" | "always"
7128
7540
  entities?: Array<{
7129
7541
  entity_schema: { ... }
7130
7542
  unique_ids: { ... }
@@ -7298,6 +7710,7 @@ type UseCaseHistoryEntry = {
7298
7710
  type: "inbound"
7299
7711
  configuration?: {
7300
7712
  direct?: boolean
7713
+ interactive?: "disabled" | "on_request" | "always"
7301
7714
  entities?: Array<{
7302
7715
  entity_schema: { ... }
7303
7716
  unique_ids: { ... }
@@ -7382,7 +7795,6 @@ type UseCaseHistoryEntry = {
7382
7795
  username?: { ... }
7383
7796
  password?: { ... }
7384
7797
  body_params?: { ... }
7385
- headers?: { ... }
7386
7798
  // ...
7387
7799
  }
7388
7800
  ```
@@ -7423,6 +7835,7 @@ type InboundUseCaseHistoryEntry = {
7423
7835
  type: "inbound"
7424
7836
  configuration?: {
7425
7837
  direct?: boolean
7838
+ interactive?: "disabled" | "on_request" | "always"
7426
7839
  entities?: Array<{
7427
7840
  entity_schema: { ... }
7428
7841
  unique_ids: { ... }
@@ -8207,6 +8620,7 @@ making it easier to test configurations before saving them.
8207
8620
  type MappingSimulationV2Request = {
8208
8621
  event_configuration: {
8209
8622
  direct?: boolean
8623
+ interactive?: "disabled" | "on_request" | "always"
8210
8624
  entities?: Array<{
8211
8625
  entity_schema: { ... }
8212
8626
  unique_ids: { ... }
@@ -8534,6 +8948,7 @@ against, and the payload to validate and translate.
8534
8948
  type DirectSimulationRequest = {
8535
8949
  event_configuration: {
8536
8950
  direct?: boolean
8951
+ interactive?: "disabled" | "on_request" | "always"
8537
8952
  entities?: Array<{
8538
8953
  entity_schema: { ... }
8539
8954
  unique_ids: { ... }
@@ -8749,6 +9164,7 @@ type IntegrationConfigurationV2 = {
8749
9164
  mapping: {
8750
9165
  events: Record<string, {
8751
9166
  direct?: { ... }
9167
+ interactive?: { ... }
8752
9168
  entities?: { ... }
8753
9169
  meter_readings?: { ... }
8754
9170
  }>
@@ -9687,7 +10103,7 @@ This schema exists so consumers can import the union as a type. It is
9687
10103
  deliberately
9688
10104
 
9689
10105
  ```ts
9690
- type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
10106
+ type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "CORRELATION_CLOSED_EMPTY" | "CORRELATION_CLOSED_INCOMPLETE" | "CORRELATION_CLOSE_IGNORED" | "CORRELATION_COMPLETED" | "CORRELATION_EVENT_LIMIT_EXCEEDED" | "CORRELATION_ID_MISSING" | "CORRELATION_LATE_EVENT" | "CORRELATION_REQUIREMENT_FAILED" | "CORRELATION_WAIT_REJECTED" | "CORRELATION_WAIT_TIMEOUT" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INTERACTIVE_CROSS_LANE_WRITE" | "INTERACTIVE_NOT_ALLOWED" | "INTERACTIVE_RATE_LIMITED" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
9691
10107
  ```
9692
10108
 
9693
10109
  ### `MonitoringEventV2`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/sdk",
3
- "version": "2.20.61",
3
+ "version": "2.20.63",
4
4
  "description": "JavaScript/TypeScript SDK for epilot APIs",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",