@epilot/customer-portal-client 0.33.3 → 0.35.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/dist/client.d.ts +1 -1
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +29 -0
- package/dist/openapi.d.ts +769 -128
- package/package.json +4 -7
- package/src/openapi-runtime.json +29 -0
- package/src/openapi.json +493 -59
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
|
*/
|
|
@@ -697,6 +695,46 @@ declare namespace Components {
|
|
|
697
695
|
*/
|
|
698
696
|
visibility?: {
|
|
699
697
|
[name: string]: any;
|
|
698
|
+
/**
|
|
699
|
+
* Block is fully hidden from portal users
|
|
700
|
+
*/
|
|
701
|
+
is_hidden?: boolean;
|
|
702
|
+
/**
|
|
703
|
+
* Block is hidden on mobile viewports
|
|
704
|
+
*/
|
|
705
|
+
hidden_on_mobile?: boolean;
|
|
706
|
+
/**
|
|
707
|
+
* Block is hidden on desktop viewports
|
|
708
|
+
*/
|
|
709
|
+
hidden_on_desktop?: boolean;
|
|
710
|
+
/**
|
|
711
|
+
* Block is hidden in the mobile app
|
|
712
|
+
*/
|
|
713
|
+
hidden_in_app?: boolean;
|
|
714
|
+
/**
|
|
715
|
+
* Schedule visibility start date. If only start_date is set, block is visible from this date onwards.
|
|
716
|
+
*/
|
|
717
|
+
start_date?: string; // date-time
|
|
718
|
+
/**
|
|
719
|
+
* Schedule visibility end date. If only end_date is set, block is visible until this date.
|
|
720
|
+
*/
|
|
721
|
+
end_date?: string; // date-time
|
|
722
|
+
/**
|
|
723
|
+
* Target IDs that must match for the block to be visible
|
|
724
|
+
*/
|
|
725
|
+
visible_for_targets?: string[];
|
|
726
|
+
/**
|
|
727
|
+
* Operator for visible_for_targets matching
|
|
728
|
+
*/
|
|
729
|
+
visible_for_operator?: "and" | "or";
|
|
730
|
+
/**
|
|
731
|
+
* Target IDs that if matched will hide the block
|
|
732
|
+
*/
|
|
733
|
+
hidden_for_targets?: string[];
|
|
734
|
+
/**
|
|
735
|
+
* Operator for hidden_for_targets matching
|
|
736
|
+
*/
|
|
737
|
+
hidden_for_operator?: "and" | "or";
|
|
700
738
|
};
|
|
701
739
|
/**
|
|
702
740
|
* The content of the block
|
|
@@ -780,7 +818,7 @@ declare namespace Components {
|
|
|
780
818
|
}
|
|
781
819
|
export interface CampaignWidget {
|
|
782
820
|
id: string;
|
|
783
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
821
|
+
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
822
|
/**
|
|
785
823
|
* Index of the widget in the list, used for ordering (left or right)
|
|
786
824
|
*/
|
|
@@ -827,13 +865,6 @@ declare namespace Components {
|
|
|
827
865
|
* Mark true if the domain is an Epilot domain
|
|
828
866
|
*/
|
|
829
867
|
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
868
|
/**
|
|
838
869
|
* ID of the design used to build the portal
|
|
839
870
|
*/
|
|
@@ -843,6 +874,15 @@ declare namespace Components {
|
|
|
843
874
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
844
875
|
*/
|
|
845
876
|
EntityId /* uuid */;
|
|
877
|
+
/**
|
|
878
|
+
* Allowed portal entities for the portal
|
|
879
|
+
* example:
|
|
880
|
+
* [
|
|
881
|
+
* "contact",
|
|
882
|
+
* "contract"
|
|
883
|
+
* ]
|
|
884
|
+
*/
|
|
885
|
+
allowed_portal_entities?: string[];
|
|
846
886
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
847
887
|
/**
|
|
848
888
|
* Enable or disable user account self management
|
|
@@ -925,6 +965,52 @@ declare namespace Components {
|
|
|
925
965
|
* eu-central-1_CUEQRNbUb
|
|
926
966
|
*/
|
|
927
967
|
cognito_user_pool_id?: string;
|
|
968
|
+
/**
|
|
969
|
+
* Timeouts for the cognito tokens
|
|
970
|
+
*/
|
|
971
|
+
timeouts?: {
|
|
972
|
+
/**
|
|
973
|
+
* Timeout for the refresh token
|
|
974
|
+
* example:
|
|
975
|
+
* 300
|
|
976
|
+
*/
|
|
977
|
+
refresh_token?: number;
|
|
978
|
+
/**
|
|
979
|
+
* Timeout for the access token
|
|
980
|
+
* example:
|
|
981
|
+
* 300
|
|
982
|
+
*/
|
|
983
|
+
access_token?: number;
|
|
984
|
+
/**
|
|
985
|
+
* Timeout for the id token
|
|
986
|
+
* example:
|
|
987
|
+
* 300
|
|
988
|
+
*/
|
|
989
|
+
id_token?: number;
|
|
990
|
+
};
|
|
991
|
+
/**
|
|
992
|
+
* Advanced authentication settings for the portal
|
|
993
|
+
*/
|
|
994
|
+
advanced_authentication?: {
|
|
995
|
+
/**
|
|
996
|
+
* 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.
|
|
997
|
+
* example:
|
|
998
|
+
* true
|
|
999
|
+
*/
|
|
1000
|
+
user_activity_logging?: boolean;
|
|
1001
|
+
/**
|
|
1002
|
+
* 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.
|
|
1003
|
+
* example:
|
|
1004
|
+
* true
|
|
1005
|
+
*/
|
|
1006
|
+
adaptive_authentication?: boolean;
|
|
1007
|
+
/**
|
|
1008
|
+
* 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.
|
|
1009
|
+
* example:
|
|
1010
|
+
* true
|
|
1011
|
+
*/
|
|
1012
|
+
compromised_credentials_detection?: boolean;
|
|
1013
|
+
};
|
|
928
1014
|
/**
|
|
929
1015
|
* Password policy for the portal
|
|
930
1016
|
*/
|
|
@@ -1200,13 +1286,6 @@ declare namespace Components {
|
|
|
1200
1286
|
* Mark true if the domain is an Epilot domain
|
|
1201
1287
|
*/
|
|
1202
1288
|
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
1289
|
/**
|
|
1211
1290
|
* ID of the design used to build the portal
|
|
1212
1291
|
*/
|
|
@@ -1216,6 +1295,15 @@ declare namespace Components {
|
|
|
1216
1295
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
1217
1296
|
*/
|
|
1218
1297
|
EntityId /* uuid */;
|
|
1298
|
+
/**
|
|
1299
|
+
* Allowed portal entities for the portal
|
|
1300
|
+
* example:
|
|
1301
|
+
* [
|
|
1302
|
+
* "contact",
|
|
1303
|
+
* "contract"
|
|
1304
|
+
* ]
|
|
1305
|
+
*/
|
|
1306
|
+
allowed_portal_entities?: string[];
|
|
1219
1307
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
1220
1308
|
/**
|
|
1221
1309
|
* Enable or disable user account self management
|
|
@@ -1298,6 +1386,52 @@ declare namespace Components {
|
|
|
1298
1386
|
* eu-central-1_CUEQRNbUb
|
|
1299
1387
|
*/
|
|
1300
1388
|
cognito_user_pool_id?: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* Timeouts for the cognito tokens
|
|
1391
|
+
*/
|
|
1392
|
+
timeouts?: {
|
|
1393
|
+
/**
|
|
1394
|
+
* Timeout for the refresh token
|
|
1395
|
+
* example:
|
|
1396
|
+
* 300
|
|
1397
|
+
*/
|
|
1398
|
+
refresh_token?: number;
|
|
1399
|
+
/**
|
|
1400
|
+
* Timeout for the access token
|
|
1401
|
+
* example:
|
|
1402
|
+
* 300
|
|
1403
|
+
*/
|
|
1404
|
+
access_token?: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* Timeout for the id token
|
|
1407
|
+
* example:
|
|
1408
|
+
* 300
|
|
1409
|
+
*/
|
|
1410
|
+
id_token?: number;
|
|
1411
|
+
};
|
|
1412
|
+
/**
|
|
1413
|
+
* Advanced authentication settings for the portal
|
|
1414
|
+
*/
|
|
1415
|
+
advanced_authentication?: {
|
|
1416
|
+
/**
|
|
1417
|
+
* 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.
|
|
1418
|
+
* example:
|
|
1419
|
+
* true
|
|
1420
|
+
*/
|
|
1421
|
+
user_activity_logging?: boolean;
|
|
1422
|
+
/**
|
|
1423
|
+
* 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.
|
|
1424
|
+
* example:
|
|
1425
|
+
* true
|
|
1426
|
+
*/
|
|
1427
|
+
adaptive_authentication?: boolean;
|
|
1428
|
+
/**
|
|
1429
|
+
* 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.
|
|
1430
|
+
* example:
|
|
1431
|
+
* true
|
|
1432
|
+
*/
|
|
1433
|
+
compromised_credentials_detection?: boolean;
|
|
1434
|
+
};
|
|
1301
1435
|
/**
|
|
1302
1436
|
* Password policy for the portal
|
|
1303
1437
|
*/
|
|
@@ -1636,7 +1770,7 @@ declare namespace Components {
|
|
|
1636
1770
|
}
|
|
1637
1771
|
export interface ContentWidget {
|
|
1638
1772
|
id: string;
|
|
1639
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
1773
|
+
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
1774
|
/**
|
|
1641
1775
|
* Index of the widget in the list, used for ordering (left or right)
|
|
1642
1776
|
*/
|
|
@@ -1977,7 +2111,7 @@ declare namespace Components {
|
|
|
1977
2111
|
export type Direction = "feed-in" | "feed-out";
|
|
1978
2112
|
export interface DocumentWidget {
|
|
1979
2113
|
id: string;
|
|
1980
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
2114
|
+
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
2115
|
/**
|
|
1982
2116
|
* Index of the widget in the list, used for ordering (left or right)
|
|
1983
2117
|
*/
|
|
@@ -1991,23 +2125,6 @@ declare namespace Components {
|
|
|
1991
2125
|
de?: string;
|
|
1992
2126
|
};
|
|
1993
2127
|
}
|
|
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
2128
|
/**
|
|
2012
2129
|
* Email templates used for authentication and internal processes
|
|
2013
2130
|
*/
|
|
@@ -2473,6 +2590,7 @@ declare namespace Components {
|
|
|
2473
2590
|
* 5
|
|
2474
2591
|
*/
|
|
2475
2592
|
hits?: number;
|
|
2593
|
+
includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
|
|
2476
2594
|
}
|
|
2477
2595
|
/**
|
|
2478
2596
|
* Response for entity search requests
|
|
@@ -2512,12 +2630,13 @@ declare namespace Components {
|
|
|
2512
2630
|
* 10
|
|
2513
2631
|
*/
|
|
2514
2632
|
hits?: number;
|
|
2633
|
+
includes?: /* Side-loaded enrichment data requested via the `include` parameter. */ SearchIncludes;
|
|
2515
2634
|
}
|
|
2516
2635
|
export interface EntitySearchParams {
|
|
2517
2636
|
/**
|
|
2518
|
-
*
|
|
2637
|
+
* Entity slug, array of slugs, or array of per-slug configurations
|
|
2519
2638
|
*/
|
|
2520
|
-
slug: /*
|
|
2639
|
+
slug: /* Entity slug, array of slugs, or array of per-slug configurations */ /**
|
|
2521
2640
|
* URL-friendly identifier for the entity schema
|
|
2522
2641
|
* example:
|
|
2523
2642
|
* contact
|
|
@@ -2535,6 +2654,9 @@ declare namespace Components {
|
|
|
2535
2654
|
* contact
|
|
2536
2655
|
*/
|
|
2537
2656
|
EntitySlug[]
|
|
2657
|
+
] | [
|
|
2658
|
+
/* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig,
|
|
2659
|
+
.../* Per-slug search configuration with scoped targets and templates */ EntitySlugConfig[]
|
|
2538
2660
|
];
|
|
2539
2661
|
/**
|
|
2540
2662
|
* Keyword search query
|
|
@@ -2663,6 +2785,14 @@ declare namespace Components {
|
|
|
2663
2785
|
* ]
|
|
2664
2786
|
*/
|
|
2665
2787
|
targets?: string /* uuid */[];
|
|
2788
|
+
/**
|
|
2789
|
+
* Optional enrichment data to side-load alongside results under the `includes` response key.
|
|
2790
|
+
* example:
|
|
2791
|
+
* [
|
|
2792
|
+
* "active_workflow"
|
|
2793
|
+
* ]
|
|
2794
|
+
*/
|
|
2795
|
+
include?: ("active_workflow")[];
|
|
2666
2796
|
}
|
|
2667
2797
|
/**
|
|
2668
2798
|
* URL-friendly identifier for the entity schema
|
|
@@ -2670,6 +2800,21 @@ declare namespace Components {
|
|
|
2670
2800
|
* contact
|
|
2671
2801
|
*/
|
|
2672
2802
|
export type EntitySlug = string;
|
|
2803
|
+
/**
|
|
2804
|
+
* Per-slug search configuration with scoped targets and templates
|
|
2805
|
+
*/
|
|
2806
|
+
export interface EntitySlugConfig {
|
|
2807
|
+
slug: /**
|
|
2808
|
+
* URL-friendly identifier for the entity schema
|
|
2809
|
+
* example:
|
|
2810
|
+
* contact
|
|
2811
|
+
*/
|
|
2812
|
+
EntitySlug;
|
|
2813
|
+
targets?: string /* uuid */[];
|
|
2814
|
+
templates?: {
|
|
2815
|
+
[name: string]: string;
|
|
2816
|
+
};
|
|
2817
|
+
}
|
|
2673
2818
|
export interface EntityTemplates {
|
|
2674
2819
|
/**
|
|
2675
2820
|
* Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
|
|
@@ -2692,7 +2837,7 @@ declare namespace Components {
|
|
|
2692
2837
|
}
|
|
2693
2838
|
export interface EntityWidget {
|
|
2694
2839
|
id: string;
|
|
2695
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
2840
|
+
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
2841
|
/**
|
|
2697
2842
|
* Index of the widget in the list, used for ordering (left or right)
|
|
2698
2843
|
*/
|
|
@@ -3021,6 +3166,7 @@ declare namespace Components {
|
|
|
3021
3166
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
3022
3167
|
*/
|
|
3023
3168
|
use_static_ips?: boolean;
|
|
3169
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3024
3170
|
}
|
|
3025
3171
|
/**
|
|
3026
3172
|
* Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
|
|
@@ -3097,6 +3243,7 @@ declare namespace Components {
|
|
|
3097
3243
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
3098
3244
|
*/
|
|
3099
3245
|
use_static_ips?: boolean;
|
|
3246
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3100
3247
|
}
|
|
3101
3248
|
/**
|
|
3102
3249
|
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
@@ -3144,6 +3291,7 @@ declare namespace Components {
|
|
|
3144
3291
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
3145
3292
|
*/
|
|
3146
3293
|
use_static_ips?: boolean;
|
|
3294
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3147
3295
|
}
|
|
3148
3296
|
/**
|
|
3149
3297
|
* Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
|
|
@@ -3235,6 +3383,7 @@ declare namespace Components {
|
|
|
3235
3383
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
3236
3384
|
*/
|
|
3237
3385
|
use_static_ips?: boolean;
|
|
3386
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3238
3387
|
}
|
|
3239
3388
|
/**
|
|
3240
3389
|
* Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
@@ -3282,6 +3431,7 @@ declare namespace Components {
|
|
|
3282
3431
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
3283
3432
|
*/
|
|
3284
3433
|
use_static_ips?: boolean;
|
|
3434
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3285
3435
|
}
|
|
3286
3436
|
/**
|
|
3287
3437
|
* Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
|
|
@@ -3328,6 +3478,7 @@ declare namespace Components {
|
|
|
3328
3478
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
3329
3479
|
*/
|
|
3330
3480
|
use_static_ips?: boolean;
|
|
3481
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3331
3482
|
}
|
|
3332
3483
|
export type ExtensionHookSelection = {
|
|
3333
3484
|
/**
|
|
@@ -3749,12 +3900,6 @@ declare namespace Components {
|
|
|
3749
3900
|
* Whether the org is in canary mode
|
|
3750
3901
|
*/
|
|
3751
3902
|
is_canary?: boolean;
|
|
3752
|
-
/**
|
|
3753
|
-
* The URL to redirect to
|
|
3754
|
-
* example:
|
|
3755
|
-
* https://example.com
|
|
3756
|
-
*/
|
|
3757
|
-
redirect_to?: string;
|
|
3758
3903
|
}
|
|
3759
3904
|
/**
|
|
3760
3905
|
* The meter entity
|
|
@@ -3804,7 +3949,7 @@ declare namespace Components {
|
|
|
3804
3949
|
}
|
|
3805
3950
|
export interface MeterChartWidget {
|
|
3806
3951
|
id: string;
|
|
3807
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
3952
|
+
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
3953
|
/**
|
|
3809
3954
|
* Index of the widget in the list, used for ordering (left or right)
|
|
3810
3955
|
*/
|
|
@@ -3865,7 +4010,7 @@ declare namespace Components {
|
|
|
3865
4010
|
/**
|
|
3866
4011
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
3867
4012
|
* example:
|
|
3868
|
-
* 2022-10-
|
|
4013
|
+
* 2022-10-10
|
|
3869
4014
|
*/
|
|
3870
4015
|
timestamp?: string;
|
|
3871
4016
|
/**
|
|
@@ -3968,7 +4113,7 @@ declare namespace Components {
|
|
|
3968
4113
|
}
|
|
3969
4114
|
export interface MeterReadingWidget {
|
|
3970
4115
|
id: string;
|
|
3971
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
4116
|
+
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
4117
|
/**
|
|
3973
4118
|
* Index of the widget in the list, used for ordering (left or right)
|
|
3974
4119
|
*/
|
|
@@ -4320,6 +4465,38 @@ declare namespace Components {
|
|
|
4320
4465
|
*/
|
|
4321
4466
|
visibility?: {
|
|
4322
4467
|
[name: string]: any;
|
|
4468
|
+
/**
|
|
4469
|
+
* Page is fully hidden from portal users
|
|
4470
|
+
*/
|
|
4471
|
+
is_hidden?: boolean;
|
|
4472
|
+
/**
|
|
4473
|
+
* Page is hidden in the mobile app
|
|
4474
|
+
*/
|
|
4475
|
+
hidden_in_app?: boolean;
|
|
4476
|
+
/**
|
|
4477
|
+
* Schedule visibility start date. If only start_date is set, page is visible from this date onwards.
|
|
4478
|
+
*/
|
|
4479
|
+
start_date?: string; // date-time
|
|
4480
|
+
/**
|
|
4481
|
+
* Schedule visibility end date. If only end_date is set, page is visible until this date.
|
|
4482
|
+
*/
|
|
4483
|
+
end_date?: string; // date-time
|
|
4484
|
+
/**
|
|
4485
|
+
* Target IDs that must match for the page to be visible
|
|
4486
|
+
*/
|
|
4487
|
+
visible_for_targets?: string[];
|
|
4488
|
+
/**
|
|
4489
|
+
* Operator for visible_for_targets matching
|
|
4490
|
+
*/
|
|
4491
|
+
visible_for_operator?: "and" | "or";
|
|
4492
|
+
/**
|
|
4493
|
+
* Target IDs that if matched will hide the page
|
|
4494
|
+
*/
|
|
4495
|
+
hidden_for_targets?: string[];
|
|
4496
|
+
/**
|
|
4497
|
+
* Operator for hidden_for_targets matching
|
|
4498
|
+
*/
|
|
4499
|
+
hidden_for_operator?: "and" | "or";
|
|
4323
4500
|
};
|
|
4324
4501
|
/**
|
|
4325
4502
|
* The content of the page
|
|
@@ -4360,6 +4537,12 @@ declare namespace Components {
|
|
|
4360
4537
|
* contact
|
|
4361
4538
|
*/
|
|
4362
4539
|
detail_schema?: string;
|
|
4540
|
+
/**
|
|
4541
|
+
* Whether the detail page should appear in the main navigation
|
|
4542
|
+
* example:
|
|
4543
|
+
* false
|
|
4544
|
+
*/
|
|
4545
|
+
show_in_navigation?: boolean;
|
|
4363
4546
|
/**
|
|
4364
4547
|
* Whether the page is public
|
|
4365
4548
|
* example:
|
|
@@ -4371,7 +4554,7 @@ declare namespace Components {
|
|
|
4371
4554
|
* example:
|
|
4372
4555
|
* c495fef9-eeca-4019-a989-8390dcd9825b
|
|
4373
4556
|
*/
|
|
4374
|
-
parentId?: string;
|
|
4557
|
+
parentId?: string | null;
|
|
4375
4558
|
/**
|
|
4376
4559
|
* Whether the page is the entry route
|
|
4377
4560
|
* example:
|
|
@@ -4417,6 +4600,38 @@ declare namespace Components {
|
|
|
4417
4600
|
*/
|
|
4418
4601
|
visibility?: {
|
|
4419
4602
|
[name: string]: any;
|
|
4603
|
+
/**
|
|
4604
|
+
* Page is fully hidden from portal users
|
|
4605
|
+
*/
|
|
4606
|
+
is_hidden?: boolean;
|
|
4607
|
+
/**
|
|
4608
|
+
* Page is hidden in the mobile app
|
|
4609
|
+
*/
|
|
4610
|
+
hidden_in_app?: boolean;
|
|
4611
|
+
/**
|
|
4612
|
+
* Schedule visibility start date. If only start_date is set, page is visible from this date onwards.
|
|
4613
|
+
*/
|
|
4614
|
+
start_date?: string; // date-time
|
|
4615
|
+
/**
|
|
4616
|
+
* Schedule visibility end date. If only end_date is set, page is visible until this date.
|
|
4617
|
+
*/
|
|
4618
|
+
end_date?: string; // date-time
|
|
4619
|
+
/**
|
|
4620
|
+
* Target IDs that must match for the page to be visible
|
|
4621
|
+
*/
|
|
4622
|
+
visible_for_targets?: string[];
|
|
4623
|
+
/**
|
|
4624
|
+
* Operator for visible_for_targets matching
|
|
4625
|
+
*/
|
|
4626
|
+
visible_for_operator?: "and" | "or";
|
|
4627
|
+
/**
|
|
4628
|
+
* Target IDs that if matched will hide the page
|
|
4629
|
+
*/
|
|
4630
|
+
hidden_for_targets?: string[];
|
|
4631
|
+
/**
|
|
4632
|
+
* Operator for hidden_for_targets matching
|
|
4633
|
+
*/
|
|
4634
|
+
hidden_for_operator?: "and" | "or";
|
|
4420
4635
|
};
|
|
4421
4636
|
/**
|
|
4422
4637
|
* The content of the page
|
|
@@ -4457,6 +4672,12 @@ declare namespace Components {
|
|
|
4457
4672
|
* contact
|
|
4458
4673
|
*/
|
|
4459
4674
|
detail_schema?: string;
|
|
4675
|
+
/**
|
|
4676
|
+
* Whether the detail page should appear in the main navigation
|
|
4677
|
+
* example:
|
|
4678
|
+
* false
|
|
4679
|
+
*/
|
|
4680
|
+
show_in_navigation?: boolean;
|
|
4460
4681
|
/**
|
|
4461
4682
|
* Whether the page is public
|
|
4462
4683
|
* example:
|
|
@@ -4468,7 +4689,7 @@ declare namespace Components {
|
|
|
4468
4689
|
* example:
|
|
4469
4690
|
* c495fef9-eeca-4019-a989-8390dcd9825b
|
|
4470
4691
|
*/
|
|
4471
|
-
parentId?: string;
|
|
4692
|
+
parentId?: string | null;
|
|
4472
4693
|
/**
|
|
4473
4694
|
* Whether the page is the entry route
|
|
4474
4695
|
* example:
|
|
@@ -4484,7 +4705,7 @@ declare namespace Components {
|
|
|
4484
4705
|
}
|
|
4485
4706
|
export interface PaymentWidget {
|
|
4486
4707
|
id: string;
|
|
4487
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
4708
|
+
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
4709
|
/**
|
|
4489
4710
|
* Index of the widget in the list, used for ordering (left or right)
|
|
4490
4711
|
*/
|
|
@@ -4519,19 +4740,21 @@ declare namespace Components {
|
|
|
4519
4740
|
* Mark true if the domain is an Epilot domain
|
|
4520
4741
|
*/
|
|
4521
4742
|
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
4743
|
design_id?: /**
|
|
4530
4744
|
* Entity ID
|
|
4531
4745
|
* example:
|
|
4532
4746
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
4533
4747
|
*/
|
|
4534
4748
|
EntityId /* uuid */;
|
|
4749
|
+
/**
|
|
4750
|
+
* Allowed portal entities for the portal
|
|
4751
|
+
* example:
|
|
4752
|
+
* [
|
|
4753
|
+
* "contact",
|
|
4754
|
+
* "contract"
|
|
4755
|
+
* ]
|
|
4756
|
+
*/
|
|
4757
|
+
allowed_portal_entities?: string[];
|
|
4535
4758
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
4536
4759
|
/**
|
|
4537
4760
|
* Enable or disable user account self management
|
|
@@ -4614,6 +4837,52 @@ declare namespace Components {
|
|
|
4614
4837
|
* eu-central-1_CUEQRNbUb
|
|
4615
4838
|
*/
|
|
4616
4839
|
cognito_user_pool_id?: string;
|
|
4840
|
+
/**
|
|
4841
|
+
* Timeouts for the cognito tokens
|
|
4842
|
+
*/
|
|
4843
|
+
timeouts?: {
|
|
4844
|
+
/**
|
|
4845
|
+
* Timeout for the refresh token
|
|
4846
|
+
* example:
|
|
4847
|
+
* 300
|
|
4848
|
+
*/
|
|
4849
|
+
refresh_token?: number;
|
|
4850
|
+
/**
|
|
4851
|
+
* Timeout for the access token
|
|
4852
|
+
* example:
|
|
4853
|
+
* 300
|
|
4854
|
+
*/
|
|
4855
|
+
access_token?: number;
|
|
4856
|
+
/**
|
|
4857
|
+
* Timeout for the id token
|
|
4858
|
+
* example:
|
|
4859
|
+
* 300
|
|
4860
|
+
*/
|
|
4861
|
+
id_token?: number;
|
|
4862
|
+
};
|
|
4863
|
+
/**
|
|
4864
|
+
* Advanced authentication settings for the portal
|
|
4865
|
+
*/
|
|
4866
|
+
advanced_authentication?: {
|
|
4867
|
+
/**
|
|
4868
|
+
* 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.
|
|
4869
|
+
* example:
|
|
4870
|
+
* true
|
|
4871
|
+
*/
|
|
4872
|
+
user_activity_logging?: boolean;
|
|
4873
|
+
/**
|
|
4874
|
+
* 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.
|
|
4875
|
+
* example:
|
|
4876
|
+
* true
|
|
4877
|
+
*/
|
|
4878
|
+
adaptive_authentication?: boolean;
|
|
4879
|
+
/**
|
|
4880
|
+
* 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.
|
|
4881
|
+
* example:
|
|
4882
|
+
* true
|
|
4883
|
+
*/
|
|
4884
|
+
compromised_credentials_detection?: boolean;
|
|
4885
|
+
};
|
|
4617
4886
|
/**
|
|
4618
4887
|
* Password policy for the portal
|
|
4619
4888
|
*/
|
|
@@ -4975,19 +5244,21 @@ declare namespace Components {
|
|
|
4975
5244
|
* Mark true if the domain is an Epilot domain
|
|
4976
5245
|
*/
|
|
4977
5246
|
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
5247
|
design_id?: /**
|
|
4986
5248
|
* Entity ID
|
|
4987
5249
|
* example:
|
|
4988
5250
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
4989
5251
|
*/
|
|
4990
5252
|
EntityId /* uuid */;
|
|
5253
|
+
/**
|
|
5254
|
+
* Allowed portal entities for the portal
|
|
5255
|
+
* example:
|
|
5256
|
+
* [
|
|
5257
|
+
* "contact",
|
|
5258
|
+
* "contract"
|
|
5259
|
+
* ]
|
|
5260
|
+
*/
|
|
5261
|
+
allowed_portal_entities?: string[];
|
|
4991
5262
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
4992
5263
|
/**
|
|
4993
5264
|
* Enable or disable user account self management
|
|
@@ -5070,6 +5341,52 @@ declare namespace Components {
|
|
|
5070
5341
|
* eu-central-1_CUEQRNbUb
|
|
5071
5342
|
*/
|
|
5072
5343
|
cognito_user_pool_id?: string;
|
|
5344
|
+
/**
|
|
5345
|
+
* Timeouts for the cognito tokens
|
|
5346
|
+
*/
|
|
5347
|
+
timeouts?: {
|
|
5348
|
+
/**
|
|
5349
|
+
* Timeout for the refresh token
|
|
5350
|
+
* example:
|
|
5351
|
+
* 300
|
|
5352
|
+
*/
|
|
5353
|
+
refresh_token?: number;
|
|
5354
|
+
/**
|
|
5355
|
+
* Timeout for the access token
|
|
5356
|
+
* example:
|
|
5357
|
+
* 300
|
|
5358
|
+
*/
|
|
5359
|
+
access_token?: number;
|
|
5360
|
+
/**
|
|
5361
|
+
* Timeout for the id token
|
|
5362
|
+
* example:
|
|
5363
|
+
* 300
|
|
5364
|
+
*/
|
|
5365
|
+
id_token?: number;
|
|
5366
|
+
};
|
|
5367
|
+
/**
|
|
5368
|
+
* Advanced authentication settings for the portal
|
|
5369
|
+
*/
|
|
5370
|
+
advanced_authentication?: {
|
|
5371
|
+
/**
|
|
5372
|
+
* 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.
|
|
5373
|
+
* example:
|
|
5374
|
+
* true
|
|
5375
|
+
*/
|
|
5376
|
+
user_activity_logging?: boolean;
|
|
5377
|
+
/**
|
|
5378
|
+
* 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.
|
|
5379
|
+
* example:
|
|
5380
|
+
* true
|
|
5381
|
+
*/
|
|
5382
|
+
adaptive_authentication?: boolean;
|
|
5383
|
+
/**
|
|
5384
|
+
* 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.
|
|
5385
|
+
* example:
|
|
5386
|
+
* true
|
|
5387
|
+
*/
|
|
5388
|
+
compromised_credentials_detection?: boolean;
|
|
5389
|
+
};
|
|
5073
5390
|
/**
|
|
5074
5391
|
* Password policy for the portal
|
|
5075
5392
|
*/
|
|
@@ -5415,7 +5732,7 @@ declare namespace Components {
|
|
|
5415
5732
|
_schema: "portal_user";
|
|
5416
5733
|
}
|
|
5417
5734
|
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;
|
|
5735
|
+
export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
|
|
5419
5736
|
/**
|
|
5420
5737
|
* The product entity
|
|
5421
5738
|
*/
|
|
@@ -5462,6 +5779,34 @@ declare namespace Components {
|
|
|
5462
5779
|
_updated_at: string; // date-time
|
|
5463
5780
|
_schema: "product";
|
|
5464
5781
|
}
|
|
5782
|
+
export interface ProductRecommendationsWidget {
|
|
5783
|
+
id: string;
|
|
5784
|
+
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET" | "PRODUCT_RECOMMENDATIONS_WIDGET";
|
|
5785
|
+
/**
|
|
5786
|
+
* Index of the widget in the list, used for ordering (left or right)
|
|
5787
|
+
*/
|
|
5788
|
+
listIndex: number;
|
|
5789
|
+
headline?: {
|
|
5790
|
+
en?: string;
|
|
5791
|
+
de?: string;
|
|
5792
|
+
};
|
|
5793
|
+
subHeadline?: {
|
|
5794
|
+
en?: string;
|
|
5795
|
+
de?: string;
|
|
5796
|
+
};
|
|
5797
|
+
imageUrl?: string;
|
|
5798
|
+
button?: {
|
|
5799
|
+
label?: {
|
|
5800
|
+
en?: string;
|
|
5801
|
+
de?: string;
|
|
5802
|
+
};
|
|
5803
|
+
url?: string;
|
|
5804
|
+
};
|
|
5805
|
+
/**
|
|
5806
|
+
* ID of the campaign
|
|
5807
|
+
*/
|
|
5808
|
+
campaign_id?: string;
|
|
5809
|
+
}
|
|
5465
5810
|
export interface ProviderConfig {
|
|
5466
5811
|
slug?: /**
|
|
5467
5812
|
* URL-friendly slug to use as organization-unique identifier for Provider
|
|
@@ -5874,12 +6219,38 @@ declare namespace Components {
|
|
|
5874
6219
|
*/
|
|
5875
6220
|
slug?: string;
|
|
5876
6221
|
}
|
|
6222
|
+
/**
|
|
6223
|
+
* Side-loaded enrichment data requested via the `include` parameter.
|
|
6224
|
+
*/
|
|
6225
|
+
export interface SearchIncludes {
|
|
6226
|
+
/**
|
|
6227
|
+
* The active workflow execution for each entity, keyed by entity ID. Only entities with an active workflow are present.
|
|
6228
|
+
*/
|
|
6229
|
+
active_workflow?: {
|
|
6230
|
+
[name: string]: {
|
|
6231
|
+
[key: string]: any;
|
|
6232
|
+
};
|
|
6233
|
+
};
|
|
6234
|
+
}
|
|
6235
|
+
/**
|
|
6236
|
+
* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.
|
|
6237
|
+
*/
|
|
6238
|
+
export interface SecureProxyConfig {
|
|
6239
|
+
/**
|
|
6240
|
+
* Integration ID that owns the secure_proxy use case.
|
|
6241
|
+
*/
|
|
6242
|
+
integration_id: string; // uuid
|
|
6243
|
+
/**
|
|
6244
|
+
* Use case slug for the secure proxy use case.
|
|
6245
|
+
*/
|
|
6246
|
+
use_case_slug: string;
|
|
6247
|
+
}
|
|
5877
6248
|
export type Source = "ECP" | "ERP" | "360" | "journey-submission";
|
|
5878
6249
|
export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
|
|
5879
6250
|
export type TariffType = "ht" | "nt";
|
|
5880
6251
|
export interface TeaserWidget {
|
|
5881
6252
|
id: string;
|
|
5882
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
6253
|
+
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
6254
|
/**
|
|
5884
6255
|
* Index of the widget in the list, used for ordering (left or right)
|
|
5885
6256
|
*/
|
|
@@ -6029,19 +6400,21 @@ declare namespace Components {
|
|
|
6029
6400
|
* Mark true if the domain is an Epilot domain
|
|
6030
6401
|
*/
|
|
6031
6402
|
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
6403
|
design_id?: /**
|
|
6040
6404
|
* Entity ID
|
|
6041
6405
|
* example:
|
|
6042
6406
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
6043
6407
|
*/
|
|
6044
6408
|
EntityId /* uuid */;
|
|
6409
|
+
/**
|
|
6410
|
+
* Allowed portal entities for the portal
|
|
6411
|
+
* example:
|
|
6412
|
+
* [
|
|
6413
|
+
* "contact",
|
|
6414
|
+
* "contract"
|
|
6415
|
+
* ]
|
|
6416
|
+
*/
|
|
6417
|
+
allowed_portal_entities?: string[];
|
|
6045
6418
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
6046
6419
|
/**
|
|
6047
6420
|
* Enable or disable user account self management
|
|
@@ -6124,6 +6497,52 @@ declare namespace Components {
|
|
|
6124
6497
|
* eu-central-1_CUEQRNbUb
|
|
6125
6498
|
*/
|
|
6126
6499
|
cognito_user_pool_id?: string;
|
|
6500
|
+
/**
|
|
6501
|
+
* Timeouts for the cognito tokens
|
|
6502
|
+
*/
|
|
6503
|
+
timeouts?: {
|
|
6504
|
+
/**
|
|
6505
|
+
* Timeout for the refresh token
|
|
6506
|
+
* example:
|
|
6507
|
+
* 300
|
|
6508
|
+
*/
|
|
6509
|
+
refresh_token?: number;
|
|
6510
|
+
/**
|
|
6511
|
+
* Timeout for the access token
|
|
6512
|
+
* example:
|
|
6513
|
+
* 300
|
|
6514
|
+
*/
|
|
6515
|
+
access_token?: number;
|
|
6516
|
+
/**
|
|
6517
|
+
* Timeout for the id token
|
|
6518
|
+
* example:
|
|
6519
|
+
* 300
|
|
6520
|
+
*/
|
|
6521
|
+
id_token?: number;
|
|
6522
|
+
};
|
|
6523
|
+
/**
|
|
6524
|
+
* Advanced authentication settings for the portal
|
|
6525
|
+
*/
|
|
6526
|
+
advanced_authentication?: {
|
|
6527
|
+
/**
|
|
6528
|
+
* 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.
|
|
6529
|
+
* example:
|
|
6530
|
+
* true
|
|
6531
|
+
*/
|
|
6532
|
+
user_activity_logging?: boolean;
|
|
6533
|
+
/**
|
|
6534
|
+
* 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.
|
|
6535
|
+
* example:
|
|
6536
|
+
* true
|
|
6537
|
+
*/
|
|
6538
|
+
adaptive_authentication?: boolean;
|
|
6539
|
+
/**
|
|
6540
|
+
* 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.
|
|
6541
|
+
* example:
|
|
6542
|
+
* true
|
|
6543
|
+
*/
|
|
6544
|
+
compromised_credentials_detection?: boolean;
|
|
6545
|
+
};
|
|
6127
6546
|
/**
|
|
6128
6547
|
* Password policy for the portal
|
|
6129
6548
|
*/
|
|
@@ -6439,19 +6858,21 @@ declare namespace Components {
|
|
|
6439
6858
|
* Mark true if the domain is an Epilot domain
|
|
6440
6859
|
*/
|
|
6441
6860
|
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
6861
|
design_id?: /**
|
|
6450
6862
|
* Entity ID
|
|
6451
6863
|
* example:
|
|
6452
6864
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
6453
6865
|
*/
|
|
6454
6866
|
EntityId /* uuid */;
|
|
6867
|
+
/**
|
|
6868
|
+
* Allowed portal entities for the portal
|
|
6869
|
+
* example:
|
|
6870
|
+
* [
|
|
6871
|
+
* "contact",
|
|
6872
|
+
* "contract"
|
|
6873
|
+
* ]
|
|
6874
|
+
*/
|
|
6875
|
+
allowed_portal_entities?: string[];
|
|
6455
6876
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
6456
6877
|
/**
|
|
6457
6878
|
* Enable or disable user account self management
|
|
@@ -6534,6 +6955,52 @@ declare namespace Components {
|
|
|
6534
6955
|
* eu-central-1_CUEQRNbUb
|
|
6535
6956
|
*/
|
|
6536
6957
|
cognito_user_pool_id?: string;
|
|
6958
|
+
/**
|
|
6959
|
+
* Timeouts for the cognito tokens
|
|
6960
|
+
*/
|
|
6961
|
+
timeouts?: {
|
|
6962
|
+
/**
|
|
6963
|
+
* Timeout for the refresh token
|
|
6964
|
+
* example:
|
|
6965
|
+
* 300
|
|
6966
|
+
*/
|
|
6967
|
+
refresh_token?: number;
|
|
6968
|
+
/**
|
|
6969
|
+
* Timeout for the access token
|
|
6970
|
+
* example:
|
|
6971
|
+
* 300
|
|
6972
|
+
*/
|
|
6973
|
+
access_token?: number;
|
|
6974
|
+
/**
|
|
6975
|
+
* Timeout for the id token
|
|
6976
|
+
* example:
|
|
6977
|
+
* 300
|
|
6978
|
+
*/
|
|
6979
|
+
id_token?: number;
|
|
6980
|
+
};
|
|
6981
|
+
/**
|
|
6982
|
+
* Advanced authentication settings for the portal
|
|
6983
|
+
*/
|
|
6984
|
+
advanced_authentication?: {
|
|
6985
|
+
/**
|
|
6986
|
+
* 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.
|
|
6987
|
+
* example:
|
|
6988
|
+
* true
|
|
6989
|
+
*/
|
|
6990
|
+
user_activity_logging?: boolean;
|
|
6991
|
+
/**
|
|
6992
|
+
* 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.
|
|
6993
|
+
* example:
|
|
6994
|
+
* true
|
|
6995
|
+
*/
|
|
6996
|
+
adaptive_authentication?: boolean;
|
|
6997
|
+
/**
|
|
6998
|
+
* 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.
|
|
6999
|
+
* example:
|
|
7000
|
+
* true
|
|
7001
|
+
*/
|
|
7002
|
+
compromised_credentials_detection?: boolean;
|
|
7003
|
+
};
|
|
6537
7004
|
/**
|
|
6538
7005
|
* Password policy for the portal
|
|
6539
7006
|
*/
|
|
@@ -6834,7 +7301,7 @@ declare namespace Components {
|
|
|
6834
7301
|
}
|
|
6835
7302
|
export interface WidgetBase {
|
|
6836
7303
|
id: string;
|
|
6837
|
-
type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET" | "METER_READING_WIDGET" | "METER_CHART_WIDGET" | "CAMPAIGN_WIDGET";
|
|
7304
|
+
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
7305
|
/**
|
|
6839
7306
|
* Index of the widget in the list, used for ordering (left or right)
|
|
6840
7307
|
*/
|
|
@@ -8960,19 +9427,21 @@ declare namespace Paths {
|
|
|
8960
9427
|
* Mark true if the domain is an Epilot domain
|
|
8961
9428
|
*/
|
|
8962
9429
|
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
9430
|
design_id?: /**
|
|
8971
9431
|
* Entity ID
|
|
8972
9432
|
* example:
|
|
8973
9433
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8974
9434
|
*/
|
|
8975
9435
|
Components.Schemas.EntityId /* uuid */;
|
|
9436
|
+
/**
|
|
9437
|
+
* Allowed portal entities for the portal
|
|
9438
|
+
* example:
|
|
9439
|
+
* [
|
|
9440
|
+
* "contact",
|
|
9441
|
+
* "contract"
|
|
9442
|
+
* ]
|
|
9443
|
+
*/
|
|
9444
|
+
allowed_portal_entities?: string[];
|
|
8976
9445
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
8977
9446
|
/**
|
|
8978
9447
|
* Enable or disable user account self management
|
|
@@ -9055,6 +9524,52 @@ declare namespace Paths {
|
|
|
9055
9524
|
* eu-central-1_CUEQRNbUb
|
|
9056
9525
|
*/
|
|
9057
9526
|
cognito_user_pool_id?: string;
|
|
9527
|
+
/**
|
|
9528
|
+
* Timeouts for the cognito tokens
|
|
9529
|
+
*/
|
|
9530
|
+
timeouts?: {
|
|
9531
|
+
/**
|
|
9532
|
+
* Timeout for the refresh token
|
|
9533
|
+
* example:
|
|
9534
|
+
* 300
|
|
9535
|
+
*/
|
|
9536
|
+
refresh_token?: number;
|
|
9537
|
+
/**
|
|
9538
|
+
* Timeout for the access token
|
|
9539
|
+
* example:
|
|
9540
|
+
* 300
|
|
9541
|
+
*/
|
|
9542
|
+
access_token?: number;
|
|
9543
|
+
/**
|
|
9544
|
+
* Timeout for the id token
|
|
9545
|
+
* example:
|
|
9546
|
+
* 300
|
|
9547
|
+
*/
|
|
9548
|
+
id_token?: number;
|
|
9549
|
+
};
|
|
9550
|
+
/**
|
|
9551
|
+
* Advanced authentication settings for the portal
|
|
9552
|
+
*/
|
|
9553
|
+
advanced_authentication?: {
|
|
9554
|
+
/**
|
|
9555
|
+
* 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.
|
|
9556
|
+
* example:
|
|
9557
|
+
* true
|
|
9558
|
+
*/
|
|
9559
|
+
user_activity_logging?: boolean;
|
|
9560
|
+
/**
|
|
9561
|
+
* 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.
|
|
9562
|
+
* example:
|
|
9563
|
+
* true
|
|
9564
|
+
*/
|
|
9565
|
+
adaptive_authentication?: boolean;
|
|
9566
|
+
/**
|
|
9567
|
+
* 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.
|
|
9568
|
+
* example:
|
|
9569
|
+
* true
|
|
9570
|
+
*/
|
|
9571
|
+
compromised_credentials_detection?: boolean;
|
|
9572
|
+
};
|
|
9058
9573
|
/**
|
|
9059
9574
|
* Password policy for the portal
|
|
9060
9575
|
*/
|
|
@@ -9406,19 +9921,21 @@ declare namespace Paths {
|
|
|
9406
9921
|
* Mark true if the domain is an Epilot domain
|
|
9407
9922
|
*/
|
|
9408
9923
|
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
9924
|
design_id?: /**
|
|
9417
9925
|
* Entity ID
|
|
9418
9926
|
* example:
|
|
9419
9927
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
9420
9928
|
*/
|
|
9421
9929
|
Components.Schemas.EntityId /* uuid */;
|
|
9930
|
+
/**
|
|
9931
|
+
* Allowed portal entities for the portal
|
|
9932
|
+
* example:
|
|
9933
|
+
* [
|
|
9934
|
+
* "contact",
|
|
9935
|
+
* "contract"
|
|
9936
|
+
* ]
|
|
9937
|
+
*/
|
|
9938
|
+
allowed_portal_entities?: string[];
|
|
9422
9939
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
9423
9940
|
/**
|
|
9424
9941
|
* Enable or disable user account self management
|
|
@@ -9501,6 +10018,52 @@ declare namespace Paths {
|
|
|
9501
10018
|
* eu-central-1_CUEQRNbUb
|
|
9502
10019
|
*/
|
|
9503
10020
|
cognito_user_pool_id?: string;
|
|
10021
|
+
/**
|
|
10022
|
+
* Timeouts for the cognito tokens
|
|
10023
|
+
*/
|
|
10024
|
+
timeouts?: {
|
|
10025
|
+
/**
|
|
10026
|
+
* Timeout for the refresh token
|
|
10027
|
+
* example:
|
|
10028
|
+
* 300
|
|
10029
|
+
*/
|
|
10030
|
+
refresh_token?: number;
|
|
10031
|
+
/**
|
|
10032
|
+
* Timeout for the access token
|
|
10033
|
+
* example:
|
|
10034
|
+
* 300
|
|
10035
|
+
*/
|
|
10036
|
+
access_token?: number;
|
|
10037
|
+
/**
|
|
10038
|
+
* Timeout for the id token
|
|
10039
|
+
* example:
|
|
10040
|
+
* 300
|
|
10041
|
+
*/
|
|
10042
|
+
id_token?: number;
|
|
10043
|
+
};
|
|
10044
|
+
/**
|
|
10045
|
+
* Advanced authentication settings for the portal
|
|
10046
|
+
*/
|
|
10047
|
+
advanced_authentication?: {
|
|
10048
|
+
/**
|
|
10049
|
+
* 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.
|
|
10050
|
+
* example:
|
|
10051
|
+
* true
|
|
10052
|
+
*/
|
|
10053
|
+
user_activity_logging?: boolean;
|
|
10054
|
+
/**
|
|
10055
|
+
* 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.
|
|
10056
|
+
* example:
|
|
10057
|
+
* true
|
|
10058
|
+
*/
|
|
10059
|
+
adaptive_authentication?: boolean;
|
|
10060
|
+
/**
|
|
10061
|
+
* 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.
|
|
10062
|
+
* example:
|
|
10063
|
+
* true
|
|
10064
|
+
*/
|
|
10065
|
+
compromised_credentials_detection?: boolean;
|
|
10066
|
+
};
|
|
9504
10067
|
/**
|
|
9505
10068
|
* Password policy for the portal
|
|
9506
10069
|
*/
|
|
@@ -10777,6 +11340,35 @@ declare namespace Paths {
|
|
|
10777
11340
|
export type $500 = Components.Responses.InternalServerError;
|
|
10778
11341
|
}
|
|
10779
11342
|
}
|
|
11343
|
+
namespace InterpolatePortalPages {
|
|
11344
|
+
export interface RequestBody {
|
|
11345
|
+
/**
|
|
11346
|
+
* The pages to interpolate
|
|
11347
|
+
*/
|
|
11348
|
+
pages: Components.Schemas.Page[];
|
|
11349
|
+
context_entities?: /**
|
|
11350
|
+
* Additional entities to include in the context for variable interpolation. Portal User and Contact entities are automatically part of the context.
|
|
11351
|
+
* example:
|
|
11352
|
+
* [
|
|
11353
|
+
* {
|
|
11354
|
+
* "entity_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
11355
|
+
* "entity_schema": "contract"
|
|
11356
|
+
* }
|
|
11357
|
+
* ]
|
|
11358
|
+
*/
|
|
11359
|
+
Components.Schemas.ContextEntities;
|
|
11360
|
+
/**
|
|
11361
|
+
* When true, evaluates targeting conditions and annotates each page/block visibility with _targeting_status ('visible' | 'hidden' | 'no_targeting'). Blocks and pages are never removed — for preview/builder use only.
|
|
11362
|
+
*/
|
|
11363
|
+
evaluate_targeting?: boolean;
|
|
11364
|
+
}
|
|
11365
|
+
namespace Responses {
|
|
11366
|
+
export type $200 = Components.Schemas.Page[];
|
|
11367
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11368
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11369
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11370
|
+
}
|
|
11371
|
+
}
|
|
10780
11372
|
namespace InvitePartner {
|
|
10781
11373
|
export interface RequestBody {
|
|
10782
11374
|
/**
|
|
@@ -10789,6 +11381,24 @@ declare namespace Paths {
|
|
|
10789
11381
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
10790
11382
|
*/
|
|
10791
11383
|
Components.Schemas.EntityId /* uuid */[];
|
|
11384
|
+
/**
|
|
11385
|
+
* Additional contact entity fields to set when creating the contact for the invited user.
|
|
11386
|
+
* These are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).
|
|
11387
|
+
* Values can be strings or arrays of strings (for multiselect attributes).
|
|
11388
|
+
*
|
|
11389
|
+
*/
|
|
11390
|
+
contact_data?: {
|
|
11391
|
+
[name: string]: string | string[];
|
|
11392
|
+
};
|
|
11393
|
+
/**
|
|
11394
|
+
* Additional portal user entity fields to set when creating the portal user for the invited user.
|
|
11395
|
+
* These are mapped directly to portal_user entity attributes.
|
|
11396
|
+
* Values can be strings or arrays of strings (for multiselect attributes).
|
|
11397
|
+
*
|
|
11398
|
+
*/
|
|
11399
|
+
portal_user_data?: {
|
|
11400
|
+
[name: string]: string | string[];
|
|
11401
|
+
};
|
|
10792
11402
|
}
|
|
10793
11403
|
namespace Responses {
|
|
10794
11404
|
export interface $200 {
|
|
@@ -10834,6 +11444,10 @@ declare namespace Paths {
|
|
|
10834
11444
|
*/
|
|
10835
11445
|
email?: string;
|
|
10836
11446
|
origin?: /* Origin of the portal */ Components.Schemas.Origin;
|
|
11447
|
+
/**
|
|
11448
|
+
* The portal ID to look up the portal config. When provided, takes precedence over origin.
|
|
11449
|
+
*/
|
|
11450
|
+
portal_id?: string;
|
|
10837
11451
|
}
|
|
10838
11452
|
namespace Responses {
|
|
10839
11453
|
export interface $200 {
|
|
@@ -12146,6 +12760,7 @@ declare namespace Paths {
|
|
|
12146
12760
|
}
|
|
12147
12761
|
}
|
|
12148
12762
|
|
|
12763
|
+
|
|
12149
12764
|
export interface OperationMethods {
|
|
12150
12765
|
/**
|
|
12151
12766
|
* upsertPortal - upsertPortal
|
|
@@ -12444,7 +13059,7 @@ export interface OperationMethods {
|
|
|
12444
13059
|
/**
|
|
12445
13060
|
* getPublicPortalWidgets - getPublicPortalWidgets
|
|
12446
13061
|
*
|
|
12447
|
-
* Retrieves the public widgets of a portal
|
|
13062
|
+
* Retrieves the public widgets of a portal.
|
|
12448
13063
|
*/
|
|
12449
13064
|
'getPublicPortalWidgets'(
|
|
12450
13065
|
parameters?: Parameters<Paths.GetPublicPortalWidgets.QueryParameters> | null,
|
|
@@ -12454,7 +13069,7 @@ export interface OperationMethods {
|
|
|
12454
13069
|
/**
|
|
12455
13070
|
* getPortalWidgets - getPortalWidgets
|
|
12456
13071
|
*
|
|
12457
|
-
* Retrieves the widgets of a portal
|
|
13072
|
+
* Retrieves the widgets of a portal.
|
|
12458
13073
|
*/
|
|
12459
13074
|
'getPortalWidgets'(
|
|
12460
13075
|
parameters?: Parameters<Paths.GetPortalWidgets.QueryParameters> | null,
|
|
@@ -12744,7 +13359,7 @@ export interface OperationMethods {
|
|
|
12744
13359
|
/**
|
|
12745
13360
|
* getAllOrders - getAllOrders
|
|
12746
13361
|
*
|
|
12747
|
-
* Get all orders for the portal user
|
|
13362
|
+
* Get all orders for the portal user. Use searchPortalUserEntities instead.
|
|
12748
13363
|
*/
|
|
12749
13364
|
'getAllOrders'(
|
|
12750
13365
|
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
|
|
@@ -12764,7 +13379,7 @@ export interface OperationMethods {
|
|
|
12764
13379
|
/**
|
|
12765
13380
|
* getOrder - getOrder
|
|
12766
13381
|
*
|
|
12767
|
-
* Get an order by id
|
|
13382
|
+
* Get an order by id. Use getPortalUserEntity instead.
|
|
12768
13383
|
*/
|
|
12769
13384
|
'getOrder'(
|
|
12770
13385
|
parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
|
|
@@ -12774,7 +13389,7 @@ export interface OperationMethods {
|
|
|
12774
13389
|
/**
|
|
12775
13390
|
* updateOrder - updateOrder
|
|
12776
13391
|
*
|
|
12777
|
-
* Update an order by id
|
|
13392
|
+
* Update an order by id. Use getPortalUserEntity instead.
|
|
12778
13393
|
*/
|
|
12779
13394
|
'updateOrder'(
|
|
12780
13395
|
parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
|
|
@@ -12784,7 +13399,7 @@ export interface OperationMethods {
|
|
|
12784
13399
|
/**
|
|
12785
13400
|
* getAllOpportunities - getAllOpportunities
|
|
12786
13401
|
*
|
|
12787
|
-
* Get all opportunities of a portal user
|
|
13402
|
+
* Get all opportunities of a portal user. Use searchPortalUserEntities instead.
|
|
12788
13403
|
*/
|
|
12789
13404
|
'getAllOpportunities'(
|
|
12790
13405
|
parameters?: Parameters<Paths.GetAllOpportunities.QueryParameters> | null,
|
|
@@ -12794,7 +13409,7 @@ export interface OperationMethods {
|
|
|
12794
13409
|
/**
|
|
12795
13410
|
* getSearchableAttributesForOpportunities - getSearchableAttributesForOpportunities
|
|
12796
13411
|
*
|
|
12797
|
-
* Get all opportunity searchable attributes for a portal user
|
|
13412
|
+
* Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.
|
|
12798
13413
|
*/
|
|
12799
13414
|
'getSearchableAttributesForOpportunities'(
|
|
12800
13415
|
parameters?: Parameters<Paths.GetSearchableAttributesForOpportunities.QueryParameters> | null,
|
|
@@ -12804,7 +13419,7 @@ export interface OperationMethods {
|
|
|
12804
13419
|
/**
|
|
12805
13420
|
* getSearchResultsForOpportunities - getSearchResultsForOpportunities
|
|
12806
13421
|
*
|
|
12807
|
-
* Get all opportunity with the given
|
|
13422
|
+
* Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.
|
|
12808
13423
|
*/
|
|
12809
13424
|
'getSearchResultsForOpportunities'(
|
|
12810
13425
|
parameters?: Parameters<Paths.GetSearchResultsForOpportunities.QueryParameters> | null,
|
|
@@ -12814,7 +13429,7 @@ export interface OperationMethods {
|
|
|
12814
13429
|
/**
|
|
12815
13430
|
* getOpportunity - getOpportunity
|
|
12816
13431
|
*
|
|
12817
|
-
* Get an opportunity by id
|
|
13432
|
+
* Get an opportunity by id. Use getPortalUserEntity instead.
|
|
12818
13433
|
*/
|
|
12819
13434
|
'getOpportunity'(
|
|
12820
13435
|
parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
|
|
@@ -12824,7 +13439,7 @@ export interface OperationMethods {
|
|
|
12824
13439
|
/**
|
|
12825
13440
|
* updateOpportunity - updateOpportunity
|
|
12826
13441
|
*
|
|
12827
|
-
* Update an opportunity by id
|
|
13442
|
+
* Update an opportunity by id.
|
|
12828
13443
|
*/
|
|
12829
13444
|
'updateOpportunity'(
|
|
12830
13445
|
parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
|
|
@@ -12834,7 +13449,7 @@ export interface OperationMethods {
|
|
|
12834
13449
|
/**
|
|
12835
13450
|
* getAllRequests - getAllRequests
|
|
12836
13451
|
*
|
|
12837
|
-
* Get all opportunities & orders of a portal user
|
|
13452
|
+
* Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.
|
|
12838
13453
|
*/
|
|
12839
13454
|
'getAllRequests'(
|
|
12840
13455
|
parameters?: Parameters<Paths.GetAllRequests.QueryParameters> | null,
|
|
@@ -12844,7 +13459,7 @@ export interface OperationMethods {
|
|
|
12844
13459
|
/**
|
|
12845
13460
|
* getAllContracts - getAllContracts
|
|
12846
13461
|
*
|
|
12847
|
-
* Get all contracts for a portal user
|
|
13462
|
+
* Get all contracts for a portal user. Use searchPortalUserEntities instead.
|
|
12848
13463
|
*/
|
|
12849
13464
|
'getAllContracts'(
|
|
12850
13465
|
parameters?: Parameters<Paths.GetAllContracts.QueryParameters> | null,
|
|
@@ -12854,7 +13469,7 @@ export interface OperationMethods {
|
|
|
12854
13469
|
/**
|
|
12855
13470
|
* getContract - getContract
|
|
12856
13471
|
*
|
|
12857
|
-
* Get a contract by id
|
|
13472
|
+
* Get a contract by id. Use getPortalUserEntity instead.
|
|
12858
13473
|
*/
|
|
12859
13474
|
'getContract'(
|
|
12860
13475
|
parameters?: Parameters<Paths.GetContract.PathParameters> | null,
|
|
@@ -12864,7 +13479,7 @@ export interface OperationMethods {
|
|
|
12864
13479
|
/**
|
|
12865
13480
|
* updateContract - updateContract
|
|
12866
13481
|
*
|
|
12867
|
-
* Update a contract by id
|
|
13482
|
+
* Update a contract by id. Use getPortalUserEntity instead.
|
|
12868
13483
|
*/
|
|
12869
13484
|
'updateContract'(
|
|
12870
13485
|
parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
|
|
@@ -12987,7 +13602,7 @@ export interface OperationMethods {
|
|
|
12987
13602
|
/**
|
|
12988
13603
|
* getFileById - getFileById
|
|
12989
13604
|
*
|
|
12990
|
-
* Fetch a document with ID
|
|
13605
|
+
* Fetch a document with ID. Use getPortalUserEntity instead.
|
|
12991
13606
|
*/
|
|
12992
13607
|
'getFileById'(
|
|
12993
13608
|
parameters?: Parameters<Paths.GetFileById.PathParameters> | null,
|
|
@@ -13282,6 +13897,16 @@ export interface OperationMethods {
|
|
|
13282
13897
|
data?: any,
|
|
13283
13898
|
config?: AxiosRequestConfig
|
|
13284
13899
|
): OperationResponse<Paths.GetPublicPages.Responses.$200>
|
|
13900
|
+
/**
|
|
13901
|
+
* interpolatePortalPages - interpolatePortalPages
|
|
13902
|
+
*
|
|
13903
|
+
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
|
|
13904
|
+
*/
|
|
13905
|
+
'interpolatePortalPages'(
|
|
13906
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13907
|
+
data?: Paths.InterpolatePortalPages.RequestBody,
|
|
13908
|
+
config?: AxiosRequestConfig
|
|
13909
|
+
): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
|
|
13285
13910
|
/**
|
|
13286
13911
|
* getDefaultPages - getDefaultPages
|
|
13287
13912
|
*
|
|
@@ -13865,7 +14490,7 @@ export interface PathsDictionary {
|
|
|
13865
14490
|
/**
|
|
13866
14491
|
* getPublicPortalWidgets - getPublicPortalWidgets
|
|
13867
14492
|
*
|
|
13868
|
-
* Retrieves the public widgets of a portal
|
|
14493
|
+
* Retrieves the public widgets of a portal.
|
|
13869
14494
|
*/
|
|
13870
14495
|
'get'(
|
|
13871
14496
|
parameters?: Parameters<Paths.GetPublicPortalWidgets.QueryParameters> | null,
|
|
@@ -13887,7 +14512,7 @@ export interface PathsDictionary {
|
|
|
13887
14512
|
/**
|
|
13888
14513
|
* getPortalWidgets - getPortalWidgets
|
|
13889
14514
|
*
|
|
13890
|
-
* Retrieves the widgets of a portal
|
|
14515
|
+
* Retrieves the widgets of a portal.
|
|
13891
14516
|
*/
|
|
13892
14517
|
'get'(
|
|
13893
14518
|
parameters?: Parameters<Paths.GetPortalWidgets.QueryParameters> | null,
|
|
@@ -14217,7 +14842,7 @@ export interface PathsDictionary {
|
|
|
14217
14842
|
/**
|
|
14218
14843
|
* getAllOrders - getAllOrders
|
|
14219
14844
|
*
|
|
14220
|
-
* Get all orders for the portal user
|
|
14845
|
+
* Get all orders for the portal user. Use searchPortalUserEntities instead.
|
|
14221
14846
|
*/
|
|
14222
14847
|
'get'(
|
|
14223
14848
|
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
|
|
@@ -14241,7 +14866,7 @@ export interface PathsDictionary {
|
|
|
14241
14866
|
/**
|
|
14242
14867
|
* getOrder - getOrder
|
|
14243
14868
|
*
|
|
14244
|
-
* Get an order by id
|
|
14869
|
+
* Get an order by id. Use getPortalUserEntity instead.
|
|
14245
14870
|
*/
|
|
14246
14871
|
'get'(
|
|
14247
14872
|
parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
|
|
@@ -14251,7 +14876,7 @@ export interface PathsDictionary {
|
|
|
14251
14876
|
/**
|
|
14252
14877
|
* updateOrder - updateOrder
|
|
14253
14878
|
*
|
|
14254
|
-
* Update an order by id
|
|
14879
|
+
* Update an order by id. Use getPortalUserEntity instead.
|
|
14255
14880
|
*/
|
|
14256
14881
|
'patch'(
|
|
14257
14882
|
parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
|
|
@@ -14263,7 +14888,7 @@ export interface PathsDictionary {
|
|
|
14263
14888
|
/**
|
|
14264
14889
|
* getAllOpportunities - getAllOpportunities
|
|
14265
14890
|
*
|
|
14266
|
-
* Get all opportunities of a portal user
|
|
14891
|
+
* Get all opportunities of a portal user. Use searchPortalUserEntities instead.
|
|
14267
14892
|
*/
|
|
14268
14893
|
'get'(
|
|
14269
14894
|
parameters?: Parameters<Paths.GetAllOpportunities.QueryParameters> | null,
|
|
@@ -14275,7 +14900,7 @@ export interface PathsDictionary {
|
|
|
14275
14900
|
/**
|
|
14276
14901
|
* getSearchableAttributesForOpportunities - getSearchableAttributesForOpportunities
|
|
14277
14902
|
*
|
|
14278
|
-
* Get all opportunity searchable attributes for a portal user
|
|
14903
|
+
* Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.
|
|
14279
14904
|
*/
|
|
14280
14905
|
'get'(
|
|
14281
14906
|
parameters?: Parameters<Paths.GetSearchableAttributesForOpportunities.QueryParameters> | null,
|
|
@@ -14287,7 +14912,7 @@ export interface PathsDictionary {
|
|
|
14287
14912
|
/**
|
|
14288
14913
|
* getSearchResultsForOpportunities - getSearchResultsForOpportunities
|
|
14289
14914
|
*
|
|
14290
|
-
* Get all opportunity with the given
|
|
14915
|
+
* Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.
|
|
14291
14916
|
*/
|
|
14292
14917
|
'post'(
|
|
14293
14918
|
parameters?: Parameters<Paths.GetSearchResultsForOpportunities.QueryParameters> | null,
|
|
@@ -14299,7 +14924,7 @@ export interface PathsDictionary {
|
|
|
14299
14924
|
/**
|
|
14300
14925
|
* getOpportunity - getOpportunity
|
|
14301
14926
|
*
|
|
14302
|
-
* Get an opportunity by id
|
|
14927
|
+
* Get an opportunity by id. Use getPortalUserEntity instead.
|
|
14303
14928
|
*/
|
|
14304
14929
|
'get'(
|
|
14305
14930
|
parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
|
|
@@ -14309,7 +14934,7 @@ export interface PathsDictionary {
|
|
|
14309
14934
|
/**
|
|
14310
14935
|
* updateOpportunity - updateOpportunity
|
|
14311
14936
|
*
|
|
14312
|
-
* Update an opportunity by id
|
|
14937
|
+
* Update an opportunity by id.
|
|
14313
14938
|
*/
|
|
14314
14939
|
'patch'(
|
|
14315
14940
|
parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
|
|
@@ -14321,7 +14946,7 @@ export interface PathsDictionary {
|
|
|
14321
14946
|
/**
|
|
14322
14947
|
* getAllRequests - getAllRequests
|
|
14323
14948
|
*
|
|
14324
|
-
* Get all opportunities & orders of a portal user
|
|
14949
|
+
* Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.
|
|
14325
14950
|
*/
|
|
14326
14951
|
'get'(
|
|
14327
14952
|
parameters?: Parameters<Paths.GetAllRequests.QueryParameters> | null,
|
|
@@ -14333,7 +14958,7 @@ export interface PathsDictionary {
|
|
|
14333
14958
|
/**
|
|
14334
14959
|
* getAllContracts - getAllContracts
|
|
14335
14960
|
*
|
|
14336
|
-
* Get all contracts for a portal user
|
|
14961
|
+
* Get all contracts for a portal user. Use searchPortalUserEntities instead.
|
|
14337
14962
|
*/
|
|
14338
14963
|
'get'(
|
|
14339
14964
|
parameters?: Parameters<Paths.GetAllContracts.QueryParameters> | null,
|
|
@@ -14345,7 +14970,7 @@ export interface PathsDictionary {
|
|
|
14345
14970
|
/**
|
|
14346
14971
|
* getContract - getContract
|
|
14347
14972
|
*
|
|
14348
|
-
* Get a contract by id
|
|
14973
|
+
* Get a contract by id. Use getPortalUserEntity instead.
|
|
14349
14974
|
*/
|
|
14350
14975
|
'get'(
|
|
14351
14976
|
parameters?: Parameters<Paths.GetContract.PathParameters> | null,
|
|
@@ -14355,7 +14980,7 @@ export interface PathsDictionary {
|
|
|
14355
14980
|
/**
|
|
14356
14981
|
* updateContract - updateContract
|
|
14357
14982
|
*
|
|
14358
|
-
* Update a contract by id
|
|
14983
|
+
* Update a contract by id. Use getPortalUserEntity instead.
|
|
14359
14984
|
*/
|
|
14360
14985
|
'patch'(
|
|
14361
14986
|
parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
|
|
@@ -14500,7 +15125,7 @@ export interface PathsDictionary {
|
|
|
14500
15125
|
/**
|
|
14501
15126
|
* getFileById - getFileById
|
|
14502
15127
|
*
|
|
14503
|
-
* Fetch a document with ID
|
|
15128
|
+
* Fetch a document with ID. Use getPortalUserEntity instead.
|
|
14504
15129
|
*/
|
|
14505
15130
|
'get'(
|
|
14506
15131
|
parameters?: Parameters<Paths.GetFileById.PathParameters> | null,
|
|
@@ -14844,6 +15469,18 @@ export interface PathsDictionary {
|
|
|
14844
15469
|
config?: AxiosRequestConfig
|
|
14845
15470
|
): OperationResponse<Paths.GetPublicPages.Responses.$200>
|
|
14846
15471
|
}
|
|
15472
|
+
['/v2/portal/pages/interpolate']: {
|
|
15473
|
+
/**
|
|
15474
|
+
* interpolatePortalPages - interpolatePortalPages
|
|
15475
|
+
*
|
|
15476
|
+
* Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.
|
|
15477
|
+
*/
|
|
15478
|
+
'post'(
|
|
15479
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15480
|
+
data?: Paths.InterpolatePortalPages.RequestBody,
|
|
15481
|
+
config?: AxiosRequestConfig
|
|
15482
|
+
): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
|
|
15483
|
+
}
|
|
14847
15484
|
['/v2/portal/pages/default']: {
|
|
14848
15485
|
/**
|
|
14849
15486
|
* getDefaultPages - getDefaultPages
|
|
@@ -15114,6 +15751,7 @@ export interface PathsDictionary {
|
|
|
15114
15751
|
|
|
15115
15752
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
15116
15753
|
|
|
15754
|
+
|
|
15117
15755
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
15118
15756
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
15119
15757
|
export type ActionWidget = Components.Schemas.ActionWidget;
|
|
@@ -15153,7 +15791,6 @@ export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
|
15153
15791
|
export type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
|
|
15154
15792
|
export type Direction = Components.Schemas.Direction;
|
|
15155
15793
|
export type DocumentWidget = Components.Schemas.DocumentWidget;
|
|
15156
|
-
export type DomainSettings = Components.Schemas.DomainSettings;
|
|
15157
15794
|
export type EmailTemplates = Components.Schemas.EmailTemplates;
|
|
15158
15795
|
export type Entity = Components.Schemas.Entity;
|
|
15159
15796
|
export type EntityEditRule = Components.Schemas.EntityEditRule;
|
|
@@ -15167,6 +15804,7 @@ export type EntityResponseGroupedWithHits = Components.Schemas.EntityResponseGro
|
|
|
15167
15804
|
export type EntityResponseWithHits = Components.Schemas.EntityResponseWithHits;
|
|
15168
15805
|
export type EntitySearchParams = Components.Schemas.EntitySearchParams;
|
|
15169
15806
|
export type EntitySlug = Components.Schemas.EntitySlug;
|
|
15807
|
+
export type EntitySlugConfig = Components.Schemas.EntitySlugConfig;
|
|
15170
15808
|
export type EntityTemplates = Components.Schemas.EntityTemplates;
|
|
15171
15809
|
export type EntityWidget = Components.Schemas.EntityWidget;
|
|
15172
15810
|
export type ErrorResp = Components.Schemas.ErrorResp;
|
|
@@ -15216,6 +15854,7 @@ export type PortalUser = Components.Schemas.PortalUser;
|
|
|
15216
15854
|
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
|
15217
15855
|
export type PortalWidget = Components.Schemas.PortalWidget;
|
|
15218
15856
|
export type Product = Components.Schemas.Product;
|
|
15857
|
+
export type ProductRecommendationsWidget = Components.Schemas.ProductRecommendationsWidget;
|
|
15219
15858
|
export type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
15220
15859
|
export type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
15221
15860
|
export type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
@@ -15238,6 +15877,8 @@ export type SSOLoginToken = Components.Schemas.SSOLoginToken;
|
|
|
15238
15877
|
export type SaveEntityFile = Components.Schemas.SaveEntityFile;
|
|
15239
15878
|
export type SavePortalFile = Components.Schemas.SavePortalFile;
|
|
15240
15879
|
export type Schema = Components.Schemas.Schema;
|
|
15880
|
+
export type SearchIncludes = Components.Schemas.SearchIncludes;
|
|
15881
|
+
export type SecureProxyConfig = Components.Schemas.SecureProxyConfig;
|
|
15241
15882
|
export type Source = Components.Schemas.Source;
|
|
15242
15883
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
15243
15884
|
export type TariffType = Components.Schemas.TariffType;
|