@epilot/sdk 2.7.0 → 2.8.0-rc.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 (254) hide show
  1. package/README.md +1 -0
  2. package/definitions/app.json +101 -8
  3. package/definitions/configuration-hub-runtime.json +1 -1
  4. package/definitions/configuration-hub.json +623 -0
  5. package/definitions/customer-portal-runtime.json +1 -1
  6. package/definitions/customer-portal.json +505 -6
  7. package/definitions/design-runtime.json +1 -1
  8. package/definitions/design.json +1 -11
  9. package/definitions/email-settings-runtime.json +1 -1
  10. package/definitions/email-settings.json +86 -4
  11. package/definitions/file-runtime.json +1 -1
  12. package/definitions/file.json +262 -4
  13. package/definitions/focus-pocus-runtime.json +1 -0
  14. package/definitions/focus-pocus.json +757 -0
  15. package/definitions/journey-runtime.json +1 -1
  16. package/definitions/journey.json +21 -1
  17. package/dist/README-37TXN4EL.cjs +7 -0
  18. package/dist/README-Z2WITBOR.js +7 -0
  19. package/dist/{_index-DB2VV4PQ.cjs → _index-HTUXYSTD.cjs} +4 -1
  20. package/dist/{_index-5FB6F5YY.js → _index-YTOJUFGD.js} +3 -0
  21. package/dist/apis/access-token.cjs +6 -6
  22. package/dist/apis/access-token.js +1 -1
  23. package/dist/apis/address-suggestions.cjs +6 -6
  24. package/dist/apis/address-suggestions.js +1 -1
  25. package/dist/apis/address.cjs +6 -6
  26. package/dist/apis/address.js +1 -1
  27. package/dist/apis/ai-agents.cjs +6 -6
  28. package/dist/apis/ai-agents.js +1 -1
  29. package/dist/apis/app.cjs +6 -6
  30. package/dist/apis/app.d.cts +2 -2
  31. package/dist/apis/app.d.ts +2 -2
  32. package/dist/apis/app.js +1 -1
  33. package/dist/apis/audit-logs.cjs +6 -6
  34. package/dist/apis/audit-logs.js +1 -1
  35. package/dist/apis/automation.cjs +6 -6
  36. package/dist/apis/automation.js +1 -1
  37. package/dist/apis/billing.cjs +6 -6
  38. package/dist/apis/billing.js +1 -1
  39. package/dist/apis/blueprint-manifest.cjs +6 -6
  40. package/dist/apis/blueprint-manifest.js +1 -1
  41. package/dist/apis/calendar.cjs +6 -6
  42. package/dist/apis/calendar.js +1 -1
  43. package/dist/apis/configuration-hub.cjs +8 -8
  44. package/dist/apis/configuration-hub.d.cts +2 -2
  45. package/dist/apis/configuration-hub.d.ts +2 -2
  46. package/dist/apis/configuration-hub.js +2 -2
  47. package/dist/apis/consent.cjs +6 -6
  48. package/dist/apis/consent.js +1 -1
  49. package/dist/apis/customer-portal.cjs +8 -8
  50. package/dist/apis/customer-portal.d.cts +2 -2
  51. package/dist/apis/customer-portal.d.ts +2 -2
  52. package/dist/apis/customer-portal.js +2 -2
  53. package/dist/apis/dashboard.cjs +6 -6
  54. package/dist/apis/dashboard.js +1 -1
  55. package/dist/apis/data-governance.cjs +6 -6
  56. package/dist/apis/data-governance.js +1 -1
  57. package/dist/apis/deduplication.cjs +6 -6
  58. package/dist/apis/deduplication.js +1 -1
  59. package/dist/apis/design.cjs +8 -8
  60. package/dist/apis/design.js +2 -2
  61. package/dist/apis/document.cjs +6 -6
  62. package/dist/apis/document.js +1 -1
  63. package/dist/apis/email-settings.cjs +8 -8
  64. package/dist/apis/email-settings.d.cts +2 -2
  65. package/dist/apis/email-settings.d.ts +2 -2
  66. package/dist/apis/email-settings.js +2 -2
  67. package/dist/apis/email-template.cjs +6 -6
  68. package/dist/apis/email-template.js +1 -1
  69. package/dist/apis/entity-mapping.cjs +6 -6
  70. package/dist/apis/entity-mapping.js +1 -1
  71. package/dist/apis/entity.cjs +6 -6
  72. package/dist/apis/entity.js +1 -1
  73. package/dist/apis/environments.cjs +6 -6
  74. package/dist/apis/environments.js +1 -1
  75. package/dist/apis/event-catalog.cjs +6 -6
  76. package/dist/apis/event-catalog.js +1 -1
  77. package/dist/apis/file.cjs +8 -8
  78. package/dist/apis/file.d.cts +2 -2
  79. package/dist/apis/file.d.ts +2 -2
  80. package/dist/apis/file.js +2 -2
  81. package/dist/apis/focus-pocus.cjs +38 -0
  82. package/dist/apis/focus-pocus.d.cts +18 -0
  83. package/dist/apis/focus-pocus.d.ts +18 -0
  84. package/dist/apis/focus-pocus.js +38 -0
  85. package/dist/apis/iban.cjs +6 -6
  86. package/dist/apis/iban.js +1 -1
  87. package/dist/apis/integration-toolkit.cjs +6 -6
  88. package/dist/apis/integration-toolkit.js +1 -1
  89. package/dist/apis/journey.cjs +8 -8
  90. package/dist/apis/journey.d.cts +2 -2
  91. package/dist/apis/journey.d.ts +2 -2
  92. package/dist/apis/journey.js +2 -2
  93. package/dist/apis/kanban.cjs +6 -6
  94. package/dist/apis/kanban.js +1 -1
  95. package/dist/apis/message.cjs +6 -6
  96. package/dist/apis/message.js +1 -1
  97. package/dist/apis/metering.cjs +6 -6
  98. package/dist/apis/metering.js +1 -1
  99. package/dist/apis/notes.cjs +6 -6
  100. package/dist/apis/notes.js +1 -1
  101. package/dist/apis/notification.cjs +6 -6
  102. package/dist/apis/notification.js +1 -1
  103. package/dist/apis/organization.cjs +6 -6
  104. package/dist/apis/organization.js +1 -1
  105. package/dist/apis/partner-directory.cjs +6 -6
  106. package/dist/apis/partner-directory.js +1 -1
  107. package/dist/apis/permissions.cjs +6 -6
  108. package/dist/apis/permissions.js +1 -1
  109. package/dist/apis/pricing-tier.cjs +6 -6
  110. package/dist/apis/pricing-tier.js +1 -1
  111. package/dist/apis/pricing.cjs +6 -6
  112. package/dist/apis/pricing.js +1 -1
  113. package/dist/apis/purpose.cjs +6 -6
  114. package/dist/apis/purpose.js +1 -1
  115. package/dist/apis/query.cjs +6 -6
  116. package/dist/apis/query.js +1 -1
  117. package/dist/apis/sandbox.cjs +6 -6
  118. package/dist/apis/sandbox.js +1 -1
  119. package/dist/apis/sharing.cjs +6 -6
  120. package/dist/apis/sharing.js +1 -1
  121. package/dist/apis/submission.cjs +6 -6
  122. package/dist/apis/submission.js +1 -1
  123. package/dist/apis/target.cjs +6 -6
  124. package/dist/apis/target.js +1 -1
  125. package/dist/apis/targeting.cjs +6 -6
  126. package/dist/apis/targeting.js +1 -1
  127. package/dist/apis/template-variables.cjs +6 -6
  128. package/dist/apis/template-variables.js +1 -1
  129. package/dist/apis/user.cjs +6 -6
  130. package/dist/apis/user.js +1 -1
  131. package/dist/apis/validation-rules.cjs +6 -6
  132. package/dist/apis/validation-rules.js +1 -1
  133. package/dist/apis/webhooks.cjs +6 -6
  134. package/dist/apis/webhooks.js +1 -1
  135. package/dist/apis/workflow-definition.cjs +6 -6
  136. package/dist/apis/workflow-definition.js +1 -1
  137. package/dist/apis/workflow.cjs +6 -6
  138. package/dist/apis/workflow.js +1 -1
  139. package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
  140. package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
  141. package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
  142. package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
  143. package/dist/chunk-3APTSPY4.js +14 -0
  144. package/dist/{chunk-JB7LITSP.js → chunk-54KWFSCM.js} +35 -24
  145. package/dist/chunk-A6FYGWQ7.cjs +14 -0
  146. package/dist/{chunk-35CN2YFK.cjs → chunk-F5Z6I7TF.cjs} +35 -24
  147. package/dist/chunk-JOUTFBLN.js +14 -0
  148. package/dist/chunk-KCPVNRDL.js +14 -0
  149. package/dist/chunk-KJPOUJBU.cjs +14 -0
  150. package/dist/chunk-LAWKCWVU.cjs +14 -0
  151. package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
  152. package/dist/chunk-OPXGJKZR.cjs +14 -0
  153. package/dist/chunk-P42Q6HOW.js +14 -0
  154. package/dist/chunk-P4NA7NWG.js +14 -0
  155. package/dist/chunk-PTEJYAYJ.js +14 -0
  156. package/dist/chunk-WHXYES2D.cjs +14 -0
  157. package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
  158. package/dist/chunk-YI5YGTAH.cjs +14 -0
  159. package/dist/configuration-hub-E7S4JB2T.js +7 -0
  160. package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
  161. package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
  162. package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
  163. package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
  164. package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
  165. package/dist/customer-portal-DR6XFCTQ.js +7 -0
  166. package/dist/customer-portal-PNFBVIAH.cjs +7 -0
  167. package/dist/{customer-portal-runtime-OEXTSMSE.cjs → customer-portal-runtime-IYHJ3RME.cjs} +2 -2
  168. package/dist/{customer-portal-runtime-N4NWQ67M.js → customer-portal-runtime-ZYU3WIXY.js} +1 -1
  169. package/dist/{customer-portal.d-ChSEioI5.d.cts → customer-portal.d-CTTCBAZI.d.cts} +764 -14
  170. package/dist/{customer-portal.d-ChSEioI5.d.ts → customer-portal.d-CTTCBAZI.d.ts} +764 -14
  171. package/dist/data-governance-QYFHBCNB.cjs +7 -0
  172. package/dist/data-governance-YS2NA6W4.js +7 -0
  173. package/dist/design-EWZQZ5KX.js +7 -0
  174. package/dist/design-MUUYXB2J.cjs +7 -0
  175. package/dist/design-runtime-3RHYNHUV.cjs +5 -0
  176. package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
  177. package/dist/email-settings-YJ4X5VFU.cjs +7 -0
  178. package/dist/email-settings-YUK3DXFJ.js +7 -0
  179. package/dist/{email-settings-runtime-EGIJ2AVQ.js → email-settings-runtime-BXRZV4M5.js} +1 -1
  180. package/dist/{email-settings-runtime-WGVLI7N6.cjs → email-settings-runtime-FWJQBQBK.cjs} +2 -2
  181. package/dist/{email-settings.d-B7Q_xT25.d.cts → email-settings.d-UJ0C3jPI.d.cts} +108 -9
  182. package/dist/{email-settings.d-B7Q_xT25.d.ts → email-settings.d-UJ0C3jPI.d.ts} +108 -9
  183. package/dist/file-P2FUUER2.js +7 -0
  184. package/dist/file-XTY74SIX.cjs +7 -0
  185. package/dist/file-runtime-24S3QPA7.cjs +5 -0
  186. package/dist/{file-runtime-B6AAGZQF.js → file-runtime-BIRMXYRH.js} +1 -1
  187. package/dist/{file.d-DcTJxjp7.d.cts → file.d-DTlrbI40.d.cts} +2336 -19
  188. package/dist/{file.d-DcTJxjp7.d.ts → file.d-DTlrbI40.d.ts} +2336 -19
  189. package/dist/focus-pocus-JGXH42OF.cjs +7 -0
  190. package/dist/focus-pocus-XVDVUYL6.js +7 -0
  191. package/dist/focus-pocus-runtime-QXBBYVX7.js +5 -0
  192. package/dist/focus-pocus-runtime-X6GQ3WI4.cjs +5 -0
  193. package/dist/focus-pocus.d-BRFGe53G.d.cts +489 -0
  194. package/dist/focus-pocus.d-BRFGe53G.d.ts +489 -0
  195. package/dist/index.cjs +34 -26
  196. package/dist/index.d.cts +57 -55
  197. package/dist/index.d.ts +57 -55
  198. package/dist/index.js +23 -15
  199. package/dist/journey-4DIIPRU4.js +7 -0
  200. package/dist/journey-ATC3Y5AW.cjs +7 -0
  201. package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
  202. package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
  203. package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
  204. package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
  205. package/dist/pricing-R5ENSVPQ.cjs +7 -0
  206. package/dist/pricing-X27CCRI6.js +7 -0
  207. package/dist/targeting-74BV7F7H.cjs +7 -0
  208. package/dist/targeting-W5EKJYR2.js +7 -0
  209. package/docs/app.md +34 -10
  210. package/docs/configuration-hub.md +660 -0
  211. package/docs/customer-portal.md +604 -176
  212. package/docs/data-governance.md +17 -17
  213. package/docs/design.md +1 -1
  214. package/docs/email-settings.md +67 -3
  215. package/docs/file.md +101 -2
  216. package/docs/focus-pocus.md +460 -0
  217. package/docs/journey.md +2 -0
  218. package/docs/pricing.md +1 -1
  219. package/docs/targeting.md +4 -4
  220. package/package.json +10 -1
  221. package/dist/README-46VYEGGW.js +0 -7
  222. package/dist/README-IVBISSWB.cjs +0 -7
  223. package/dist/chunk-4W22EIRF.cjs +0 -14
  224. package/dist/chunk-5OBMZHRL.cjs +0 -14
  225. package/dist/chunk-E2WMGOM5.js +0 -14
  226. package/dist/chunk-EFWPEVXI.js +0 -14
  227. package/dist/chunk-EIIIKDOJ.cjs +0 -14
  228. package/dist/chunk-KEI3GHDY.cjs +0 -14
  229. package/dist/chunk-KIWRGUKM.js +0 -14
  230. package/dist/chunk-MB6NKETA.cjs +0 -14
  231. package/dist/chunk-VSZEOCIE.js +0 -14
  232. package/dist/chunk-Z6HGUGXK.js +0 -14
  233. package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
  234. package/dist/configuration-hub-PMAW44U5.js +0 -7
  235. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  236. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  237. package/dist/customer-portal-5I7ZGQDU.cjs +0 -7
  238. package/dist/customer-portal-YL2YMPZL.js +0 -7
  239. package/dist/data-governance-2U5UU4GM.cjs +0 -7
  240. package/dist/data-governance-36Y33JVG.js +0 -7
  241. package/dist/design-DROLIWS3.js +0 -7
  242. package/dist/design-XZKOZLTR.cjs +0 -7
  243. package/dist/design-runtime-OXEXKZVG.cjs +0 -5
  244. package/dist/email-settings-CKFJU4WZ.js +0 -7
  245. package/dist/email-settings-NQJJKS2P.cjs +0 -7
  246. package/dist/file-UOWBTDIU.cjs +0 -7
  247. package/dist/file-XSN3NAVZ.js +0 -7
  248. package/dist/file-runtime-SFZIKODF.cjs +0 -5
  249. package/dist/journey-KDR5EU3W.js +0 -7
  250. package/dist/journey-REBN4TGQ.cjs +0 -7
  251. package/dist/pricing-FODHQFCB.cjs +0 -7
  252. package/dist/pricing-XRIDVZFC.js +0 -7
  253. package/dist/targeting-EYGYZD6M.cjs +0 -7
  254. package/dist/targeting-GEJTJN5Z.js +0 -7
