@epilot/customer-portal-client 0.33.2 → 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 +594 -17
- package/package.json +13 -17
- package/src/openapi-runtime.json +12 -0
- package/src/openapi.d.ts +15754 -0
- package/src/openapi.json +278 -2
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
|
*/
|
|
@@ -836,6 +834,15 @@ declare namespace Components {
|
|
|
836
834
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
837
835
|
*/
|
|
838
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[];
|
|
839
846
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
840
847
|
/**
|
|
841
848
|
* Enable or disable user account self management
|
|
@@ -918,6 +925,52 @@ declare namespace Components {
|
|
|
918
925
|
* eu-central-1_CUEQRNbUb
|
|
919
926
|
*/
|
|
920
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
|
+
};
|
|
921
974
|
/**
|
|
922
975
|
* Password policy for the portal
|
|
923
976
|
*/
|
|
@@ -1202,6 +1255,15 @@ declare namespace Components {
|
|
|
1202
1255
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
1203
1256
|
*/
|
|
1204
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[];
|
|
1205
1267
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
1206
1268
|
/**
|
|
1207
1269
|
* Enable or disable user account self management
|
|
@@ -1284,6 +1346,52 @@ declare namespace Components {
|
|
|
1284
1346
|
* eu-central-1_CUEQRNbUb
|
|
1285
1347
|
*/
|
|
1286
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
|
+
};
|
|
1287
1395
|
/**
|
|
1288
1396
|
* Password policy for the portal
|
|
1289
1397
|
*/
|
|
@@ -1622,7 +1730,7 @@ declare namespace Components {
|
|
|
1622
1730
|
}
|
|
1623
1731
|
export interface ContentWidget {
|
|
1624
1732
|
id: string;
|
|
1625
|
-
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";
|
|
1626
1734
|
/**
|
|
1627
1735
|
* Index of the widget in the list, used for ordering (left or right)
|
|
1628
1736
|
*/
|
|
@@ -1963,7 +2071,7 @@ declare namespace Components {
|
|
|
1963
2071
|
export type Direction = "feed-in" | "feed-out";
|
|
1964
2072
|
export interface DocumentWidget {
|
|
1965
2073
|
id: string;
|
|
1966
|
-
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";
|
|
1967
2075
|
/**
|
|
1968
2076
|
* Index of the widget in the list, used for ordering (left or right)
|
|
1969
2077
|
*/
|
|
@@ -2442,6 +2550,7 @@ declare namespace Components {
|
|
|
2442
2550
|
* 5
|
|
2443
2551
|
*/
|
|
2444
2552
|
hits?: number;
|
|
2553
|
+
includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
|
|
2445
2554
|
}
|
|
2446
2555
|
/**
|
|
2447
2556
|
* Response for entity search requests
|
|
@@ -2481,12 +2590,13 @@ declare namespace Components {
|
|
|
2481
2590
|
* 10
|
|
2482
2591
|
*/
|
|
2483
2592
|
hits?: number;
|
|
2593
|
+
includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
|
|
2484
2594
|
}
|
|
2485
2595
|
export interface EntitySearchParams {
|
|
2486
2596
|
/**
|
|
2487
|
-
*
|
|
2597
|
+
* Entity slug, array of slugs, or array of per-slug configurations
|
|
2488
2598
|
*/
|
|
2489
|
-
slug: /*
|
|
2599
|
+
slug: /* Entity slug, array of slugs, or array of per-slug configurations */ /**
|
|
2490
2600
|
* URL-friendly identifier for the entity schema
|
|
2491
2601
|
* example:
|
|
2492
2602
|
* contact
|
|
@@ -2504,6 +2614,9 @@ declare namespace Components {
|
|
|
2504
2614
|
* contact
|
|
2505
2615
|
*/
|
|
2506
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[]
|
|
2507
2620
|
];
|
|
2508
2621
|
/**
|
|
2509
2622
|
* Keyword search query
|
|
@@ -2632,6 +2745,14 @@ declare namespace Components {
|
|
|
2632
2745
|
* ]
|
|
2633
2746
|
*/
|
|
2634
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")[];
|
|
2635
2756
|
}
|
|
2636
2757
|
/**
|
|
2637
2758
|
* URL-friendly identifier for the entity schema
|
|
@@ -2639,6 +2760,21 @@ declare namespace Components {
|
|
|
2639
2760
|
* contact
|
|
2640
2761
|
*/
|
|
2641
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
|
+
}
|
|
2642
2778
|
export interface EntityTemplates {
|
|
2643
2779
|
/**
|
|
2644
2780
|
* Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
|
|
@@ -2661,7 +2797,7 @@ declare namespace Components {
|
|
|
2661
2797
|
}
|
|
2662
2798
|
export interface EntityWidget {
|
|
2663
2799
|
id: string;
|
|
2664
|
-
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";
|
|
2665
2801
|
/**
|
|
2666
2802
|
* Index of the widget in the list, used for ordering (left or right)
|
|
2667
2803
|
*/
|
|
@@ -3767,7 +3903,7 @@ declare namespace Components {
|
|
|
3767
3903
|
}
|
|
3768
3904
|
export interface MeterChartWidget {
|
|
3769
3905
|
id: string;
|
|
3770
|
-
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";
|
|
3771
3907
|
/**
|
|
3772
3908
|
* Index of the widget in the list, used for ordering (left or right)
|
|
3773
3909
|
*/
|
|
@@ -3931,7 +4067,7 @@ declare namespace Components {
|
|
|
3931
4067
|
}
|
|
3932
4068
|
export interface MeterReadingWidget {
|
|
3933
4069
|
id: string;
|
|
3934
|
-
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";
|
|
3935
4071
|
/**
|
|
3936
4072
|
* Index of the widget in the list, used for ordering (left or right)
|
|
3937
4073
|
*/
|
|
@@ -4323,6 +4459,12 @@ declare namespace Components {
|
|
|
4323
4459
|
* contact
|
|
4324
4460
|
*/
|
|
4325
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;
|
|
4326
4468
|
/**
|
|
4327
4469
|
* Whether the page is public
|
|
4328
4470
|
* example:
|
|
@@ -4334,7 +4476,7 @@ declare namespace Components {
|
|
|
4334
4476
|
* example:
|
|
4335
4477
|
* c495fef9-eeca-4019-a989-8390dcd9825b
|
|
4336
4478
|
*/
|
|
4337
|
-
parentId?: string;
|
|
4479
|
+
parentId?: string | null;
|
|
4338
4480
|
/**
|
|
4339
4481
|
* Whether the page is the entry route
|
|
4340
4482
|
* example:
|
|
@@ -4420,6 +4562,12 @@ declare namespace Components {
|
|
|
4420
4562
|
* contact
|
|
4421
4563
|
*/
|
|
4422
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;
|
|
4423
4571
|
/**
|
|
4424
4572
|
* Whether the page is public
|
|
4425
4573
|
* example:
|
|
@@ -4431,7 +4579,7 @@ declare namespace Components {
|
|
|
4431
4579
|
* example:
|
|
4432
4580
|
* c495fef9-eeca-4019-a989-8390dcd9825b
|
|
4433
4581
|
*/
|
|
4434
|
-
parentId?: string;
|
|
4582
|
+
parentId?: string | null;
|
|
4435
4583
|
/**
|
|
4436
4584
|
* Whether the page is the entry route
|
|
4437
4585
|
* example:
|
|
@@ -4447,7 +4595,7 @@ declare namespace Components {
|
|
|
4447
4595
|
}
|
|
4448
4596
|
export interface PaymentWidget {
|
|
4449
4597
|
id: string;
|
|
4450
|
-
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";
|
|
4451
4599
|
/**
|
|
4452
4600
|
* Index of the widget in the list, used for ordering (left or right)
|
|
4453
4601
|
*/
|
|
@@ -4488,6 +4636,15 @@ declare namespace Components {
|
|
|
4488
4636
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
4489
4637
|
*/
|
|
4490
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[];
|
|
4491
4648
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
4492
4649
|
/**
|
|
4493
4650
|
* Enable or disable user account self management
|
|
@@ -4570,6 +4727,52 @@ declare namespace Components {
|
|
|
4570
4727
|
* eu-central-1_CUEQRNbUb
|
|
4571
4728
|
*/
|
|
4572
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
|
+
};
|
|
4573
4776
|
/**
|
|
4574
4777
|
* Password policy for the portal
|
|
4575
4778
|
*/
|
|
@@ -4937,6 +5140,15 @@ declare namespace Components {
|
|
|
4937
5140
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
4938
5141
|
*/
|
|
4939
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[];
|
|
4940
5152
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
4941
5153
|
/**
|
|
4942
5154
|
* Enable or disable user account self management
|
|
@@ -5019,6 +5231,52 @@ declare namespace Components {
|
|
|
5019
5231
|
* eu-central-1_CUEQRNbUb
|
|
5020
5232
|
*/
|
|
5021
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
|
+
};
|
|
5022
5280
|
/**
|
|
5023
5281
|
* Password policy for the portal
|
|
5024
5282
|
*/
|
|
@@ -5364,7 +5622,7 @@ declare namespace Components {
|
|
|
5364
5622
|
_schema: "portal_user";
|
|
5365
5623
|
}
|
|
5366
5624
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
5367
|
-
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;
|
|
5368
5626
|
/**
|
|
5369
5627
|
* The product entity
|
|
5370
5628
|
*/
|
|
@@ -5411,6 +5669,34 @@ declare namespace Components {
|
|
|
5411
5669
|
_updated_at: string; // date-time
|
|
5412
5670
|
_schema: "product";
|
|
5413
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
|
+
}
|
|
5414
5700
|
export interface ProviderConfig {
|
|
5415
5701
|
slug?: /**
|
|
5416
5702
|
* URL-friendly slug to use as organization-unique identifier for Provider
|
|
@@ -5823,12 +6109,25 @@ declare namespace Components {
|
|
|
5823
6109
|
*/
|
|
5824
6110
|
slug?: string;
|
|
5825
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
|
+
}
|
|
5826
6125
|
export type Source = "ECP" | "ERP" | "360" | "journey-submission";
|
|
5827
6126
|
export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
|
|
5828
6127
|
export type TariffType = "ht" | "nt";
|
|
5829
6128
|
export interface TeaserWidget {
|
|
5830
6129
|
id: string;
|
|
5831
|
-
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";
|
|
5832
6131
|
/**
|
|
5833
6132
|
* Index of the widget in the list, used for ordering (left or right)
|
|
5834
6133
|
*/
|
|
@@ -5984,6 +6283,15 @@ declare namespace Components {
|
|
|
5984
6283
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
5985
6284
|
*/
|
|
5986
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[];
|
|
5987
6295
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
5988
6296
|
/**
|
|
5989
6297
|
* Enable or disable user account self management
|
|
@@ -6066,6 +6374,52 @@ declare namespace Components {
|
|
|
6066
6374
|
* eu-central-1_CUEQRNbUb
|
|
6067
6375
|
*/
|
|
6068
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
|
+
};
|
|
6069
6423
|
/**
|
|
6070
6424
|
* Password policy for the portal
|
|
6071
6425
|
*/
|
|
@@ -6387,6 +6741,15 @@ declare namespace Components {
|
|
|
6387
6741
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
6388
6742
|
*/
|
|
6389
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[];
|
|
6390
6753
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
6391
6754
|
/**
|
|
6392
6755
|
* Enable or disable user account self management
|
|
@@ -6469,6 +6832,52 @@ declare namespace Components {
|
|
|
6469
6832
|
* eu-central-1_CUEQRNbUb
|
|
6470
6833
|
*/
|
|
6471
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
|
+
};
|
|
6472
6881
|
/**
|
|
6473
6882
|
* Password policy for the portal
|
|
6474
6883
|
*/
|
|
@@ -6769,7 +7178,7 @@ declare namespace Components {
|
|
|
6769
7178
|
}
|
|
6770
7179
|
export interface WidgetBase {
|
|
6771
7180
|
id: string;
|
|
6772
|
-
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";
|
|
6773
7182
|
/**
|
|
6774
7183
|
* Index of the widget in the list, used for ordering (left or right)
|
|
6775
7184
|
*/
|
|
@@ -8901,6 +9310,15 @@ declare namespace Paths {
|
|
|
8901
9310
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8902
9311
|
*/
|
|
8903
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[];
|
|
8904
9322
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
8905
9323
|
/**
|
|
8906
9324
|
* Enable or disable user account self management
|
|
@@ -8983,6 +9401,52 @@ declare namespace Paths {
|
|
|
8983
9401
|
* eu-central-1_CUEQRNbUb
|
|
8984
9402
|
*/
|
|
8985
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
|
+
};
|
|
8986
9450
|
/**
|
|
8987
9451
|
* Password policy for the portal
|
|
8988
9452
|
*/
|
|
@@ -9340,6 +9804,15 @@ declare namespace Paths {
|
|
|
9340
9804
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
9341
9805
|
*/
|
|
9342
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[];
|
|
9343
9816
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
9344
9817
|
/**
|
|
9345
9818
|
* Enable or disable user account self management
|
|
@@ -9422,6 +9895,52 @@ declare namespace Paths {
|
|
|
9422
9895
|
* eu-central-1_CUEQRNbUb
|
|
9423
9896
|
*/
|
|
9424
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
|
+
};
|
|
9425
9944
|
/**
|
|
9426
9945
|
* Password policy for the portal
|
|
9427
9946
|
*/
|
|
@@ -10698,6 +11217,31 @@ declare namespace Paths {
|
|
|
10698
11217
|
export type $500 = Components.Responses.InternalServerError;
|
|
10699
11218
|
}
|
|
10700
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
|
+
}
|
|
10701
11245
|
namespace InvitePartner {
|
|
10702
11246
|
export interface RequestBody {
|
|
10703
11247
|
/**
|
|
@@ -10710,6 +11254,14 @@ declare namespace Paths {
|
|
|
10710
11254
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
10711
11255
|
*/
|
|
10712
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
|
+
};
|
|
10713
11265
|
}
|
|
10714
11266
|
namespace Responses {
|
|
10715
11267
|
export interface $200 {
|
|
@@ -13204,6 +13756,16 @@ export interface OperationMethods {
|
|
|
13204
13756
|
data?: any,
|
|
13205
13757
|
config?: AxiosRequestConfig
|
|
13206
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>
|
|
13207
13769
|
/**
|
|
13208
13770
|
* getDefaultPages - getDefaultPages
|
|
13209
13771
|
*
|
|
@@ -14766,6 +15328,18 @@ export interface PathsDictionary {
|
|
|
14766
15328
|
config?: AxiosRequestConfig
|
|
14767
15329
|
): OperationResponse<Paths.GetPublicPages.Responses.$200>
|
|
14768
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
|
+
}
|
|
14769
15343
|
['/v2/portal/pages/default']: {
|
|
14770
15344
|
/**
|
|
14771
15345
|
* getDefaultPages - getDefaultPages
|
|
@@ -15089,6 +15663,7 @@ export type EntityResponseGroupedWithHits = Components.Schemas.EntityResponseGro
|
|
|
15089
15663
|
export type EntityResponseWithHits = Components.Schemas.EntityResponseWithHits;
|
|
15090
15664
|
export type EntitySearchParams = Components.Schemas.EntitySearchParams;
|
|
15091
15665
|
export type EntitySlug = Components.Schemas.EntitySlug;
|
|
15666
|
+
export type EntitySlugConfig = Components.Schemas.EntitySlugConfig;
|
|
15092
15667
|
export type EntityTemplates = Components.Schemas.EntityTemplates;
|
|
15093
15668
|
export type EntityWidget = Components.Schemas.EntityWidget;
|
|
15094
15669
|
export type ErrorResp = Components.Schemas.ErrorResp;
|
|
@@ -15138,6 +15713,7 @@ export type PortalUser = Components.Schemas.PortalUser;
|
|
|
15138
15713
|
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
|
15139
15714
|
export type PortalWidget = Components.Schemas.PortalWidget;
|
|
15140
15715
|
export type Product = Components.Schemas.Product;
|
|
15716
|
+
export type ProductRecommendationsWidget = Components.Schemas.ProductRecommendationsWidget;
|
|
15141
15717
|
export type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
15142
15718
|
export type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
15143
15719
|
export type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
@@ -15160,6 +15736,7 @@ export type SSOLoginToken = Components.Schemas.SSOLoginToken;
|
|
|
15160
15736
|
export type SaveEntityFile = Components.Schemas.SaveEntityFile;
|
|
15161
15737
|
export type SavePortalFile = Components.Schemas.SavePortalFile;
|
|
15162
15738
|
export type Schema = Components.Schemas.Schema;
|
|
15739
|
+
export type SearchIncludes = Components.Schemas.SearchIncludes;
|
|
15163
15740
|
export type Source = Components.Schemas.Source;
|
|
15164
15741
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
15165
15742
|
export type TariffType = Components.Schemas.TariffType;
|