@epilot/customer-portal-client 0.48.0 → 0.48.1
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/definition.js +1 -1
- package/dist/openapi-runtime.json +18 -0
- package/dist/openapi.d.ts +368 -293
- package/package.json +1 -1
- package/src/openapi-runtime.json +18 -0
- package/src/openapi.json +430 -66
package/dist/openapi.d.ts
CHANGED
|
@@ -1067,35 +1067,7 @@ declare namespace Components {
|
|
|
1067
1067
|
* false
|
|
1068
1068
|
*/
|
|
1069
1069
|
user_account_self_management?: boolean;
|
|
1070
|
-
|
|
1071
|
-
* Feature settings for the portal
|
|
1072
|
-
*/
|
|
1073
|
-
feature_settings?: {
|
|
1074
|
-
/**
|
|
1075
|
-
* Start page feature flag
|
|
1076
|
-
*/
|
|
1077
|
-
start_page?: boolean;
|
|
1078
|
-
/**
|
|
1079
|
-
* Billing feature flag
|
|
1080
|
-
*/
|
|
1081
|
-
billing?: boolean;
|
|
1082
|
-
/**
|
|
1083
|
-
* Change due date feature flag
|
|
1084
|
-
*/
|
|
1085
|
-
change_due_date?: boolean;
|
|
1086
|
-
/**
|
|
1087
|
-
* Enable or disable the new design for the portal
|
|
1088
|
-
*/
|
|
1089
|
-
new_design?: boolean;
|
|
1090
|
-
/**
|
|
1091
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
1092
|
-
*/
|
|
1093
|
-
mcp_enabled?: boolean;
|
|
1094
|
-
/**
|
|
1095
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1096
|
-
*/
|
|
1097
|
-
mcp_grant_version?: number;
|
|
1098
|
-
};
|
|
1070
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
1099
1071
|
/**
|
|
1100
1072
|
* Access token for the portal
|
|
1101
1073
|
*/
|
|
@@ -1635,35 +1607,7 @@ declare namespace Components {
|
|
|
1635
1607
|
* false
|
|
1636
1608
|
*/
|
|
1637
1609
|
user_account_self_management?: boolean;
|
|
1638
|
-
|
|
1639
|
-
* Feature settings for the portal
|
|
1640
|
-
*/
|
|
1641
|
-
feature_settings?: {
|
|
1642
|
-
/**
|
|
1643
|
-
* Start page feature flag
|
|
1644
|
-
*/
|
|
1645
|
-
start_page?: boolean;
|
|
1646
|
-
/**
|
|
1647
|
-
* Billing feature flag
|
|
1648
|
-
*/
|
|
1649
|
-
billing?: boolean;
|
|
1650
|
-
/**
|
|
1651
|
-
* Change due date feature flag
|
|
1652
|
-
*/
|
|
1653
|
-
change_due_date?: boolean;
|
|
1654
|
-
/**
|
|
1655
|
-
* Enable or disable the new design for the portal
|
|
1656
|
-
*/
|
|
1657
|
-
new_design?: boolean;
|
|
1658
|
-
/**
|
|
1659
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
1660
|
-
*/
|
|
1661
|
-
mcp_enabled?: boolean;
|
|
1662
|
-
/**
|
|
1663
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1664
|
-
*/
|
|
1665
|
-
mcp_grant_version?: number;
|
|
1666
|
-
};
|
|
1610
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
1667
1611
|
/**
|
|
1668
1612
|
* Access token for the portal
|
|
1669
1613
|
*/
|
|
@@ -2333,6 +2277,15 @@ declare namespace Components {
|
|
|
2333
2277
|
* []
|
|
2334
2278
|
*/
|
|
2335
2279
|
allowed_operations?: string[];
|
|
2280
|
+
/**
|
|
2281
|
+
* Whether the identified contact already has a portal user on this portal, so the caller
|
|
2282
|
+
* can skip offering account creation. Present only on a match; omitted when it could not
|
|
2283
|
+
* be determined.
|
|
2284
|
+
*
|
|
2285
|
+
* example:
|
|
2286
|
+
* false
|
|
2287
|
+
*/
|
|
2288
|
+
has_portal_user?: boolean;
|
|
2336
2289
|
/**
|
|
2337
2290
|
* Present only when no token was issued. NOT_FOUND means the given identifiers did not
|
|
2338
2291
|
* match any contact (definitive - the client should not retry). TIMEOUT means the contact
|
|
@@ -5256,7 +5209,7 @@ declare namespace Components {
|
|
|
5256
5209
|
*/
|
|
5257
5210
|
scanned: number;
|
|
5258
5211
|
usages: {
|
|
5259
|
-
kind: "portal-config" | "portal-block"
|
|
5212
|
+
kind: "portal-config" | "portal-block";
|
|
5260
5213
|
resource: {
|
|
5261
5214
|
type: "portal";
|
|
5262
5215
|
id: string;
|
|
@@ -5291,6 +5244,26 @@ declare namespace Components {
|
|
|
5291
5244
|
* https://example.com
|
|
5292
5245
|
*/
|
|
5293
5246
|
redirect_to?: string;
|
|
5247
|
+
/**
|
|
5248
|
+
* Portal name, served as the document title before the app boots
|
|
5249
|
+
* example:
|
|
5250
|
+
* Kundenportal
|
|
5251
|
+
*/
|
|
5252
|
+
title?: string;
|
|
5253
|
+
/**
|
|
5254
|
+
* Whether the served document should carry a `noindex, nofollow` robots meta tag
|
|
5255
|
+
*/
|
|
5256
|
+
prevent_indexing?: boolean;
|
|
5257
|
+
/**
|
|
5258
|
+
* Organization of the portal, used to preload its design from the served document
|
|
5259
|
+
* example:
|
|
5260
|
+
* 123
|
|
5261
|
+
*/
|
|
5262
|
+
organization_id?: string;
|
|
5263
|
+
/**
|
|
5264
|
+
* Design of the portal, used to preload it from the served document
|
|
5265
|
+
*/
|
|
5266
|
+
design_id?: string;
|
|
5294
5267
|
}
|
|
5295
5268
|
/**
|
|
5296
5269
|
* The meter entity
|
|
@@ -6525,35 +6498,7 @@ declare namespace Components {
|
|
|
6525
6498
|
* false
|
|
6526
6499
|
*/
|
|
6527
6500
|
user_account_self_management?: boolean;
|
|
6528
|
-
|
|
6529
|
-
* Feature settings for the portal
|
|
6530
|
-
*/
|
|
6531
|
-
feature_settings?: {
|
|
6532
|
-
/**
|
|
6533
|
-
* Start page feature flag
|
|
6534
|
-
*/
|
|
6535
|
-
start_page?: boolean;
|
|
6536
|
-
/**
|
|
6537
|
-
* Billing feature flag
|
|
6538
|
-
*/
|
|
6539
|
-
billing?: boolean;
|
|
6540
|
-
/**
|
|
6541
|
-
* Change due date feature flag
|
|
6542
|
-
*/
|
|
6543
|
-
change_due_date?: boolean;
|
|
6544
|
-
/**
|
|
6545
|
-
* Enable or disable the new design for the portal
|
|
6546
|
-
*/
|
|
6547
|
-
new_design?: boolean;
|
|
6548
|
-
/**
|
|
6549
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
6550
|
-
*/
|
|
6551
|
-
mcp_enabled?: boolean;
|
|
6552
|
-
/**
|
|
6553
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
6554
|
-
*/
|
|
6555
|
-
mcp_grant_version?: number;
|
|
6556
|
-
};
|
|
6501
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
6557
6502
|
/**
|
|
6558
6503
|
* Access token for the portal
|
|
6559
6504
|
*/
|
|
@@ -7062,6 +7007,123 @@ declare namespace Components {
|
|
|
7062
7007
|
grants?: Grant[];
|
|
7063
7008
|
identity_providers?: ProviderPublicConfig[];
|
|
7064
7009
|
}
|
|
7010
|
+
/**
|
|
7011
|
+
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
7012
|
+
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
7013
|
+
* identity providers and certificate details are left out; read them per portal with
|
|
7014
|
+
* `getPortalConfigV3`.
|
|
7015
|
+
*
|
|
7016
|
+
*/
|
|
7017
|
+
export interface PortalConfigSummaryV3 {
|
|
7018
|
+
portal_id?: /**
|
|
7019
|
+
* ID of the portal
|
|
7020
|
+
* example:
|
|
7021
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7022
|
+
*/
|
|
7023
|
+
PortalId;
|
|
7024
|
+
/**
|
|
7025
|
+
* ID of the organization
|
|
7026
|
+
* example:
|
|
7027
|
+
* 12345
|
|
7028
|
+
*/
|
|
7029
|
+
organization_id?: string;
|
|
7030
|
+
origin?: /* Origin of the portal */ Origin;
|
|
7031
|
+
/**
|
|
7032
|
+
* Name of the portal
|
|
7033
|
+
*/
|
|
7034
|
+
name?: string;
|
|
7035
|
+
/**
|
|
7036
|
+
* Whether the portal is enabled
|
|
7037
|
+
*/
|
|
7038
|
+
enabled?: boolean;
|
|
7039
|
+
/**
|
|
7040
|
+
* Custom domain of the portal
|
|
7041
|
+
*/
|
|
7042
|
+
domain?: string;
|
|
7043
|
+
/**
|
|
7044
|
+
* epilot-hosted domain of the portal
|
|
7045
|
+
*/
|
|
7046
|
+
epilot_domain?: string;
|
|
7047
|
+
is_epilot_domain?: boolean;
|
|
7048
|
+
/**
|
|
7049
|
+
* Status of the custom domain setup, when a custom domain is configured
|
|
7050
|
+
*/
|
|
7051
|
+
dnsStatus?: "CONFIGURING" | "PENDING" | "SUCCEED" | "EXPIRED" | "NEW_CERT_IN_PROGRESS";
|
|
7052
|
+
design_id?: /**
|
|
7053
|
+
* Entity ID
|
|
7054
|
+
* example:
|
|
7055
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
7056
|
+
*/
|
|
7057
|
+
EntityId /* uuid */;
|
|
7058
|
+
/**
|
|
7059
|
+
* The logo to show for the portal in lists: the `logoImage` of the first page
|
|
7060
|
+
* that sets one. Absent when no page carries a logo; fall back to the design.
|
|
7061
|
+
*
|
|
7062
|
+
*/
|
|
7063
|
+
logo_image?: {
|
|
7064
|
+
/**
|
|
7065
|
+
* Logo for the light theme
|
|
7066
|
+
* example:
|
|
7067
|
+
* https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/logo.png
|
|
7068
|
+
*/
|
|
7069
|
+
url?: string;
|
|
7070
|
+
/**
|
|
7071
|
+
* Logo for the dark theme
|
|
7072
|
+
*/
|
|
7073
|
+
dark_url?: string;
|
|
7074
|
+
};
|
|
7075
|
+
/**
|
|
7076
|
+
* Default 360 user to notify upon an internal notification
|
|
7077
|
+
*/
|
|
7078
|
+
default_user_to_notify?: {
|
|
7079
|
+
/**
|
|
7080
|
+
* Default admin users for pending user notification to notify
|
|
7081
|
+
*/
|
|
7082
|
+
onPendingUser?: AdminUser[];
|
|
7083
|
+
};
|
|
7084
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7085
|
+
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
7086
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
|
|
7087
|
+
block_registration_if_portal_user_exists?: boolean;
|
|
7088
|
+
/**
|
|
7089
|
+
* Entity type used as the primary identifier for self-registration
|
|
7090
|
+
*/
|
|
7091
|
+
self_registration_entity?: "contact" | "account";
|
|
7092
|
+
/**
|
|
7093
|
+
* Enable or disable user account self management
|
|
7094
|
+
*/
|
|
7095
|
+
user_account_self_management?: boolean;
|
|
7096
|
+
/**
|
|
7097
|
+
* Identifiers to identify a contact of a portal user during the registration.
|
|
7098
|
+
*/
|
|
7099
|
+
registration_identifiers?: ContractIdentifier[];
|
|
7100
|
+
/**
|
|
7101
|
+
* Surfaces this portal's data is reached from besides the portal UI itself.
|
|
7102
|
+
*/
|
|
7103
|
+
surfaces?: /**
|
|
7104
|
+
* One surface a portal's data is reached from (see `surfaces` on the portal config).
|
|
7105
|
+
*
|
|
7106
|
+
* A surface names how callers authenticate on it and what they may reach once they
|
|
7107
|
+
* have. Data access is always a subset of the portal's own: a schema not in
|
|
7108
|
+
* `allowed_portal_entities` cannot be opened up by a surface, and the portal's
|
|
7109
|
+
* contact-relation rules still apply underneath the surface's own.
|
|
7110
|
+
*
|
|
7111
|
+
* Tokens minted for a surface (currently: contact identification tokens for
|
|
7112
|
+
* `registration_identifiers` surfaces) carry the surface id. The surface's data
|
|
7113
|
+
* access is resolved from the portal config on every request, not baked into the
|
|
7114
|
+
* token, so tightening a surface applies to tokens already in circulation.
|
|
7115
|
+
*
|
|
7116
|
+
*/
|
|
7117
|
+
PortalSurface[];
|
|
7118
|
+
is_dummy?: boolean;
|
|
7119
|
+
is_v3_item?: boolean;
|
|
7120
|
+
/**
|
|
7121
|
+
* ID of the currently published revision, if the portal has been published
|
|
7122
|
+
*/
|
|
7123
|
+
published_revision_id?: string;
|
|
7124
|
+
_created_at?: string; // date-time
|
|
7125
|
+
_updated_at?: string; // date-time
|
|
7126
|
+
}
|
|
7065
7127
|
export interface PortalConfigV3 {
|
|
7066
7128
|
/**
|
|
7067
7129
|
* Journey actions allowed on an entity by a portal user
|
|
@@ -7186,35 +7248,7 @@ declare namespace Components {
|
|
|
7186
7248
|
* false
|
|
7187
7249
|
*/
|
|
7188
7250
|
user_account_self_management?: boolean;
|
|
7189
|
-
|
|
7190
|
-
* Feature settings for the portal
|
|
7191
|
-
*/
|
|
7192
|
-
feature_settings?: {
|
|
7193
|
-
/**
|
|
7194
|
-
* Start page feature flag
|
|
7195
|
-
*/
|
|
7196
|
-
start_page?: boolean;
|
|
7197
|
-
/**
|
|
7198
|
-
* Billing feature flag
|
|
7199
|
-
*/
|
|
7200
|
-
billing?: boolean;
|
|
7201
|
-
/**
|
|
7202
|
-
* Change due date feature flag
|
|
7203
|
-
*/
|
|
7204
|
-
change_due_date?: boolean;
|
|
7205
|
-
/**
|
|
7206
|
-
* Enable or disable the new design for the portal
|
|
7207
|
-
*/
|
|
7208
|
-
new_design?: boolean;
|
|
7209
|
-
/**
|
|
7210
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
7211
|
-
*/
|
|
7212
|
-
mcp_enabled?: boolean;
|
|
7213
|
-
/**
|
|
7214
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7215
|
-
*/
|
|
7216
|
-
mcp_grant_version?: number;
|
|
7217
|
-
};
|
|
7251
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7218
7252
|
/**
|
|
7219
7253
|
* Access token for the portal
|
|
7220
7254
|
*/
|
|
@@ -7781,6 +7815,47 @@ declare namespace Components {
|
|
|
7781
7815
|
*/
|
|
7782
7816
|
installer?: string;
|
|
7783
7817
|
}
|
|
7818
|
+
/**
|
|
7819
|
+
* Feature settings for the portal
|
|
7820
|
+
*/
|
|
7821
|
+
export interface PortalFeatureSettings {
|
|
7822
|
+
/**
|
|
7823
|
+
* Retired, not read. A portal shows a start page by having a `dashboard` page.
|
|
7824
|
+
*/
|
|
7825
|
+
start_page?: boolean;
|
|
7826
|
+
/**
|
|
7827
|
+
* Retired, not read. Billing follows the organization's `commodity_billing` setting.
|
|
7828
|
+
*/
|
|
7829
|
+
billing?: boolean;
|
|
7830
|
+
/**
|
|
7831
|
+
* Retired, not read. Billing pages and blocks follow the organization's `commodity_billing` setting.
|
|
7832
|
+
*/
|
|
7833
|
+
commodity_billing?: boolean;
|
|
7834
|
+
/**
|
|
7835
|
+
* Retired, not read.
|
|
7836
|
+
*/
|
|
7837
|
+
change_due_date?: boolean;
|
|
7838
|
+
/**
|
|
7839
|
+
* Enable or disable the new design for the portal
|
|
7840
|
+
*/
|
|
7841
|
+
new_design?: boolean;
|
|
7842
|
+
/**
|
|
7843
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
7844
|
+
*/
|
|
7845
|
+
mcp_enabled?: boolean;
|
|
7846
|
+
/**
|
|
7847
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7848
|
+
*/
|
|
7849
|
+
mcp_grant_version?: number;
|
|
7850
|
+
/**
|
|
7851
|
+
* Enable the portal copilot chat for this portal
|
|
7852
|
+
*/
|
|
7853
|
+
portal_copilot?: boolean;
|
|
7854
|
+
/**
|
|
7855
|
+
* ID of the Agent Builder portal agent this portal's copilot chat runs, set by Agent Builder. When unset, or when the agent no longer exists in the portal's organization, the chat runs the default portal copilot.
|
|
7856
|
+
*/
|
|
7857
|
+
portal_copilot_agent_id?: string;
|
|
7858
|
+
}
|
|
7784
7859
|
/**
|
|
7785
7860
|
* ID of the portal
|
|
7786
7861
|
* example:
|
|
@@ -8131,35 +8206,7 @@ declare namespace Components {
|
|
|
8131
8206
|
* false
|
|
8132
8207
|
*/
|
|
8133
8208
|
user_account_self_management?: boolean;
|
|
8134
|
-
|
|
8135
|
-
* Feature settings for the portal
|
|
8136
|
-
*/
|
|
8137
|
-
feature_settings?: {
|
|
8138
|
-
/**
|
|
8139
|
-
* Start page feature flag
|
|
8140
|
-
*/
|
|
8141
|
-
start_page?: boolean;
|
|
8142
|
-
/**
|
|
8143
|
-
* Billing feature flag
|
|
8144
|
-
*/
|
|
8145
|
-
billing?: boolean;
|
|
8146
|
-
/**
|
|
8147
|
-
* Change due date feature flag
|
|
8148
|
-
*/
|
|
8149
|
-
change_due_date?: boolean;
|
|
8150
|
-
/**
|
|
8151
|
-
* Enable or disable the new design for the portal
|
|
8152
|
-
*/
|
|
8153
|
-
new_design?: boolean;
|
|
8154
|
-
/**
|
|
8155
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
8156
|
-
*/
|
|
8157
|
-
mcp_enabled?: boolean;
|
|
8158
|
-
/**
|
|
8159
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
8160
|
-
*/
|
|
8161
|
-
mcp_grant_version?: number;
|
|
8162
|
-
};
|
|
8209
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
8163
8210
|
/**
|
|
8164
8211
|
* Access token for the portal
|
|
8165
8212
|
*/
|
|
@@ -10060,10 +10107,52 @@ declare namespace Components {
|
|
|
10060
10107
|
*/
|
|
10061
10108
|
status: string;
|
|
10062
10109
|
}
|
|
10110
|
+
export interface SwapPortalReferenceGroup {
|
|
10111
|
+
/**
|
|
10112
|
+
* Items whose references now point at the target portal.
|
|
10113
|
+
*/
|
|
10114
|
+
updated: SwapPortalReferenceItem[];
|
|
10115
|
+
/**
|
|
10116
|
+
* Items that reference the source portal but could not be updated.
|
|
10117
|
+
*/
|
|
10118
|
+
failed: SwapPortalReferenceItem[];
|
|
10119
|
+
/**
|
|
10120
|
+
* Set when the items could not be listed, so none of them were checked.
|
|
10121
|
+
*/
|
|
10122
|
+
list_error?: string;
|
|
10123
|
+
}
|
|
10124
|
+
export interface SwapPortalReferenceItem {
|
|
10125
|
+
/**
|
|
10126
|
+
* Journey id or automation flow id.
|
|
10127
|
+
*/
|
|
10128
|
+
id: string;
|
|
10129
|
+
name?: string;
|
|
10130
|
+
/**
|
|
10131
|
+
* Where the reference sat in the item.
|
|
10132
|
+
* example:
|
|
10133
|
+
* [
|
|
10134
|
+
* "steps[0].uischema.elements[2].options.portalId"
|
|
10135
|
+
* ]
|
|
10136
|
+
*/
|
|
10137
|
+
paths?: string[];
|
|
10138
|
+
/**
|
|
10139
|
+
* Why the update failed. Only set on failed items.
|
|
10140
|
+
*/
|
|
10141
|
+
error?: string;
|
|
10142
|
+
}
|
|
10143
|
+
/**
|
|
10144
|
+
* Outcome of the `portal_references` swap option. Only present when that option was requested. The swap itself has already succeeded when this is returned, so failures here do not undo it.
|
|
10145
|
+
*/
|
|
10146
|
+
export interface SwapPortalReferencesResult {
|
|
10147
|
+
journeys: SwapPortalReferenceGroup;
|
|
10148
|
+
automation_flows: SwapPortalReferenceGroup;
|
|
10149
|
+
}
|
|
10063
10150
|
/**
|
|
10064
10151
|
* Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
|
|
10152
|
+
* - `email_templates`: swap the email templates of the two portals.
|
|
10153
|
+
* - `portal_references`: after the swap, re-point configuration in other services from the source portal to the target portal: the portal on journey login (AuthControl) blocks and in file upload portal access, and the portal of automation flow portal triggers. One-directional: references to the target portal are left unchanged, because the target keeps its domain and users. System flows are not changed. Uses the caller's permissions; the outcome is returned in `portal_references`.
|
|
10065
10154
|
*/
|
|
10066
|
-
export type SwappableConfig = "email_templates";
|
|
10155
|
+
export type SwappableConfig = "email_templates" | "portal_references";
|
|
10067
10156
|
export type TariffType = "ht" | "nt";
|
|
10068
10157
|
export interface TeaserWidget {
|
|
10069
10158
|
id: string;
|
|
@@ -10342,35 +10431,7 @@ declare namespace Components {
|
|
|
10342
10431
|
* false
|
|
10343
10432
|
*/
|
|
10344
10433
|
user_account_self_management?: boolean;
|
|
10345
|
-
|
|
10346
|
-
* Feature settings for the portal
|
|
10347
|
-
*/
|
|
10348
|
-
feature_settings?: {
|
|
10349
|
-
/**
|
|
10350
|
-
* Start page feature flag
|
|
10351
|
-
*/
|
|
10352
|
-
start_page?: boolean;
|
|
10353
|
-
/**
|
|
10354
|
-
* Billing feature flag
|
|
10355
|
-
*/
|
|
10356
|
-
billing?: boolean;
|
|
10357
|
-
/**
|
|
10358
|
-
* Change due date feature flag
|
|
10359
|
-
*/
|
|
10360
|
-
change_due_date?: boolean;
|
|
10361
|
-
/**
|
|
10362
|
-
* Enable or disable the new design for the portal
|
|
10363
|
-
*/
|
|
10364
|
-
new_design?: boolean;
|
|
10365
|
-
/**
|
|
10366
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
10367
|
-
*/
|
|
10368
|
-
mcp_enabled?: boolean;
|
|
10369
|
-
/**
|
|
10370
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
10371
|
-
*/
|
|
10372
|
-
mcp_grant_version?: number;
|
|
10373
|
-
};
|
|
10434
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
10374
10435
|
/**
|
|
10375
10436
|
* Access token for the portal
|
|
10376
10437
|
*/
|
|
@@ -10971,35 +11032,7 @@ declare namespace Components {
|
|
|
10971
11032
|
* false
|
|
10972
11033
|
*/
|
|
10973
11034
|
user_account_self_management?: boolean;
|
|
10974
|
-
|
|
10975
|
-
* Feature settings for the portal
|
|
10976
|
-
*/
|
|
10977
|
-
feature_settings?: {
|
|
10978
|
-
/**
|
|
10979
|
-
* Start page feature flag
|
|
10980
|
-
*/
|
|
10981
|
-
start_page?: boolean;
|
|
10982
|
-
/**
|
|
10983
|
-
* Billing feature flag
|
|
10984
|
-
*/
|
|
10985
|
-
billing?: boolean;
|
|
10986
|
-
/**
|
|
10987
|
-
* Change due date feature flag
|
|
10988
|
-
*/
|
|
10989
|
-
change_due_date?: boolean;
|
|
10990
|
-
/**
|
|
10991
|
-
* Enable or disable the new design for the portal
|
|
10992
|
-
*/
|
|
10993
|
-
new_design?: boolean;
|
|
10994
|
-
/**
|
|
10995
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
10996
|
-
*/
|
|
10997
|
-
mcp_enabled?: boolean;
|
|
10998
|
-
/**
|
|
10999
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
11000
|
-
*/
|
|
11001
|
-
mcp_grant_version?: number;
|
|
11002
|
-
};
|
|
11035
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
11003
11036
|
/**
|
|
11004
11037
|
* Access token for the portal
|
|
11005
11038
|
*/
|
|
@@ -11920,6 +11953,48 @@ declare namespace Paths {
|
|
|
11920
11953
|
export type $500 = Components.Responses.InternalServerError;
|
|
11921
11954
|
}
|
|
11922
11955
|
}
|
|
11956
|
+
namespace CompleteTemporaryPassword {
|
|
11957
|
+
export interface RequestBody {
|
|
11958
|
+
/**
|
|
11959
|
+
* Organization ID
|
|
11960
|
+
* example:
|
|
11961
|
+
* 123
|
|
11962
|
+
*/
|
|
11963
|
+
org_id: string;
|
|
11964
|
+
/**
|
|
11965
|
+
* ID of the portal the user belongs to
|
|
11966
|
+
* example:
|
|
11967
|
+
* 7hj28akg-97fb-4f5c-b2a1-3e4fbc1d8c7a
|
|
11968
|
+
*/
|
|
11969
|
+
portal_id: string;
|
|
11970
|
+
/**
|
|
11971
|
+
* Email address of the portal user
|
|
11972
|
+
* example:
|
|
11973
|
+
* user@example.com
|
|
11974
|
+
*/
|
|
11975
|
+
email: string;
|
|
11976
|
+
/**
|
|
11977
|
+
* Temporary password from the email
|
|
11978
|
+
*/
|
|
11979
|
+
temporary_password: string;
|
|
11980
|
+
/**
|
|
11981
|
+
* New password, must match the portal's password policy
|
|
11982
|
+
*/
|
|
11983
|
+
new_password: string;
|
|
11984
|
+
}
|
|
11985
|
+
namespace Responses {
|
|
11986
|
+
export interface $200 {
|
|
11987
|
+
/**
|
|
11988
|
+
* example:
|
|
11989
|
+
* Password set successfully.
|
|
11990
|
+
*/
|
|
11991
|
+
message?: string;
|
|
11992
|
+
}
|
|
11993
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
11994
|
+
export type $429 = Components.Responses.TooManyRequests;
|
|
11995
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11996
|
+
}
|
|
11997
|
+
}
|
|
11923
11998
|
namespace ConfigureDistribution {
|
|
11924
11999
|
namespace Parameters {
|
|
11925
12000
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -15013,35 +15088,7 @@ declare namespace Paths {
|
|
|
15013
15088
|
* false
|
|
15014
15089
|
*/
|
|
15015
15090
|
user_account_self_management?: boolean;
|
|
15016
|
-
|
|
15017
|
-
* Feature settings for the portal
|
|
15018
|
-
*/
|
|
15019
|
-
feature_settings?: {
|
|
15020
|
-
/**
|
|
15021
|
-
* Start page feature flag
|
|
15022
|
-
*/
|
|
15023
|
-
start_page?: boolean;
|
|
15024
|
-
/**
|
|
15025
|
-
* Billing feature flag
|
|
15026
|
-
*/
|
|
15027
|
-
billing?: boolean;
|
|
15028
|
-
/**
|
|
15029
|
-
* Change due date feature flag
|
|
15030
|
-
*/
|
|
15031
|
-
change_due_date?: boolean;
|
|
15032
|
-
/**
|
|
15033
|
-
* Enable or disable the new design for the portal
|
|
15034
|
-
*/
|
|
15035
|
-
new_design?: boolean;
|
|
15036
|
-
/**
|
|
15037
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
15038
|
-
*/
|
|
15039
|
-
mcp_enabled?: boolean;
|
|
15040
|
-
/**
|
|
15041
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
15042
|
-
*/
|
|
15043
|
-
mcp_grant_version?: number;
|
|
15044
|
-
};
|
|
15091
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
15045
15092
|
/**
|
|
15046
15093
|
* Access token for the portal
|
|
15047
15094
|
*/
|
|
@@ -15672,35 +15719,7 @@ declare namespace Paths {
|
|
|
15672
15719
|
* false
|
|
15673
15720
|
*/
|
|
15674
15721
|
user_account_self_management?: boolean;
|
|
15675
|
-
|
|
15676
|
-
* Feature settings for the portal
|
|
15677
|
-
*/
|
|
15678
|
-
feature_settings?: {
|
|
15679
|
-
/**
|
|
15680
|
-
* Start page feature flag
|
|
15681
|
-
*/
|
|
15682
|
-
start_page?: boolean;
|
|
15683
|
-
/**
|
|
15684
|
-
* Billing feature flag
|
|
15685
|
-
*/
|
|
15686
|
-
billing?: boolean;
|
|
15687
|
-
/**
|
|
15688
|
-
* Change due date feature flag
|
|
15689
|
-
*/
|
|
15690
|
-
change_due_date?: boolean;
|
|
15691
|
-
/**
|
|
15692
|
-
* Enable or disable the new design for the portal
|
|
15693
|
-
*/
|
|
15694
|
-
new_design?: boolean;
|
|
15695
|
-
/**
|
|
15696
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
15697
|
-
*/
|
|
15698
|
-
mcp_enabled?: boolean;
|
|
15699
|
-
/**
|
|
15700
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
15701
|
-
*/
|
|
15702
|
-
mcp_grant_version?: number;
|
|
15703
|
-
};
|
|
15722
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
15704
15723
|
/**
|
|
15705
15724
|
* Access token for the portal
|
|
15706
15725
|
*/
|
|
@@ -16885,35 +16904,7 @@ declare namespace Paths {
|
|
|
16885
16904
|
* false
|
|
16886
16905
|
*/
|
|
16887
16906
|
user_account_self_management?: boolean;
|
|
16888
|
-
|
|
16889
|
-
* Feature settings for the portal
|
|
16890
|
-
*/
|
|
16891
|
-
feature_settings?: {
|
|
16892
|
-
/**
|
|
16893
|
-
* Start page feature flag
|
|
16894
|
-
*/
|
|
16895
|
-
start_page?: boolean;
|
|
16896
|
-
/**
|
|
16897
|
-
* Billing feature flag
|
|
16898
|
-
*/
|
|
16899
|
-
billing?: boolean;
|
|
16900
|
-
/**
|
|
16901
|
-
* Change due date feature flag
|
|
16902
|
-
*/
|
|
16903
|
-
change_due_date?: boolean;
|
|
16904
|
-
/**
|
|
16905
|
-
* Enable or disable the new design for the portal
|
|
16906
|
-
*/
|
|
16907
|
-
new_design?: boolean;
|
|
16908
|
-
/**
|
|
16909
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
16910
|
-
*/
|
|
16911
|
-
mcp_enabled?: boolean;
|
|
16912
|
-
/**
|
|
16913
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
16914
|
-
*/
|
|
16915
|
-
mcp_grant_version?: number;
|
|
16916
|
-
};
|
|
16907
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
16917
16908
|
/**
|
|
16918
16909
|
* Access token for the portal
|
|
16919
16910
|
*/
|
|
@@ -18269,6 +18260,23 @@ declare namespace Paths {
|
|
|
18269
18260
|
export type $500 = Components.Responses.InternalServerError;
|
|
18270
18261
|
}
|
|
18271
18262
|
}
|
|
18263
|
+
namespace ListPortalConfigSummaries {
|
|
18264
|
+
namespace Responses {
|
|
18265
|
+
export interface $200 {
|
|
18266
|
+
data?: /**
|
|
18267
|
+
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
18268
|
+
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
18269
|
+
* identity providers and certificate details are left out; read them per portal with
|
|
18270
|
+
* `getPortalConfigV3`.
|
|
18271
|
+
*
|
|
18272
|
+
*/
|
|
18273
|
+
Components.Schemas.PortalConfigSummaryV3[];
|
|
18274
|
+
}
|
|
18275
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
18276
|
+
export type $403 = Components.Responses.Forbidden;
|
|
18277
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
18278
|
+
}
|
|
18279
|
+
}
|
|
18272
18280
|
namespace ListPortalNotifications {
|
|
18273
18281
|
namespace Parameters {
|
|
18274
18282
|
export type Cursor = string;
|
|
@@ -19154,7 +19162,12 @@ declare namespace Paths {
|
|
|
19154
19162
|
/**
|
|
19155
19163
|
* Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped.
|
|
19156
19164
|
*/
|
|
19157
|
-
items_to_swap?:
|
|
19165
|
+
items_to_swap?: /**
|
|
19166
|
+
* Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
|
|
19167
|
+
* - `email_templates`: swap the email templates of the two portals.
|
|
19168
|
+
* - `portal_references`: after the swap, re-point configuration in other services from the source portal to the target portal: the portal on journey login (AuthControl) blocks and in file upload portal access, and the portal of automation flow portal triggers. One-directional: references to the target portal are left unchanged, because the target keeps its domain and users. System flows are not changed. Uses the caller's permissions; the outcome is returned in `portal_references`.
|
|
19169
|
+
*/
|
|
19170
|
+
Components.Schemas.SwappableConfig[];
|
|
19158
19171
|
}
|
|
19159
19172
|
namespace Responses {
|
|
19160
19173
|
export interface $200 {
|
|
@@ -19163,6 +19176,7 @@ declare namespace Paths {
|
|
|
19163
19176
|
* Domain and users swapped successfully.
|
|
19164
19177
|
*/
|
|
19165
19178
|
message?: string;
|
|
19179
|
+
portal_references?: /* Outcome of the `portal_references` swap option. Only present when that option was requested. The swap itself has already succeeded when this is returned, so failures here do not undo it. */ Components.Schemas.SwapPortalReferencesResult;
|
|
19166
19180
|
}
|
|
19167
19181
|
export type $400 = Components.Responses.InvalidRequest;
|
|
19168
19182
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -21585,6 +21599,16 @@ export interface OperationMethods {
|
|
|
21585
21599
|
data?: any,
|
|
21586
21600
|
config?: AxiosRequestConfig
|
|
21587
21601
|
): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
|
|
21602
|
+
/**
|
|
21603
|
+
* completeTemporaryPassword - completeTemporaryPassword
|
|
21604
|
+
*
|
|
21605
|
+
* Replaces a portal user's temporary password with the password they chose.
|
|
21606
|
+
*/
|
|
21607
|
+
'completeTemporaryPassword'(
|
|
21608
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
21609
|
+
data?: Paths.CompleteTemporaryPassword.RequestBody,
|
|
21610
|
+
config?: AxiosRequestConfig
|
|
21611
|
+
): OperationResponse<Paths.CompleteTemporaryPassword.Responses.$200>
|
|
21588
21612
|
/**
|
|
21589
21613
|
* updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
|
|
21590
21614
|
*
|
|
@@ -21778,6 +21802,22 @@ export interface OperationMethods {
|
|
|
21778
21802
|
data?: any,
|
|
21779
21803
|
config?: AxiosRequestConfig
|
|
21780
21804
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
21805
|
+
/**
|
|
21806
|
+
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
21807
|
+
*
|
|
21808
|
+
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
21809
|
+
* display and registration fields of each portal config, without pages, email
|
|
21810
|
+
* templates, grants, feature flags, identity providers or certificate details.
|
|
21811
|
+
*
|
|
21812
|
+
* Use it for portal overviews and pickers. Read a single portal with
|
|
21813
|
+
* `getPortalConfigV3` when the full configuration is needed.
|
|
21814
|
+
*
|
|
21815
|
+
*/
|
|
21816
|
+
'listPortalConfigSummaries'(
|
|
21817
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
21818
|
+
data?: any,
|
|
21819
|
+
config?: AxiosRequestConfig
|
|
21820
|
+
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
21781
21821
|
/**
|
|
21782
21822
|
* swapPortalConfig - swapPortalConfig
|
|
21783
21823
|
*
|
|
@@ -23746,6 +23786,18 @@ export interface PathsDictionary {
|
|
|
23746
23786
|
config?: AxiosRequestConfig
|
|
23747
23787
|
): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
|
|
23748
23788
|
}
|
|
23789
|
+
['/v3/portal/public/user/temporary-password/complete']: {
|
|
23790
|
+
/**
|
|
23791
|
+
* completeTemporaryPassword - completeTemporaryPassword
|
|
23792
|
+
*
|
|
23793
|
+
* Replaces a portal user's temporary password with the password they chose.
|
|
23794
|
+
*/
|
|
23795
|
+
'post'(
|
|
23796
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
23797
|
+
data?: Paths.CompleteTemporaryPassword.RequestBody,
|
|
23798
|
+
config?: AxiosRequestConfig
|
|
23799
|
+
): OperationResponse<Paths.CompleteTemporaryPassword.Responses.$200>
|
|
23800
|
+
}
|
|
23749
23801
|
['/v2/portal/campaign/{campaign_id}/entity:status']: {
|
|
23750
23802
|
/**
|
|
23751
23803
|
* updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
|
|
@@ -23967,6 +24019,24 @@ export interface PathsDictionary {
|
|
|
23967
24019
|
config?: AxiosRequestConfig
|
|
23968
24020
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
23969
24021
|
}
|
|
24022
|
+
['/v3/portal/configs/summaries']: {
|
|
24023
|
+
/**
|
|
24024
|
+
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
24025
|
+
*
|
|
24026
|
+
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
24027
|
+
* display and registration fields of each portal config, without pages, email
|
|
24028
|
+
* templates, grants, feature flags, identity providers or certificate details.
|
|
24029
|
+
*
|
|
24030
|
+
* Use it for portal overviews and pickers. Read a single portal with
|
|
24031
|
+
* `getPortalConfigV3` when the full configuration is needed.
|
|
24032
|
+
*
|
|
24033
|
+
*/
|
|
24034
|
+
'get'(
|
|
24035
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
24036
|
+
data?: any,
|
|
24037
|
+
config?: AxiosRequestConfig
|
|
24038
|
+
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
24039
|
+
}
|
|
23970
24040
|
['/v3/portal/config/swap']: {
|
|
23971
24041
|
/**
|
|
23972
24042
|
* swapPortalConfig - swapPortalConfig
|
|
@@ -24240,9 +24310,11 @@ export type Page = Components.Schemas.Page;
|
|
|
24240
24310
|
export type PageRequest = Components.Schemas.PageRequest;
|
|
24241
24311
|
export type PaymentWidget = Components.Schemas.PaymentWidget;
|
|
24242
24312
|
export type PortalConfig = Components.Schemas.PortalConfig;
|
|
24313
|
+
export type PortalConfigSummaryV3 = Components.Schemas.PortalConfigSummaryV3;
|
|
24243
24314
|
export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
24244
24315
|
export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
24245
24316
|
export type PortalDescriptionOverrides = Components.Schemas.PortalDescriptionOverrides;
|
|
24317
|
+
export type PortalFeatureSettings = Components.Schemas.PortalFeatureSettings;
|
|
24246
24318
|
export type PortalId = Components.Schemas.PortalId;
|
|
24247
24319
|
export type PortalNameOverrides = Components.Schemas.PortalNameOverrides;
|
|
24248
24320
|
export type PortalNotification = Components.Schemas.PortalNotification;
|
|
@@ -24302,6 +24374,9 @@ export type Source = Components.Schemas.Source;
|
|
|
24302
24374
|
export type SupportReportType = Components.Schemas.SupportReportType;
|
|
24303
24375
|
export type SupportRequestAttachment = Components.Schemas.SupportRequestAttachment;
|
|
24304
24376
|
export type SupportRequestResult = Components.Schemas.SupportRequestResult;
|
|
24377
|
+
export type SwapPortalReferenceGroup = Components.Schemas.SwapPortalReferenceGroup;
|
|
24378
|
+
export type SwapPortalReferenceItem = Components.Schemas.SwapPortalReferenceItem;
|
|
24379
|
+
export type SwapPortalReferencesResult = Components.Schemas.SwapPortalReferencesResult;
|
|
24305
24380
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
24306
24381
|
export type TariffType = Components.Schemas.TariffType;
|
|
24307
24382
|
export type TeaserWidget = Components.Schemas.TeaserWidget;
|