@@ -46,6 +46,31 @@ declare namespace Components {
46
46
  */
47
47
  decision: "accept" | "decline";
48
48
  }
49
+ export interface AccountExistsRequest {
50
+ /**
51
+ * ID of the organization
52
+ * example:
53
+ * 728
54
+ */
55
+ org_id: string;
56
+ /**
57
+ * Identifier-value pairs per schema to identify an account during portal user registration
58
+ * example:
59
+ * {
60
+ * "account": {
61
+ * "customer_number": "ACC-123456"
62
+ * },
63
+ * "contract": {
64
+ * "contract_number": "123456"
65
+ * }
66
+ * }
67
+ */
68
+ registration_identifiers: {
69
+ [name: string]: {
70
+ [name: string]: string;
71
+ };
72
+ };
73
+ }
49
74
  export interface ActionLabel {
50
75
  en?: string | null;
51
76
  de?: string | null;
@@ -904,6 +929,13 @@ declare namespace Components {
904
929
  * Mark true if the domain is an Epilot domain
905
930
  */
906
931
  is_epilot_domain?: boolean;
932
+ /**
933
+ * The URL on which the portal is accessible
934
+ * example:
935
+ * example-portal-12345.ecp.epilot.cloud
936
+ */
937
+ epilot_domain?: string;
938
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
907
939
  /**
908
940
  * ID of the design used to build the portal
909
941
  */
@@ -923,6 +955,14 @@ declare namespace Components {
923
955
  */
924
956
  allowed_portal_entities?: string[];
925
957
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
958
+ /**
959
+ * Controls behavior of self-registration when account is used as the registration entity
960
+ */
961
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
962
+ /**
963
+ * Entity type used as the primary identifier for self-registration
964
+ */
965
+ self_registration_entity?: "contact" | "account";
926
966
  /**
927
967
  * Enable or disable user account self management
928
968
  * example:
@@ -1303,6 +1343,12 @@ declare namespace Components {
1303
1343
  pages?: {
1304
1344
  [name: string]: Page;
1305
1345
  };
1346
+ /**
1347
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
1348
+ */
1349
+ global_blocks?: {
1350
+ [name: string]: Block;
1351
+ };
1306
1352
  }
1307
1353
  export interface CommonConfigAttributesV3 {
1308
1354
  /**
@@ -1325,6 +1371,13 @@ declare namespace Components {
1325
1371
  * Mark true if the domain is an Epilot domain
1326
1372
  */
1327
1373
  is_epilot_domain?: boolean;
1374
+ /**
1375
+ * The Epilot domain on which the portal is accessible
1376
+ * example:
1377
+ * example-portal-1.ecp.epilot.io
1378
+ */
1379
+ epilot_domain?: string;
1380
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
1328
1381
  /**
1329
1382
  * ID of the design used to build the portal
1330
1383
  */
@@ -1344,6 +1397,14 @@ declare namespace Components {
1344
1397
  */
1345
1398
  allowed_portal_entities?: string[];
1346
1399
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
1400
+ /**
1401
+ * Controls behavior of self-registration when account is used as the registration entity
1402
+ */
1403
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
1404
+ /**
1405
+ * Entity type used as the primary identifier for self-registration
1406
+ */
1407
+ self_registration_entity?: "contact" | "account";
1347
1408
  /**
1348
1409
  * Enable or disable user account self management
1349
1410
  * example:
@@ -1721,6 +1782,12 @@ declare namespace Components {
1721
1782
  */
1722
1783
  portal_sk_v3?: string;
1723
1784
  origin?: /* Origin of the portal */ Origin;
1785
+ /**
1786
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
1787
+ */
1788
+ global_blocks?: {
1789
+ [name: string]: Block;
1790
+ };
1724
1791
  }
1725
1792
  /**
1726
1793
  * The mapped contact of the portal user
@@ -2207,6 +2274,23 @@ declare namespace Components {
2207
2274
  de?: string;
2208
2275
  };
2209
2276
  }
2277
+ /**
2278
+ * Domain settings for the portal
2279
+ */
2280
+ export interface DomainSettings {
2281
+ /**
2282
+ * Whether the custom domain is enabled
2283
+ */
2284
+ is_custom_domain_enabled?: boolean;
2285
+ /**
2286
+ * Whether the Epilot domain is enabled
2287
+ */
2288
+ is_epilot_domain_enabled?: boolean;
2289
+ /**
2290
+ * Whether the redirection is enabled
2291
+ */
2292
+ is_redirection_enabled?: boolean;
2293
+ }
2210
2294
  /**
2211
2295
  * Email templates used for authentication and internal processes
2212
2296
  */
@@ -3300,6 +3384,14 @@ declare namespace Components {
3300
3384
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
3301
3385
  */
3302
3386
  dataPath?: string;
3387
+ /**
3388
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3389
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3390
+ *
3391
+ * example:
3392
+ * error.message
3393
+ */
3394
+ errorMessagePath?: string;
3303
3395
  };
3304
3396
  /**
3305
3397
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3429,6 +3521,14 @@ declare namespace Components {
3429
3521
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
3430
3522
  */
3431
3523
  dataPath?: string;
3524
+ /**
3525
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3526
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3527
+ *
3528
+ * example:
3529
+ * error.message
3530
+ */
3531
+ errorMessagePath?: string;
3432
3532
  };
3433
3533
  /**
3434
3534
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3482,6 +3582,16 @@ declare namespace Components {
3482
3582
  [name: string]: string;
3483
3583
  };
3484
3584
  };
3585
+ resolved?: {
3586
+ /**
3587
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3588
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3589
+ *
3590
+ * example:
3591
+ * error.message
3592
+ */
3593
+ errorMessagePath?: string;
3594
+ };
3485
3595
  /**
3486
3596
  * Deprecated. Prefer `secure_proxy` instead.
3487
3597
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
@@ -3575,6 +3685,14 @@ declare namespace Components {
3575
3685
  * {{CallResponse.data.lower_limit}}
3576
3686
  */
3577
3687
  lower_limit?: string;
3688
+ /**
3689
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3690
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3691
+ *
3692
+ * example:
3693
+ * error.message
3694
+ */
3695
+ errorMessagePath?: string;
3578
3696
  };
