@epilot/customer-portal-client 0.33.3 → 0.34.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.
- package/LICENSE +21 -0
- package/dist/client.d.ts +1 -1
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +12 -0
- package/dist/openapi.d.ts +597 -98
- package/package.json +13 -17
- package/src/openapi-runtime.json +12 -0
- package/src/openapi.d.ts +15754 -0
- package/src/openapi.json +279 -42
package/dist/openapi.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
/* eslint-disable */
|
|
2
|
-
|
|
3
1
|
import type {
|
|
4
2
|
OpenAPIClient,
|
|
5
3
|
Parameters,
|
|
@@ -57,7 +55,7 @@ declare namespace Components {
|
|
|
57
55
|
}
|
|
58
56
|
export interface ActionWidget {
|
|
59
57
|
id: string;
|
|
60
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
58
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
61
59
|
/**
|
|
62
60
|
* Index of the widget in the list, used for ordering (left or right)
|
|
63
61
|
*/
|
|
@@ -780,7 +778,7 @@ declare namespace Components {
|
|
|
780
778
|
}
|
|
781
779
|
export interface CampaignWidget {
|
|
782
780
|
id: string;
|
|
783
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
781
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
784
782
|
/**
|
|
785
783
|
* Index of the widget in the list, used for ordering (left or right)
|
|
786
784
|
*/
|
|
@@ -827,13 +825,6 @@ declare namespace Components {
|
|
|
827
825
|
* Mark true if the domain is an Epilot domain
|
|
828
826
|
*/
|
|
829
827
|
is_epilot_domain?: boolean;
|
|
830
|
-
/**
|
|
831
|
-
* The URL on which the portal is accessible
|
|
832
|
-
* example:
|
|
833
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
834
|
-
*/
|
|
835
|
-
epilot_domain?: string;
|
|
836
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
837
828
|
/**
|
|
838
829
|
* ID of the design used to build the portal
|
|
839
830
|
*/
|
|
@@ -843,6 +834,15 @@ declare namespace Components {
|
|
|
843
834
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
844
835
|
*/
|
|
845
836
|
EntityId /* uuid */;
|
|
837
|
+
/**
|
|
838
|
+
* Allowed portal entities for the portal
|
|
839
|
+
* example:
|
|
840
|
+
* [
|
|
841
|
+
* "contact",
|
|
842
|
+
* "contract"
|
|
843
|
+
* ]
|
|
844
|
+
*/
|
|
845
|
+
allowed_portal_entities?: string[];
|
|
846
846
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
847
847
|
/**
|
|
848
848
|
* Enable or disable user account self management
|
|
@@ -925,6 +925,52 @@ declare namespace Components {
|
|
|
925
925
|
* eu-central-1_CUEQRNbUb
|
|
926
926
|
*/
|
|
927
927
|
cognito_user_pool_id?: string;
|
|
928
|
+
/**
|
|
929
|
+
* Timeouts for the cognito tokens
|
|
930
|
+
*/
|
|
931
|
+
timeouts?: {
|
|
932
|
+
/**
|
|
933
|
+
* Timeout for the refresh token
|
|
934
|
+
* example:
|
|
935
|
+
* 300
|
|
936
|
+
*/
|
|
937
|
+
refresh_token?: number;
|
|
938
|
+
/**
|
|
939
|
+
* Timeout for the access token
|
|
940
|
+
* example:
|
|
941
|
+
* 300
|
|
942
|
+
*/
|
|
943
|
+
access_token?: number;
|
|
944
|
+
/**
|
|
945
|
+
* Timeout for the id token
|
|
946
|
+
* example:
|
|
947
|
+
* 300
|
|
948
|
+
*/
|
|
949
|
+
id_token?: number;
|
|
950
|
+
};
|
|
951
|
+
/**
|
|
952
|
+
* Advanced authentication settings for the portal
|
|
953
|
+
*/
|
|
954
|
+
advanced_authentication?: {
|
|
955
|
+
/**
|
|
956
|
+
* 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.
|
|
957
|
+
* example:
|
|
958
|
+
* true
|
|
959
|
+
*/
|
|
960
|
+
user_activity_logging?: boolean;
|
|
961
|
+
/**
|
|
962
|
+
* 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.
|
|
963
|
+
* example:
|
|
964
|
+
* true
|
|
965
|
+
*/
|
|
966
|
+
adaptive_authentication?: boolean;
|
|
967
|
+
/**
|
|
968
|
+
* 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.
|
|
969
|
+
* example:
|
|
970
|
+
* true
|
|
971
|
+
*/
|
|
972
|
+
compromised_credentials_detection?: boolean;
|
|
973
|
+
};
|
|
928
974
|
/**
|
|
929
975
|
* Password policy for the portal
|
|
930
976
|
*/
|
|
@@ -1200,13 +1246,6 @@ declare namespace Components {
|
|
|
1200
1246
|
* Mark true if the domain is an Epilot domain
|
|
1201
1247
|
*/
|
|
1202
1248
|
is_epilot_domain?: boolean;
|
|
1203
|
-
/**
|
|
1204
|
-
* The Epilot domain on which the portal is accessible
|
|
1205
|
-
* example:
|
|
1206
|
-
* example-portal-1.ecp.epilot.io
|
|
1207
|
-
*/
|
|
1208
|
-
epilot_domain?: string;
|
|
1209
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
1210
1249
|
/**
|
|
1211
1250
|
* ID of the design used to build the portal
|
|
1212
1251
|
*/
|
|
@@ -1216,6 +1255,15 @@ declare namespace Components {
|
|
|
1216
1255
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
1217
1256
|
*/
|
|
1218
1257
|
EntityId /* uuid */;
|
|
1258
|
+
/**
|
|
1259
|
+
* Allowed portal entities for the portal
|
|
1260
|
+
* example:
|
|
1261
|
+
* [
|
|
1262
|
+
* "contact",
|
|
1263
|
+
* "contract"
|
|
1264
|
+
* ]
|
|
1265
|
+
*/
|
|
1266
|
+
allowed_portal_entities?: string[];
|
|
1219
1267
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
1220
1268
|
/**
|
|
1221
1269
|
* Enable or disable user account self management
|
|
@@ -1298,6 +1346,52 @@ declare namespace Components {
|
|
|
1298
1346
|
* eu-central-1_CUEQRNbUb
|
|
1299
1347
|
*/
|
|
1300
1348
|
cognito_user_pool_id?: string;
|
|
1349
|
+
/**
|
|
1350
|
+
* Timeouts for the cognito tokens
|
|
1351
|
+
*/
|
|
1352
|
+
timeouts?: {
|
|
1353
|
+
/**
|
|
1354
|
+
* Timeout for the refresh token
|
|
1355
|
+
* example:
|
|
1356
|
+
* 300
|
|
1357
|
+
*/
|
|
1358
|
+
refresh_token?: number;
|
|
1359
|
+
/**
|
|
1360
|
+
* Timeout for the access token
|
|
1361
|
+
* example:
|
|
1362
|
+
* 300
|
|
1363
|
+
*/
|
|
1364
|
+
access_token?: number;
|
|
1365
|
+
/**
|
|
1366
|
+
* Timeout for the id token
|
|
1367
|
+
* example:
|
|
1368
|
+
* 300
|
|
1369
|
+
*/
|
|
1370
|
+
id_token?: number;
|
|
1371
|
+
};
|
|
1372
|
+
/**
|
|
1373
|
+
* Advanced authentication settings for the portal
|
|
1374
|
+
*/
|
|
1375
|
+
advanced_authentication?: {
|
|
1376
|
+
/**
|
|
1377
|
+
* 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.
|
|
1378
|
+
* example:
|
|
1379
|
+
* true
|
|
1380
|
+
*/
|
|
1381
|
+
user_activity_logging?: boolean;
|
|
1382
|
+
/**
|
|
1383
|
+
* 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.
|
|
1384
|
+
* example:
|
|
1385
|
+
* true
|
|
1386
|
+
*/
|
|
1387
|
+
adaptive_authentication?: boolean;
|
|
1388
|
+
/**
|
|
1389
|
+
* 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.
|
|
1390
|
+
* example:
|
|
1391
|
+
* true
|
|
1392
|
+
*/
|
|
1393
|
+
compromised_credentials_detection?: boolean;
|
|
1394
|
+
};
|
|
1301
1395
|
/**
|
|
1302
1396
|
* Password policy for the portal
|
|
1303
1397
|
*/
|
|
@@ -1636,7 +1730,7 @@ declare namespace Components {
|
|
|
1636
1730
|
}
|
|
1637
1731
|
export interface ContentWidget {
|
|
1638
1732
|
id: string;
|
|
1639
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
1733
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
1640
1734
|
/**
|
|
1641
1735
|
* Index of the widget in the list, used for ordering (left or right)
|
|
1642
1736
|
*/
|
|
@@ -1977,7 +2071,7 @@ declare namespace Components {
|
|
|
1977
2071
|
export type Direction = "feed-in" | "feed-out";
|
|
1978
2072
|
export interface DocumentWidget {
|
|
1979
2073
|
id: string;
|
|
1980
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
2074
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
1981
2075
|
/**
|
|
1982
2076
|
* Index of the widget in the list, used for ordering (left or right)
|
|
1983
2077
|
*/
|
|
@@ -1991,23 +2085,6 @@ declare namespace Components {
|
|
|
1991
2085
|
de?: string;
|
|
1992
2086
|
};
|
|
1993
2087
|
}
|
|
1994
|
-
/**
|
|
1995
|
-
* Domain settings for the portal
|
|
1996
|
-
*/
|
|
1997
|
-
export interface DomainSettings {
|
|
1998
|
-
/**
|
|
1999
|
-
* Whether the custom domain is enabled
|
|
2000
|
-
*/
|
|
2001
|
-
is_custom_domain_enabled?: boolean;
|
|
2002
|
-
/**
|
|
2003
|
-
* Whether the Epilot domain is enabled
|
|
2004
|
-
*/
|
|
2005
|
-
is_epilot_domain_enabled?: boolean;
|
|
2006
|
-
/**
|
|
2007
|
-
* Whether the redirection is enabled
|
|
2008
|
-
*/
|
|
2009
|
-
is_redirection_enabled?: boolean;
|
|
2010
|
-
}
|
|
2011
2088
|
/**
|
|
2012
2089
|
* Email templates used for authentication and internal processes
|
|
2013
2090
|
*/
|
|
@@ -2473,6 +2550,7 @@ declare namespace Components {
|
|
|
2473
2550
|
* 5
|
|
2474
2551
|
*/
|
|
2475
2552
|
hits?: number;
|
|
2553
|
+
includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
|
|
2476
2554
|
}
|
|
2477
2555
|
/**
|
|
2478
2556
|
* Response for entity search requests
|
|
@@ -2512,12 +2590,13 @@ declare namespace Components {
|
|
|
2512
2590
|
* 10
|
|
2513
2591
|
*/
|
|
2514
2592
|
hits?: number;
|
|
2593
|
+
includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
|
|
2515
2594
|
}
|
|
2516
2595
|
export interface EntitySearchParams {
|
|
2517
2596
|
/**
|
|
2518
|
-
*
|
|
2597
|
+
* Entity slug, array of slugs, or array of per-slug configurations
|
|
2519
2598
|
*/
|
|
2520
|
-
slug: /*
|
|
2599
|
+
slug: /* Entity slug, array of slugs, or array of per-slug configurations */ /**
|
|
2521
2600
|
* URL-friendly identifier for the entity schema
|
|
2522
2601
|
* example:
|
|
2523
2602
|
* contact
|
|
@@ -2535,6 +2614,9 @@ declare namespace Components {
|
|
|
2535
2614
|
* contact
|
|
2536
2615
|
*/
|
|
2537
2616
|
EntitySlug[]
|
|
2617
|
+
] | [
|
|
2618
|
+
/* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig,
|
|
2619
|
+
.../* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig[]
|
|
2538
2620
|
];
|
|
2539
2621
|
/**
|
|
2540
2622
|
* Keyword search query
|
|
@@ -2663,6 +2745,14 @@ declare namespace Components {
|
|
|
2663
2745
|
* ]
|
|
2664
2746
|
*/
|
|
2665
2747
|
targets?: string /* uuid */[];
|
|
2748
|
+
/**
|
|
2749
|
+
* Optional enrichment data to side-load alongside results under the `includes` response key.
|
|
2750
|
+
* example:
|
|
2751
|
+
* [
|
|
2752
|
+
* "active_workflow"
|
|
2753
|
+
* ]
|
|
2754
|
+
*/
|
|
2755
|
+
include?: ("active_workflow")[];
|
|
2666
2756
|
}
|
|
2667
2757
|
/**
|
|
2668
2758
|
* URL-friendly identifier for the entity schema
|
|
@@ -2670,6 +2760,21 @@ declare namespace Components {
|
|
|
2670
2760
|
* contact
|
|
2671
2761
|
*/
|
|
2672
2762
|
export type EntitySlug = string;
|
|
2763
|
+
/**
|
|
2764
|
+
* Per-slug search configuration with scoped targets and templates
|
|
2765
|
+
*/
|
|
2766
|
+
export interface EntitySlugConfig {
|
|
2767
|
+
slug: /**
|
|
2768
|
+
* URL-friendly identifier for the entity schema
|
|
2769
|
+
* example:
|
|
2770
|
+
* contact
|
|
2771
|
+
*/
|
|
2772
|
+
EntitySlug;
|
|
2773
|
+
targets?: string /* uuid */[];
|
|
2774
|
+
templates?: {
|
|
2775
|
+
[name: string]: string;
|
|
2776
|
+
};
|
|
2777
|
+
}
|
|
2673
2778
|
export interface EntityTemplates {
|
|
2674
2779
|
/**
|
|
2675
2780
|
* Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
|
|
@@ -2692,7 +2797,7 @@ declare namespace Components {
|
|
|
2692
2797
|
}
|
|
2693
2798
|
export interface EntityWidget {
|
|
2694
2799
|
id: string;
|
|
2695
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
2800
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
2696
2801
|
/**
|
|
2697
2802
|
* Index of the widget in the list, used for ordering (left or right)
|
|
2698
2803
|
*/
|
|
@@ -3749,12 +3854,6 @@ declare namespace Components {
|
|
|
3749
3854
|
* Whether the org is in canary mode
|
|
3750
3855
|
*/
|
|
3751
3856
|
is_canary?: boolean;
|
|
3752
|
-
/**
|
|
3753
|
-
* The URL to redirect to
|
|
3754
|
-
* example:
|
|
3755
|
-
* https://example.com
|
|
3756
|
-
*/
|
|
3757
|
-
redirect_to?: string;
|
|
3758
3857
|
}
|
|
3759
3858
|
/**
|
|
3760
3859
|
* The meter entity
|
|
@@ -3804,7 +3903,7 @@ declare namespace Components {
|
|
|
3804
3903
|
}
|
|
3805
3904
|
export interface MeterChartWidget {
|
|
3806
3905
|
id: string;
|
|
3807
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
3906
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
3808
3907
|
/**
|
|
3809
3908
|
* Index of the widget in the list, used for ordering (left or right)
|
|
3810
3909
|
*/
|
|
@@ -3865,7 +3964,7 @@ declare namespace Components {
|
|
|
3865
3964
|
/**
|
|
3866
3965
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
3867
3966
|
* example:
|
|
3868
|
-
* 2022-10-
|
|
3967
|
+
* 2022-10-10
|
|
3869
3968
|
*/
|
|
3870
3969
|
timestamp?: string;
|
|
3871
3970
|
/**
|
|
@@ -3968,7 +4067,7 @@ declare namespace Components {
|
|
|
3968
4067
|
}
|
|
3969
4068
|
export interface MeterReadingWidget {
|
|
3970
4069
|
id: string;
|
|
3971
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
4070
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
3972
4071
|
/**
|
|
3973
4072
|
* Index of the widget in the list, used for ordering (left or right)
|
|
3974
4073
|
*/
|
|
@@ -4360,6 +4459,12 @@ declare namespace Components {
|
|
|
4360
4459
|
* contact
|
|
4361
4460
|
*/
|
|
4362
4461
|
detail_schema?: string;
|
|
4462
|
+
/**
|
|
4463
|
+
* Whether the detail page should appear in the main navigation
|
|
4464
|
+
* example:
|
|
4465
|
+
* false
|
|
4466
|
+
*/
|
|
4467
|
+
show_in_navigation?: boolean;
|
|
4363
4468
|
/**
|
|
4364
4469
|
* Whether the page is public
|
|
4365
4470
|
* example:
|
|
@@ -4371,7 +4476,7 @@ declare namespace Components {
|
|
|
4371
4476
|
* example:
|
|
4372
4477
|
* c495fef9-eeca-4019-a989-8390dcd9825b
|
|
4373
4478
|
*/
|
|
4374
|
-
parentId?: string;
|
|
4479
|
+
parentId?: string | null;
|
|
4375
4480
|
/**
|
|
4376
4481
|
* Whether the page is the entry route
|
|
4377
4482
|
* example:
|
|
@@ -4457,6 +4562,12 @@ declare namespace Components {
|
|
|
4457
4562
|
* contact
|
|
4458
4563
|
*/
|
|
4459
4564
|
detail_schema?: string;
|
|
4565
|
+
/**
|
|
4566
|
+
* Whether the detail page should appear in the main navigation
|
|
4567
|
+
* example:
|
|
4568
|
+
* false
|
|
4569
|
+
*/
|
|
4570
|
+
show_in_navigation?: boolean;
|
|
4460
4571
|
/**
|
|
4461
4572
|
* Whether the page is public
|
|
4462
4573
|
* example:
|
|
@@ -4468,7 +4579,7 @@ declare namespace Components {
|
|
|
4468
4579
|
* example:
|
|
4469
4580
|
* c495fef9-eeca-4019-a989-8390dcd9825b
|
|
4470
4581
|
*/
|
|
4471
|
-
parentId?: string;
|
|
4582
|
+
parentId?: string | null;
|
|
4472
4583
|
/**
|
|
4473
4584
|
* Whether the page is the entry route
|
|
4474
4585
|
* example:
|
|
@@ -4484,7 +4595,7 @@ declare namespace Components {
|
|
|
4484
4595
|
}
|
|
4485
4596
|
export interface PaymentWidget {
|
|
4486
4597
|
id: string;
|
|
4487
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
4598
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
4488
4599
|
/**
|
|
4489
4600
|
* Index of the widget in the list, used for ordering (left or right)
|
|
4490
4601
|
*/
|
|
@@ -4519,19 +4630,21 @@ declare namespace Components {
|
|
|
4519
4630
|
* Mark true if the domain is an Epilot domain
|
|
4520
4631
|
*/
|
|
4521
4632
|
is_epilot_domain?: boolean;
|
|
4522
|
-
/**
|
|
4523
|
-
* The URL on which the portal is accessible
|
|
4524
|
-
* example:
|
|
4525
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
4526
|
-
*/
|
|
4527
|
-
epilot_domain?: string;
|
|
4528
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
4529
4633
|
design_id?: /**
|
|
4530
4634
|
* Entity ID
|
|
4531
4635
|
* example:
|
|
4532
4636
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
4533
4637
|
*/
|
|
4534
4638
|
EntityId /* uuid */;
|
|
4639
|
+
/**
|
|
4640
|
+
* Allowed portal entities for the portal
|
|
4641
|
+
* example:
|
|
4642
|
+
* [
|
|
4643
|
+
* "contact",
|
|
4644
|
+
* "contract"
|
|
4645
|
+
* ]
|
|
4646
|
+
*/
|
|
4647
|
+
allowed_portal_entities?: string[];
|
|
4535
4648
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
4536
4649
|
/**
|
|
4537
4650
|
* Enable or disable user account self management
|
|
@@ -4614,6 +4727,52 @@ declare namespace Components {
|
|
|
4614
4727
|
* eu-central-1_CUEQRNbUb
|
|
4615
4728
|
*/
|
|
4616
4729
|
cognito_user_pool_id?: string;
|
|
4730
|
+
/**
|
|
4731
|
+
* Timeouts for the cognito tokens
|
|
4732
|
+
*/
|
|
4733
|
+
timeouts?: {
|
|
4734
|
+
/**
|
|
4735
|
+
* Timeout for the refresh token
|
|
4736
|
+
* example:
|
|
4737
|
+
* 300
|
|
4738
|
+
*/
|
|
4739
|
+
refresh_token?: number;
|
|
4740
|
+
/**
|
|
4741
|
+
* Timeout for the access token
|
|
4742
|
+
* example:
|
|
4743
|
+
* 300
|
|
4744
|
+
*/
|
|
4745
|
+
access_token?: number;
|
|
4746
|
+
/**
|
|
4747
|
+
* Timeout for the id token
|
|
4748
|
+
* example:
|
|
4749
|
+
* 300
|
|
4750
|
+
*/
|
|
4751
|
+
id_token?: number;
|
|
4752
|
+
};
|
|
4753
|
+
/**
|
|
4754
|
+
* Advanced authentication settings for the portal
|
|
4755
|
+
*/
|
|
4756
|
+
advanced_authentication?: {
|
|
4757
|
+
/**
|
|
4758
|
+
* 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.
|
|
4759
|
+
* example:
|
|
4760
|
+
* true
|
|
4761
|
+
*/
|
|
4762
|
+
user_activity_logging?: boolean;
|
|
4763
|
+
/**
|
|
4764
|
+
* 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.
|
|
4765
|
+
* example:
|
|
4766
|
+
* true
|
|
4767
|
+
*/
|
|
4768
|
+
adaptive_authentication?: boolean;
|
|
4769
|
+
/**
|
|
4770
|
+
* 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.
|
|
4771
|
+
* example:
|
|
4772
|
+
* true
|
|
4773
|
+
*/
|
|
4774
|
+
compromised_credentials_detection?: boolean;
|
|
4775
|
+
};
|
|
4617
4776
|
/**
|
|
4618
4777
|
* Password policy for the portal
|
|
4619
4778
|
*/
|
|
@@ -4975,19 +5134,21 @@ declare namespace Components {
|
|
|
4975
5134
|
* Mark true if the domain is an Epilot domain
|
|
4976
5135
|
*/
|
|
4977
5136
|
is_epilot_domain?: boolean;
|
|
4978
|
-
/**
|
|
4979
|
-
* The Epilot domain on which the portal is accessible
|
|
4980
|
-
* example:
|
|
4981
|
-
* example-portal-1.ecp.epilot.io
|
|
4982
|
-
*/
|
|
4983
|
-
epilot_domain?: string;
|
|
4984
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
4985
5137
|
design_id?: /**
|
|
4986
5138
|
* Entity ID
|
|
4987
5139
|
* example:
|
|
4988
5140
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
4989
5141
|
*/
|
|
4990
5142
|
EntityId /* uuid */;
|
|
5143
|
+
/**
|
|
5144
|
+
* Allowed portal entities for the portal
|
|
5145
|
+
* example:
|
|
5146
|
+
* [
|
|
5147
|
+
* "contact",
|
|
5148
|
+
* "contract"
|
|
5149
|
+
* ]
|
|
5150
|
+
*/
|
|
5151
|
+
allowed_portal_entities?: string[];
|
|
4991
5152
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
4992
5153
|
/**
|
|
4993
5154
|
* Enable or disable user account self management
|
|
@@ -5070,6 +5231,52 @@ declare namespace Components {
|
|
|
5070
5231
|
* eu-central-1_CUEQRNbUb
|
|
5071
5232
|
*/
|
|
5072
5233
|
cognito_user_pool_id?: string;
|
|
5234
|
+
/**
|
|
5235
|
+
* Timeouts for the cognito tokens
|
|
5236
|
+
*/
|
|
5237
|
+
timeouts?: {
|
|
5238
|
+
/**
|
|
5239
|
+
* Timeout for the refresh token
|
|
5240
|
+
* example:
|
|
5241
|
+
* 300
|
|
5242
|
+
*/
|
|
5243
|
+
refresh_token?: number;
|
|
5244
|
+
/**
|
|
5245
|
+
* Timeout for the access token
|
|
5246
|
+
* example:
|
|
5247
|
+
* 300
|
|
5248
|
+
*/
|
|
5249
|
+
access_token?: number;
|
|
5250
|
+
/**
|
|
5251
|
+
* Timeout for the id token
|
|
5252
|
+
* example:
|
|
5253
|
+
* 300
|
|
5254
|
+
*/
|
|
5255
|
+
id_token?: number;
|
|
5256
|
+
};
|
|
5257
|
+
/**
|
|
5258
|
+
* Advanced authentication settings for the portal
|
|
5259
|
+
*/
|
|
5260
|
+
advanced_authentication?: {
|
|
5261
|
+
/**
|
|
5262
|
+
* 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.
|
|
5263
|
+
* example:
|
|
5264
|
+
* true
|
|
5265
|
+
*/
|
|
5266
|
+
user_activity_logging?: boolean;
|
|
5267
|
+
/**
|
|
5268
|
+
* 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.
|
|
5269
|
+
* example:
|
|
5270
|
+
* true
|
|
5271
|
+
*/
|
|
5272
|
+
adaptive_authentication?: boolean;
|
|
5273
|
+
/**
|
|
5274
|
+
* 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.
|
|
5275
|
+
* example:
|
|
5276
|
+
* true
|
|
5277
|
+
*/
|
|
5278
|
+
compromised_credentials_detection?: boolean;
|
|
5279
|
+
};
|
|
5073
5280
|
/**
|
|
5074
5281
|
* Password policy for the portal
|
|
5075
5282
|
*/
|
|
@@ -5415,7 +5622,7 @@ declare namespace Components {
|
|
|
5415
5622
|
_schema: "portal_user";
|
|
5416
5623
|
}
|
|
5417
5624
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
5418
|
-
export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget;
|
|
5625
|
+
export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
|
|
5419
5626
|
/**
|
|
5420
5627
|
* The product entity
|
|
5421
5628
|
*/
|
|
@@ -5462,6 +5669,34 @@ declare namespace Components {
|
|
|
5462
5669
|
_updated_at: string; // date-time
|
|
5463
5670
|
_schema: "product";
|
|
5464
5671
|
}
|
|
5672
|
+
export interface ProductRecommendationsWidget {
|
|
5673
|
+
id: string;
|
|
5674
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
5675
|
+
/**
|
|
5676
|
+
* Index of the widget in the list, used for ordering (left or right)
|
|
5677
|
+
*/
|
|
5678
|
+
listIndex: number;
|
|
5679
|
+
headline?: {
|
|
5680
|
+
en?: string;
|
|
5681
|
+
de?: string;
|
|
5682
|
+
};
|
|
5683
|
+
subHeadline?: {
|
|
5684
|
+
en?: string;
|
|
5685
|
+
de?: string;
|
|
5686
|
+
};
|
|
5687
|
+
imageUrl?: string;
|
|
5688
|
+
button?: {
|
|
5689
|
+
label?: {
|
|
5690
|
+
en?: string;
|
|
5691
|
+
de?: string;
|
|
5692
|
+
};
|
|
5693
|
+
url?: string;
|
|
5694
|
+
};
|
|
5695
|
+
/**
|
|
5696
|
+
* ID of the campaign
|
|
5697
|
+
*/
|
|
5698
|
+
campaign_id?: string;
|
|
5699
|
+
}
|
|
5465
5700
|
export interface ProviderConfig {
|
|
5466
5701
|
slug?: /**
|
|
5467
5702
|
* URL-friendly slug to use as organization-unique identifier for Provider
|
|
@@ -5874,12 +6109,25 @@ declare namespace Components {
|
|
|
5874
6109
|
*/
|
|
5875
6110
|
slug?: string;
|
|
5876
6111
|
}
|
|
6112
|
+
/**
|
|
6113
|
+
* Side-loaded enrichment data requested via the `include` parameter.
|
|
6114
|
+
*/
|
|
6115
|
+
export interface SearchIncludes {
|
|
6116
|
+
/**
|
|
6117
|
+
* The active workflow execution for each entity, keyed by entity ID. Only entities with an active workflow are present.
|
|
6118
|
+
*/
|
|
6119
|
+
active_workflow?: {
|
|
6120
|
+
[name: string]: {
|
|
6121
|
+
[key: string]: any;
|
|
6122
|
+
};
|
|
6123
|
+
};
|
|
6124
|
+
}
|
|
5877
6125
|
export type Source = "ECP" | "ERP" | "360" | "journey-submission";
|
|
5878
6126
|
export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
|
|
5879
6127
|
export type TariffType = "ht" | "nt";
|
|
5880
6128
|
export interface TeaserWidget {
|
|
5881
6129
|
id: string;
|
|
5882
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
6130
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
5883
6131
|
/**
|
|
5884
6132
|
* Index of the widget in the list, used for ordering (left or right)
|
|
5885
6133
|
*/
|
|
@@ -6029,19 +6277,21 @@ declare namespace Components {
|
|
|
6029
6277
|
* Mark true if the domain is an Epilot domain
|
|
6030
6278
|
*/
|
|
6031
6279
|
is_epilot_domain?: boolean;
|
|
6032
|
-
/**
|
|
6033
|
-
* The URL on which the portal is accessible
|
|
6034
|
-
* example:
|
|
6035
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
6036
|
-
*/
|
|
6037
|
-
epilot_domain?: string;
|
|
6038
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6039
6280
|
design_id?: /**
|
|
6040
6281
|
* Entity ID
|
|
6041
6282
|
* example:
|
|
6042
6283
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
6043
6284
|
*/
|
|
6044
6285
|
EntityId /* uuid */;
|
|
6286
|
+
/**
|
|
6287
|
+
* Allowed portal entities for the portal
|
|
6288
|
+
* example:
|
|
6289
|
+
* [
|
|
6290
|
+
* "contact",
|
|
6291
|
+
* "contract"
|
|
6292
|
+
* ]
|
|
6293
|
+
*/
|
|
6294
|
+
allowed_portal_entities?: string[];
|
|
6045
6295
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
6046
6296
|
/**
|
|
6047
6297
|
* Enable or disable user account self management
|
|
@@ -6124,6 +6374,52 @@ declare namespace Components {
|
|
|
6124
6374
|
* eu-central-1_CUEQRNbUb
|
|
6125
6375
|
*/
|
|
6126
6376
|
cognito_user_pool_id?: string;
|
|
6377
|
+
/**
|
|
6378
|
+
* Timeouts for the cognito tokens
|
|
6379
|
+
*/
|
|
6380
|
+
timeouts?: {
|
|
6381
|
+
/**
|
|
6382
|
+
* Timeout for the refresh token
|
|
6383
|
+
* example:
|
|
6384
|
+
* 300
|
|
6385
|
+
*/
|
|
6386
|
+
refresh_token?: number;
|
|
6387
|
+
/**
|
|
6388
|
+
* Timeout for the access token
|
|
6389
|
+
* example:
|
|
6390
|
+
* 300
|
|
6391
|
+
*/
|
|
6392
|
+
access_token?: number;
|
|
6393
|
+
/**
|
|
6394
|
+
* Timeout for the id token
|
|
6395
|
+
* example:
|
|
6396
|
+
* 300
|
|
6397
|
+
*/
|
|
6398
|
+
id_token?: number;
|
|
6399
|
+
};
|
|
6400
|
+
/**
|
|
6401
|
+
* Advanced authentication settings for the portal
|
|
6402
|
+
*/
|
|
6403
|
+
advanced_authentication?: {
|
|
6404
|
+
/**
|
|
6405
|
+
* 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.
|
|
6406
|
+
* example:
|
|
6407
|
+
* true
|
|
6408
|
+
*/
|
|
6409
|
+
user_activity_logging?: boolean;
|
|
6410
|
+
/**
|
|
6411
|
+
* 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.
|
|
6412
|
+
* example:
|
|
6413
|
+
* true
|
|
6414
|
+
*/
|
|
6415
|
+
adaptive_authentication?: boolean;
|
|
6416
|
+
/**
|
|
6417
|
+
* 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.
|
|
6418
|
+
* example:
|
|
6419
|
+
* true
|
|
6420
|
+
*/
|
|
6421
|
+
compromised_credentials_detection?: boolean;
|
|
6422
|
+
};
|
|
6127
6423
|
/**
|
|
6128
6424
|
* Password policy for the portal
|
|
6129
6425
|
*/
|
|
@@ -6439,19 +6735,21 @@ declare namespace Components {
|
|
|
6439
6735
|
* Mark true if the domain is an Epilot domain
|
|
6440
6736
|
*/
|
|
6441
6737
|
is_epilot_domain?: boolean;
|
|
6442
|
-
/**
|
|
6443
|
-
* The Epilot domain on which the portal is accessible
|
|
6444
|
-
* example:
|
|
6445
|
-
* example-portal-1.ecp.epilot.io
|
|
6446
|
-
*/
|
|
6447
|
-
epilot_domain?: string;
|
|
6448
|
-
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6449
6738
|
design_id?: /**
|
|
6450
6739
|
* Entity ID
|
|
6451
6740
|
* example:
|
|
6452
6741
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
6453
6742
|
*/
|
|
6454
6743
|
EntityId /* uuid */;
|
|
6744
|
+
/**
|
|
6745
|
+
* Allowed portal entities for the portal
|
|
6746
|
+
* example:
|
|
6747
|
+
* [
|
|
6748
|
+
* "contact",
|
|
6749
|
+
* "contract"
|
|
6750
|
+
* ]
|
|
6751
|
+
*/
|
|
6752
|
+
allowed_portal_entities?: string[];
|
|
6455
6753
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
6456
6754
|
/**
|
|
6457
6755
|
* Enable or disable user account self management
|
|
@@ -6534,6 +6832,52 @@ declare namespace Components {
|
|
|
6534
6832
|
* eu-central-1_CUEQRNbUb
|
|
6535
6833
|
*/
|
|
6536
6834
|
cognito_user_pool_id?: string;
|
|
6835
|
+
/**
|
|
6836
|
+
* Timeouts for the cognito tokens
|
|
6837
|
+
*/
|
|
6838
|
+
timeouts?: {
|
|
6839
|
+
/**
|
|
6840
|
+
* Timeout for the refresh token
|
|
6841
|
+
* example:
|
|
6842
|
+
* 300
|
|
6843
|
+
*/
|
|
6844
|
+
refresh_token?: number;
|
|
6845
|
+
/**
|
|
6846
|
+
* Timeout for the access token
|
|
6847
|
+
* example:
|
|
6848
|
+
* 300
|
|
6849
|
+
*/
|
|
6850
|
+
access_token?: number;
|
|
6851
|
+
/**
|
|
6852
|
+
* Timeout for the id token
|
|
6853
|
+
* example:
|
|
6854
|
+
* 300
|
|
6855
|
+
*/
|
|
6856
|
+
id_token?: number;
|
|
6857
|
+
};
|
|
6858
|
+
/**
|
|
6859
|
+
* Advanced authentication settings for the portal
|
|
6860
|
+
*/
|
|
6861
|
+
advanced_authentication?: {
|
|
6862
|
+
/**
|
|
6863
|
+
* 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.
|
|
6864
|
+
* example:
|
|
6865
|
+
* true
|
|
6866
|
+
*/
|
|
6867
|
+
user_activity_logging?: boolean;
|
|
6868
|
+
/**
|
|
6869
|
+
* 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.
|
|
6870
|
+
* example:
|
|
6871
|
+
* true
|
|
6872
|
+
*/
|
|
6873
|
+
adaptive_authentication?: boolean;
|
|
6874
|
+
/**
|
|
6875
|
+
* 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.
|
|
6876
|
+
* example:
|
|
6877
|
+
* true
|
|
6878
|
+
*/
|
|
6879
|
+
compromised_credentials_detection?: boolean;
|
|
6880
|
+
};
|
|
6537
6881
|
/**
|
|
6538
6882
|
* Password policy for the portal
|
|
6539
6883
|
*/
|
|
@@ -6834,7 +7178,7 @@ declare namespace Components {
|
|
|
6834
7178
|
}
|
|
6835
7179
|
export interface WidgetBase {
|
|
6836
7180
|
id: string;
|
|
6837
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
7181
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
6838
7182
|
/**
|
|
6839
7183
|
* Index of the widget in the list, used for ordering (left or right)
|
|
6840
7184
|
*/
|
|
@@ -8960,19 +9304,21 @@ declare namespace Paths {
|
|
|
8960
9304
|
* Mark true if the domain is an Epilot domain
|
|
8961
9305
|
*/
|
|
8962
9306
|
is_epilot_domain?: boolean;
|
|
8963
|
-
/**
|
|
8964
|
-
* The URL on which the portal is accessible
|
|
8965
|
-
* example:
|
|
8966
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
8967
|
-
*/
|
|
8968
|
-
epilot_domain?: string;
|
|
8969
|
-
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
8970
9307
|
design_id?: /**
|
|
8971
9308
|
* Entity ID
|
|
8972
9309
|
* example:
|
|
8973
9310
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8974
9311
|
*/
|
|
8975
9312
|
Components.Schemas.EntityId /* uuid */;
|
|
9313
|
+
/**
|
|
9314
|
+
* Allowed portal entities for the portal
|
|
9315
|
+
* example:
|
|
9316
|
+
* [
|
|
9317
|
+
* "contact",
|
|
9318
|
+
* "contract"
|
|
9319
|
+
* ]
|
|
9320
|
+
*/
|
|
9321
|
+
allowed_portal_entities?: string[];
|
|
8976
9322
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
8977
9323
|
/**
|
|
8978
9324
|
* Enable or disable user account self management
|
|
@@ -9055,6 +9401,52 @@ declare namespace Paths {
|
|
|
9055
9401
|
* eu-central-1_CUEQRNbUb
|
|
9056
9402
|
*/
|
|
9057
9403
|
cognito_user_pool_id?: string;
|
|
9404
|
+
/**
|
|
9405
|
+
* Timeouts for the cognito tokens
|
|
9406
|
+
*/
|
|
9407
|
+
timeouts?: {
|
|
9408
|
+
/**
|
|
9409
|
+
* Timeout for the refresh token
|
|
9410
|
+
* example:
|
|
9411
|
+
* 300
|
|
9412
|
+
*/
|
|
9413
|
+
refresh_token?: number;
|
|
9414
|
+
/**
|
|
9415
|
+
* Timeout for the access token
|
|
9416
|
+
* example:
|
|
9417
|
+
* 300
|
|
9418
|
+
*/
|
|
9419
|
+
access_token?: number;
|
|
9420
|
+
/**
|
|
9421
|
+
* Timeout for the id token
|
|
9422
|
+
* example:
|
|
9423
|
+
* 300
|
|
9424
|
+
*/
|
|
9425
|
+
id_token?: number;
|
|
9426
|
+
};
|
|
9427
|
+
/**
|
|
9428
|
+
* Advanced authentication settings for the portal
|
|
9429
|
+
*/
|
|
9430
|
+
advanced_authentication?: {
|
|
9431
|
+
/**
|
|
9432
|
+
* 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.
|
|
9433
|
+
* example:
|
|
9434
|
+
* true
|
|
9435
|
+
*/
|
|
9436
|
+
user_activity_logging?: boolean;
|
|
9437
|
+
/**
|
|
9438
|
+
* 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.
|
|
9439
|
+
* example:
|
|
9440
|
+
* true
|
|
9441
|
+
*/
|
|
9442
|
+
adaptive_authentication?: boolean;
|
|
9443
|
+
/**
|
|
9444
|
+
* 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.
|
|
9445
|
+
* example:
|
|
9446
|
+
* true
|
|
9447
|
+
*/
|
|
9448
|
+
compromised_credentials_detection?: boolean;
|
|
9449
|
+
};
|
|
9058
9450
|
/**
|
|
9059
9451
|
* Password policy for the portal
|
|
9060
9452
|
*/
|
|
@@ -9406,19 +9798,21 @@ declare namespace Paths {
|
|
|
9406
9798
|
* Mark true if the domain is an Epilot domain
|
|
9407
9799
|
*/
|
|
9408
9800
|
is_epilot_domain?: boolean;
|
|
9409
|
-
/**
|
|
9410
|
-
* The URL on which the portal is accessible
|
|
9411
|
-
* example:
|
|
9412
|
-
* example-portal-12345.ecp.epilot.cloud
|
|
9413
|
-
*/
|
|
9414
|
-
epilot_domain?: string;
|
|
9415
|
-
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
9416
9801
|
design_id?: /**
|
|
9417
9802
|
* Entity ID
|
|
9418
9803
|
* example:
|
|
9419
9804
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
9420
9805
|
*/
|
|
9421
9806
|
Components.Schemas.EntityId /* uuid */;
|
|
9807
|
+
/**
|
|
9808
|
+
* Allowed portal entities for the portal
|
|
9809
|
+
* example:
|
|
9810
|
+
* [
|
|
9811
|
+
* "contact",
|
|
9812
|
+
* "contract"
|
|
9813
|
+
* ]
|
|
9814
|
+
*/
|
|
9815
|
+
allowed_portal_entities?: string[];
|
|
9422
9816
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
9423
9817
|
/**
|
|
9424
9818
|
* Enable or disable user account self management
|
|
@@ -9501,6 +9895,52 @@ declare namespace Paths {
|
|
|
9501
9895
|
* eu-central-1_CUEQRNbUb
|
|
9502
9896
|
*/
|
|
9503
9897
|
cognito_user_pool_id?: string;
|
|
9898
|
+
/**
|
|
9899
|
+
* Timeouts for the cognito tokens
|
|
9900
|
+
*/
|
|
9901
|
+
timeouts?: {
|
|
9902
|
+
/**
|
|
9903
|
+
* Timeout for the refresh token
|
|
9904
|
+
* example:
|
|
9905
|
+
* 300
|
|
9906
|
+
*/
|
|
9907
|
+
refresh_token?: number;
|
|
9908
|
+
/**
|
|
9909
|
+
* Timeout for the access token
|
|
9910
|
+
* example:
|
|
9911
|
+
* 300
|
|
9912
|
+
*/
|
|
9913
|
+
access_token?: number;
|
|
9914
|
+
/**
|
|
9915
|
+
* Timeout for the id token
|
|
9916
|
+
* example:
|
|
9917
|
+
* 300
|
|
9918
|
+
*/
|
|
9919
|
+
id_token?: number;
|
|
9920
|
+
};
|
|
9921
|
+
/**
|
|
9922
|
+
* Advanced authentication settings for the portal
|
|
9923
|
+
*/
|
|
9924
|
+
advanced_authentication?: {
|
|
9925
|
+
/**
|
|
9926
|
+
* 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.
|
|
9927
|
+
* example:
|
|
9928
|
+
* true
|
|
9929
|
+
*/
|
|
9930
|
+
user_activity_logging?: boolean;
|
|
9931
|
+
/**
|
|
9932
|
+
* 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.
|
|
9933
|
+
* example:
|
|
9934
|
+
* true
|
|
9935
|
+
*/
|
|
9936
|
+
adaptive_authentication?: boolean;
|
|
9937
|
+
/**
|
|
9938
|
+
* 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.
|
|
9939
|
+
* example:
|
|
9940
|
+
* true
|
|
9941
|
+
*/
|
|
9942
|
+
compromised_credentials_detection?: boolean;
|
|
9943
|
+
};
|
|
9504
9944
|
/**
|
|
9505
9945
|
* Password policy for the portal
|
|
9506
9946
|
*/
|
|
@@ -10777,6 +11217,31 @@ declare namespace Paths {
|
|
|
10777
11217
|
export type $500 = Components.Responses.InternalServerError;
|
|
10778
11218
|
}
|
|
10779
11219
|
}
|
|
11220
|
+
namespace InterpolatePortalPages {
|
|
11221
|
+
export interface RequestBody {
|
|
11222
|
+
/**
|
|
11223
|
+
* The pages to interpolate
|
|
11224
|
+
*/
|
|
11225
|
+
pages: Components.Schemas.Page[];
|
|
11226
|
+
context_entities?: /**
|
|
11227
|
+
* Additional entities to include in the context for variable interpolation. Portal User and Contact entities are automatically part of the context.
|
|
11228
|
+
* example:
|
|
11229
|
+
* [
|
|
11230
|
+
* {
|
|
11231
|
+
* "entity_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
11232
|
+
* "entity_schema": "contract"
|
|
11233
|
+
* }
|
|
11234
|
+
* ]
|
|
11235
|
+
*/
|
|
11236
|
+
Components.Schemas.ContextEntities;
|
|
11237
|
+
}
|
|
11238
|
+
namespace Responses {
|
|
11239
|
+
export type $200 = Components.Schemas.Page[];
|
|
11240
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11241
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11242
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11243
|
+
}
|
|
11244
|
+
}
|
|
10780
11245
|
namespace InvitePartner {
|
|
10781
11246
|
export interface RequestBody {
|
|
10782
11247
|
/**
|
|
@@ -10789,6 +11254,14 @@ declare namespace Paths {
|
|
|
10789
11254
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
10790
11255
|
*/
|
|
10791
11256
|
Components.Schemas.EntityId /* uuid */[];
|
|
11257
|
+
/**
|
|
11258
|
+
* Additional contact entity fields to set when creating the contact for the invited user.
|
|
11259
|
+
* These are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).
|
|
11260
|
+
*
|
|
11261
|
+
*/
|
|
11262
|
+
contact_data?: {
|
|
11263
|
+
[name: string]: string;
|
|
11264
|
+
};
|
|
10792
11265
|
}
|
|
10793
11266
|
namespace Responses {
|
|
10794
11267
|
export interface $200 {
|
|
@@ -12146,6 +12619,7 @@ declare namespace Paths {
|
|
|
12146
12619
|
}
|
|
12147
12620
|
}
|
|
12148
12621
|
|
|
12622
|
+
|
|
12149
12623
|
export interface OperationMethods {
|
|
12150
12624
|
/**
|
|
12151
12625
|
* upsertPortal - upsertPortal
|
|
@@ -13282,6 +13756,16 @@ export interface OperationMethods {
|
|
|
13282
13756
|
data?: any,
|
|
13283
13757
|
config?: AxiosRequestConfig
|
|
13284
13758
|
): OperationResponse<Paths.GetPublicPages.Responses.$200>
|
|
13759
|
+
/**
|
|
13760
|
+
* interpolatePortalPages - interpolatePortalPages
|
|
13761
|
+
*
|
|
13762
|
+
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
|
|
13763
|
+
*/
|
|
13764
|
+
'interpolatePortalPages'(
|
|
13765
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13766
|
+
data?: Paths.InterpolatePortalPages.RequestBody,
|
|
13767
|
+
config?: AxiosRequestConfig
|
|
13768
|
+
): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
|
|
13285
13769
|
/**
|
|
13286
13770
|
* getDefaultPages - getDefaultPages
|
|
13287
13771
|
*
|
|
@@ -14844,6 +15328,18 @@ export interface PathsDictionary {
|
|
|
14844
15328
|
config?: AxiosRequestConfig
|
|
14845
15329
|
): OperationResponse<Paths.GetPublicPages.Responses.$200>
|
|
14846
15330
|
}
|
|
15331
|
+
['/v2/portal/pages/interpolate']: {
|
|
15332
|
+
/**
|
|
15333
|
+
* interpolatePortalPages - interpolatePortalPages
|
|
15334
|
+
*
|
|
15335
|
+
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
|
|
15336
|
+
*/
|
|
15337
|
+
'post'(
|
|
15338
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15339
|
+
data?: Paths.InterpolatePortalPages.RequestBody,
|
|
15340
|
+
config?: AxiosRequestConfig
|
|
15341
|
+
): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
|
|
15342
|
+
}
|
|
14847
15343
|
['/v2/portal/pages/default']: {
|
|
14848
15344
|
/**
|
|
14849
15345
|
* getDefaultPages - getDefaultPages
|
|
@@ -15114,6 +15610,7 @@ export interface PathsDictionary {
|
|
|
15114
15610
|
|
|
15115
15611
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
15116
15612
|
|
|
15613
|
+
|
|
15117
15614
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
15118
15615
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
15119
15616
|
export type ActionWidget = Components.Schemas.ActionWidget;
|
|
@@ -15153,7 +15650,6 @@ export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
|
15153
15650
|
export type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
|
|
15154
15651
|
export type Direction = Components.Schemas.Direction;
|
|
15155
15652
|
export type DocumentWidget = Components.Schemas.DocumentWidget;
|
|
15156
|
-
export type DomainSettings = Components.Schemas.DomainSettings;
|
|
15157
15653
|
export type EmailTemplates = Components.Schemas.EmailTemplates;
|
|
15158
15654
|
export type Entity = Components.Schemas.Entity;
|
|
15159
15655
|
export type EntityEditRule = Components.Schemas.EntityEditRule;
|
|
@@ -15167,6 +15663,7 @@ export type EntityResponseGroupedWithHits = Components.Schemas.EntityResponseGro
|
|
|
15167
15663
|
export type EntityResponseWithHits = Components.Schemas.EntityResponseWithHits;
|
|
15168
15664
|
export type EntitySearchParams = Components.Schemas.EntitySearchParams;
|
|
15169
15665
|
export type EntitySlug = Components.Schemas.EntitySlug;
|
|
15666
|
+
export type EntitySlugConfig = Components.Schemas.EntitySlugConfig;
|
|
15170
15667
|
export type EntityTemplates = Components.Schemas.EntityTemplates;
|
|
15171
15668
|
export type EntityWidget = Components.Schemas.EntityWidget;
|
|
15172
15669
|
export type ErrorResp = Components.Schemas.ErrorResp;
|
|
@@ -15216,6 +15713,7 @@ export type PortalUser = Components.Schemas.PortalUser;
|
|
|
15216
15713
|
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
|
15217
15714
|
export type PortalWidget = Components.Schemas.PortalWidget;
|
|
15218
15715
|
export type Product = Components.Schemas.Product;
|
|
15716
|
+
export type ProductRecommendationsWidget = Components.Schemas.ProductRecommendationsWidget;
|
|
15219
15717
|
export type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
15220
15718
|
export type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
15221
15719
|
export type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
@@ -15238,6 +15736,7 @@ export type SSOLoginToken = Components.Schemas.SSOLoginToken;
|
|
|
15238
15736
|
export type SaveEntityFile = Components.Schemas.SaveEntityFile;
|
|
15239
15737
|
export type SavePortalFile = Components.Schemas.SavePortalFile;
|
|
15240
15738
|
export type Schema = Components.Schemas.Schema;
|
|
15739
|
+
export type SearchIncludes = Components.Schemas.SearchIncludes;
|
|
15241
15740
|
export type Source = Components.Schemas.Source;
|
|
15242
15741
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
15243
15742
|
export type TariffType = Components.Schemas.TariffType;
|