@epilot/sdk 2.4.4 → 2.6.0

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 (215) hide show
  1. package/definitions/app.json +137 -58
  2. package/definitions/customer-portal-runtime.json +1 -1
  3. package/definitions/customer-portal.json +496 -24
  4. package/definitions/entity.json +185 -8
  5. package/definitions/integration-toolkit-runtime.json +1 -1
  6. package/definitions/integration-toolkit.json +480 -4
  7. package/definitions/metering-runtime.json +1 -1
  8. package/definitions/metering.json +728 -64
  9. package/definitions/webhooks-runtime.json +1 -1
  10. package/definitions/webhooks.json +134 -4
  11. package/dist/apis/access-token.cjs +6 -6
  12. package/dist/apis/access-token.js +1 -1
  13. package/dist/apis/address-suggestions.cjs +6 -6
  14. package/dist/apis/address-suggestions.js +1 -1
  15. package/dist/apis/address.cjs +6 -6
  16. package/dist/apis/address.js +1 -1
  17. package/dist/apis/ai-agents.cjs +6 -6
  18. package/dist/apis/ai-agents.js +1 -1
  19. package/dist/apis/app.cjs +8 -8
  20. package/dist/apis/app.d.cts +2 -2
  21. package/dist/apis/app.d.ts +2 -2
  22. package/dist/apis/app.js +2 -2
  23. package/dist/apis/audit-logs.cjs +6 -6
  24. package/dist/apis/audit-logs.js +1 -1
  25. package/dist/apis/automation.cjs +6 -6
  26. package/dist/apis/automation.js +1 -1
  27. package/dist/apis/billing.cjs +6 -6
  28. package/dist/apis/billing.js +1 -1
  29. package/dist/apis/blueprint-manifest.cjs +6 -6
  30. package/dist/apis/blueprint-manifest.js +1 -1
  31. package/dist/apis/calendar.cjs +6 -6
  32. package/dist/apis/calendar.js +1 -1
  33. package/dist/apis/configuration-hub.cjs +6 -6
  34. package/dist/apis/configuration-hub.js +1 -1
  35. package/dist/apis/consent.cjs +6 -6
  36. package/dist/apis/consent.js +1 -1
  37. package/dist/apis/customer-portal.cjs +8 -8
  38. package/dist/apis/customer-portal.d.cts +2 -2
  39. package/dist/apis/customer-portal.d.ts +2 -2
  40. package/dist/apis/customer-portal.js +2 -2
  41. package/dist/apis/dashboard.cjs +6 -6
  42. package/dist/apis/dashboard.js +1 -1
  43. package/dist/apis/data-governance.cjs +6 -6
  44. package/dist/apis/data-governance.js +1 -1
  45. package/dist/apis/deduplication.cjs +6 -6
  46. package/dist/apis/deduplication.js +1 -1
  47. package/dist/apis/design.cjs +6 -6
  48. package/dist/apis/design.js +1 -1
  49. package/dist/apis/document.cjs +6 -6
  50. package/dist/apis/document.js +1 -1
  51. package/dist/apis/email-settings.cjs +6 -6
  52. package/dist/apis/email-settings.js +1 -1
  53. package/dist/apis/email-template.cjs +6 -6
  54. package/dist/apis/email-template.js +1 -1
  55. package/dist/apis/entity-mapping.cjs +6 -6
  56. package/dist/apis/entity-mapping.js +1 -1
  57. package/dist/apis/entity.cjs +6 -6
  58. package/dist/apis/entity.d.cts +2 -2
  59. package/dist/apis/entity.d.ts +2 -2
  60. package/dist/apis/entity.js +1 -1
  61. package/dist/apis/environments.cjs +6 -6
  62. package/dist/apis/environments.js +1 -1
  63. package/dist/apis/event-catalog.cjs +6 -6
  64. package/dist/apis/event-catalog.js +1 -1
  65. package/dist/apis/file.cjs +6 -6
  66. package/dist/apis/file.js +1 -1
  67. package/dist/apis/iban.cjs +6 -6
  68. package/dist/apis/iban.js +1 -1
  69. package/dist/apis/integration-toolkit.cjs +8 -8
  70. package/dist/apis/integration-toolkit.d.cts +2 -2
  71. package/dist/apis/integration-toolkit.d.ts +2 -2
  72. package/dist/apis/integration-toolkit.js +2 -2
  73. package/dist/apis/journey.cjs +6 -6
  74. package/dist/apis/journey.js +1 -1
  75. package/dist/apis/kanban.cjs +6 -6
  76. package/dist/apis/kanban.js +1 -1
  77. package/dist/apis/message.cjs +6 -6
  78. package/dist/apis/message.js +1 -1
  79. package/dist/apis/metering.cjs +8 -8
  80. package/dist/apis/metering.d.cts +2 -2
  81. package/dist/apis/metering.d.ts +2 -2
  82. package/dist/apis/metering.js +2 -2
  83. package/dist/apis/notes.cjs +6 -6
  84. package/dist/apis/notes.d.cts +2 -2
  85. package/dist/apis/notes.d.ts +2 -2
  86. package/dist/apis/notes.js +1 -1
  87. package/dist/apis/notification.cjs +6 -6
  88. package/dist/apis/notification.js +1 -1
  89. package/dist/apis/organization.cjs +6 -6
  90. package/dist/apis/organization.js +1 -1
  91. package/dist/apis/partner-directory.cjs +6 -6
  92. package/dist/apis/partner-directory.js +1 -1
  93. package/dist/apis/permissions.cjs +6 -6
  94. package/dist/apis/permissions.js +1 -1
  95. package/dist/apis/pricing-tier.cjs +6 -6
  96. package/dist/apis/pricing-tier.js +1 -1
  97. package/dist/apis/pricing.cjs +6 -6
  98. package/dist/apis/pricing.js +1 -1
  99. package/dist/apis/purpose.cjs +6 -6
  100. package/dist/apis/purpose.js +1 -1
  101. package/dist/apis/query.cjs +6 -6
  102. package/dist/apis/query.js +1 -1
  103. package/dist/apis/sandbox.cjs +6 -6
  104. package/dist/apis/sandbox.js +1 -1
  105. package/dist/apis/sharing.cjs +6 -6
  106. package/dist/apis/sharing.js +1 -1
  107. package/dist/apis/submission.cjs +6 -6
  108. package/dist/apis/submission.js +1 -1
  109. package/dist/apis/target.cjs +6 -6
  110. package/dist/apis/target.js +1 -1
  111. package/dist/apis/targeting.cjs +6 -6
  112. package/dist/apis/targeting.js +1 -1
  113. package/dist/apis/template-variables.cjs +6 -6
  114. package/dist/apis/template-variables.js +1 -1
  115. package/dist/apis/user.cjs +6 -6
  116. package/dist/apis/user.js +1 -1
  117. package/dist/apis/validation-rules.cjs +6 -6
  118. package/dist/apis/validation-rules.js +1 -1
  119. package/dist/apis/webhooks.cjs +8 -8
  120. package/dist/apis/webhooks.d.cts +2 -2
  121. package/dist/apis/webhooks.d.ts +2 -2
  122. package/dist/apis/webhooks.js +2 -2
  123. package/dist/apis/workflow-definition.cjs +6 -6
  124. package/dist/apis/workflow-definition.js +1 -1
  125. package/dist/apis/workflow.cjs +6 -6
  126. package/dist/apis/workflow.js +1 -1
  127. package/dist/app-34OBBTA4.js +7 -0
  128. package/dist/app-SSF545U7.cjs +7 -0
  129. package/dist/app-runtime-AFNM67YN.cjs +5 -0
  130. package/dist/{app-runtime-U7RGV7KT.js → app-runtime-DBUXZL6E.js} +1 -1
  131. package/dist/{app.d-u7Dq42kU.d.cts → app.d--5n0FQQ4.d.cts} +377 -11
  132. package/dist/{app.d-u7Dq42kU.d.ts → app.d--5n0FQQ4.d.ts} +377 -11
  133. package/dist/bin/cli.js +1 -1
  134. package/dist/{chunk-JTFWOEZF.cjs → chunk-4FFGRWLS.cjs} +1 -1
  135. package/dist/chunk-56MMZJOD.js +14 -0
  136. package/dist/chunk-5OBMZHRL.cjs +14 -0
  137. package/dist/{chunk-L66IX6GX.cjs → chunk-KMVJYNLB.cjs} +1 -1
  138. package/dist/chunk-KYCVV2XE.cjs +14 -0
  139. package/dist/{chunk-TSV242UN.js → chunk-QNUU4TTU.js} +13 -13
  140. package/dist/chunk-RGO3LTAM.js +14 -0
  141. package/dist/{chunk-CD4OX2U6.cjs → chunk-SDIGGISZ.cjs} +13 -13
  142. package/dist/chunk-T6A22LSD.cjs +14 -0
  143. package/dist/chunk-WM74R3BD.js +14 -0
  144. package/dist/{chunk-LLZYRINH.js → chunk-Z4H2FZ2K.js} +1 -1
  145. package/dist/chunk-Z6HGUGXK.js +14 -0
  146. package/dist/customer-portal-5I7ZGQDU.cjs +7 -0
  147. package/dist/customer-portal-YL2YMPZL.js +7 -0
  148. package/dist/{customer-portal-runtime-PSM55KGU.js → customer-portal-runtime-N4NWQ67M.js} +1 -1
  149. package/dist/{customer-portal-runtime-DULJLR7F.cjs → customer-portal-runtime-OEXTSMSE.cjs} +2 -2
  150. package/dist/{customer-portal.d-DyZ2n2dW.d.cts → customer-portal.d-ChSEioI5.d.cts} +394 -9
  151. package/dist/{customer-portal.d-DyZ2n2dW.d.ts → customer-portal.d-ChSEioI5.d.ts} +394 -9
  152. package/dist/entity-SS36LQO6.cjs +7 -0
  153. package/dist/entity-Z4YWKDVG.js +7 -0
  154. package/dist/{entity.d-BHR9dEon.d.cts → entity.d-fospShiN.d.cts} +234 -169
  155. package/dist/{entity.d-BHR9dEon.d.ts → entity.d-fospShiN.d.ts} +234 -169
  156. package/dist/index.cjs +18 -18
  157. package/dist/index.d.cts +7 -7
  158. package/dist/index.d.ts +7 -7
  159. package/dist/index.js +6 -6
  160. package/dist/integration-toolkit-3I3IPVFN.cjs +7 -0
  161. package/dist/integration-toolkit-XAFQXNQY.js +7 -0
  162. package/dist/{integration-toolkit-runtime-5KG3LGXF.cjs → integration-toolkit-runtime-YHTU4X5J.cjs} +2 -2
  163. package/dist/{integration-toolkit-runtime-LYHFVIRW.js → integration-toolkit-runtime-YR4CIMKH.js} +1 -1
  164. package/dist/{integration-toolkit.d-Ry-KC9ow.d.cts → integration-toolkit.d-BstNqiJb.d.cts} +460 -20
  165. package/dist/{integration-toolkit.d-Ry-KC9ow.d.ts → integration-toolkit.d-BstNqiJb.d.ts} +460 -20
  166. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  167. package/dist/metering-3IUSYAGN.js +7 -0
  168. package/dist/metering-MHBFU7QH.cjs +7 -0
  169. package/dist/{webhooks-runtime-EBM4M3SU.cjs → metering-runtime-IUZJHBVS.cjs} +2 -2
  170. package/dist/{metering-runtime-NJ6NEUMB.js → metering-runtime-KZMJKKUZ.js} +1 -1
  171. package/dist/{metering.d-DvtPv7wk.d.ts → metering.d-CUICZDiL.d.cts} +718 -130
  172. package/dist/{metering.d-DvtPv7wk.d.cts → metering.d-CUICZDiL.d.ts} +718 -130
  173. package/dist/notes-K2IIFCX3.cjs +7 -0
  174. package/dist/notes-Q7JGS7O3.js +7 -0
  175. package/dist/{notes.d-BC-scR42.d.cts → notes.d-BcV_m5fe.d.cts} +33 -11
  176. package/dist/{notes.d-BC-scR42.d.ts → notes.d-BcV_m5fe.d.ts} +33 -11
  177. package/dist/{pricing-XAET4G7T.cjs → pricing-FODHQFCB.cjs} +1 -1
  178. package/dist/{pricing-G67CH3XH.js → pricing-XRIDVZFC.js} +1 -1
  179. package/dist/webhooks-NZ3TM3AY.cjs +7 -0
  180. package/dist/webhooks-XLBUXXCS.js +7 -0
  181. package/dist/{metering-runtime-HAIWXZXJ.cjs → webhooks-runtime-QVAFNBDW.cjs} +2 -2
  182. package/dist/{webhooks-runtime-XCQYIGQK.js → webhooks-runtime-UYTPQQVG.js} +1 -1
  183. package/dist/{webhooks.d-pLHIL_io.d.cts → webhooks.d-D79qib9f.d.cts} +115 -5
  184. package/dist/{webhooks.d-pLHIL_io.d.ts → webhooks.d-D79qib9f.d.ts} +115 -5
  185. package/docs/app.md +244 -9
  186. package/docs/customer-portal.md +340 -113
  187. package/docs/entity.md +65 -0
  188. package/docs/integration-toolkit.md +334 -19
  189. package/docs/metering.md +570 -48
  190. package/docs/notes.md +19 -12
  191. package/docs/pricing.md +3 -1
  192. package/docs/webhooks.md +49 -0
  193. package/package.json +1 -1
  194. package/dist/app-5KSVSKDU.js +0 -7
  195. package/dist/app-PL3IOROO.cjs +0 -7
  196. package/dist/app-runtime-SSNHSBR7.cjs +0 -5
  197. package/dist/chunk-265TE2OV.js +0 -14
  198. package/dist/chunk-2MMSXUOL.cjs +0 -14
  199. package/dist/chunk-4ZMLRFDX.cjs +0 -14
  200. package/dist/chunk-A7AAVJGM.js +0 -14
  201. package/dist/chunk-GVNT76UU.js +0 -14
  202. package/dist/chunk-HHMXS5NC.cjs +0 -14
  203. package/dist/chunk-U4PUHKZC.js +0 -14
  204. package/dist/customer-portal-5LMHNBMD.cjs +0 -7
  205. package/dist/customer-portal-RZACUF4N.js +0 -7
  206. package/dist/entity-H6ESUH3Y.js +0 -7
  207. package/dist/entity-ZVDKWQSF.cjs +0 -7
  208. package/dist/integration-toolkit-FRPFOYT2.js +0 -7
  209. package/dist/integration-toolkit-VNMDI55O.cjs +0 -7
  210. package/dist/metering-DZNZPPY6.cjs +0 -7
  211. package/dist/metering-KOSCPPKB.js +0 -7
  212. package/dist/notes-3AO5GXIT.js +0 -7
  213. package/dist/notes-MPWOQC5J.cjs +0 -7
  214. package/dist/webhooks-H3RT33BF.cjs +0 -7
  215. package/dist/webhooks-RTOU3MS5.js +0 -7