3579
3697
  /**
3580
3698
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3625,6 +3743,14 @@ declare namespace Components {
3625
3743
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
3626
3744
  */
3627
3745
  dataPath?: string;
3746
+ /**
3747
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3748
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3749
+ *
3750
+ * example:
3751
+ * error.message
3752
+ */
3753
+ errorMessagePath?: string;
3628
3754
  };
3629
3755
  /**
3630
3756
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3737,6 +3863,14 @@ declare namespace Components {
3737
3863
  * Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
3738
3864
  */
3739
3865
  dataPath?: string;
3866
+ /**
3867
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3868
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3869
+ *
3870
+ * example:
3871
+ * error.message
3872
+ */
3873
+ errorMessagePath?: string;
3740
3874
  };
3741
3875
  /**
3742
3876
  * Deprecated. Prefer `secure_proxy` instead.
@@ -4215,6 +4349,12 @@ declare namespace Components {
4215
4349
  * Whether the org is in canary mode
4216
4350
  */
4217
4351
  is_canary?: boolean;
4352
+ /**
4353
+ * The URL to redirect to
4354
+ * example:
4355
+ * https://example.com
4356
+ */
4357
+ redirect_to?: string;
4218
4358
  }
4219
4359
  /**
4220
4360
  * The meter entity
@@ -4470,40 +4610,62 @@ declare namespace Components {
4470
4610
  };
4471
4611
  schema?: string;
4472
4612
  }
4613
+ /**
4614
+ * Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
4615
+ * fields below may reference org env vars via mustache-like templates, e.g.
4616
+ * `{{ env.MOBILE_CLIENT_SECRET }}`.
4617
+ *
4618
+ */
4473
4619
  export interface MoblieOIDCConfig {
4474
4620
  /**
4475
- * Client ID for the mobile app
4621
+ * Client ID for the mobile app. Supports env var interpolation.
4476
4622
  * example:
4477
4623
  * 123456
4478
4624
  */
4479
4625
  client_id?: string;
4480
4626
  /**
4481
- * Client Secret for the mobile app
4627
+ * Client Secret for the mobile app. Supports env var interpolation (incl. secrets),
4628
+ * e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
4629
+ *
4482
4630
  * example:
4483
4631
  * 123456
4484
4632
  */
4485
4633
  client_secret?: string;
4486
4634
  }
