@epilot/sdk 2.0.0-beta.6 → 2.0.3

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 (134) hide show
  1. package/LICENSE +21 -0
  2. package/dist/apis/automation.d.cts +2 -2
  3. package/dist/apis/automation.d.ts +2 -2
  4. package/dist/apis/customer-portal.cjs +1 -1
  5. package/dist/apis/customer-portal.d.cts +2 -2
  6. package/dist/apis/customer-portal.d.ts +2 -2
  7. package/dist/apis/customer-portal.js +1 -1
  8. package/dist/apis/erp-integration.cjs +1 -1
  9. package/dist/apis/erp-integration.d.cts +2 -2
  10. package/dist/apis/erp-integration.d.ts +2 -2
  11. package/dist/apis/erp-integration.js +1 -1
  12. package/dist/apis/journey.d.cts +2 -2
  13. package/dist/apis/journey.d.ts +2 -2
  14. package/dist/apis/kanban.d.cts +2 -2
  15. package/dist/apis/kanban.d.ts +2 -2
  16. package/dist/apis/organization.cjs +1 -1
  17. package/dist/apis/organization.d.cts +2 -2
  18. package/dist/apis/organization.d.ts +2 -2
  19. package/dist/apis/organization.js +1 -1
  20. package/dist/apis/workflow.d.cts +2 -2
  21. package/dist/apis/workflow.d.ts +2 -2
  22. package/dist/{automation.d-sRCRiHKf.d.cts → automation.d-KOiZ6ru5.d.cts} +2 -24
  23. package/dist/{automation.d-sRCRiHKf.d.ts → automation.d-KOiZ6ru5.d.ts} +2 -24
  24. package/dist/{customer-portal.d-D7cJvhBK.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
  25. package/dist/{customer-portal.d-D7cJvhBK.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
  26. package/dist/{erp-integration.d-3LmxMirP.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
  27. package/dist/{erp-integration.d-3LmxMirP.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
  28. package/dist/index.d.cts +7 -7
  29. package/dist/index.d.ts +7 -7
  30. package/dist/{journey.d-DkBvO_Wa.d.ts → journey.d-C4N4t1Rh.d.cts} +122 -4
  31. package/dist/{journey.d-DkBvO_Wa.d.cts → journey.d-C4N4t1Rh.d.ts} +122 -4
  32. package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
  33. package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
  34. package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
  35. package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
  36. package/dist/{workflow.d-EPa2OdVW.d.cts → workflow.d-DvhTpEtU.d.cts} +45 -3
  37. package/dist/{workflow.d-EPa2OdVW.d.ts → workflow.d-DvhTpEtU.d.ts} +45 -3
  38. package/package.json +10 -11
  39. package/definitions/access-token-runtime.json +0 -1
  40. package/definitions/access-token.json +0 -663
  41. package/definitions/address-runtime.json +0 -1
  42. package/definitions/address-suggestions-runtime.json +0 -1
  43. package/definitions/address-suggestions.json +0 -582
  44. package/definitions/address.json +0 -578
  45. package/definitions/ai-agents-runtime.json +0 -1
  46. package/definitions/ai-agents.json +0 -1711
  47. package/definitions/app-runtime.json +0 -1
  48. package/definitions/app.json +0 -4443
  49. package/definitions/audit-logs-runtime.json +0 -1
  50. package/definitions/audit-logs.json +0 -305
  51. package/definitions/automation-runtime.json +0 -1
  52. package/definitions/automation.json +0 -4850
  53. package/definitions/billing-runtime.json +0 -1
  54. package/definitions/billing.json +0 -837
  55. package/definitions/blueprint-manifest-runtime.json +0 -1
  56. package/definitions/blueprint-manifest.json +0 -3376
  57. package/definitions/consent-runtime.json +0 -1
  58. package/definitions/consent.json +0 -344
  59. package/definitions/customer-portal-runtime.json +0 -1
  60. package/definitions/customer-portal.json +0 -15000
  61. package/definitions/dashboard-runtime.json +0 -1
  62. package/definitions/dashboard.json +0 -484
  63. package/definitions/data-management-runtime.json +0 -1
  64. package/definitions/data-management.json +0 -962
  65. package/definitions/deduplication-runtime.json +0 -1
  66. package/definitions/deduplication.json +0 -183
  67. package/definitions/design-runtime.json +0 -1
  68. package/definitions/design.json +0 -1423
  69. package/definitions/document-runtime.json +0 -1
  70. package/definitions/document.json +0 -758
  71. package/definitions/email-settings-runtime.json +0 -1
  72. package/definitions/email-settings.json +0 -2627
  73. package/definitions/email-template-runtime.json +0 -1
  74. package/definitions/email-template.json +0 -1419
  75. package/definitions/entity-mapping-runtime.json +0 -1
  76. package/definitions/entity-mapping.json +0 -1642
  77. package/definitions/entity-runtime.json +0 -1
  78. package/definitions/entity.json +0 -10074
  79. package/definitions/environments-runtime.json +0 -1
  80. package/definitions/environments.json +0 -363
  81. package/definitions/erp-integration-runtime.json +0 -1
  82. package/definitions/erp-integration.json +0 -5845
  83. package/definitions/event-catalog-runtime.json +0 -1
  84. package/definitions/event-catalog.json +0 -1051
  85. package/definitions/file-runtime.json +0 -1
  86. package/definitions/file.json +0 -2842
  87. package/definitions/iban-runtime.json +0 -1
  88. package/definitions/iban.json +0 -132
  89. package/definitions/journey-runtime.json +0 -1
  90. package/definitions/journey.json +0 -2341
  91. package/definitions/kanban-runtime.json +0 -1
  92. package/definitions/kanban.json +0 -929
  93. package/definitions/message-runtime.json +0 -1
  94. package/definitions/message.json +0 -2660
  95. package/definitions/metering-runtime.json +0 -1
  96. package/definitions/metering.json +0 -2321
  97. package/definitions/notes-runtime.json +0 -1
  98. package/definitions/notes.json +0 -1531
  99. package/definitions/notification-runtime.json +0 -1
  100. package/definitions/notification.json +0 -1425
  101. package/definitions/organization-runtime.json +0 -1
  102. package/definitions/organization.json +0 -629
  103. package/definitions/partner-directory-runtime.json +0 -1
  104. package/definitions/partner-directory.json +0 -1718
  105. package/definitions/permissions-runtime.json +0 -1
  106. package/definitions/permissions.json +0 -1480
  107. package/definitions/pricing-runtime.json +0 -1
  108. package/definitions/pricing-tier-runtime.json +0 -1
  109. package/definitions/pricing-tier.json +0 -105
  110. package/definitions/pricing.json +0 -9884
  111. package/definitions/purpose-runtime.json +0 -1
  112. package/definitions/purpose.json +0 -524
  113. package/definitions/sandbox-runtime.json +0 -1
  114. package/definitions/sandbox.json +0 -453
  115. package/definitions/submission-runtime.json +0 -1
  116. package/definitions/submission.json +0 -313
  117. package/definitions/targeting-runtime.json +0 -1
  118. package/definitions/targeting.json +0 -1474
  119. package/definitions/template-variables-runtime.json +0 -1
  120. package/definitions/template-variables.json +0 -1408
  121. package/definitions/user-runtime.json +0 -1
  122. package/definitions/user.json +0 -2408
  123. package/definitions/validation-rules-runtime.json +0 -1
  124. package/definitions/validation-rules.json +0 -1491
  125. package/definitions/webhooks-runtime.json +0 -1
  126. package/definitions/webhooks.json +0 -1525
  127. package/definitions/workflow-definition-runtime.json +0 -1
  128. package/definitions/workflow-definition.json +0 -3417
  129. package/definitions/workflow-runtime.json +0 -1
  130. package/definitions/workflow.json +0 -4106
  131. package/dist/kanban.d-DUClxyBG.d.cts +0 -630
  132. package/dist/kanban.d-DUClxyBG.d.ts +0 -630
  133. package/dist/organization.d-BOLK3v9o.d.cts +0 -628
  134. package/dist/organization.d-BOLK3v9o.d.ts +0 -628
@@ -1,8 +1,6 @@
1
1
  import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
2
 
3
3
  /* Auto-copied from customer-portal-client */
4
- /* eslint-disable */
5
-
6
4
 
7
5
 
8
6
  declare namespace Components {
@@ -54,7 +52,7 @@ declare namespace Components {
54
52
  }
55
53
  export interface ActionWidget {
56
54
  id: string;
57
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
55
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
58
56
  /**
59
57
  * Index of the widget in the list, used for ordering (left or right)
60
58
  */
@@ -777,7 +775,7 @@ declare namespace Components {
777
775
  }
778
776
  export interface CampaignWidget {
779
777
  id: string;
780
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
778
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
781
779
  /**
782
780
  * Index of the widget in the list, used for ordering (left or right)
783
781
  */
@@ -824,13 +822,6 @@ declare namespace Components {
824
822
  * Mark true if the domain is an Epilot domain
825
823
  */
826
824
  is_epilot_domain?: boolean;
827
- /**
828
- * The URL on which the portal is accessible
829
- * example:
830
- * example-portal-12345.ecp.epilot.cloud
831
- */
832
- epilot_domain?: string;
833
- domain_settings?: /* Domain settings for the portal */ DomainSettings;
834
825
  /**
835
826
  * ID of the design used to build the portal
836
827
  */
@@ -840,6 +831,15 @@ declare namespace Components {
840
831
  * 5da0a718-c822-403d-9f5d-20d4584e0528
841
832
  */
842
833
  EntityId /* uuid */;
834
+ /**
835
+ * Allowed portal entities for the portal
836
+ * example:
837
+ * [
838
+ * "contact",
839
+ * "contract"
840
+ * ]
841
+ */
842
+ allowed_portal_entities?: string[];
843
843
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
844
844
  /**
845
845
  * Enable or disable user account self management
@@ -922,6 +922,52 @@ declare namespace Components {
922
922
  * eu-central-1_CUEQRNbUb
923
923
  */
924
924
  cognito_user_pool_id?: string;
925
+ /**
926
+ * Timeouts for the cognito tokens
927
+ */
928
+ timeouts?: {
929
+ /**
930
+ * Timeout for the refresh token
931
+ * example:
932
+ * 300
933
+ */
934
+ refresh_token?: number;
935
+ /**
936
+ * Timeout for the access token
937
+ * example:
938
+ * 300
939
+ */
940
+ access_token?: number;
941
+ /**
942
+ * Timeout for the id token
943
+ * example:
944
+ * 300
945
+ */
946
+ id_token?: number;
947
+ };
948
+ /**
949
+ * Advanced authentication settings for the portal
950
+ */
951
+ advanced_authentication?: {
952
+ /**
953
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
954
+ * example:
955
+ * true
956
+ */
957
+ user_activity_logging?: boolean;
958
+ /**
959
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
960
+ * example:
961
+ * true
962
+ */
963
+ adaptive_authentication?: boolean;
964
+ /**
965
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
966
+ * example:
967
+ * true
968
+ */
969
+ compromised_credentials_detection?: boolean;
970
+ };
925
971
  /**
926
972
  * Password policy for the portal
927
973
  */
@@ -1197,13 +1243,6 @@ declare namespace Components {
1197
1243
  * Mark true if the domain is an Epilot domain
1198
1244
  */
1199
1245
  is_epilot_domain?: boolean;
1200
- /**
1201
- * The Epilot domain on which the portal is accessible
1202
- * example:
1203
- * example-portal-1.ecp.epilot.io
1204
- */
1205
- epilot_domain?: string;
1206
- domain_settings?: /* Domain settings for the portal */ DomainSettings;
1207
1246
  /**
1208
1247
  * ID of the design used to build the portal
1209
1248
  */
@@ -1213,6 +1252,15 @@ declare namespace Components {
1213
1252
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1214
1253
  */
1215
1254
  EntityId /* uuid */;
1255
+ /**
1256
+ * Allowed portal entities for the portal
1257
+ * example:
1258
+ * [
1259
+ * "contact",
1260
+ * "contract"
1261
+ * ]
1262
+ */
1263
+ allowed_portal_entities?: string[];
1216
1264
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
1217
1265
  /**
1218
1266
  * Enable or disable user account self management
@@ -1295,6 +1343,52 @@ declare namespace Components {
1295
1343
  * eu-central-1_CUEQRNbUb
1296
1344
  */
1297
1345
  cognito_user_pool_id?: string;
1346
+ /**
1347
+ * Timeouts for the cognito tokens
1348
+ */
1349
+ timeouts?: {
1350
+ /**
1351
+ * Timeout for the refresh token
1352
+ * example:
1353
+ * 300
1354
+ */
1355
+ refresh_token?: number;
1356
+ /**
1357
+ * Timeout for the access token
1358
+ * example:
1359
+ * 300
1360
+ */
1361
+ access_token?: number;
1362
+ /**
1363
+ * Timeout for the id token
1364
+ * example:
1365
+ * 300
1366
+ */
1367
+ id_token?: number;
1368
+ };
1369
+ /**
1370
+ * Advanced authentication settings for the portal
1371
+ */
1372
+ advanced_authentication?: {
1373
+ /**
1374
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
1375
+ * example:
1376
+ * true
1377
+ */
1378
+ user_activity_logging?: boolean;
1379
+ /**
1380
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
1381
+ * example:
1382
+ * true
1383
+ */
1384
+ adaptive_authentication?: boolean;
1385
+ /**
1386
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
1387
+ * example:
1388
+ * true
1389
+ */
1390
+ compromised_credentials_detection?: boolean;
1391
+ };
1298
1392
  /**
1299
1393
  * Password policy for the portal
1300
1394
  */
@@ -1633,7 +1727,7 @@ declare namespace Components {
1633
1727
  }
1634
1728
  export interface ContentWidget {
1635
1729
  id: string;
1636
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
1730
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
1637
1731
  /**
1638
1732
  * Index of the widget in the list, used for ordering (left or right)
1639
1733
  */
@@ -1974,7 +2068,7 @@ declare namespace Components {
1974
2068
  export type Direction = "feed-in" | "feed-out";
1975
2069
  export interface DocumentWidget {
1976
2070
  id: string;
1977
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
2071
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
1978
2072
  /**
1979
2073
  * Index of the widget in the list, used for ordering (left or right)
1980
2074
  */
@@ -1988,23 +2082,6 @@ declare namespace Components {
1988
2082
  de?: string;
1989
2083
  };
1990
2084
  }
1991
- /**
1992
- * Domain settings for the portal
1993
- */
1994
- export interface DomainSettings {
1995
- /**
1996
- * Whether the custom domain is enabled
1997
- */
1998
- is_custom_domain_enabled?: boolean;
1999
- /**
2000
- * Whether the Epilot domain is enabled
2001
- */
2002
- is_epilot_domain_enabled?: boolean;
2003
- /**
2004
- * Whether the redirection is enabled
2005
- */
2006
- is_redirection_enabled?: boolean;
2007
- }
2008
2085
  /**
2009
2086
  * Email templates used for authentication and internal processes
2010
2087
  */
@@ -2470,6 +2547,7 @@ declare namespace Components {
2470
2547
  * 5
2471
2548
  */
2472
2549
  hits?: number;
2550
+ includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
2473
2551
  }
2474
2552
  /**
2475
2553
  * Response for entity search requests
@@ -2509,12 +2587,13 @@ declare namespace Components {
2509
2587
  * 10
2510
2588
  */
2511
2589
  hits?: number;
2590
+ includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
2512
2591
  }
2513
2592
  export interface EntitySearchParams {
2514
2593
  /**
2515
- * Single entity schema slug or array of slugs
2594
+ * Entity slug, array of slugs, or array of per-slug configurations
2516
2595
  */
2517
- slug: /* Single entity schema slug or array of slugs */ /**
2596
+ slug: /* Entity slug, array of slugs, or array of per-slug configurations */ /**
2518
2597
  * URL-friendly identifier for the entity schema
2519
2598
  * example:
2520
2599
  * contact
@@ -2532,6 +2611,9 @@ declare namespace Components {
2532
2611
  * contact
2533
2612
  */
2534
2613
  EntitySlug[]
2614
+ ] | [
2615
+ /* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig,
2616
+ .../* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig[]
2535
2617
  ];
2536
2618
  /**
2537
2619
  * Keyword search query
@@ -2660,6 +2742,14 @@ declare namespace Components {
2660
2742
  * ]
2661
2743
  */
2662
2744
  targets?: string /* uuid */[];
2745
+ /**
2746
+ * Optional enrichment data to side-load alongside results under the `includes` response key.
2747
+ * example:
2748
+ * [
2749
+ * "active_workflow"
2750
+ * ]
2751
+ */
2752
+ include?: ("active_workflow")[];
2663
2753
  }
2664
2754
  /**
2665
2755
  * URL-friendly identifier for the entity schema
@@ -2667,6 +2757,21 @@ declare namespace Components {
2667
2757
  * contact
2668
2758
  */
2669
2759
  export type EntitySlug = string;
2760
+ /**
2761
+ * Per-slug search configuration with scoped targets and templates
2762
+ */
2763
+ export interface EntitySlugConfig {
2764
+ slug: /**
2765
+ * URL-friendly identifier for the entity schema
2766
+ * example:
2767
+ * contact
2768
+ */
2769
+ EntitySlug;
2770
+ targets?: string /* uuid */[];
2771
+ templates?: {
2772
+ [name: string]: string;
2773
+ };
2774
+ }
2670
2775
  export interface EntityTemplates {
2671
2776
  /**
2672
2777
  * Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
@@ -2689,7 +2794,7 @@ declare namespace Components {
2689
2794
  }
2690
2795
  export interface EntityWidget {
2691
2796
  id: string;
2692
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
2797
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
2693
2798
  /**
2694
2799
  * Index of the widget in the list, used for ordering (left or right)
2695
2800
  */
@@ -3746,12 +3851,6 @@ declare namespace Components {
3746
3851
  * Whether the org is in canary mode
3747
3852
  */
3748
3853
  is_canary?: boolean;
3749
- /**
3750
- * The URL to redirect to
3751
- * example:
3752
- * https://example.com
3753
- */
3754
- redirect_to?: string;
3755
3854
  }
3756
3855
  /**
3757
3856
  * The meter entity
@@ -3801,7 +3900,7 @@ declare namespace Components {
3801
3900
  }
3802
3901
  export interface MeterChartWidget {
3803
3902
  id: string;
3804
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
3903
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
3805
3904
  /**
3806
3905
  * Index of the widget in the list, used for ordering (left or right)
3807
3906
  */
@@ -3862,7 +3961,7 @@ declare namespace Components {
3862
3961
  /**
3863
3962
  * If the value is not provided, the system will be set with the time the request is processed.
3864
3963
  * example:
3865
- * 2022-10-10T00:00:00.000Z
3964
+ * 2022-10-10
3866
3965
  */
3867
3966
  timestamp?: string;
3868
3967
  /**
@@ -3965,7 +4064,7 @@ declare namespace Components {
3965
4064
  }
3966
4065
  export interface MeterReadingWidget {
3967
4066
  id: string;
3968
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
4067
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
3969
4068
  /**
3970
4069
  * Index of the widget in the list, used for ordering (left or right)
3971
4070
  */
@@ -4357,6 +4456,12 @@ declare namespace Components {
4357
4456
  * contact
4358
4457
  */
4359
4458
  detail_schema?: string;
4459
+ /**
4460
+ * Whether the detail page should appear in the main navigation
4461
+ * example:
4462
+ * false
4463
+ */
4464
+ show_in_navigation?: boolean;
4360
4465
  /**
4361
4466
  * Whether the page is public
4362
4467
  * example:
@@ -4368,7 +4473,7 @@ declare namespace Components {
4368
4473
  * example:
4369
4474
  * c495fef9-eeca-4019-a989-8390dcd9825b
4370
4475
  */
4371
- parentId?: string;
4476
+ parentId?: string | null;
4372
4477
  /**
4373
4478
  * Whether the page is the entry route
4374
4479
  * example:
@@ -4454,6 +4559,12 @@ declare namespace Components {
4454
4559
  * contact
4455
4560
  */
4456
4561
  detail_schema?: string;
4562
+ /**
4563
+ * Whether the detail page should appear in the main navigation
4564
+ * example:
4565
+ * false
4566
+ */
4567
+ show_in_navigation?: boolean;
4457
4568
  /**
4458
4569
  * Whether the page is public
4459
4570
  * example:
@@ -4465,7 +4576,7 @@ declare namespace Components {
4465
4576
  * example:
4466
4577
  * c495fef9-eeca-4019-a989-8390dcd9825b
4467
4578
  */
4468
- parentId?: string;
4579
+ parentId?: string | null;
4469
4580
  /**
4470
4581
  * Whether the page is the entry route
4471
4582
  * example:
@@ -4481,7 +4592,7 @@ declare namespace Components {
4481
4592
  }
4482
4593
  export interface PaymentWidget {
4483
4594
  id: string;
4484
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
4595
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
4485
4596
  /**
4486
4597
  * Index of the widget in the list, used for ordering (left or right)
4487
4598
  */
@@ -4516,19 +4627,21 @@ declare namespace Components {
4516
4627
  * Mark true if the domain is an Epilot domain
4517
4628
  */
4518
4629
  is_epilot_domain?: boolean;
4519
- /**
4520
- * The URL on which the portal is accessible
4521
- * example:
4522
- * example-portal-12345.ecp.epilot.cloud
4523
- */
4524
- epilot_domain?: string;
4525
- domain_settings?: /* Domain settings for the portal */ DomainSettings;
4526
4630
  design_id?: /**
4527
4631
  * Entity ID
4528
4632
  * example:
4529
4633
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4530
4634
  */
4531
4635
  EntityId /* uuid */;
4636
+ /**
4637
+ * Allowed portal entities for the portal
4638
+ * example:
4639
+ * [
4640
+ * "contact",
4641
+ * "contract"
4642
+ * ]
4643
+ */
4644
+ allowed_portal_entities?: string[];
4532
4645
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
4533
4646
  /**
4534
4647
  * Enable or disable user account self management
@@ -4611,6 +4724,52 @@ declare namespace Components {
4611
4724
  * eu-central-1_CUEQRNbUb
4612
4725
  */
4613
4726
  cognito_user_pool_id?: string;
4727
+ /**
4728
+ * Timeouts for the cognito tokens
4729
+ */
4730
+ timeouts?: {
4731
+ /**
4732
+ * Timeout for the refresh token
4733
+ * example:
4734
+ * 300
4735
+ */
4736
+ refresh_token?: number;
4737
+ /**
4738
+ * Timeout for the access token
4739
+ * example:
4740
+ * 300
4741
+ */
4742
+ access_token?: number;
4743
+ /**
4744
+ * Timeout for the id token
4745
+ * example:
4746
+ * 300
4747
+ */
4748
+ id_token?: number;
4749
+ };
4750
+ /**
4751
+ * Advanced authentication settings for the portal
4752
+ */
4753
+ advanced_authentication?: {
4754
+ /**
4755
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
4756
+ * example:
4757
+ * true
4758
+ */
4759
+ user_activity_logging?: boolean;
4760
+ /**
4761
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
4762
+ * example:
4763
+ * true
4764
+ */
4765
+ adaptive_authentication?: boolean;
4766
+ /**
4767
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
4768
+ * example:
4769
+ * true
4770
+ */
4771
+ compromised_credentials_detection?: boolean;
4772
+ };
4614
4773
  /**
4615
4774
  * Password policy for the portal
4616
4775
  */
@@ -4972,19 +5131,21 @@ declare namespace Components {
4972
5131
  * Mark true if the domain is an Epilot domain
4973
5132
  */
4974
5133
  is_epilot_domain?: boolean;
4975
- /**
4976
- * The Epilot domain on which the portal is accessible
4977
- * example:
4978
- * example-portal-1.ecp.epilot.io
4979
- */
4980
- epilot_domain?: string;
4981
- domain_settings?: /* Domain settings for the portal */ DomainSettings;
4982
5134
  design_id?: /**
4983
5135
  * Entity ID
4984
5136
  * example:
4985
5137
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4986
5138
  */
4987
5139
  EntityId /* uuid */;
5140
+ /**
5141
+ * Allowed portal entities for the portal
5142
+ * example:
5143
+ * [
5144
+ * "contact",
5145
+ * "contract"
5146
+ * ]
5147
+ */
5148
+ allowed_portal_entities?: string[];
4988
5149
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
4989
5150
  /**
4990
5151
  * Enable or disable user account self management
@@ -5067,6 +5228,52 @@ declare namespace Components {
5067
5228
  * eu-central-1_CUEQRNbUb
5068
5229
  */
5069
5230
  cognito_user_pool_id?: string;
5231
+ /**
5232
+ * Timeouts for the cognito tokens
5233
+ */
5234
+ timeouts?: {
5235
+ /**
5236
+ * Timeout for the refresh token
5237
+ * example:
5238
+ * 300
5239
+ */
5240
+ refresh_token?: number;
5241
+ /**
5242
+ * Timeout for the access token
5243
+ * example:
5244
+ * 300
5245
+ */
5246
+ access_token?: number;
5247
+ /**
5248
+ * Timeout for the id token
5249
+ * example:
5250
+ * 300
5251
+ */
5252
+ id_token?: number;
5253
+ };
5254
+ /**
5255
+ * Advanced authentication settings for the portal
5256
+ */
5257
+ advanced_authentication?: {
5258
+ /**
5259
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
5260
+ * example:
5261
+ * true
5262
+ */
5263
+ user_activity_logging?: boolean;
5264
+ /**
5265
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
5266
+ * example:
5267
+ * true
5268
+ */
5269
+ adaptive_authentication?: boolean;
5270
+ /**
5271
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
5272
+ * example:
5273
+ * true
5274
+ */
5275
+ compromised_credentials_detection?: boolean;
5276
+ };
5070
5277
  /**
5071
5278
  * Password policy for the portal
5072
5279
  */
@@ -5412,7 +5619,7 @@ declare namespace Components {
5412
5619
  _schema: "portal_user";
5413
5620
  }
5414
5621
  export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
5415
- export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget;
5622
+ export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
5416
5623
  /**
5417
5624
  * The product entity
5418
5625
  */
@@ -5459,6 +5666,34 @@ declare namespace Components {
5459
5666
  _updated_at: string; // date-time
5460
5667
  _schema: "product";
5461
5668
  }
5669
+ export interface ProductRecommendationsWidget {
5670
+ id: string;
5671
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
5672
+ /**
5673
+ * Index of the widget in the list, used for ordering (left or right)
5674
+ */
5675
+ listIndex: number;
5676
+ headline?: {
5677
+ en?: string;
5678
+ de?: string;
5679
+ };
5680
+ subHeadline?: {
5681
+ en?: string;
5682
+ de?: string;
5683
+ };
5684
+ imageUrl?: string;
5685
+ button?: {
5686
+ label?: {
5687
+ en?: string;
5688
+ de?: string;
5689
+ };
5690
+ url?: string;
5691
+ };
5692
+ /**
5693
+ * ID of the campaign
5694
+ */
5695
+ campaign_id?: string;
5696
+ }
5462
5697
  export interface ProviderConfig {
5463
5698
  slug?: /**
5464
5699
  * URL-friendly slug to use as organization-unique identifier for Provider
@@ -5871,12 +6106,25 @@ declare namespace Components {
5871
6106
  */
5872
6107
  slug?: string;
5873
6108
  }
6109
+ /**
6110
+ * Side-loaded enrichment data requested via the `include` parameter.
6111
+ */
6112
+ export interface SearchIncludes {
6113
+ /**
6114
+ * The active workflow execution for each entity, keyed by entity ID. Only entities with an active workflow are present.
6115
+ */
6116
+ active_workflow?: {
6117
+ [name: string]: {
6118
+ [key: string]: any;
6119
+ };
6120
+ };
6121
+ }
5874
6122
  export type Source = "ECP" | "ERP" | "360" | "journey-submission";
5875
6123
  export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
5876
6124
  export type TariffType = "ht" | "nt";
5877
6125
  export interface TeaserWidget {
5878
6126
  id: string;
5879
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
6127
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
5880
6128
  /**
5881
6129
  * Index of the widget in the list, used for ordering (left or right)
5882
6130
  */
@@ -6026,19 +6274,21 @@ declare namespace Components {
6026
6274
  * Mark true if the domain is an Epilot domain
6027
6275
  */
6028
6276
  is_epilot_domain?: boolean;
6029
- /**
6030
- * The URL on which the portal is accessible
6031
- * example:
6032
- * example-portal-12345.ecp.epilot.cloud
6033
- */
6034
- epilot_domain?: string;
6035
- domain_settings?: /* Domain settings for the portal */ DomainSettings;
6036
6277
  design_id?: /**
6037
6278
  * Entity ID
6038
6279
  * example:
6039
6280
  * 5da0a718-c822-403d-9f5d-20d4584e0528
6040
6281
  */
6041
6282
  EntityId /* uuid */;
6283
+ /**
6284
+ * Allowed portal entities for the portal
6285
+ * example:
6286
+ * [
6287
+ * "contact",
6288
+ * "contract"
6289
+ * ]
6290
+ */
6291
+ allowed_portal_entities?: string[];
6042
6292
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
6043
6293
  /**
6044
6294
  * Enable or disable user account self management
@@ -6121,6 +6371,52 @@ declare namespace Components {
6121
6371
  * eu-central-1_CUEQRNbUb
6122
6372
  */
6123
6373
  cognito_user_pool_id?: string;
6374
+ /**
6375
+ * Timeouts for the cognito tokens
6376
+ */
6377
+ timeouts?: {
6378
+ /**
6379
+ * Timeout for the refresh token
6380
+ * example:
6381
+ * 300
6382
+ */
6383
+ refresh_token?: number;
6384
+ /**
6385
+ * Timeout for the access token
6386
+ * example:
6387
+ * 300
6388
+ */
6389
+ access_token?: number;
6390
+ /**
6391
+ * Timeout for the id token
6392
+ * example:
6393
+ * 300
6394
+ */
6395
+ id_token?: number;
6396
+ };
6397
+ /**
6398
+ * Advanced authentication settings for the portal
6399
+ */
6400
+ advanced_authentication?: {
6401
+ /**
6402
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
6403
+ * example:
6404
+ * true
6405
+ */
6406
+ user_activity_logging?: boolean;
6407
+ /**
6408
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
6409
+ * example:
6410
+ * true
6411
+ */
6412
+ adaptive_authentication?: boolean;
6413
+ /**
6414
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
6415
+ * example:
6416
+ * true
6417
+ */
6418
+ compromised_credentials_detection?: boolean;
6419
+ };
6124
6420
  /**
6125
6421
  * Password policy for the portal
6126
6422
  */
@@ -6436,19 +6732,21 @@ declare namespace Components {
6436
6732
  * Mark true if the domain is an Epilot domain
6437
6733
  */
6438
6734
  is_epilot_domain?: boolean;
6439
- /**
6440
- * The Epilot domain on which the portal is accessible
6441
- * example:
6442
- * example-portal-1.ecp.epilot.io
6443
- */
6444
- epilot_domain?: string;
6445
- domain_settings?: /* Domain settings for the portal */ DomainSettings;
6446
6735
  design_id?: /**
6447
6736
  * Entity ID
6448
6737
  * example:
6449
6738
  * 5da0a718-c822-403d-9f5d-20d4584e0528
6450
6739
  */
6451
6740
  EntityId /* uuid */;
6741
+ /**
6742
+ * Allowed portal entities for the portal
6743
+ * example:
6744
+ * [
6745
+ * "contact",
6746
+ * "contract"
6747
+ * ]
6748
+ */
6749
+ allowed_portal_entities?: string[];
6452
6750
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
6453
6751
  /**
6454
6752
  * Enable or disable user account self management
@@ -6531,6 +6829,52 @@ declare namespace Components {
6531
6829
  * eu-central-1_CUEQRNbUb
6532
6830
  */
6533
6831
  cognito_user_pool_id?: string;
6832
+ /**
6833
+ * Timeouts for the cognito tokens
6834
+ */
6835
+ timeouts?: {
6836
+ /**
6837
+ * Timeout for the refresh token
6838
+ * example:
6839
+ * 300
6840
+ */
6841
+ refresh_token?: number;
6842
+ /**
6843
+ * Timeout for the access token
6844
+ * example:
6845
+ * 300
6846
+ */
6847
+ access_token?: number;
6848
+ /**
6849
+ * Timeout for the id token
6850
+ * example:
6851
+ * 300
6852
+ */
6853
+ id_token?: number;
6854
+ };
6855
+ /**
6856
+ * Advanced authentication settings for the portal
6857
+ */
6858
+ advanced_authentication?: {
6859
+ /**
6860
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
6861
+ * example:
6862
+ * true
6863
+ */
6864
+ user_activity_logging?: boolean;
6865
+ /**
6866
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
6867
+ * example:
6868
+ * true
6869
+ */
6870
+ adaptive_authentication?: boolean;
6871
+ /**
6872
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
6873
+ * example:
6874
+ * true
6875
+ */
6876
+ compromised_credentials_detection?: boolean;
6877
+ };
6534
6878
  /**
6535
6879
  * Password policy for the portal
6536
6880
  */
@@ -6831,7 +7175,7 @@ declare namespace Components {
6831
7175
  }
6832
7176
  export interface WidgetBase {
6833
7177
  id: string;
6834
- type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
7178
+ type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
6835
7179
  /**
6836
7180
  * Index of the widget in the list, used for ordering (left or right)
6837
7181
  */
@@ -8957,19 +9301,21 @@ declare namespace Paths {
8957
9301
  * Mark true if the domain is an Epilot domain
8958
9302
  */
8959
9303
  is_epilot_domain?: boolean;
8960
- /**
8961
- * The URL on which the portal is accessible
8962
- * example:
8963
- * example-portal-12345.ecp.epilot.cloud
8964
- */
8965
- epilot_domain?: string;
8966
- domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
8967
9304
  design_id?: /**
8968
9305
  * Entity ID
8969
9306
  * example:
8970
9307
  * 5da0a718-c822-403d-9f5d-20d4584e0528
8971
9308
  */
8972
9309
  Components.Schemas.EntityId /* uuid */;
9310
+ /**
9311
+ * Allowed portal entities for the portal
9312
+ * example:
9313
+ * [
9314
+ * "contact",
9315
+ * "contract"
9316
+ * ]
9317
+ */
9318
+ allowed_portal_entities?: string[];
8973
9319
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
8974
9320
  /**
8975
9321
  * Enable or disable user account self management
@@ -9052,6 +9398,52 @@ declare namespace Paths {
9052
9398
  * eu-central-1_CUEQRNbUb
9053
9399
  */
9054
9400
  cognito_user_pool_id?: string;
9401
+ /**
9402
+ * Timeouts for the cognito tokens
9403
+ */
9404
+ timeouts?: {
9405
+ /**
9406
+ * Timeout for the refresh token
9407
+ * example:
9408
+ * 300
9409
+ */
9410
+ refresh_token?: number;
9411
+ /**
9412
+ * Timeout for the access token
9413
+ * example:
9414
+ * 300
9415
+ */
9416
+ access_token?: number;
9417
+ /**
9418
+ * Timeout for the id token
9419
+ * example:
9420
+ * 300
9421
+ */
9422
+ id_token?: number;
9423
+ };
9424
+ /**
9425
+ * Advanced authentication settings for the portal
9426
+ */
9427
+ advanced_authentication?: {
9428
+ /**
9429
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
9430
+ * example:
9431
+ * true
9432
+ */
9433
+ user_activity_logging?: boolean;
9434
+ /**
9435
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
9436
+ * example:
9437
+ * true
9438
+ */
9439
+ adaptive_authentication?: boolean;
9440
+ /**
9441
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
9442
+ * example:
9443
+ * true
9444
+ */
9445
+ compromised_credentials_detection?: boolean;
9446
+ };
9055
9447
  /**
9056
9448
  * Password policy for the portal
9057
9449
  */
@@ -9403,19 +9795,21 @@ declare namespace Paths {
9403
9795
  * Mark true if the domain is an Epilot domain
9404
9796
  */
9405
9797
  is_epilot_domain?: boolean;
9406
- /**
9407
- * The URL on which the portal is accessible
9408
- * example:
9409
- * example-portal-12345.ecp.epilot.cloud
9410
- */
9411
- epilot_domain?: string;
9412
- domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
9413
9798
  design_id?: /**
9414
9799
  * Entity ID
9415
9800
  * example:
9416
9801
  * 5da0a718-c822-403d-9f5d-20d4584e0528
9417
9802
  */
9418
9803
  Components.Schemas.EntityId /* uuid */;
9804
+ /**
9805
+ * Allowed portal entities for the portal
9806
+ * example:
9807
+ * [
9808
+ * "contact",
9809
+ * "contract"
9810
+ * ]
9811
+ */
9812
+ allowed_portal_entities?: string[];
9419
9813
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
9420
9814
  /**
9421
9815
  * Enable or disable user account self management
@@ -9498,6 +9892,52 @@ declare namespace Paths {
9498
9892
  * eu-central-1_CUEQRNbUb
9499
9893
  */
9500
9894
  cognito_user_pool_id?: string;
9895
+ /**
9896
+ * Timeouts for the cognito tokens
9897
+ */
9898
+ timeouts?: {
9899
+ /**
9900
+ * Timeout for the refresh token
9901
+ * example:
9902
+ * 300
9903
+ */
9904
+ refresh_token?: number;
9905
+ /**
9906
+ * Timeout for the access token
9907
+ * example:
9908
+ * 300
9909
+ */
9910
+ access_token?: number;
9911
+ /**
9912
+ * Timeout for the id token
9913
+ * example:
9914
+ * 300
9915
+ */
9916
+ id_token?: number;
9917
+ };
9918
+ /**
9919
+ * Advanced authentication settings for the portal
9920
+ */
9921
+ advanced_authentication?: {
9922
+ /**
9923
+ * Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring.
9924
+ * example:
9925
+ * true
9926
+ */
9927
+ user_activity_logging?: boolean;
9928
+ /**
9929
+ * Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time.
9930
+ * example:
9931
+ * true
9932
+ */
9933
+ adaptive_authentication?: boolean;
9934
+ /**
9935
+ * Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials.
9936
+ * example:
9937
+ * true
9938
+ */
9939
+ compromised_credentials_detection?: boolean;
9940
+ };
9501
9941
  /**
9502
9942
  * Password policy for the portal
9503
9943
  */
@@ -10774,6 +11214,31 @@ declare namespace Paths {
10774
11214
  export type $500 = Components.Responses.InternalServerError;
10775
11215
  }
10776
11216
  }
11217
+ namespace InterpolatePortalPages {
11218
+ export interface RequestBody {
11219
+ /**
11220
+ * The pages to interpolate
11221
+ */
11222
+ pages: Components.Schemas.Page[];
11223
+ context_entities?: /**
11224
+ * Additional entities to include in the context for variable interpolation. Portal User and Contact entities are automatically part of the context.
11225
+ * example:
11226
+ * [
11227
+ * {
11228
+ * "entity_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
11229
+ * "entity_schema": "contract"
11230
+ * }
11231
+ * ]
11232
+ */
11233
+ Components.Schemas.ContextEntities;
11234
+ }
11235
+ namespace Responses {
11236
+ export type $200 = Components.Schemas.Page[];
11237
+ export type $401 = Components.Responses.Unauthorized;
11238
+ export type $403 = Components.Responses.Forbidden;
11239
+ export type $500 = Components.Responses.InternalServerError;
11240
+ }
11241
+ }
10777
11242
  namespace InvitePartner {
10778
11243
  export interface RequestBody {
10779
11244
  /**
@@ -10786,6 +11251,14 @@ declare namespace Paths {
10786
11251
  * 5da0a718-c822-403d-9f5d-20d4584e0528
10787
11252
  */
10788
11253
  Components.Schemas.EntityId /* uuid */[];
11254
+ /**
11255
+ * Additional contact entity fields to set when creating the contact for the invited user.
11256
+ * These are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).
11257
+ *
11258
+ */
11259
+ contact_data?: {
11260
+ [name: string]: string;
11261
+ };
10789
11262
  }
10790
11263
  namespace Responses {
10791
11264
  export interface $200 {
@@ -12143,6 +12616,7 @@ declare namespace Paths {
12143
12616
  }
12144
12617
  }
12145
12618
 
12619
+
12146
12620
  interface OperationMethods {
12147
12621
  /**
12148
12622
  * upsertPortal - upsertPortal
@@ -13279,6 +13753,16 @@ interface OperationMethods {
13279
13753
  data?: any,
13280
13754
  config?: AxiosRequestConfig
13281
13755
  ): OperationResponse<Paths.GetPublicPages.Responses.$200>
13756
+ /**
13757
+ * interpolatePortalPages - interpolatePortalPages
13758
+ *
13759
+ * Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
13760
+ */
13761
+ 'interpolatePortalPages'(
13762
+ parameters?: Parameters<UnknownParamsObject> | null,
13763
+ data?: Paths.InterpolatePortalPages.RequestBody,
13764
+ config?: AxiosRequestConfig
13765
+ ): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
13282
13766
  /**
13283
13767
  * getDefaultPages - getDefaultPages
13284
13768
  *
@@ -14841,6 +15325,18 @@ interface PathsDictionary {
14841
15325
  config?: AxiosRequestConfig
14842
15326
  ): OperationResponse<Paths.GetPublicPages.Responses.$200>
14843
15327
  }
15328
+ ['/v2/portal/pages/interpolate']: {
15329
+ /**
15330
+ * interpolatePortalPages - interpolatePortalPages
15331
+ *
15332
+ * Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
15333
+ */
15334
+ 'post'(
15335
+ parameters?: Parameters<UnknownParamsObject> | null,
15336
+ data?: Paths.InterpolatePortalPages.RequestBody,
15337
+ config?: AxiosRequestConfig
15338
+ ): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
15339
+ }
14844
15340
  ['/v2/portal/pages/default']: {
14845
15341
  /**
14846
15342
  * getDefaultPages - getDefaultPages
@@ -15111,6 +15607,7 @@ interface PathsDictionary {
15111
15607
 
15112
15608
  type Client = OpenAPIClient<OperationMethods, PathsDictionary>
15113
15609
 
15610
+
15114
15611
  type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
15115
15612
  type ActionLabel = Components.Schemas.ActionLabel;
15116
15613
  type ActionWidget = Components.Schemas.ActionWidget;
@@ -15150,7 +15647,6 @@ type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
15150
15647
  type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
15151
15648
  type Direction = Components.Schemas.Direction;
15152
15649
  type DocumentWidget = Components.Schemas.DocumentWidget;
15153
- type DomainSettings = Components.Schemas.DomainSettings;
15154
15650
  type EmailTemplates = Components.Schemas.EmailTemplates;
15155
15651
  type Entity = Components.Schemas.Entity;
15156
15652
  type EntityEditRule = Components.Schemas.EntityEditRule;
@@ -15164,6 +15660,7 @@ type EntityResponseGroupedWithHits = Components.Schemas.EntityResponseGroupedWit
15164
15660
  type EntityResponseWithHits = Components.Schemas.EntityResponseWithHits;
15165
15661
  type EntitySearchParams = Components.Schemas.EntitySearchParams;
15166
15662
  type EntitySlug = Components.Schemas.EntitySlug;
15663
+ type EntitySlugConfig = Components.Schemas.EntitySlugConfig;
15167
15664
  type EntityTemplates = Components.Schemas.EntityTemplates;
15168
15665
  type EntityWidget = Components.Schemas.EntityWidget;
15169
15666
  type ErrorResp = Components.Schemas.ErrorResp;
@@ -15213,6 +15710,7 @@ type PortalUser = Components.Schemas.PortalUser;
15213
15710
  type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
15214
15711
  type PortalWidget = Components.Schemas.PortalWidget;
15215
15712
  type Product = Components.Schemas.Product;
15713
+ type ProductRecommendationsWidget = Components.Schemas.ProductRecommendationsWidget;
15216
15714
  type ProviderConfig = Components.Schemas.ProviderConfig;
15217
15715
  type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
15218
15716
  type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
@@ -15235,6 +15733,7 @@ type SSOLoginToken = Components.Schemas.SSOLoginToken;
15235
15733
  type SaveEntityFile = Components.Schemas.SaveEntityFile;
15236
15734
  type SavePortalFile = Components.Schemas.SavePortalFile;
15237
15735
  type Schema = Components.Schemas.Schema;
15736
+ type SearchIncludes = Components.Schemas.SearchIncludes;
15238
15737
  type Source = Components.Schemas.Source;
15239
15738
  type SwappableConfig = Components.Schemas.SwappableConfig;
15240
15739
  type TariffType = Components.Schemas.TariffType;
@@ -15251,4 +15750,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
15251
15750
  type WorkflowExecution = Components.Schemas.WorkflowExecution;
15252
15751
  type WorkflowStep = Components.Schemas.WorkflowStep;
15253
15752
 
15254
- export { type EntityResponse 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 DomainSettings as S, type EmailTemplates as T, type Entity as U, type EntityEditRule as V, type EntityFileCount as W, type EntityGetParams as X, type EntityId as Y, type EntityItem as Z, type EntityMatchingConfig as _, Components as a, type ReadingStatus as a$, type EntityResponseGroupedWithHits as a0, type EntityResponseWithHits as a1, type EntitySearchParams as a2, type EntitySlug 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 MoblieOIDCConfig as aA, type OIDCProviderConfig as aB, type OIDCProviderMetadata as aC, type Opportunity as aD, type Order as aE, type OrganizationSettings as aF, type Origin as aG, type Page as aH, type PageRequest as aI, type PaymentWidget as aJ, type PortalConfig as aK, type PortalConfigV3 as aL, type PortalId as aM, type PortalUser as aN, type PortalUserRegistrationStatus as aO, type PortalWidget as aP, type Product as aQ, type ProviderConfig as aR, type ProviderDisplayName as aS, type ProviderPublicConfig as aT, type ProviderSlug as aU, type PublicContractIdentificationDetails as aV, type PublicDataRetrievalHookDetails as aW, type PublicExtensionCapabilities as aX, type PublicExtensionDetails as aY, type PublicMeterReadingPlausibilityCheckDetails as aZ, type ReadBy as a_, type ExtensionConfig as aa, type ExtensionHook as ab, type ExtensionHookConsumptionDataRetrieval as ac, type ExtensionHookContractIdentification as ad, type ExtensionHookCostDataRetrieval as ae, type ExtensionHookMeterReadingPlausibilityCheck as af, type ExtensionHookPriceDataRetrieval as ag, type ExtensionHookRegistrationIdentifiersCheck as ah, type ExtensionHookSelection as ai, type ExtensionSeamlessLink as aj, type ExternalLink as ak, type ExtraSchemaAttributes as al, type FailedRuleErrorResp as am, type File as an, type FileItem as ao, type Grant as ap, type IdentifierAttribute as aq, type InstallmentEvent as ar, type JourneyActions as as, type JuiceSettings as at, type Meter as au, type MeterChartWidget as av, type MeterReading as aw, type MeterReadingPhoto as ax, type MeterReadingPhotoData as ay, type MeterReadingWidget as az, type PathsDictionary as b, type Reason as b0, type RegistrationIdentifier as b1, type ReimbursementEvent as b2, type Rule as b3, type SAMLProviderConfig as b4, type SSOCallbackRequest as b5, type SSOCallbackResponse as b6, type SSOLoginToken as b7, SaveEntityFile as b8, type SavePortalFile as b9, type Schema as ba, type Source as bb, type SwappableConfig as bc, type TariffType as bd, type TeaserWidget as be, type TriggerPortalFlow as bf, type UpdateOnlyPortalConfigAttributes as bg, type UpsertPortalConfig as bh, type UpsertPortalConfigV3 as bi, UpsertPortalWidget as bj, type UserRequest as bk, type WidgetAction as bl, type WidgetBase as bm, type WorfklowIdentifier as bn, type WorkflowExecution as bo, type WorkflowStep as bp, 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 };
15753
+ 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 ReadBy 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 MoblieOIDCConfig as aA, type OIDCProviderConfig as aB, type OIDCProviderMetadata as aC, type Opportunity as aD, type Order as aE, type OrganizationSettings as aF, type Origin as aG, type Page as aH, type PageRequest as aI, type PaymentWidget as aJ, type PortalConfig as aK, type PortalConfigV3 as aL, type PortalId as aM, type PortalUser as aN, type PortalUserRegistrationStatus as aO, type PortalWidget as aP, type Product as aQ, type ProductRecommendationsWidget as aR, type ProviderConfig as aS, type ProviderDisplayName as aT, type ProviderPublicConfig as aU, type ProviderSlug as aV, type PublicContractIdentificationDetails as aW, type PublicDataRetrievalHookDetails as aX, type PublicExtensionCapabilities as aY, type PublicExtensionDetails as aZ, type PublicMeterReadingPlausibilityCheckDetails as a_, type ExtensionConfig as aa, type ExtensionHook as ab, type ExtensionHookConsumptionDataRetrieval as ac, type ExtensionHookContractIdentification as ad, type ExtensionHookCostDataRetrieval as ae, type ExtensionHookMeterReadingPlausibilityCheck as af, type ExtensionHookPriceDataRetrieval as ag, type ExtensionHookRegistrationIdentifiersCheck as ah, type ExtensionHookSelection as ai, type ExtensionSeamlessLink as aj, type ExternalLink as ak, type ExtraSchemaAttributes as al, type FailedRuleErrorResp as am, type File as an, type FileItem as ao, type Grant as ap, type IdentifierAttribute as aq, type InstallmentEvent as ar, type JourneyActions as as, type JuiceSettings as at, type Meter as au, type MeterChartWidget as av, type MeterReading as aw, type MeterReadingPhoto as ax, type MeterReadingPhotoData as ay, type MeterReadingWidget as az, type PathsDictionary as b, type ReadingStatus as b0, type Reason as b1, type RegistrationIdentifier as b2, type ReimbursementEvent as b3, type Rule as b4, type SAMLProviderConfig as b5, type SSOCallbackRequest as b6, type SSOCallbackResponse as b7, type SSOLoginToken as b8, SaveEntityFile as b9, type SavePortalFile as ba, type Schema as bb, type SearchIncludes as bc, type Source as bd, type SwappableConfig as be, type TariffType as bf, type TeaserWidget as bg, type TriggerPortalFlow as bh, type UpdateOnlyPortalConfigAttributes as bi, type UpsertPortalConfig as bj, type UpsertPortalConfigV3 as bk, UpsertPortalWidget as bl, type UserRequest as bm, type WidgetAction as bn, type WidgetBase as bo, type WorfklowIdentifier as bp, type WorkflowExecution as bq, type WorkflowStep as br, 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 };