@@ -293,10 +293,10 @@ declare namespace Components {
293
293
  */
294
294
  name: string;
295
295
  /**
296
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
296
+ * URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
297
297
  *
298
298
  */
299
- slug?: string; // ^[a-z0-9][a-z0-9_-]*$
299
+ slug: string; // ^[a-z0-9][a-z0-9_-]*$
300
300
  /**
301
301
  * Whether the use case is enabled
302
302
  */
@@ -321,10 +321,10 @@ declare namespace Components {
321
321
  */
322
322
  name: string;
323
323
  /**
324
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
324
+ * URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
325
325
  *
326
326
  */
327
- slug?: string; // ^[a-z0-9][a-z0-9_-]*$
327
+ slug: string; // ^[a-z0-9][a-z0-9_-]*$
328
328
  /**
329
329
  * Whether the use case is enabled
330
330
  */
@@ -378,10 +378,10 @@ declare namespace Components {
378
378
  */
379
379
  name: string;
380
380
  /**
381
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
381
+ * URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
382
382
  *
383
383
  */
384
- slug?: string; // ^[a-z0-9][a-z0-9_-]*$
384
+ slug: string; // ^[a-z0-9][a-z0-9_-]*$
385
385
  /**
386
386
  * Whether the use case is enabled
387
387
  */
@@ -398,10 +398,10 @@ declare namespace Components {
398
398
  */
399
399
  name: string;
400
400
  /**
401
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
401
+ * URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
402
402
  *
403
403
  */
404
- slug?: string; // ^[a-z0-9][a-z0-9_-]*$
404
+ slug: string; // ^[a-z0-9][a-z0-9_-]*$
405
405
  /**
406
406
  * Whether the use case is enabled
407
407
  */
@@ -418,10 +418,10 @@ declare namespace Components {
418
418
  */
419
419
  name: string;
420
420
  /**
421
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
421
+ * URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
422
422
  *
423
423
  */
424
- slug?: string; // ^[a-z0-9][a-z0-9_-]*$
424
+ slug: string; // ^[a-z0-9][a-z0-9_-]*$
425
425
  /**
426
426
  * Whether the use case is enabled
427
427
  */
@@ -443,10 +443,10 @@ declare namespace Components {
443
443
  */
444
444
  name: string;
445
445
  /**
446
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
446
+ * URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
447
447
  *
448
448
  */
449
- slug?: string; // ^[a-z0-9][a-z0-9_-]*$
449
+ slug: string; // ^[a-z0-9][a-z0-9_-]*$
450
450
  /**
451
451
  * Whether the use case is enabled
452
452
  */
@@ -497,7 +497,7 @@ declare namespace Components {
497
497
  */
498
498
  name: string;
499
499
  /**
500
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
500
+ * URL-safe identifier for the use case. Optional on this upsert/sync endpoint when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
501
501
  *
502
502
  */
503
503
  slug?: string; // ^[a-z0-9][a-z0-9_-]*$
@@ -537,7 +537,7 @@ declare namespace Components {
537
537
  */
538
538
  name: string;
539
539
  /**
540
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
540
+ * URL-safe identifier for the use case. Optional on this upsert/sync endpoint when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
541
541
  *
542
542
  */
543
543
  slug?: string; // ^[a-z0-9][a-z0-9_-]*$
@@ -569,7 +569,7 @@ declare namespace Components {
569
569
  */
570
570
  name: string;
571
571
  /**
572
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
572
+ * URL-safe identifier for the use case. Optional on this upsert/sync endpoint when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
573
573
  *
574
574
  */
575
575
  slug?: string; // ^[a-z0-9][a-z0-9_-]*$
@@ -601,7 +601,7 @@ declare namespace Components {
601
601
  */
602
602
  name: string;
603
603
  /**
604
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
604
+ * URL-safe identifier for the use case. Optional on this upsert/sync endpoint when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
605
605
  *
606
606
  */
607
607
  slug?: string; // ^[a-z0-9][a-z0-9_-]*$
@@ -633,7 +633,7 @@ declare namespace Components {
633
633
  */
634
634
  name: string;
635
635
  /**
636
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
636
+ * URL-safe identifier for the use case. Optional on this upsert/sync endpoint when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
637
637
  *
638
638
  */
639
639
  slug?: string; // ^[a-z0-9][a-z0-9_-]*$
@@ -670,7 +670,7 @@ declare namespace Components {
670
670
  */
671
671
  name: string;
672
672
  /**
673
- * URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Must be unique per integration. Immutable after creation.
673
+ * URL-safe identifier for the use case. Optional on this upsert/sync endpoint when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
674
674
  *
675
675
  */
676
676
  slug?: string; // ^[a-z0-9][a-z0-9_-]*$
@@ -701,6 +701,43 @@ declare namespace Components {
701
701
  [name: string]: any;
702
702
  };
703
703
  }
704
+ /**
705
+ * Resolves to an org-scoped environment variable from the epilot environments-api service at runtime, replacing hard-coded environment-specific values (URLs, prefixes, identifiers) in inbound mappings. Secrets (`SecretString` values) are never exposed; the runtime treats both "missing key" and "secret-typed key" as identical `undefined` outcomes (no info disclosure via error code). For secret-resolving contexts (e.g. authorization headers in managed-call or file-proxy step configurations), use the templated `{{ env.<key> }}` syntax instead — that mechanism does decrypt secrets.
706
+ *
707
+ */
708
+ export type EnvVarRefConfig = /**
709
+ * Resolves to an org-scoped environment variable from the epilot environments-api service at runtime, replacing hard-coded environment-specific values (URLs, prefixes, identifiers) in inbound mappings. Secrets (`SecretString` values) are never exposed; the runtime treats both "missing key" and "secret-typed key" as identical `undefined` outcomes (no info disclosure via error code). For secret-resolving contexts (e.g. authorization headers in managed-call or file-proxy step configurations), use the templated `{{ env.<key> }}` syntax instead — that mechanism does decrypt secrets.
710
+ *
711
+ */
712
+ {
713
+ /**
714
+ * Environment variable key. Must match the environments-api key contract (lowercase, digits, `_`, `.`, `-`; max 128 chars; starts with a lowercase letter or digit). Supports dot-namespaced keys like `erp_api.base_url`.
715
+ *
716
+ */
717
+ key: string; // ^[a-z0-9][a-z0-9_.-]{0,127}$
718
+ /**
719
+ * Literal string returned when the key is missing (or is a secret). When provided, the `ENV_VAR_REF_NOT_FOUND` warning is suppressed because the author signalled the absence is expected.
720
+ *
721
+ */
722
+ default?: string;
723
+ /**
724
+ * `value` returns the resolved env-var string as-is.
725
+ *
726
+ */
727
+ return?: "value";
728
+ } | {
729
+ key: string; // ^[a-z0-9][a-z0-9_.-]{0,127}$
730
+ default?: string;
731
+ /**
732
+ * Evaluate the sibling `jsonataExpression` against the resolved env-var value (the input `$` is the string value).
733
+ *
734
+ */
735
+ return: "jsonata";
736
+ /**
737
+ * JSONata expression evaluated against the resolved env-var value.
738
+ */
739
+ jsonataExpression: string;
740
+ };
704
741
  export interface EnvironmentFieldConfig {
705
742
  /**
706
743
  * Environment variable key, used to look up the value in the Environments API.
@@ -876,6 +913,31 @@ declare namespace Components {
876
913
  * Optional ID that identifies the specific request for debugging purposes
877
914
  */
878
915
  correlation_id?: string;
916
+ /**
917
+ * Controls ordering and parallelism for this request's events.
918
+ *
919
+ * By default, all events for a given `integration_id` are processed
920
+ * **strictly in order, one at a time**. For high-volume integrations this
921
+ * can become a throughput bottleneck.
922
+ *
923
+ * Set `group_id` to opt into **parallel processing**:
924
+ * - Events sharing the same `group_id` are processed in the order received.
925
+ * - Events with different `group_id` values are processed in parallel.
926
+ *
927
+ * Typical usage is to derive `group_id` from a logical partition key in
928
+ * your payload — for example the customer ID, contract ID, or meter ID —
929
+ * so updates to the same business object remain ordered while unrelated
930
+ * objects are processed concurrently.
931
+ *
932
+ * Notes:
933
+ * - Up to 20 groups per integration are processed concurrently. Using
934
+ * more distinct values than that yields no additional parallelism.
935
+ * - Omit this field if strict per-integration ordering is required.
936
+ *
937
+ * example:
938
+ * customer-42
939
+ */
940
+ group_id?: string;
879
941
  /**
880
942
  * List of ERP events to process
881
943
  */
@@ -1128,6 +1190,10 @@ declare namespace Components {
1128
1190
  * Additional use-case-specific parameters expected in the download URL query string (beyond the required orgId, integrationId, and useCaseSlug or useCaseId)
1129
1191
  */
1130
1192
  params?: FileProxyParam[];
1193
+ /**
1194
+ * Additional origins permitted to call /download for this use case (CORS, exact match). Portal origins are always allowed.
1195
+ */
1196
+ allowed_origins?: string /* uri ^https?:// */[];
1131
1197
  /**
1132
1198
  * Ordered list of HTTP steps to execute to retrieve the file
1133
1199
  */
@@ -1166,6 +1232,10 @@ declare namespace Components {
1166
1232
  * Description of the change that was made at this point in history
1167
1233
  */
1168
1234
  change_description?: string;
1235
+ /**
1236
+ * User ID of the user who made the change that produced this history entry
1237
+ */
1238
+ changed_by?: string;
1169
1239
  /**
1170
1240
  * ISO-8601 timestamp when the use case was originally created
1171
1241
  */
@@ -1502,6 +1572,10 @@ declare namespace Components {
1502
1572
  * Description of the change that was made at this point in history
1503
1573
  */
1504
1574
  change_description?: string;
1575
+ /**
1576
+ * User ID of the user who made the change that produced this history entry
1577
+ */
1578
+ changed_by?: string;
1505
1579
  /**
1506
1580
  * ISO-8601 timestamp when the use case was originally created
1507
1581
  */
@@ -1726,6 +1800,16 @@ declare namespace Components {
1726
1800
  *
1727
1801
  */
1728
1802
  FileProxyUrlConfig;
1803
+ portal_ref?: /**
1804
+ * Resolves to a property of one of the calling organization's epilot portal configurations at runtime, replacing hard-coded environment-specific portal UUIDs in inbound mappings. Matched portals are sorted ascending by `(_created_at, portal_id)`; portals without `_created_at` sort first (treated as oldest). When `select: "single"` matches more than one portal, the resolver still returns the oldest match and emits a `PORTAL_REF_AMBIGUOUS` warning.
1805
+ *
1806
+ */
1807
+ PortalRefConfig;
1808
+ env_var_ref?: /**
1809
+ * Resolves to an org-scoped environment variable from the epilot environments-api service at runtime, replacing hard-coded environment-specific values (URLs, prefixes, identifiers) in inbound mappings. Secrets (`SecretString` values) are never exposed; the runtime treats both "missing key" and "secret-typed key" as identical `undefined` outcomes (no info disclosure via error code). For secret-resolving contexts (e.g. authorization headers in managed-call or file-proxy step configurations), use the templated `{{ env.<key> }}` syntax instead — that mechanism does decrypt secrets.
1810
+ *
1811
+ */
1812
+ EnvVarRefConfig;
1729
1813
  }
1730
1814
  export interface IntegrationFieldV1 {
1731
1815
  /**
@@ -2084,6 +2168,10 @@ declare namespace Components {
2084
2168
  * Description of the change that was made at this point in history
2085
2169
  */
2086
2170
  change_description?: string;
2171
+ /**
2172
+ * User ID of the user who made the change that produced this history entry
2173
+ */
2174
+ changed_by?: string;
2087
2175
  /**
2088
2176
  * ISO-8601 timestamp when the use case was originally created
2089
2177
  */
@@ -2198,7 +2286,7 @@ declare namespace Components {
2198
2286
  };
2199
2287
  };
2200
2288
  /**
2201
- * Meter reading attributes. Required: external_id, timestamp, source, value. `source` must be one of: ECP, ERP, 360, journey-submission. `reason` (optional) must be one of: regular, irregular, last, first, meter_change, contract_change, meter_adjustment (or empty/null).
2289
+ * Meter reading attributes. Required: external_id, timestamp, source, value. `timestamp` must be ISO 8601 — either `YYYY-MM-DD` or `YYYY-MM-DDTHH:mm:ss` (with optional fractional seconds and optional `Z` / `±HH:mm` timezone offset); non-ISO formats (e.g. `DD.MM.YYYY` or epoch numbers) are rejected and must be converted upstream via a `jsonataExpression` (e.g. `$fromMillis(...)`). Date-only values are normalized to midnight UTC and offset-less date-times are anchored to UTC before being forwarded to the metering API. `source` must be one of: ECP, ERP, 360, journey-submission. `reason` (optional) must be one of: regular, irregular, last, first, meter_change, contract_change, meter_adjustment (or empty/null).
2202
2290
  */
2203
2291
  attributes: {
2204
2292
  [name: string]: any;
@@ -2587,6 +2675,10 @@ declare namespace Components {
2587
2675
  * Description of the change that was made at this point in history
2588
2676
  */
2589
2677
  change_description?: string;
2678
+ /**
2679
+ * User ID of the user who made the change that produced this history entry
2680
+ */
2681
+ changed_by?: string;
2590
2682
  /**
2591
2683
  * ISO-8601 timestamp when the use case was originally created
2592
2684
  */
@@ -2642,6 +2734,80 @@ declare namespace Components {
2642
2734
  */
2643
2735
  conflicts?: OutboundConflict[];
2644
2736
  }
2737
+ /**
2738
+ * Origin/type of an epilot portal configuration.
2739
+ */
2740
+ export type PortalOrigin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL" | "B2B_PORTAL" | "ADDITIONAL_PORTAL";
2741
+ /**
2742
+ * Resolves to a property of one of the calling organization's epilot portal configurations at runtime, replacing hard-coded environment-specific portal UUIDs in inbound mappings. Matched portals are sorted ascending by `(_created_at, portal_id)`; portals without `_created_at` sort first (treated as oldest). When `select: "single"` matches more than one portal, the resolver still returns the oldest match and emits a `PORTAL_REF_AMBIGUOUS` warning.
2743
+ *
2744
+ */
2745
+ export type PortalRefConfig = /**
2746
+ * Resolves to a property of one of the calling organization's epilot portal configurations at runtime, replacing hard-coded environment-specific portal UUIDs in inbound mappings. Matched portals are sorted ascending by `(_created_at, portal_id)`; portals without `_created_at` sort first (treated as oldest). When `select: "single"` matches more than one portal, the resolver still returns the oldest match and emits a `PORTAL_REF_AMBIGUOUS` warning.
2747
+ *
2748
+ */
2749
+ {
2750
+ filter?: /**
2751
+ * Filter applied to the org's portal configurations before selection. All filters default to "match any" except `enabled` (default `true`) and `is_dummy` (default `false`). Set `enabled` or `is_dummy` to `null` to opt out of the default.
2752
+ *
2753
+ */
2754
+ PortalRefFilter;
2755
+ /**
2756
+ * `single` returns one literal value (the oldest matching portal); `all` returns an array of literal values (0, 1, or many).
2757
+ *
2758
+ */
2759
+ select?: "single" | "all";
2760
+ /**
2761
+ * Which portal field to emit.
2762
+ */
2763
+ return?: "portal_id" | "origin" | "domain" | "name";
2764
+ } | {
2765
+ filter?: /**
2766
+ * Filter applied to the org's portal configurations before selection. All filters default to "match any" except `enabled` (default `true`) and `is_dummy` (default `false`). Set `enabled` or `is_dummy` to `null` to opt out of the default.
2767
+ *
2768
+ */
2769
+ PortalRefFilter;
2770
+ select?: "single" | "all";
2771
+ /**
2772
+ * Evaluate the sibling `jsonataExpression` against the matched portal(s). With `select: "single"` the input is the matched PortalConfig object; with `select: "all"` it is the full filtered+sorted array.
2773
+ *
2774
+ */
2775
+ return: "jsonata";
2776
+ /**
2777
+ * JSONata expression evaluated against the matched portal(s).
2778
+ */
2779
+ jsonataExpression: string;
2780
+ };
2781
+ /**
2782
+ * Filter applied to the org's portal configurations before selection. All filters default to "match any" except `enabled` (default `true`) and `is_dummy` (default `false`). Set `enabled` or `is_dummy` to `null` to opt out of the default.
2783
+ *
2784
+ */
2785
+ export interface PortalRefFilter {
2786
+ /**
2787
+ * Single origin or array of origins (matches if origin is in the array).
2788
+ */
2789
+ origin?: /* Single origin or array of origins (matches if origin is in the array). */ /* Origin/type of an epilot portal configuration. */ PortalOrigin | /* Origin/type of an epilot portal configuration. */ PortalOrigin[];
2790
+ /**
2791
+ * Match portals with this `enabled` value. Default `true`. Set to `null` to ignore.
2792
+ */
2793
+ enabled?: boolean | null;
2794
+ /**
2795
+ * Match portals with this `is_dummy` value. Default `false`. Set to `null` to ignore.
2796
+ */
2797
+ is_dummy?: boolean | null;
2798
+ /**
2799
+ * Optional restriction on `is_epilot_domain`.
2800
+ */
2801
+ is_epilot_domain?: boolean;
2802
+ /**
2803
+ * Exact match on the portal's `name`.
2804
+ */
2805
+ name?: string;
2806
+ /**
2807
+ * Exact match on the portal's `domain`.
2808
+ */
2809
+ domain?: string;
2810
+ }
2645
2811
  /**
2646
2812
  * Scope configuration for upsert-prune-scope modes.
2647
2813
  * Defines how to find entities that should be pruned if not in the upsert payload.
@@ -3351,6 +3517,10 @@ declare namespace Components {
3351
3517
  * Description of the change that was made at this point in history
3352
3518
  */
3353
3519
  change_description?: string;
3520
+ /**
3521
+ * User ID of the user who made the change that produced this history entry
3522
+ */
3523
+ changed_by?: string;
3354
3524
  /**
3355
3525
  * ISO-8601 timestamp when the use case was originally created
3356
3526
  */
@@ -3373,6 +3543,53 @@ declare namespace Components {
3373
3543
  */
3374
3544
  SecureProxyUseCaseConfiguration;
3375
3545
  }
3546
+ /**
3547
+ * Current whitelist state for a secure_proxy use case. vpc_mode is read-only
3548
+ * context so the UI can show the user what mode the pool is in.
3549
+ *
3550
+ */
3551
+ export interface SecureProxyWhitelist {
3552
+ /**
3553
+ * VPC routing mode (read-only). `null` if not yet set.
3554
+ */
3555
+ vpc_mode: "static_ip" | "secure_link";
3556
+ /**
3557
+ * Exact domain ("api.example.com") or wildcard prefix ("*.example.com").
3558
+ * Wildcards must have at least 2 labels in the suffix.
3559
+ *
3560
+ */
3561
+ allowed_domains: string[];
3562
+ /**
3563
+ * CIDR-notation IP ranges, e.g. "10.0.0.0/24".
3564
+ */
3565
+ allowed_ips: string[];
3566
+ }
3567
+ /**
3568
+ * Partial update for a secure_proxy whitelist. At least one of
3569
+ * `allowed_domains` or `allowed_ips` must be provided.
3570
+ *
3571
+ * Per-field semantics:
3572
+ * - **omitted** — the field is not modified; the stored value is preserved.
3573
+ * - **non-empty array** — the stored value is replaced with the supplied list.
3574
+ * - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is the
3575
+ * canonical way to remove all entries from a list. `null` is not accepted.
3576
+ *
3577
+ */
3578
+ export interface SecureProxyWhitelistUpdate {
3579
+ /**
3580
+ * Exact domain ("api.example.com") or wildcard prefix ("*.example.com").
3581
+ * Wildcards must have at least 2 labels in the suffix.
3582
+ * Pass `[]` to clear all allowed domains.
3583
+ *
3584
+ */
3585
+ allowed_domains?: string[];
3586
+ /**
3587
+ * CIDR-notation IP ranges, e.g. "10.0.0.0/24".
3588
+ * Pass `[]` to clear all allowed IPs.
3589
+ *
3590
+ */
3591
+ allowed_ips?: string[];
3592
+ }
3376
3593
  export interface SetIntegrationAppMappingRequest {
3377
3594
  /**
3378
3595
  * UUID of the integration app instance
@@ -3858,6 +4075,10 @@ declare namespace Components {
3858
4075
  * Description of the change that was made at this point in history
3859
4076
  */
3860
4077
  change_description?: string;
4078
+ /**
4079
+ * User ID of the user who made the change that produced this history entry
4080
+ */
4081
+ changed_by?: string;
3861
4082
  /**
3862
4083
  * ISO-8601 timestamp when the use case was originally created
3863
4084
  */
@@ -4202,6 +4423,29 @@ declare namespace Paths {
4202
4423
  export type $500 = Components.Responses.InternalServerError;
4203
4424
  }
4204
4425
  }
4426
+ namespace GetSecureProxyWhitelist {
4427
+ namespace Parameters {
4428
+ export type IntegrationId = string; // uuid
4429
+ export type UseCaseId = string; // uuid
4430
+ }
4431
+ export interface PathParameters {
4432
+ integrationId: Parameters.IntegrationId /* uuid */;
4433
+ useCaseId: Parameters.UseCaseId /* uuid */;
4434
+ }
4435
+ namespace Responses {
4436
+ export type $200 = /**
4437
+ * Current whitelist state for a secure_proxy use case. vpc_mode is read-only
4438
+ * context so the UI can show the user what mode the pool is in.
4439
+ *
4440
+ */
4441
+ Components.Schemas.SecureProxyWhitelist;
4442
+ export type $400 = Components.Responses.BadRequest;
4443
+ export type $401 = Components.Responses.Unauthorized;
4444
+ export type $403 = Components.Responses.Forbidden;
4445
+ export interface $404 {
4446
+ }
4447
+ }
4448
+ }
4205
4449
  namespace GetUseCase {
4206
4450
  namespace Parameters {
4207
4451
  export type IntegrationId = string; // uuid
@@ -4246,6 +4490,37 @@ declare namespace Paths {
4246
4490
  export type $500 = Components.Responses.InternalServerError;
4247
4491
  }
4248
4492
  }
4493
+ namespace ListSecureProxyWhitelistHistory {
4494
+ namespace Parameters {
4495
+ export type IntegrationId = string; // uuid
4496
+ export type Limit = number;
4497
+ export type UseCaseId = string; // uuid
4498
+ }
4499
+ export interface PathParameters {
4500
+ integrationId: Parameters.IntegrationId /* uuid */;
4501
+ useCaseId: Parameters.UseCaseId /* uuid */;
4502
+ }
4503
+ export interface QueryParameters {
4504
+ limit?: Parameters.Limit;
4505
+ }
4506
+ namespace Responses {
4507
+ export interface $200 {
4508
+ /**
4509
+ * Entries are `SecureProxyUseCaseHistoryEntry` in reverse
4510
+ * chronological order (newest first). Entries older than the
4511
+ * requested `limit` are not returned.
4512
+ *
4513
+ */
4514
+ history: Components.Schemas.SecureProxyUseCaseHistoryEntry[];
4515
+ }
4516
+ export type $400 = Components.Responses.BadRequest;
4517
+ export type $401 = Components.Responses.Unauthorized;
4518
+ export type $403 = Components.Responses.Forbidden;
4519
+ export interface $404 {
4520
+ }
4521
+ export type $500 = Components.Responses.InternalServerError;
4522
+ }
4523
+ }
4249
4524
  namespace ListUseCaseHistory {
4250
4525
  namespace Parameters {
4251
4526
  export type Cursor = string;
@@ -4569,6 +4844,41 @@ declare namespace Paths {
4569
4844
  export type $500 = Components.Responses.InternalServerError;
4570
4845
  }
4571
4846
  }
4847
+ namespace UpdateSecureProxyWhitelist {
4848
+ namespace Parameters {
4849
+ export type IntegrationId = string; // uuid
4850
+ export type UseCaseId = string; // uuid
4851
+ }
4852
+ export interface PathParameters {
4853
+ integrationId: Parameters.IntegrationId /* uuid */;
4854
+ useCaseId: Parameters.UseCaseId /* uuid */;
4855
+ }
4856
+ export type RequestBody = /**
4857
+ * Partial update for a secure_proxy whitelist. At least one of
4858
+ * `allowed_domains` or `allowed_ips` must be provided.
4859
+ *
4860
+ * Per-field semantics:
4861
+ * - **omitted** — the field is not modified; the stored value is preserved.
4862
+ * - **non-empty array** — the stored value is replaced with the supplied list.
4863
+ * - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is the
4864
+ * canonical way to remove all entries from a list. `null` is not accepted.
4865
+ *
4866
+ */
4867
+ Components.Schemas.SecureProxyWhitelistUpdate;
4868
+ namespace Responses {
4869
+ export type $200 = /**
4870
+ * Current whitelist state for a secure_proxy use case. vpc_mode is read-only
4871
+ * context so the UI can show the user what mode the pool is in.
4872
+ *
4873
+ */
4874
+ Components.Schemas.SecureProxyWhitelist;
4875
+ export type $400 = Components.Responses.BadRequest;
4876
+ export type $401 = Components.Responses.Unauthorized;
4877
+ export type $403 = Components.Responses.Forbidden;
4878
+ export interface $404 {
4879
+ }
4880
+ }
4881
+ }
4572
4882
  namespace UpdateUseCase {
4573
4883
  namespace Parameters {
4574
4884
  export type IntegrationId = string; // uuid
@@ -4868,6 +5178,66 @@ interface OperationMethods {
4868
5178
  data?: any,
4869
5179
  config?: AxiosRequestConfig
4870
5180
  ): OperationResponse<Paths.DeleteIntegrationV2.Responses.$200>
5181
+ /**
5182
+ * getSecureProxyWhitelist - Get secure_proxy whitelist (admin portal only)
5183
+ *
5184
+ * Returns the current allowed_domains, allowed_ips, and vpc_mode for a secure_proxy use case.
5185
+ * Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool membership.
5186
+ * Rejects Login-As tokens.
5187
+ *
5188
+ */
5189
+ 'getSecureProxyWhitelist'(
5190
+ parameters?: Parameters<Paths.GetSecureProxyWhitelist.PathParameters> | null,
5191
+ data?: any,
5192
+ config?: AxiosRequestConfig
5193
+ ): OperationResponse<Paths.GetSecureProxyWhitelist.Responses.$200>
5194
+ /**
5195
+ * updateSecureProxyWhitelist - Update secure_proxy whitelist (admin portal only)
5196
+ *
5197
+ * Replaces allowed_domains and/or allowed_ips on a secure_proxy use case.
5198
+ * At least one of the two fields is required. Validation mirrors the CLI's
5199
+ * `validateDomainPatterns` / `validateCidrs`. Writes a USECASE_HISTORY row
5200
+ * with the admin user's email as `changed_by`.
5201
+ *
5202
+ * Update semantics per field:
5203
+ * - **omitted** — field is not modified; the stored value is preserved.
5204
+ * - **non-empty array** — the stored value is replaced with the supplied list.
5205
+ * - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is
5206
+ * the canonical way to remove all entries. `null` is not accepted.
5207
+ *
5208
+ * Staff-only — same auth gates as GET.
5209
+ *
5210
+ */
5211
+ 'updateSecureProxyWhitelist'(
5212
+ parameters?: Parameters<Paths.UpdateSecureProxyWhitelist.PathParameters> | null,
5213
+ data?: Paths.UpdateSecureProxyWhitelist.RequestBody,
5214
+ config?: AxiosRequestConfig
5215
+ ): OperationResponse<Paths.UpdateSecureProxyWhitelist.Responses.$200>
5216
+ /**
5217
+ * listSecureProxyWhitelistHistory - List secure_proxy whitelist change history (admin portal only)
5218
+ *
5219
+ * Returns the most recent USECASE_HISTORY entries for a secure_proxy use case,
5220
+ * in reverse chronological order (newest first). Each entry includes the
5221
+ * actor email (`changed_by`), the ISO-8601 timestamp (`history_created_at`),
5222
+ * the `change_description` (free-text action), and the full `configuration`
5223
+ * snapshot — from which UI-08 computes a before/after diff between consecutive
5224
+ * entries.
5225
+ *
5226
+ * Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool
5227
+ * membership. Rejects Login-As tokens (same auth gate as the GET / PUT
5228
+ * secure-proxy-whitelist operations).
5229
+ *
5230
+ * Thin wrapper over the service-layer `listUseCaseHistory` that powers
5231
+ * `GET /v1/integrations/{integrationId}/use-cases/{useCaseId}/history` — the
5232
+ * separate path exists because the /v1 variant is tenant-gated and admin-portal
5233
+ * internal-auth tokens do not carry tenant permissions.
5234
+ *
5235
+ */
5236
+ 'listSecureProxyWhitelistHistory'(
5237
+ parameters?: Parameters<Paths.ListSecureProxyWhitelistHistory.QueryParameters & Paths.ListSecureProxyWhitelistHistory.PathParameters> | null,
5238
+ data?: any,
5239
+ config?: AxiosRequestConfig
5240
+ ): OperationResponse<Paths.ListSecureProxyWhitelistHistory.Responses.$200>
4871
5241
  /**
4872
5242
  * setIntegrationAppMapping - setIntegrationAppMapping
4873
5243
  *
@@ -5400,6 +5770,70 @@ interface PathsDictionary {
5400
5770
  config?: AxiosRequestConfig
5401
5771
  ): OperationResponse<Paths.DeleteIntegrationV2.Responses.$200>
5402
5772
  }
5773
+ ['/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist']: {
5774
+ /**
5775
+ * getSecureProxyWhitelist - Get secure_proxy whitelist (admin portal only)
5776
+ *
5777
+ * Returns the current allowed_domains, allowed_ips, and vpc_mode for a secure_proxy use case.
5778
+ * Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool membership.
5779
+ * Rejects Login-As tokens.
5780
+ *
5781
+ */
5782
+ 'get'(
5783
+ parameters?: Parameters<Paths.GetSecureProxyWhitelist.PathParameters> | null,
5784
+ data?: any,
5785
+ config?: AxiosRequestConfig
5786
+ ): OperationResponse<Paths.GetSecureProxyWhitelist.Responses.$200>
5787
+ /**
5788
+ * updateSecureProxyWhitelist - Update secure_proxy whitelist (admin portal only)
5789
+ *
5790
+ * Replaces allowed_domains and/or allowed_ips on a secure_proxy use case.
5791
+ * At least one of the two fields is required. Validation mirrors the CLI's
5792
+ * `validateDomainPatterns` / `validateCidrs`. Writes a USECASE_HISTORY row
5793
+ * with the admin user's email as `changed_by`.
5794
+ *
5795
+ * Update semantics per field:
5796
+ * - **omitted** — field is not modified; the stored value is preserved.
5797
+ * - **non-empty array** — the stored value is replaced with the supplied list.
5798
+ * - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is
5799
+ * the canonical way to remove all entries. `null` is not accepted.
5800
+ *
5801
+ * Staff-only — same auth gates as GET.
5802
+ *
5803
+ */
5804
+ 'put'(
5805
+ parameters?: Parameters<Paths.UpdateSecureProxyWhitelist.PathParameters> | null,
5806
+ data?: Paths.UpdateSecureProxyWhitelist.RequestBody,
5807
+ config?: AxiosRequestConfig
5808
+ ): OperationResponse<Paths.UpdateSecureProxyWhitelist.Responses.$200>
5809
+ }
5810
+ ['/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist/history']: {
5811
+ /**
5812
+ * listSecureProxyWhitelistHistory - List secure_proxy whitelist change history (admin portal only)
5813
+ *
5814
+ * Returns the most recent USECASE_HISTORY entries for a secure_proxy use case,
5815
+ * in reverse chronological order (newest first). Each entry includes the
5816
+ * actor email (`changed_by`), the ISO-8601 timestamp (`history_created_at`),
5817
+ * the `change_description` (free-text action), and the full `configuration`
5818
+ * snapshot — from which UI-08 computes a before/after diff between consecutive
5819
+ * entries.
5820
+ *
5821
+ * Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool
5822
+ * membership. Rejects Login-As tokens (same auth gate as the GET / PUT
5823
+ * secure-proxy-whitelist operations).
5824
+ *
5825
+ * Thin wrapper over the service-layer `listUseCaseHistory` that powers
5826
+ * `GET /v1/integrations/{integrationId}/use-cases/{useCaseId}/history` — the
5827
+ * separate path exists because the /v1 variant is tenant-gated and admin-portal
5828
+ * internal-auth tokens do not carry tenant permissions.
5829
+ *
5830
+ */
5831
+ 'get'(
5832
+ parameters?: Parameters<Paths.ListSecureProxyWhitelistHistory.QueryParameters & Paths.ListSecureProxyWhitelistHistory.PathParameters> | null,
5833
+ data?: any,
5834
+ config?: AxiosRequestConfig
5835
+ ): OperationResponse<Paths.ListSecureProxyWhitelistHistory.Responses.$200>
5836
+ }
5403
5837
  ['/v1/integrations/{integrationId}/app-mapping']: {
5404
5838
  /**
5405
5839
  * setIntegrationAppMapping - setIntegrationAppMapping
@@ -5683,6 +6117,7 @@ type EmbeddedSecureProxyUseCaseRequest = Components.Schemas.EmbeddedSecureProxyU
5683
6117
  type EmbeddedUseCaseRequest = Components.Schemas.EmbeddedUseCaseRequest;
5684
6118
  type EmbeddedUseCaseRequestBase = Components.Schemas.EmbeddedUseCaseRequestBase;
5685
6119
  type EntityUpdate = Components.Schemas.EntityUpdate;
6120
+ type EnvVarRefConfig = Components.Schemas.EnvVarRefConfig;
5686
6121
  type EnvironmentFieldConfig = Components.Schemas.EnvironmentFieldConfig;
5687
6122
  type ErpEvent = Components.Schemas.ErpEvent;
5688
6123
  type ErpEventV3 = Components.Schemas.ErpEventV3;
@@ -5749,6 +6184,9 @@ type OutboundStatusResponse = Components.Schemas.OutboundStatusResponse;
5749
6184
  type OutboundUseCase = Components.Schemas.OutboundUseCase;
5750
6185
  type OutboundUseCaseHistoryEntry = Components.Schemas.OutboundUseCaseHistoryEntry;
5751
6186
  type OutboundUseCaseStatus = Components.Schemas.OutboundUseCaseStatus;
6187
+ type PortalOrigin = Components.Schemas.PortalOrigin;
6188
+ type PortalRefConfig = Components.Schemas.PortalRefConfig;
6189
+ type PortalRefFilter = Components.Schemas.PortalRefFilter;
5752
6190
  type PruneScopeConfig = Components.Schemas.PruneScopeConfig;
5753
6191
  type QueryAccessLogsRequest = Components.Schemas.QueryAccessLogsRequest;
5754
6192
  type QueryEventsRequest = Components.Schemas.QueryEventsRequest;
@@ -5769,6 +6207,8 @@ type SecureProxySummary = Components.Schemas.SecureProxySummary;
5769
6207
  type SecureProxyUseCase = Components.Schemas.SecureProxyUseCase;
5770
6208
  type SecureProxyUseCaseConfiguration = Components.Schemas.SecureProxyUseCaseConfiguration;
5771
6209
  type SecureProxyUseCaseHistoryEntry = Components.Schemas.SecureProxyUseCaseHistoryEntry;
6210
+ type SecureProxyWhitelist = Components.Schemas.SecureProxyWhitelist;
6211
+ type SecureProxyWhitelistUpdate = Components.Schemas.SecureProxyWhitelistUpdate;
5772
6212
  type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationAppMappingRequest;
5773
6213
  type TimeSeriesBreakdownItemV2 = Components.Schemas.TimeSeriesBreakdownItemV2;
5774
6214
  type TimeSeriesBucket = Components.Schemas.TimeSeriesBucket;
@@ -5793,4 +6233,4 @@ type UseCaseHistoryEntryBase = Components.Schemas.UseCaseHistoryEntryBase;
5793
6233
  type UseCaseTypePreview = Components.Schemas.UseCaseTypePreview;
5794
6234
  type WebhookStatus = Components.Schemas.WebhookStatus;
5795
6235
 
5796
- export { type InboundMonitoringEvent as $, type AccessLogEntry as A, type ErpUpdatesEventsV3Request as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type ErrorResponseBase as F, type FileProxyAuth as G, type FileProxyParam as H, type FileProxyResponseConfig as I, type FileProxySecureProxyAttachment as J, type FileProxyStep as K, type FileProxyUrlConfig as L, type FileProxyUrlParam as M, type FileProxyUrlParams as N, type OperationMethods as O, Paths as P, type FileProxyUseCase as Q, type FileProxyUseCaseConfiguration as R, type FileProxyUseCaseHistoryEntry as S, type GenerateTypesPreviewResponse as T, type GenerateTypesRequest as U, type GenerateTypesResponse as V, type GetMonitoringStatsRequest as W, type GetMonitoringStatsV2Request as X, type GetMonitoringTimeSeriesRequest as Y, type GetMonitoringTimeSeriesV2Request as Z, type InboundIntegrationEventConfiguration as _, Components as a, type TimeSeriesBucketV2 as a$, type InboundUseCase as a0, type InboundUseCaseHistoryEntry as a1, type Integration as a2, type IntegrationAppMapping as a3, type IntegrationConfigurationV1 as a4, type IntegrationConfigurationV2 as a5, type IntegrationEditableFields as a6, type IntegrationEntity as a7, type IntegrationEntityField as a8, type IntegrationFieldV1 as a9, type OutboundStatusResponse as aA, type OutboundUseCase as aB, type OutboundUseCaseHistoryEntry as aC, type OutboundUseCaseStatus as aD, type PruneScopeConfig as aE, type QueryAccessLogsRequest as aF, type QueryEventsRequest as aG, type QueryInboundMonitoringEventsRequest as aH, type QueryMonitoringEventsV2Request as aI, type QueryOutboundMonitoringEventsRequest as aJ, type RelationConfig as aK, type RelationItemConfig as aL, type RelationRefItemConfig as aM, type RelationRefValueConfig as aN, type RelationRefsConfig as aO, type RelationUniqueIdField as aP, type RepeatableFieldType as aQ, type ReplayEventsRequest as aR, type SecureProxyRequest as aS, type SecureProxyResponse as aT, type SecureProxySummary as aU, type SecureProxyUseCase as aV, type SecureProxyUseCaseConfiguration as aW, type SecureProxyUseCaseHistoryEntry as aX, type SetIntegrationAppMappingRequest as aY, type TimeSeriesBreakdownItemV2 as aZ, type TimeSeriesBucket as a_, type IntegrationMeterReading as aa, type IntegrationObjectV1 as ab, type IntegrationSettings as ac, type IntegrationWithUseCases as ad, type ManagedCallAuth as ae, type ManagedCallErrorResponse as af, type ManagedCallExecuteRequest as ag, type ManagedCallExecuteResponse as ah, type ManagedCallOperation as ai, type ManagedCallOperationConfig as aj, type ManagedCallUseCase as ak, type ManagedCallUseCaseHistoryEntry as al, type MappingSimulationRequest as am, type MappingSimulationResponse as an, type MappingSimulationV2Request as ao, type MappingSimulationWarning as ap, type MeterReadingPruneScopeConfig as aq, type MeterReadingUpdate as ar, type MeterUniqueIdsConfig as as, type MonitoringEventV2 as at, type MonitoringStats as au, type MonitoringStatsV2 as av, type OutboundConflict as aw, type OutboundIntegrationEventConfiguration as ax, type OutboundMapping as ay, type OutboundMonitoringEvent as az, type PathsDictionary as b, type TriggerErpActionRequest as b0, type TriggerWebhookResp as b1, type TypeAnnotations as b2, type TypeDescriptor as b3, type UpdateFileProxyUseCaseRequest as b4, type UpdateInboundUseCaseRequest as b5, type UpdateIntegrationRequest as b6, type UpdateManagedCallUseCaseRequest as b7, type UpdateOutboundUseCaseRequest as b8, type UpdateSecureProxyUseCaseRequest as b9, type UpdateUseCaseRequest as ba, type UpdateUseCaseRequestBase as bb, type UpsertIntegrationWithUseCasesRequest as bc, type UseCase as bd, type UseCaseBase as be, type UseCaseHistoryEntry as bf, type UseCaseHistoryEntryBase as bg, type UseCaseTypePreview as bh, type WebhookStatus as bi, type AutoRefreshSettings as c, type CommitTypesRequest as d, type CommitTypesResponse as e, type ConnectorConfig as f, type CreateFileProxyUseCaseRequest as g, type CreateInboundUseCaseRequest as h, type CreateIntegrationRequest as i, type CreateManagedCallUseCaseRequest as j, type CreateOutboundUseCaseRequest as k, type CreateSecureProxyUseCaseRequest as l, type CreateUseCaseRequest as m, type CreateUseCaseRequestBase as n, type DeliveryConfig as o, type EmbeddedInboundUseCaseRequest as p, type EmbeddedManagedCallUseCaseRequest as q, type EmbeddedOutboundUseCaseRequest as r, type EmbeddedSecureProxyUseCaseRequest as s, type EmbeddedUseCaseRequest as t, type EmbeddedUseCaseRequestBase as u, type EntityUpdate as v, type EnvironmentFieldConfig as w, type ErpEvent as x, type ErpEventV3 as y, type ErpUpdatesEventsV2Request as z };
6236
+ export { type InboundIntegrationEventConfiguration as $, type AccessLogEntry as A, type ErpUpdatesEventsV2Request as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type ErpUpdatesEventsV3Request as F, type ErrorResponseBase as G, type FileProxyAuth as H, type FileProxyParam as I, type FileProxyResponseConfig as J, type FileProxySecureProxyAttachment as K, type FileProxyStep as L, type FileProxyUrlConfig as M, type FileProxyUrlParam as N, type OperationMethods as O, Paths as P, type FileProxyUrlParams as Q, type FileProxyUseCase as R, type FileProxyUseCaseConfiguration as S, type FileProxyUseCaseHistoryEntry as T, type GenerateTypesPreviewResponse as U, type GenerateTypesRequest as V, type GenerateTypesResponse as W, type GetMonitoringStatsRequest as X, type GetMonitoringStatsV2Request as Y, type GetMonitoringTimeSeriesRequest as Z, type GetMonitoringTimeSeriesV2Request as _, Components as a, type SecureProxyUseCaseHistoryEntry as a$, type InboundMonitoringEvent as a0, type InboundUseCase as a1, type InboundUseCaseHistoryEntry as a2, type Integration as a3, type IntegrationAppMapping as a4, type IntegrationConfigurationV1 as a5, type IntegrationConfigurationV2 as a6, type IntegrationEditableFields as a7, type IntegrationEntity as a8, type IntegrationEntityField as a9, type OutboundMonitoringEvent as aA, type OutboundStatusResponse as aB, type OutboundUseCase as aC, type OutboundUseCaseHistoryEntry as aD, type OutboundUseCaseStatus as aE, type PortalOrigin as aF, type PortalRefConfig as aG, type PortalRefFilter as aH, type PruneScopeConfig as aI, type QueryAccessLogsRequest as aJ, type QueryEventsRequest as aK, type QueryInboundMonitoringEventsRequest as aL, type QueryMonitoringEventsV2Request as aM, type QueryOutboundMonitoringEventsRequest as aN, type RelationConfig as aO, type RelationItemConfig as aP, type RelationRefItemConfig as aQ, type RelationRefValueConfig as aR, type RelationRefsConfig as aS, type RelationUniqueIdField as aT, type RepeatableFieldType as aU, type ReplayEventsRequest as aV, type SecureProxyRequest as aW, type SecureProxyResponse as aX, type SecureProxySummary as aY, type SecureProxyUseCase as aZ, type SecureProxyUseCaseConfiguration as a_, type IntegrationFieldV1 as aa, type IntegrationMeterReading as ab, type IntegrationObjectV1 as ac, type IntegrationSettings as ad, type IntegrationWithUseCases as ae, type ManagedCallAuth as af, type ManagedCallErrorResponse as ag, type ManagedCallExecuteRequest as ah, type ManagedCallExecuteResponse as ai, type ManagedCallOperation as aj, type ManagedCallOperationConfig as ak, type ManagedCallUseCase as al, type ManagedCallUseCaseHistoryEntry as am, type MappingSimulationRequest as an, type MappingSimulationResponse as ao, type MappingSimulationV2Request as ap, type MappingSimulationWarning as aq, type MeterReadingPruneScopeConfig as ar, type MeterReadingUpdate as as, type MeterUniqueIdsConfig as at, type MonitoringEventV2 as au, type MonitoringStats as av, type MonitoringStatsV2 as aw, type OutboundConflict as ax, type OutboundIntegrationEventConfiguration as ay, type OutboundMapping as az, type PathsDictionary as b, type SecureProxyWhitelist as b0, type SecureProxyWhitelistUpdate as b1, type SetIntegrationAppMappingRequest as b2, type TimeSeriesBreakdownItemV2 as b3, type TimeSeriesBucket as b4, type TimeSeriesBucketV2 as b5, type TriggerErpActionRequest as b6, type TriggerWebhookResp as b7, type TypeAnnotations as b8, type TypeDescriptor as b9, type UpdateFileProxyUseCaseRequest as ba, type UpdateInboundUseCaseRequest as bb, type UpdateIntegrationRequest as bc, type UpdateManagedCallUseCaseRequest as bd, type UpdateOutboundUseCaseRequest as be, type UpdateSecureProxyUseCaseRequest as bf, type UpdateUseCaseRequest as bg, type UpdateUseCaseRequestBase as bh, type UpsertIntegrationWithUseCasesRequest as bi, type UseCase as bj, type UseCaseBase as bk, type UseCaseHistoryEntry as bl, type UseCaseHistoryEntryBase as bm, type UseCaseTypePreview as bn, type WebhookStatus as bo, type AutoRefreshSettings as c, type CommitTypesRequest as d, type CommitTypesResponse as e, type ConnectorConfig as f, type CreateFileProxyUseCaseRequest as g, type CreateInboundUseCaseRequest as h, type CreateIntegrationRequest as i, type CreateManagedCallUseCaseRequest as j, type CreateOutboundUseCaseRequest as k, type CreateSecureProxyUseCaseRequest as l, type CreateUseCaseRequest as m, type CreateUseCaseRequestBase as n, type DeliveryConfig as o, type EmbeddedInboundUseCaseRequest as p, type EmbeddedManagedCallUseCaseRequest as q, type EmbeddedOutboundUseCaseRequest as r, type EmbeddedSecureProxyUseCaseRequest as s, type EmbeddedUseCaseRequest as t, type EmbeddedUseCaseRequestBase as u, type EntityUpdate as v, type EnvVarRefConfig as w, type EnvironmentFieldConfig as x, type ErpEvent as y, type ErpEventV3 as z };