4635
+ /**
4636
+ * OIDC provider configuration. Values are resolved at SSO invocation time
4637
+ * (login / callback), so the fields below may reference org env vars via
4638
+ * mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
4639
+ *
4640
+ * Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
4641
+ * `ProviderConfig.display_name`) are NOT interpolated and must be literal.
4642
+ *
4643
+ */
4487
4644
  export interface OIDCProviderConfig {
4488
4645
  type?: "authorization_code" | "implicit";
4489
4646
  /**
4490
- * Issuing Authority URL
4647
+ * Issuing Authority URL. Supports env var interpolation, e.g. `{{ env.MY_ISSUER }}`.
4491
4648
  * example:
4492
4649
  * https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
4493
4650
  */
4494
4651
  oidc_issuer: string;
4495
4652
  /**
4496
- * Redirect URI for the OIDC flow
4653
+ * Redirect URI for the OIDC flow. Supports env var interpolation.
4497
4654
  * example:
4498
4655
  * https://customer-portal.com/login
4499
4656
  */
4500
4657
  redirect_uri?: string;
4501
4658
  /**
4659
+ * Supports env var interpolation, e.g. `{{ env.MY_CLIENT_ID }}`.
4502
4660
  * example:
4503
4661
  * ab81daf8-8b1f-42d6-94ca-c51621054c75
4504
4662
  */
4505
4663
  client_id: string;
4506
4664
  /**
4665
+ * Client Secret. Supports env var interpolation (incl. secrets), e.g.
4666
+ * `{{ env.MY_CLIENT_SECRET }}`. Prefer storing the actual secret as an org
4667
+ * env var and referencing it here.
4668
+ *
4507
4669
  * example:
4508
4670
  * 7BIUnn~6shh.7fNtXb..3k1Mp3s6k6WK3B
4509
4671
  */
@@ -4524,6 +4686,10 @@ declare namespace Components {
4524
4686
  prompt?: "login" | "select_account" | "consent";
4525
4687
  }
4526
4688
  export interface OIDCProviderMetadata {
4689
+ /**
4690
+ * Response modes the provider accepts (e.g. `form_post` for Apple)
4691
+ */
4692
+ response_modes_supported?: ("form_post" | "fragment" | "query")[];
4527
4693
  /**
4528
4694
  * URL of the authorization endpoint
4529
4695
  * example:
@@ -4565,13 +4731,17 @@ declare namespace Components {
4565
4731
  */
4566
4732
  mobile_redirect_uri?: string;
4567
4733
  /**
4568
- * The username for the test auth, only used for testing on auth code flow
4734
+ * The username for the test auth, only used for testing on auth code flow.
4735
+ * Supports env var interpolation, e.g. `{{ env.MY_TEST_AUTH_USERNAME }}`.
4736
+ *
4569
4737
  * example:
4570
4738
  * test@epilot.io
4571
4739
  */
4572
4740
  test_auth_username?: string;
4573
4741
  /**
4574
- * The password for the test auth, only used for testing on auth code flow
4742
+ * The password for the test auth, only used for testing on auth code flow.
4743
+ * Supports env var interpolation (incl. secrets), e.g. `{{ env.MY_TEST_AUTH_PASSWORD }}`.
4744
+ *
4575
4745
  */
4576
4746
  test_auth_password?: string;
4577
4747
  }
@@ -5140,6 +5310,13 @@ declare namespace Components {
5140
5310
  * Mark true if the domain is an Epilot domain
5141
5311
  */
5142
5312
  is_epilot_domain?: boolean;
5313
+ /**
5314
+ * The URL on which the portal is accessible
5315
+ * example:
5316
+ * example-portal-12345.ecp.epilot.cloud
5317
+ */
5318
+ epilot_domain?: string;
5319
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
5143
5320
  design_id?: /**
5144
5321
  * Entity ID
5145
5322
  * example:
@@ -5156,6 +5333,14 @@ declare namespace Components {
5156
5333
  */
5157
5334
  allowed_portal_entities?: string[];
5158
5335
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
5336
+ /**
5337
+ * Controls behavior of self-registration when account is used as the registration entity
5338
+ */
5339
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
5340
+ /**
5341
+ * Entity type used as the primary identifier for self-registration
5342
+ */
5343
+ self_registration_entity?: "contact" | "account";
5159
5344
  /**
5160
5345
  * Enable or disable user account self management
5161
5346
  * example:
@@ -5536,6 +5721,12 @@ declare namespace Components {
5536
5721
  pages?: {
5537
5722
  [name: string]: Page;
5538
5723
  };
5724
+ /**
5725
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
5726
+ */
5727
+ global_blocks?: {
5728
+ [name: string]: Block;
5729
+ };
5539
5730
  /**
5540
5731
  * ID of the organization
5541
5732
  * example:
@@ -5624,6 +5815,18 @@ declare namespace Components {
5624
5815
  */
5625
5816
  onPendingUser?: AdminUser[];
5626
5817
  };
5818
+ /**
5819
+ * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
5820
+ * the list is fully synced — incoming providers are upserted and any existing
5821
+ * providers not in the list are deleted. Omit the field to leave SSO
5822
+ * configuration unchanged; send an empty array to remove all providers.
5823
+ *
5824
+ * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
5825
+ * as sent. Customers are encouraged to reference an org env secret via
5826
+ * `{{ env.VAR }}` rather than embed raw values.
5827
+ *
5828
+ */
5829
+ identity_providers?: ProviderPublicConfig[];
5627
5830
  /**
5628
5831
  * Enable/Disable the portal access
5629
5832
  */
@@ -5644,6 +5847,13 @@ declare namespace Components {
5644
5847
  * Mark true if the domain is an Epilot domain
5645
5848
  */
5646
5849
  is_epilot_domain?: boolean;
5850
+ /**
5851
+ * The Epilot domain on which the portal is accessible
5852
+ * example:
5853
+ * example-portal-1.ecp.epilot.io
5854
+ */
5855
+ epilot_domain?: string;
5856
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
5647
5857
  design_id?: /**
5648
5858
  * Entity ID
5649
5859
  * example:
@@ -5660,6 +5870,14 @@ declare namespace Components {
5660
5870
  */
5661
5871
  allowed_portal_entities?: string[];
5662
5872
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
5873
+ /**
5874
+ * Controls behavior of self-registration when account is used as the registration entity
5875
+ */
5876
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
5877
+ /**
5878
+ * Entity type used as the primary identifier for self-registration
5879
+ */
5880
+ self_registration_entity?: "contact" | "account";
5663
5881
  /**
5664
5882
  * Enable or disable user account self management
5665
5883
  * example:
@@ -6037,6 +6255,12 @@ declare namespace Components {
6037
6255
  */
6038
6256
  portal_sk_v3?: string;
6039
6257
  origin?: /* Origin of the portal */ Origin;
6258
+ /**
6259
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
6260
+ */
6261
+ global_blocks?: {
6262
+ [name: string]: Block;
6263
+ };
6040
6264
  /**
6041
6265
  * ID of the organization
6042
6266
  * example:
@@ -6076,7 +6300,6 @@ declare namespace Components {
6076
6300
  * Permissions granted to a portal user while accessing entities
6077
6301
  */
6078
6302
  grants?: Grant[];
6079
- identity_providers?: ProviderPublicConfig[];
6080
6303
  pages?: Page[];
6081
6304
  }
6082
6305
  /**
@@ -6249,6 +6472,20 @@ declare namespace Components {
6249
6472
  */
6250
6473
  campaign_id?: string;
6251
6474
  }
6475
+ /**
6476
+ * SSO identity provider configuration.
6477
+ *
6478
+ * Env var interpolation: only string fields under `oidc_config` and
6479
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
6480
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
6481
+ * get resolved at runtime against the organization's environment.
6482
+ *
6483
+ * The following fields are used as literal values and MUST NOT contain
6484
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
6485
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
6486
+ * token claims), and all keys and values under `entity_matching`.
6487
+ *
6488
+ */
6252
6489
  export interface ProviderConfig {
6253
6490
  slug?: /**
6254
6491
  * URL-friendly slug to use as organization-unique identifier for Provider
@@ -6265,8 +6502,23 @@ declare namespace Components {
6265
6502
  provider_type: "OIDC";
6266
6503
  attribute_mappings?: /* Dictionary of epilot user attributes to claims */ AttributeMappingConfig;
6267
6504
  entity_matching?: /* Configuration for matching existing entities during SSO login using token claims */ EntityMatchingConfig;
6268
- oidc_config?: OIDCProviderConfig;
6269
- mobile_oidc_config?: MoblieOIDCConfig;
6505
+ oidc_config?: /**
6506
+ * OIDC provider configuration. Values are resolved at SSO invocation time
6507
+ * (login / callback), so the fields below may reference org env vars via
6508
+ * mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
6509
+ *
6510
+ * Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
6511
+ * `ProviderConfig.display_name`) are NOT interpolated and must be literal.
6512
+ *
6513
+ */
6514
+ OIDCProviderConfig;
6515
+ mobile_oidc_config?: /**
6516
+ * Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
6517
+ * fields below may reference org env vars via mustache-like templates, e.g.
6518
+ * `{{ env.MOBILE_CLIENT_SECRET }}`.
6519
+ *
6520
+ */
6521
+ MoblieOIDCConfig;
6270
6522
  }
6271
6523
  /**
6272
6524
  * Human-readable display name for identity provider shown in login
@@ -6287,8 +6539,23 @@ declare namespace Components {
6287
6539
  * Office 365 Login
6288
6540
  */
6289
6541
  ProviderDisplayName;
6290
- oidc_config?: OIDCProviderConfig;
6291
- mobile_oidc_config?: MoblieOIDCConfig;
6542
+ oidc_config?: /**
6543
+ * OIDC provider configuration. Values are resolved at SSO invocation time
6544
+ * (login / callback), so the fields below may reference org env vars via
6545
+ * mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
6546
+ *
6547
+ * Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
6548
+ * `ProviderConfig.display_name`) are NOT interpolated and must be literal.
6549
+ *
6550
+ */
6551
+ OIDCProviderConfig;
6552
+ mobile_oidc_config?: /**
6553
+ * Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
6554
+ * fields below may reference org env vars via mustache-like templates, e.g.
6555
+ * `{{ env.MOBILE_CLIENT_SECRET }}`.
6556
+ *
6557
+ */
6558
+ MoblieOIDCConfig;
6292
6559
  }
6293
6560
  /**
6294
6561
  * URL-friendly slug to use as organization-unique identifier for Provider
@@ -6822,6 +7089,32 @@ declare namespace Components {
6822
7089
  */
6823
7090
  onPendingUser?: AdminUser[];
6824
7091
  };
7092
+ /**
7093
+ * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
7094
+ * the list is fully synced — incoming providers are upserted and any existing
7095
+ * providers not in the list are deleted. Omit the field to leave SSO
7096
+ * configuration unchanged; send an empty array to remove all providers.
7097
+ *
7098
+ * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
7099
+ * as sent. Customers are encouraged to reference an org env secret via
7100
+ * `{{ env.VAR }}` rather than embed raw values.
7101
+ *
7102
+ */
7103
+ identity_providers?: /**
7104
+ * SSO identity provider configuration.
7105
+ *
7106
+ * Env var interpolation: only string fields under `oidc_config` and
7107
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
7108
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
7109
+ * get resolved at runtime against the organization's environment.
7110
+ *
7111
+ * The following fields are used as literal values and MUST NOT contain
7112
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
7113
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
7114
+ * token claims), and all keys and values under `entity_matching`.
7115
+ *
7116
+ */
7117
+ ProviderConfig[];
6825
7118
  }
6826
7119
  export interface UpsertPortalConfig {
6827
7120
  /**
@@ -6864,6 +7157,32 @@ declare namespace Components {
6864
7157
  */
6865
7158
  onPendingUser?: AdminUser[];
6866
7159
  };
7160
+ /**
7161
+ * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
7162
+ * the list is fully synced — incoming providers are upserted and any existing
7163
+ * providers not in the list are deleted. Omit the field to leave SSO
7164
+ * configuration unchanged; send an empty array to remove all providers.
7165
+ *
7166
+ * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
7167
+ * as sent. Customers are encouraged to reference an org env secret via
7168
+ * `{{ env.VAR }}` rather than embed raw values.
7169
+ *
7170
+ */
7171
+ identity_providers?: /**
7172
+ * SSO identity provider configuration.
7173
+ *
7174
+ * Env var interpolation: only string fields under `oidc_config` and
7175
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
7176
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
7177
+ * get resolved at runtime against the organization's environment.
7178
+ *
7179
+ * The following fields are used as literal values and MUST NOT contain
7180
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
7181
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
7182
+ * token claims), and all keys and values under `entity_matching`.
7183
+ *
7184
+ */
7185
+ ProviderConfig[];
6867
7186
  /**
6868
7187
  * Enable/Disable the portal access
6869
7188
  */
@@ -6884,6 +7203,13 @@ declare namespace Components {
6884
7203
  * Mark true if the domain is an Epilot domain
6885
7204
  */
6886
7205
  is_epilot_domain?: boolean;
7206
+ /**
7207
+ * The URL on which the portal is accessible
7208
+ * example:
7209
+ * example-portal-12345.ecp.epilot.cloud
7210
+ */
7211
+ epilot_domain?: string;
7212
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
6887
7213
  design_id?: /**
6888
7214
  * Entity ID
6889
7215
  * example:
@@ -6900,6 +7226,14 @@ declare namespace Components {
6900
7226
  */
6901
7227
  allowed_portal_entities?: string[];
6902
7228
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7229
+ /**
7230
+ * Controls behavior of self-registration when account is used as the registration entity
7231
+ */
7232
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
7233
+ /**
7234
+ * Entity type used as the primary identifier for self-registration
7235
+ */
7236
+ self_registration_entity?: "contact" | "account";
6903
7237
  /**
6904
7238
  * Enable or disable user account self management
6905
7239
  * example:
@@ -7280,6 +7614,12 @@ declare namespace Components {
7280
7614
  pages?: {
7281
7615
  [name: string]: Page;
7282
7616
  };
7617
+ /**
7618
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
7619
+ */
7620
+ global_blocks?: {
7621
+ [name: string]: Block;
7622
+ };
7283
7623
  }
7284
7624
  export interface UpsertPortalConfigV3 {
7285
7625
  /**
@@ -7322,6 +7662,32 @@ declare namespace Components {
7322
7662
  */
7323
7663
  onPendingUser?: AdminUser[];
7324
7664
  };
7665
+ /**
7666
+ * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
7667
+ * the list is fully synced — incoming providers are upserted and any existing
7668
+ * providers not in the list are deleted. Omit the field to leave SSO
7669
+ * configuration unchanged; send an empty array to remove all providers.
7670
+ *
7671
+ * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
7672
+ * as sent. Customers are encouraged to reference an org env secret via
7673
+ * `{{ env.VAR }}` rather than embed raw values.
7674
+ *
7675
+ */
7676
+ identity_providers?: /**
7677
+ * SSO identity provider configuration.
7678
+ *
7679
+ * Env var interpolation: only string fields under `oidc_config` and
7680
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
7681
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
7682
+ * get resolved at runtime against the organization's environment.
7683
+ *
7684
+ * The following fields are used as literal values and MUST NOT contain
7685
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
7686
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
7687
+ * token claims), and all keys and values under `entity_matching`.
7688
+ *
7689
+ */
7690
+ ProviderConfig[];
7325
7691
  /**
7326
7692
  * Enable/Disable the portal access
7327
7693
  */
@@ -7342,6 +7708,13 @@ declare namespace Components {
7342
7708
  * Mark true if the domain is an Epilot domain
7343
7709
  */
7344
7710
  is_epilot_domain?: boolean;
7711
+ /**
7712
+ * The Epilot domain on which the portal is accessible
7713
+ * example:
7714
+ * example-portal-1.ecp.epilot.io
7715
+ */
7716
+ epilot_domain?: string;
7717
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
7345
7718
  design_id?: /**
7346
7719
  * Entity ID
7347
7720
  * example:
@@ -7358,6 +7731,14 @@ declare namespace Components {
7358
7731
  */
7359
7732
  allowed_portal_entities?: string[];
7360
7733
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7734
+ /**
7735
+ * Controls behavior of self-registration when account is used as the registration entity
7736
+ */
7737
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
7738
+ /**
7739
+ * Entity type used as the primary identifier for self-registration
7740
+ */
7741
+ self_registration_entity?: "contact" | "account";
7361
7742
  /**
7362
7743
  * Enable or disable user account self management
7363
7744
  * example:
@@ -7735,6 +8116,12 @@ declare namespace Components {
7735
8116
  */
7736
8117
  portal_sk_v3?: string;
7737
8118
  origin?: /* Origin of the portal */ Origin;
8119
+ /**
8120
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
8121
+ */
8122
+ global_blocks?: {
8123
+ [name: string]: Block;
8124
+ };
7738
8125
  pages?: PageRequest[];
7739
8126
  }
7740
8127
  export interface UpsertPortalWidget {
@@ -8027,6 +8414,44 @@ declare namespace Paths {
8027
8414
  }
8028
8415
  }
8029
8416
  }
8417
+ namespace CheckAccountExists {
8418
+ namespace Parameters {
8419
+ export type Domain = string;
8420
+ export type PortalId = /**
8421
+ * ID of the portal
8422
+ * example:
8423
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
8424
+ */
8425
+ Components.Schemas.PortalId;
8426
+ }
8427
+ export interface QueryParameters {
8428
+ portal_id?: Parameters.PortalId;
8429
+ domain?: Parameters.Domain;
8430
+ }
8431
+ export type RequestBody = Components.Schemas.AccountExistsRequest;
8432
+ namespace Responses {
8433
+ export interface $200 {
8434
+ /**
8435
+ * Whether the account exists with the given identifier values
8436
+ * example:
8437
+ * true
8438
+ */
8439
+ exists?: boolean;
8440
+ /**
8441
+ * ID of the account if exists
8442
+ */
8443
+ accountId?: /**
8444
+ * Entity ID
8445
+ * example:
8446
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
8447
+ */
8448
+ Components.Schemas.EntityId /* uuid */;
8449
+ }
8450
+ export type $400 = Components.Responses.InvalidRequest;
8451
+ export type $404 = Components.Responses.NotFound;
8452
+ export type $500 = Components.Responses.InternalServerError;
8453
+ }
8454
+ }
8030
8455
  namespace CheckContactExists {
8031
8456
  namespace Parameters {
8032
8457
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
@@ -8090,6 +8515,15 @@ declare namespace Paths {
8090
8515
  * 5da0a718-c822-403d-9f5d-20d4584e0528
8091
8516
  */
8092
8517
  Components.Schemas.EntityId /* uuid */;
8518
+ /**
8519
+ * ID of the resolved account when the portal is configured for account-based registration
8520
+ */
8521
+ accountId?: /**
8522
+ * Entity ID
8523
+ * example:
8524
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
8525
+ */
8526
+ Components.Schemas.EntityId /* uuid */;
8093
8527
  }
8094
8528
  export type $400 = Components.Responses.InvalidRequest;
8095
8529
  export type $404 = Components.Responses.NotFound;
@@ -10127,6 +10561,13 @@ declare namespace Paths {
10127
10561
  * Mark true if the domain is an Epilot domain
10128
10562
  */
10129
10563
  is_epilot_domain?: boolean;
10564
+ /**
10565
+ * The URL on which the portal is accessible
10566
+ * example:
10567
+ * example-portal-12345.ecp.epilot.cloud
10568
+ */
10569
+ epilot_domain?: string;
10570
+ domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
10130
10571
  design_id?: /**
10131
10572
  * Entity ID
10132
10573
  * example:
@@ -10143,6 +10584,14 @@ declare namespace Paths {
10143
10584
  */
10144
10585
  allowed_portal_entities?: string[];
10145
10586
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
10587
+ /**
10588
+ * Controls behavior of self-registration when account is used as the registration entity
10589
+ */
10590
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
10591
+ /**
10592
+ * Entity type used as the primary identifier for self-registration
10593
+ */
10594
+ self_registration_entity?: "contact" | "account";
10146
10595
  /**
10147
10596
  * Enable or disable user account self management
10148
10597
  * example:
@@ -10523,6 +10972,12 @@ declare namespace Paths {
10523
10972
  pages?: {
10524
10973
  [name: string]: Components.Schemas.Page;
10525
10974
  };
10975
+ /**
10976
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
10977
+ */
10978
+ global_blocks?: {
10979
+ [name: string]: Components.Schemas.Block;
10980
+ };
10526
10981
  /**
10527
10982
  * ID of the organization
10528
10983
  * example:
@@ -10568,7 +11023,28 @@ declare namespace Paths {
10568
11023
  * Permissions granted to a portal user while accessing entities
10569
11024
  */
10570
11025
  grants?: Components.Schemas.Grant[];
10571
- identity_providers?: Components.Schemas.ProviderPublicConfig[];
11026
+ /**
11027
+ * SSO identity providers configured for the portal. Includes raw
11028
+ * `oidc_config.client_secret` values so the admin UI can round-trip
11029
+ * them. Customers are encouraged to reference secrets via env
11030
+ * templates (`{{ env.VAR }}`) rather than embed raw values.
11031
+ *
11032
+ */
11033
+ identity_providers?: /**
11034
+ * SSO identity provider configuration.
11035
+ *
11036
+ * Env var interpolation: only string fields under `oidc_config` and
11037
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
11038
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
11039
+ * get resolved at runtime against the organization's environment.
11040
+ *
11041
+ * The following fields are used as literal values and MUST NOT contain
11042
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
11043
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
11044
+ * token claims), and all keys and values under `entity_matching`.
11045
+ *
11046
+ */
11047
+ Components.Schemas.ProviderConfig[];
10572
11048
  certificate_details?: {
10573
11049
  /**
10574
11050
  * Status of the certificate
@@ -10621,6 +11097,13 @@ declare namespace Paths {
10621
11097
  * Mark true if the domain is an Epilot domain
10622
11098
  */
10623
11099
  is_epilot_domain?: boolean;
11100
+ /**
11101
+ * The URL on which the portal is accessible
11102
+ * example:
11103
+ * example-portal-12345.ecp.epilot.cloud
11104
+ */
11105
+ epilot_domain?: string;
11106
+ domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
10624
11107
  design_id?: /**
10625
11108
  * Entity ID
10626
11109
  * example:
@@ -10637,6 +11120,14 @@ declare namespace Paths {
10637
11120
  */
10638
11121
  allowed_portal_entities?: string[];
10639
11122
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
11123
+ /**
11124
+ * Controls behavior of self-registration when account is used as the registration entity
11125
+ */
11126
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
11127
+ /**
11128
+ * Entity type used as the primary identifier for self-registration
11129
+ */
11130
+ self_registration_entity?: "contact" | "account";
10640
11131
  /**
10641
11132
  * Enable or disable user account self management
10642
11133
  * example:
@@ -11017,6 +11508,12 @@ declare namespace Paths {
11017
11508
  pages?: {
11018
11509
  [name: string]: Components.Schemas.Page;
11019
11510
  };
11511
+ /**
11512
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
11513
+ */
11514
+ global_blocks?: {
11515
+ [name: string]: Components.Schemas.Block;
11516
+ };
11020
11517
  /**
11021
11518
  * ID of the organization
11022
11519
  * example:
@@ -11062,7 +11559,28 @@ declare namespace Paths {
11062
11559
  * Permissions granted to a portal user while accessing entities
11063
11560
  */
11064
11561
  grants?: Components.Schemas.Grant[];
11065
- identity_providers?: Components.Schemas.ProviderPublicConfig[];
11562
+ /**
11563
+ * SSO identity providers configured for the portal. Includes raw
11564
+ * `oidc_config.client_secret` values so the admin UI can round-trip
11565
+ * them. Customers are encouraged to reference secrets via env
11566
+ * templates (`{{ env.VAR }}`) rather than embed raw values.
11567
+ *
11568
+ */
11569
+ identity_providers?: /**
11570
+ * SSO identity provider configuration.
11571
+ *
11572
+ * Env var interpolation: only string fields under `oidc_config` and
11573
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
11574
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
11575
+ * get resolved at runtime against the organization's environment.
11576
+ *
11577
+ * The following fields are used as literal values and MUST NOT contain
11578
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
11579
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
11580
+ * token claims), and all keys and values under `entity_matching`.
11581
+ *
11582
+ */
11583
+ Components.Schemas.ProviderConfig[];
11066
11584
  certificate_details?: {
11067
11585
  /**
11068
11586
  * Status of the certificate
@@ -11925,6 +12443,48 @@ declare namespace Paths {
11925
12443
  export type $500 = Components.Responses.InternalServerError;
11926
12444
  }
11927
12445
  }
12446
+ namespace GetSSOProvider {
12447
+ namespace Parameters {
12448
+ export type Domain = string;
12449
+ /**
12450
+ * example:
12451
+ * 123
12452
+ */
12453
+ export type OrgId = string;
12454
+ export type Origin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
12455
+ export type PortalId = /**
12456
+ * ID of the portal
12457
+ * example:
12458
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
12459
+ */
12460
+ Components.Schemas.PortalId;
12461
+ export type ProviderSlug = /**
12462
+ * URL-friendly slug to use as organization-unique identifier for Provider
12463
+ * example:
12464
+ * office-365-login
12465
+ */
12466
+ Components.Schemas.ProviderSlug /* [0-9a-z-]+ */;
12467
+ }
12468
+ export interface PathParameters {
12469
+ provider_slug: Parameters.ProviderSlug;
12470
+ }
12471
+ export interface QueryParameters {
12472
+ org_id?: /**
12473
+ * example:
12474
+ * 123
12475
+ */
12476
+ Parameters.OrgId;
12477
+ origin?: Parameters.Origin;
12478
+ portal_id?: Parameters.PortalId;
12479
+ domain?: Parameters.Domain;
12480
+ }
12481
+ namespace Responses {
12482
+ export type $200 = Components.Schemas.ProviderPublicConfig;
12483
+ export type $400 = Components.Responses.InvalidRequest;
12484
+ export type $404 = Components.Responses.NotFound;
12485
+ export type $500 = Components.Responses.InternalServerError;
12486
+ }
12487
+ }
11928
12488
  namespace GetSchemas {
11929
12489
  namespace Responses {
11930
12490
  export interface $200 {
@@ -12339,6 +12899,42 @@ declare namespace Paths {
12339
12899
  export type $500 = Components.Responses.InternalServerError;
12340
12900
  }
12341
12901
  }
12902
+ namespace PortalProxyExecute {
12903
+ export interface RequestBody {
12904
+ /**
12905
+ * Integration ID containing the managed-call use case
12906
+ */
12907
+ integration_id: string; // uuid
12908
+ /**
12909
+ * Use case slug (acts as the RPC method name)
12910
+ */
12911
+ use_case_slug: string;
12912
+ /**
12913
+ * Input data for the managed-call operation
12914
+ */
12915
+ payload?: {
12916
+ [name: string]: any;
12917
+ };
12918
+ }
12919
+ namespace Responses {
12920
+ export interface $200 {
12921
+ success: boolean;
12922
+ /**
12923
+ * Managed-call response payload. Shape is defined by the use
12924
+ * case's JSONata response_mapping; if no mapping is
12925
+ * configured the raw external API response is returned.
12926
+ *
12927
+ */
12928
+ data?: {
12929
+ [name: string]: any;
12930
+ };
12931
+ }
12932
+ export type $400 = Components.Responses.InvalidRequest;
12933
+ export type $401 = Components.Responses.Unauthorized;
12934
+ export type $403 = Components.Responses.Forbidden;
12935
+ export type $500 = Components.Responses.InternalServerError;
12936
+ }
12937
+ }
12342
12938
  namespace PostOrderAcceptance {
12343
12939
  namespace Parameters {
12344
12940
  export type Id = /**
@@ -13697,6 +14293,34 @@ declare namespace Paths {
13697
14293
  export type $500 = Components.Responses.InternalServerError;
13698
14294
  }
13699
14295
  }
14296
+ namespace VerifyDns {
14297
+ namespace Parameters {
14298
+ export type PortalId = /**
14299
+ * ID of the portal
14300
+ * example:
14301
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
14302
+ */
14303
+ Components.Schemas.PortalId;
14304
+ }
14305
+ export interface QueryParameters {
14306
+ portal_id: Parameters.PortalId;
14307
+ }
14308
+ namespace Responses {
14309
+ export interface $200 {
14310
+ /**
14311
+ * The status of the custom domain verification
14312
+ */
14313
+ domain_status?: "PENDING" | "SUCCEED";
14314
+ /**
14315
+ * A message describing the result
14316
+ */
14317
+ message?: string;
14318
+ }
14319
+ export type $401 = Components.Responses.Unauthorized;
14320
+ export type $403 = Components.Responses.Forbidden;
14321
+ export type $500 = Components.Responses.InternalServerError;
14322
+ }
14323
+ }
13700
14324
  }
13701
14325
 
13702
14326
 
@@ -14243,6 +14867,20 @@ interface OperationMethods {
14243
14867
  data?: Paths.CheckContactExistsV3.RequestBody,
14244
14868
  config?: AxiosRequestConfig
14245
14869
  ): OperationResponse<Paths.CheckContactExistsV3.Responses.$200>
14870
+ /**
14871
+ * checkAccountExists - checkAccountExists
14872
+ *
14873
+ * True if account with given identifiers exists.
14874
+ * Supports two identification methods:
14875
+ * 1. Using portal_id
14876
+ * 2. Using domain
14877
+ *
14878
+ */
14879
+ 'checkAccountExists'(
14880
+ parameters?: Parameters<Paths.CheckAccountExists.QueryParameters> | null,
14881
+ data?: Paths.CheckAccountExists.RequestBody,
14882
+ config?: AxiosRequestConfig
14883
+ ): OperationResponse<Paths.CheckAccountExists.Responses.$200>
14246
14884
  /**
14247
14885
  * getValidSecondaryAttributes - getValidSecondaryAttributes
14248
14886
  *
@@ -14835,6 +15473,28 @@ interface OperationMethods {
14835
15473
  data?: Paths.GetMeterReadings.RequestBody,
14836
15474
  config?: AxiosRequestConfig
14837
15475
  ): OperationResponse<Paths.GetMeterReadings.Responses.$200>
15476
+ /**
15477
+ * getSSOProvider - getSSOProvider
15478
+ *
15479
+ * Returns the public configuration of a single SSO identity provider with env var
15480
+ * placeholders (incl. secrets) already resolved against the organization's environment.
15481
+ *
15482
+ * Use this endpoint at SSO initiation time (i.e. when the end user clicks "Sign in with X")
15483
+ * to obtain the resolved OIDC settings needed to construct the authorization URL.
15484
+ * The web `client_secret` is intentionally never returned — it is used server-side by
15485
+ * the SSO callback to exchange the authorization code for tokens.
15486
+ *
15487
+ * Supports three identification methods:
15488
+ * 1. `org_id` + `origin`
15489
+ * 2. `org_id` + `portal_id`
15490
+ * 3. `domain`
15491
+ *
15492
+ */
15493
+ 'getSSOProvider'(
15494
+ parameters?: Parameters<Paths.GetSSOProvider.QueryParameters & Paths.GetSSOProvider.PathParameters> | null,
15495
+ data?: any,
15496
+ config?: AxiosRequestConfig
15497
+ ): OperationResponse<Paths.GetSSOProvider.Responses.$200>
14838
15498
  /**
14839
15499
  * ssoLogin - ssoLogin
14840
15500
  *
@@ -15203,6 +15863,28 @@ interface OperationMethods {
15203
15863
  data?: any,
15204
15864
  config?: AxiosRequestConfig
15205
15865
  ): OperationResponse<Paths.EnablePartner.Responses.$200>
15866
+ /**
15867
+ * verifyDns - verifyDns
15868
+ *
15869
+ * Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
15870
+ */
15871
+ 'verifyDns'(
15872
+ parameters?: Parameters<Paths.VerifyDns.QueryParameters> | null,
15873
+ data?: any,
15874
+ config?: AxiosRequestConfig
15875
+ ): OperationResponse<Paths.VerifyDns.Responses.$200>
15876
+ /**
15877
+ * portalProxyExecute - portalProxyExecute
15878
+ *
15879
+ * Execute an Integration Hub managed-call use case on behalf of a portal user.
15880
+ * Bridges PortalAuth to the Integration API by generating an internal token.
15881
+ *
15882
+ */
15883
+ 'portalProxyExecute'(
15884
+ parameters?: Parameters<UnknownParamsObject> | null,
15885
+ data?: Paths.PortalProxyExecute.RequestBody,
15886
+ config?: AxiosRequestConfig
15887
+ ): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
15206
15888
  }
15207
15889
 
15208
15890
  interface PathsDictionary {
@@ -15840,6 +16522,22 @@ interface PathsDictionary {
15840
16522
  config?: AxiosRequestConfig
15841
16523
  ): OperationResponse<Paths.CheckContactExistsV3.Responses.$200>
15842
16524
  }
16525
+ ['/v3/portal/public/account/exists']: {
16526
+ /**
16527
+ * checkAccountExists - checkAccountExists
16528
+ *
16529
+ * True if account with given identifiers exists.
16530
+ * Supports two identification methods:
16531
+ * 1. Using portal_id
16532
+ * 2. Using domain
16533
+ *
16534
+ */
16535
+ 'post'(
16536
+ parameters?: Parameters<Paths.CheckAccountExists.QueryParameters> | null,
16537
+ data?: Paths.CheckAccountExists.RequestBody,
16538
+ config?: AxiosRequestConfig
16539
+ ): OperationResponse<Paths.CheckAccountExists.Responses.$200>
16540
+ }
15843
16541
  ['/v2/portal/contact/valid/secondary/attributes']: {
15844
16542
  /**
15845
16543
  * getValidSecondaryAttributes - getValidSecondaryAttributes
@@ -16534,6 +17232,30 @@ interface PathsDictionary {
16534
17232
  config?: AxiosRequestConfig
16535
17233
  ): OperationResponse<Paths.GetMeterReadings.Responses.$200>
16536
17234
  }
17235
+ ['/v2/portal/public/sso/providers/{provider_slug}']: {
17236
+ /**
17237
+ * getSSOProvider - getSSOProvider
17238
+ *
17239
+ * Returns the public configuration of a single SSO identity provider with env var
17240
+ * placeholders (incl. secrets) already resolved against the organization's environment.
17241
+ *
17242
+ * Use this endpoint at SSO initiation time (i.e. when the end user clicks "Sign in with X")
17243
+ * to obtain the resolved OIDC settings needed to construct the authorization URL.
17244
+ * The web `client_secret` is intentionally never returned — it is used server-side by
17245
+ * the SSO callback to exchange the authorization code for tokens.
17246
+ *
17247
+ * Supports three identification methods:
17248
+ * 1. `org_id` + `origin`
17249
+ * 2. `org_id` + `portal_id`
17250
+ * 3. `domain`
17251
+ *
17252
+ */
17253
+ 'get'(
17254
+ parameters?: Parameters<Paths.GetSSOProvider.QueryParameters & Paths.GetSSOProvider.PathParameters> | null,
17255
+ data?: any,
17256
+ config?: AxiosRequestConfig
17257
+ ): OperationResponse<Paths.GetSSOProvider.Responses.$200>
17258
+ }
16537
17259
  ['/v2/portal/public/sso/login']: {
16538
17260
  /**
16539
17261
  * ssoLogin - ssoLogin
@@ -16956,12 +17678,39 @@ interface PathsDictionary {
16956
17678
  config?: AxiosRequestConfig
16957
17679
  ): OperationResponse<Paths.EnablePartner.Responses.$200>
16958
17680
  }
17681
+ ['/v3/portal/verify-dns']: {
17682
+ /**
17683
+ * verifyDns - verifyDns
17684
+ *
17685
+ * Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
17686
+ */
17687
+ 'post'(
17688
+ parameters?: Parameters<Paths.VerifyDns.QueryParameters> | null,
17689
+ data?: any,
17690
+ config?: AxiosRequestConfig
17691
+ ): OperationResponse<Paths.VerifyDns.Responses.$200>
17692
+ }
17693
+ ['/v2/portal/proxy/execute']: {
17694
+ /**
17695
+ * portalProxyExecute - portalProxyExecute
17696
+ *
17697
+ * Execute an Integration Hub managed-call use case on behalf of a portal user.
17698
+ * Bridges PortalAuth to the Integration API by generating an internal token.
17699
+ *
17700
+ */
17701
+ 'post'(
17702
+ parameters?: Parameters<UnknownParamsObject> | null,
17703
+ data?: Paths.PortalProxyExecute.RequestBody,
17704
+ config?: AxiosRequestConfig
17705
+ ): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
17706
+ }
16959
17707
  }
16960
17708
 
16961
17709
  type Client = OpenAPIClient<OperationMethods, PathsDictionary>
16962
17710
 
16963
17711
 
16964
17712
  type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
17713
+ type AccountExistsRequest = Components.Schemas.AccountExistsRequest;
16965
17714
  type ActionLabel = Components.Schemas.ActionLabel;
16966
17715
  type ActionWidget = Components.Schemas.ActionWidget;
16967
17716
  type Activity = Components.Schemas.Activity;
@@ -17000,6 +17749,7 @@ type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
17000
17749
  type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
17001
17750
  type Direction = Components.Schemas.Direction;
17002
17751
  type DocumentWidget = Components.Schemas.DocumentWidget;
17752
+ type DomainSettings = Components.Schemas.DomainSettings;
17003
17753
  type EmailTemplates = Components.Schemas.EmailTemplates;
17004
17754
  type Entity = Components.Schemas.Entity;
17005
17755
  type EntityEditRule = Components.Schemas.EntityEditRule;
@@ -17110,4 +17860,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
17110
17860
  type WorkflowExecution = Components.Schemas.WorkflowExecution;
17111
17861
  type WorkflowStep = Components.Schemas.WorkflowStep;
17112
17862
 
17113
- export { type EntityResponseGroupedWithHits as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type ContactCountRequest as D, type ContactExistsRequest as E, type ContentWidget as F, type ContextEntities as G, type ContextEntity as H, type Contract as I, type ContractIdentifier as J, type CreateUserRequest as K, type Currency as L, type DataRetrievalItem as M, DeleteEntityFile as N, type OperationMethods as O, Paths as P, type Direction as Q, type DocumentWidget as R, type EmailTemplates as S, type Entity as T, type EntityEditRule as U, type EntityFileCount as V, type EntityGetParams as W, type EntityId as X, type EntityItem as Y, type EntityMatchingConfig as Z, type EntityResponse as _, Components as a, type PublicExtensionCapabilities as a$, type EntityResponseWithHits as a0, type EntitySearchParams as a1, type EntitySlug as a2, type EntitySlugConfig as a3, type EntityTemplates as a4, type EntityWidget as a5, type ErrorResp as a6, type Exists as a7, type Extension as a8, type ExtensionAuthBlock as a9, type MeterReadingPhotoData as aA, type MeterReadingWidget as aB, type MoblieOIDCConfig as aC, type OIDCProviderConfig as aD, type OIDCProviderMetadata as aE, type Opportunity as aF, type Order as aG, type OrganizationSettings as aH, type Origin as aI, type Page as aJ, type PageRequest as aK, type PaymentWidget as aL, type PortalConfig as aM, type PortalConfigV3 as aN, type PortalId as aO, type PortalUser as aP, type PortalUserRegistrationStatus as aQ, type PortalWidget as aR, type Product as aS, type ProductRecommendationsWidget as aT, type ProviderConfig as aU, type ProviderDisplayName as aV, type ProviderPublicConfig as aW, type ProviderSlug as aX, type PublicAppDetails as aY, type PublicContractIdentificationDetails as aZ, type PublicDataRetrievalHookDetails as a_, type ExtensionConfig as aa, type ExtensionHook as ab, type ExtensionHookConsumptionDataRetrieval as ac, type ExtensionHookContractIdentification as ad, type ExtensionHookCostDataRetrieval as ae, type ExtensionHookDataExport as af, type ExtensionHookMeterReadingPlausibilityCheck as ag, type ExtensionHookPriceDataRetrieval as ah, type ExtensionHookRegistrationIdentifiersCheck as ai, type ExtensionHookSelection as aj, type ExtensionHookVisualizationMetadata as ak, type ExtensionSeamlessLink as al, type ExternalLink as am, type ExtraSchemaAttributes as an, type FailedRuleErrorResp as ao, type File as ap, type FileItem as aq, type Grant as ar, type IdentifierAttribute as as, type InstallmentEvent as at, type JourneyActions as au, type JuiceSettings as av, type Meter as aw, type MeterChartWidget as ax, type MeterReading as ay, type MeterReadingPhoto as az, type PathsDictionary as b, type PublicExtensionDetails as b0, type PublicMeterReadingPlausibilityCheckDetails as b1, type ReadBy as b2, type ReadingStatus as b3, type Reason as b4, type RegistrationIdentifier as b5, type ReimbursementEvent as b6, type Rule as b7, type SAMLProviderConfig as b8, type SSOCallbackRequest as b9, type SSOCallbackResponse as ba, type SSOLoginToken as bb, SaveEntityFile as bc, type SavePortalFile as bd, type Schema as be, type SearchIncludes as bf, type SecureProxyConfig as bg, type Source as bh, type SwappableConfig as bi, type TariffType as bj, type TeaserWidget as bk, type TriggerPortalFlow as bl, type UpdateOnlyPortalConfigAttributes as bm, type UpsertPortalConfig as bn, type UpsertPortalConfigV3 as bo, UpsertPortalWidget as bp, type UserRequest as bq, type VisualizationDataRange as br, type VisualizationMetadata as bs, type VisualizationTypeOption as bt, type WidgetAction as bu, type WidgetBase as bv, type WorfklowIdentifier as bw, type WorkflowExecution as bx, type WorkflowStep as by, type ActionLabel as c, type ActionWidget as d, type Activity as e, type ActivityCallerContext as f, type ActivityId as g, type ActivityItem as h, type AdminUser as i, type AllowedFileExtensions as j, type AttributeMappingConfig as k, type AuthConfig as l, type BaseBillingEvent as m, type BaseEntity as n, type BillingAccount as o, type BillingEvent as p, type Block as q, type BlockId as r, type BlockProps as s, type BlockRequest as t, type BlockType as u, type BusinessPartnerItem as v, type CampaignWidget as w, type CommonConfigAttributes as x, type CommonConfigAttributesV3 as y, type Contact as z };
17863
+ export { type EntityMatchingConfig as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type Contact as D, type ContactCountRequest as E, type ContactExistsRequest as F, type ContentWidget as G, type ContextEntities as H, type ContextEntity as I, type Contract as J, type ContractIdentifier as K, type CreateUserRequest as L, type Currency as M, type DataRetrievalItem as N, type OperationMethods as O, Paths as P, DeleteEntityFile as Q, type Direction as R, type DocumentWidget as S, type DomainSettings as T, type EmailTemplates as U, type Entity as V, type EntityEditRule as W, type EntityFileCount as X, type EntityGetParams as Y, type EntityId as Z, type EntityItem as _, Components as a, type PublicContractIdentificationDetails as a$, type EntityResponse as a0, type EntityResponseGroupedWithHits as a1, type EntityResponseWithHits as a2, type EntitySearchParams as a3, type EntitySlug as a4, type EntitySlugConfig as a5, type EntityTemplates as a6, type EntityWidget as a7, type ErrorResp as a8, type Exists as a9, type MeterReading as aA, type MeterReadingPhoto as aB, type MeterReadingPhotoData as aC, type MeterReadingWidget as aD, type MoblieOIDCConfig as aE, type OIDCProviderConfig as aF, type OIDCProviderMetadata as aG, type Opportunity as aH, type Order as aI, type OrganizationSettings as aJ, type Origin as aK, type Page as aL, type PageRequest as aM, type PaymentWidget as aN, type PortalConfig as aO, type PortalConfigV3 as aP, type PortalId as aQ, type PortalUser as aR, type PortalUserRegistrationStatus as aS, type PortalWidget as aT, type Product as aU, type ProductRecommendationsWidget as aV, type ProviderConfig as aW, type ProviderDisplayName as aX, type ProviderPublicConfig as aY, type ProviderSlug as aZ, type PublicAppDetails as a_, type Extension as aa, type ExtensionAuthBlock as ab, type ExtensionConfig as ac, type ExtensionHook as ad, type ExtensionHookConsumptionDataRetrieval as ae, type ExtensionHookContractIdentification as af, type ExtensionHookCostDataRetrieval as ag, type ExtensionHookDataExport as ah, type ExtensionHookMeterReadingPlausibilityCheck as ai, type ExtensionHookPriceDataRetrieval as aj, type ExtensionHookRegistrationIdentifiersCheck as ak, type ExtensionHookSelection as al, type ExtensionHookVisualizationMetadata as am, type ExtensionSeamlessLink as an, type ExternalLink as ao, type ExtraSchemaAttributes as ap, type FailedRuleErrorResp as aq, type File as ar, type FileItem as as, type Grant as at, type IdentifierAttribute as au, type InstallmentEvent as av, type JourneyActions as aw, type JuiceSettings as ax, type Meter as ay, type MeterChartWidget as az, type PathsDictionary as b, type PublicDataRetrievalHookDetails as b0, type PublicExtensionCapabilities as b1, type PublicExtensionDetails as b2, type PublicMeterReadingPlausibilityCheckDetails as b3, type ReadBy as b4, type ReadingStatus as b5, type Reason as b6, type RegistrationIdentifier as b7, type ReimbursementEvent as b8, type Rule as b9, type WorkflowStep as bA, type SAMLProviderConfig as ba, type SSOCallbackRequest as bb, type SSOCallbackResponse as bc, type SSOLoginToken as bd, SaveEntityFile as be, type SavePortalFile as bf, type Schema as bg, type SearchIncludes as bh, type SecureProxyConfig as bi, type Source as bj, type SwappableConfig as bk, type TariffType as bl, type TeaserWidget as bm, type TriggerPortalFlow as bn, type UpdateOnlyPortalConfigAttributes as bo, type UpsertPortalConfig as bp, type UpsertPortalConfigV3 as bq, UpsertPortalWidget as br, type UserRequest as bs, type VisualizationDataRange as bt, type VisualizationMetadata as bu, type VisualizationTypeOption as bv, type WidgetAction as bw, type WidgetBase as bx, type WorfklowIdentifier as by, type WorkflowExecution as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdminUser as j, type AllowedFileExtensions as k, type AttributeMappingConfig as l, type AuthConfig as m, type BaseBillingEvent as n, type BaseEntity as o, type BillingAccount as p, type BillingEvent as q, type Block as r, type BlockId as s, type BlockProps as t, type BlockRequest as u, type BlockType as v, type BusinessPartnerItem as w, type CampaignWidget as x, type CommonConfigAttributes as y, type CommonConfigAttributesV3 as z };