@epilot/sdk 2.20.39 → 2.20.41
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/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +473 -68
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/identity.cjs +6 -6
- package/dist/apis/identity.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-I67RRULD.js → chunk-DQ346MRA.js} +1 -1
- package/dist/{chunk-766NNARL.cjs → chunk-FBRDBE4Y.cjs} +1 -1
- package/dist/{chunk-A6FNV6JX.js → chunk-IF7LQ3EC.js} +2 -2
- package/dist/{chunk-QSGVSIS7.cjs → chunk-VZIJUUM7.cjs} +2 -2
- package/dist/customer-portal-TSJKBA37.js +7 -0
- package/dist/customer-portal-WOO2QDPR.cjs +7 -0
- package/dist/{customer-portal-runtime-5Z5NO6FH.js → customer-portal-runtime-CNW7NSCT.js} +1 -1
- package/dist/{customer-portal-runtime-5YBPM5TU.cjs → customer-portal-runtime-ZTLLE6CR.cjs} +2 -2
- package/dist/{customer-portal.d-DF4g7c3i.d.cts → customer-portal.d-COI3Xe4x.d.cts} +425 -306
- package/dist/{customer-portal.d-DF4g7c3i.d.ts → customer-portal.d-COI3Xe4x.d.ts} +425 -306
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/customer-portal.md +386 -10
- package/package.json +1 -1
- package/dist/customer-portal-2K3FXGI4.cjs +0 -7
- package/dist/customer-portal-QU3C24B4.js +0 -7
|
@@ -1064,35 +1064,7 @@ declare namespace Components {
|
|
|
1064
1064
|
* false
|
|
1065
1065
|
*/
|
|
1066
1066
|
user_account_self_management?: boolean;
|
|
1067
|
-
|
|
1068
|
-
* Feature settings for the portal
|
|
1069
|
-
*/
|
|
1070
|
-
feature_settings?: {
|
|
1071
|
-
/**
|
|
1072
|
-
* Start page feature flag
|
|
1073
|
-
*/
|
|
1074
|
-
start_page?: boolean;
|
|
1075
|
-
/**
|
|
1076
|
-
* Billing feature flag
|
|
1077
|
-
*/
|
|
1078
|
-
billing?: boolean;
|
|
1079
|
-
/**
|
|
1080
|
-
* Change due date feature flag
|
|
1081
|
-
*/
|
|
1082
|
-
change_due_date?: boolean;
|
|
1083
|
-
/**
|
|
1084
|
-
* Enable or disable the new design for the portal
|
|
1085
|
-
*/
|
|
1086
|
-
new_design?: boolean;
|
|
1087
|
-
/**
|
|
1088
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
1089
|
-
*/
|
|
1090
|
-
mcp_enabled?: boolean;
|
|
1091
|
-
/**
|
|
1092
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1093
|
-
*/
|
|
1094
|
-
mcp_grant_version?: number;
|
|
1095
|
-
};
|
|
1067
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
1096
1068
|
/**
|
|
1097
1069
|
* Access token for the portal
|
|
1098
1070
|
*/
|
|
@@ -1632,35 +1604,7 @@ declare namespace Components {
|
|
|
1632
1604
|
* false
|
|
1633
1605
|
*/
|
|
1634
1606
|
user_account_self_management?: boolean;
|
|
1635
|
-
|
|
1636
|
-
* Feature settings for the portal
|
|
1637
|
-
*/
|
|
1638
|
-
feature_settings?: {
|
|
1639
|
-
/**
|
|
1640
|
-
* Start page feature flag
|
|
1641
|
-
*/
|
|
1642
|
-
start_page?: boolean;
|
|
1643
|
-
/**
|
|
1644
|
-
* Billing feature flag
|
|
1645
|
-
*/
|
|
1646
|
-
billing?: boolean;
|
|
1647
|
-
/**
|
|
1648
|
-
* Change due date feature flag
|
|
1649
|
-
*/
|
|
1650
|
-
change_due_date?: boolean;
|
|
1651
|
-
/**
|
|
1652
|
-
* Enable or disable the new design for the portal
|
|
1653
|
-
*/
|
|
1654
|
-
new_design?: boolean;
|
|
1655
|
-
/**
|
|
1656
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
1657
|
-
*/
|
|
1658
|
-
mcp_enabled?: boolean;
|
|
1659
|
-
/**
|
|
1660
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
1661
|
-
*/
|
|
1662
|
-
mcp_grant_version?: number;
|
|
1663
|
-
};
|
|
1607
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
1664
1608
|
/**
|
|
1665
1609
|
* Access token for the portal
|
|
1666
1610
|
*/
|
|
@@ -2228,7 +2172,7 @@ declare namespace Components {
|
|
|
2228
2172
|
trigger_identifiers_check?: boolean;
|
|
2229
2173
|
}
|
|
2230
2174
|
/**
|
|
2231
|
-
* ContactExistsRequest plus the surface the token is requested for.
|
|
2175
|
+
* ContactExistsRequest plus the surface the token is requested for. `registration_identifiers` carries the values of the surface's effective identifiers (keyed by schema, then attribute name): the surface's own `identifiers` when it configures any, otherwise the portal's `registration_identifiers`.
|
|
2232
2176
|
*
|
|
2233
2177
|
*/
|
|
2234
2178
|
export interface ContactIdentifyRequest {
|
|
@@ -3519,6 +3463,15 @@ declare namespace Components {
|
|
|
3519
3463
|
* ]
|
|
3520
3464
|
*/
|
|
3521
3465
|
targets?: string /* uuid */[];
|
|
3466
|
+
/**
|
|
3467
|
+
* The entity must match at least one of these targets. Combined with `targets` (all of which must match) using AND.
|
|
3468
|
+
* example:
|
|
3469
|
+
* [
|
|
3470
|
+
* "3ec28ab5-8598-41ef-9486-b57fca1d5e2a",
|
|
3471
|
+
* "5f2c1e7a-6b0d-4a8e-9c3f-1d2e3f4a5b6c"
|
|
3472
|
+
* ]
|
|
3473
|
+
*/
|
|
3474
|
+
match_any_targets?: string /* uuid */[];
|
|
3522
3475
|
/**
|
|
3523
3476
|
* Optional enrichment data to side-load alongside results under the `includes` response key.
|
|
3524
3477
|
* example:
|
|
@@ -3551,6 +3504,10 @@ declare namespace Components {
|
|
|
3551
3504
|
*/
|
|
3552
3505
|
EntitySlug;
|
|
3553
3506
|
targets?: string /* uuid */[];
|
|
3507
|
+
/**
|
|
3508
|
+
* The entity must match at least one of these targets. Combined with `targets` (all of which must match) using AND.
|
|
3509
|
+
*/
|
|
3510
|
+
match_any_targets?: string /* uuid */[];
|
|
3554
3511
|
/**
|
|
3555
3512
|
* DEPRECATED — client-supplied Handlebars templates. Use `templates_ref` instead so templates are derived server-side from admin-authored portal configuration. Ignored when `templates_ref` is present; rejected once the org has the `portals-reject-client-templates` flag enabled.
|
|
3556
3513
|
*/
|
|
@@ -5216,6 +5173,46 @@ declare namespace Components {
|
|
|
5216
5173
|
slug?: string | null;
|
|
5217
5174
|
rules?: Rule[] | null;
|
|
5218
5175
|
}
|
|
5176
|
+
export interface JourneyContextUsagesRequest {
|
|
5177
|
+
/**
|
|
5178
|
+
* Journey whose context parameters are being looked up
|
|
5179
|
+
*/
|
|
5180
|
+
journey_id: string;
|
|
5181
|
+
/**
|
|
5182
|
+
* Context parameter names (the `paramKey` of each parameter)
|
|
5183
|
+
*/
|
|
5184
|
+
param_keys: string[];
|
|
5185
|
+
/**
|
|
5186
|
+
* Accepted for a uniform adapter request shape; portals reference parameters by name only, so this is ignored.
|
|
5187
|
+
*/
|
|
5188
|
+
param_ids?: string[];
|
|
5189
|
+
}
|
|
5190
|
+
export interface JourneyContextUsagesResponse {
|
|
5191
|
+
/**
|
|
5192
|
+
* partial when the row cap, the soft deadline or a failed portal truncated the result
|
|
5193
|
+
*/
|
|
5194
|
+
status: "ok" | "partial";
|
|
5195
|
+
/**
|
|
5196
|
+
* Portals examined
|
|
5197
|
+
*/
|
|
5198
|
+
scanned: number;
|
|
5199
|
+
usages: {
|
|
5200
|
+
kind: "portal-config" | "portal-block" | "portal-widget";
|
|
5201
|
+
resource: {
|
|
5202
|
+
type: "portal";
|
|
5203
|
+
id: string;
|
|
5204
|
+
name?: string;
|
|
5205
|
+
};
|
|
5206
|
+
location: {
|
|
5207
|
+
[name: string]: any;
|
|
5208
|
+
};
|
|
5209
|
+
matched_as: {
|
|
5210
|
+
dialect: "name";
|
|
5211
|
+
token: string;
|
|
5212
|
+
at?: string;
|
|
5213
|
+
};
|
|
5214
|
+
}[];
|
|
5215
|
+
}
|
|
5219
5216
|
export interface JuiceSettings {
|
|
5220
5217
|
/**
|
|
5221
5218
|
* Whether the org is in dummy mode
|
|
@@ -5643,6 +5640,27 @@ declare namespace Components {
|
|
|
5643
5640
|
*/
|
|
5644
5641
|
client_secret?: string;
|
|
5645
5642
|
}
|
|
5643
|
+
export interface NewDesignMigrationResult {
|
|
5644
|
+
org_id?: string;
|
|
5645
|
+
portal_id?: string;
|
|
5646
|
+
origin?: string;
|
|
5647
|
+
name?: string;
|
|
5648
|
+
is_v3_item?: boolean;
|
|
5649
|
+
dry_run?: boolean;
|
|
5650
|
+
/**
|
|
5651
|
+
* True when the migration was written (false for dry_run)
|
|
5652
|
+
*/
|
|
5653
|
+
migrated?: boolean;
|
|
5654
|
+
summary?: {
|
|
5655
|
+
[name: string]: any;
|
|
5656
|
+
};
|
|
5657
|
+
/**
|
|
5658
|
+
* Stored feature_settings and pages before the migration, for rollback
|
|
5659
|
+
*/
|
|
5660
|
+
before?: {
|
|
5661
|
+
[name: string]: any;
|
|
5662
|
+
};
|
|
5663
|
+
}
|
|
5646
5664
|
export interface NotificationTriggerConfig {
|
|
5647
5665
|
/**
|
|
5648
5666
|
* The 360 event that fires this notification trigger.
|
|
@@ -6448,35 +6466,7 @@ declare namespace Components {
|
|
|
6448
6466
|
* false
|
|
6449
6467
|
*/
|
|
6450
6468
|
user_account_self_management?: boolean;
|
|
6451
|
-
|
|
6452
|
-
* Feature settings for the portal
|
|
6453
|
-
*/
|
|
6454
|
-
feature_settings?: {
|
|
6455
|
-
/**
|
|
6456
|
-
* Start page feature flag
|
|
6457
|
-
*/
|
|
6458
|
-
start_page?: boolean;
|
|
6459
|
-
/**
|
|
6460
|
-
* Billing feature flag
|
|
6461
|
-
*/
|
|
6462
|
-
billing?: boolean;
|
|
6463
|
-
/**
|
|
6464
|
-
* Change due date feature flag
|
|
6465
|
-
*/
|
|
6466
|
-
change_due_date?: boolean;
|
|
6467
|
-
/**
|
|
6468
|
-
* Enable or disable the new design for the portal
|
|
6469
|
-
*/
|
|
6470
|
-
new_design?: boolean;
|
|
6471
|
-
/**
|
|
6472
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
6473
|
-
*/
|
|
6474
|
-
mcp_enabled?: boolean;
|
|
6475
|
-
/**
|
|
6476
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
6477
|
-
*/
|
|
6478
|
-
mcp_grant_version?: number;
|
|
6479
|
-
};
|
|
6469
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
6480
6470
|
/**
|
|
6481
6471
|
* Access token for the portal
|
|
6482
6472
|
*/
|
|
@@ -6985,6 +6975,123 @@ declare namespace Components {
|
|
|
6985
6975
|
grants?: Grant[];
|
|
6986
6976
|
identity_providers?: ProviderPublicConfig[];
|
|
6987
6977
|
}
|
|
6978
|
+
/**
|
|
6979
|
+
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
6980
|
+
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
6981
|
+
* identity providers and certificate details are left out; read them per portal with
|
|
6982
|
+
* `getPortalConfigV3`.
|
|
6983
|
+
*
|
|
6984
|
+
*/
|
|
6985
|
+
export interface PortalConfigSummaryV3 {
|
|
6986
|
+
portal_id?: /**
|
|
6987
|
+
* ID of the portal
|
|
6988
|
+
* example:
|
|
6989
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
6990
|
+
*/
|
|
6991
|
+
PortalId;
|
|
6992
|
+
/**
|
|
6993
|
+
* ID of the organization
|
|
6994
|
+
* example:
|
|
6995
|
+
* 12345
|
|
6996
|
+
*/
|
|
6997
|
+
organization_id?: string;
|
|
6998
|
+
origin?: /* Origin of the portal */ Origin;
|
|
6999
|
+
/**
|
|
7000
|
+
* Name of the portal
|
|
7001
|
+
*/
|
|
7002
|
+
name?: string;
|
|
7003
|
+
/**
|
|
7004
|
+
* Whether the portal is enabled
|
|
7005
|
+
*/
|
|
7006
|
+
enabled?: boolean;
|
|
7007
|
+
/**
|
|
7008
|
+
* Custom domain of the portal
|
|
7009
|
+
*/
|
|
7010
|
+
domain?: string;
|
|
7011
|
+
/**
|
|
7012
|
+
* epilot-hosted domain of the portal
|
|
7013
|
+
*/
|
|
7014
|
+
epilot_domain?: string;
|
|
7015
|
+
is_epilot_domain?: boolean;
|
|
7016
|
+
/**
|
|
7017
|
+
* Status of the custom domain setup, when a custom domain is configured
|
|
7018
|
+
*/
|
|
7019
|
+
dnsStatus?: "CONFIGURING" | "PENDING" | "SUCCEED" | "EXPIRED" | "NEW_CERT_IN_PROGRESS";
|
|
7020
|
+
design_id?: /**
|
|
7021
|
+
* Entity ID
|
|
7022
|
+
* example:
|
|
7023
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
7024
|
+
*/
|
|
7025
|
+
EntityId /* uuid */;
|
|
7026
|
+
/**
|
|
7027
|
+
* The logo to show for the portal in lists: the `logoImage` of the first page
|
|
7028
|
+
* that sets one. Absent when no page carries a logo; fall back to the design.
|
|
7029
|
+
*
|
|
7030
|
+
*/
|
|
7031
|
+
logo_image?: {
|
|
7032
|
+
/**
|
|
7033
|
+
* Logo for the light theme
|
|
7034
|
+
* example:
|
|
7035
|
+
* https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/logo.png
|
|
7036
|
+
*/
|
|
7037
|
+
url?: string;
|
|
7038
|
+
/**
|
|
7039
|
+
* Logo for the dark theme
|
|
7040
|
+
*/
|
|
7041
|
+
dark_url?: string;
|
|
7042
|
+
};
|
|
7043
|
+
/**
|
|
7044
|
+
* Default 360 user to notify upon an internal notification
|
|
7045
|
+
*/
|
|
7046
|
+
default_user_to_notify?: {
|
|
7047
|
+
/**
|
|
7048
|
+
* Default admin users for pending user notification to notify
|
|
7049
|
+
*/
|
|
7050
|
+
onPendingUser?: AdminUser[];
|
|
7051
|
+
};
|
|
7052
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7053
|
+
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
7054
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
|
|
7055
|
+
block_registration_if_portal_user_exists?: boolean;
|
|
7056
|
+
/**
|
|
7057
|
+
* Entity type used as the primary identifier for self-registration
|
|
7058
|
+
*/
|
|
7059
|
+
self_registration_entity?: "contact" | "account";
|
|
7060
|
+
/**
|
|
7061
|
+
* Enable or disable user account self management
|
|
7062
|
+
*/
|
|
7063
|
+
user_account_self_management?: boolean;
|
|
7064
|
+
/**
|
|
7065
|
+
* Identifiers to identify a contact of a portal user during the registration.
|
|
7066
|
+
*/
|
|
7067
|
+
registration_identifiers?: ContractIdentifier[];
|
|
7068
|
+
/**
|
|
7069
|
+
* Surfaces this portal's data is reached from besides the portal UI itself.
|
|
7070
|
+
*/
|
|
7071
|
+
surfaces?: /**
|
|
7072
|
+
* One surface a portal's data is reached from (see `surfaces` on the portal config).
|
|
7073
|
+
*
|
|
7074
|
+
* A surface names how callers authenticate on it and what they may reach once they
|
|
7075
|
+
* have. Data access is always a subset of the portal's own: a schema not in
|
|
7076
|
+
* `allowed_portal_entities` cannot be opened up by a surface, and the portal's
|
|
7077
|
+
* contact-relation rules still apply underneath the surface's own.
|
|
7078
|
+
*
|
|
7079
|
+
* Tokens minted for a surface (currently: contact identification tokens for
|
|
7080
|
+
* `registration_identifiers` surfaces) carry the surface id. The surface's data
|
|
7081
|
+
* access is resolved from the portal config on every request, not baked into the
|
|
7082
|
+
* token, so tightening a surface applies to tokens already in circulation.
|
|
7083
|
+
*
|
|
7084
|
+
*/
|
|
7085
|
+
PortalSurface[];
|
|
7086
|
+
is_dummy?: boolean;
|
|
7087
|
+
is_v3_item?: boolean;
|
|
7088
|
+
/**
|
|
7089
|
+
* ID of the currently published revision, if the portal has been published
|
|
7090
|
+
*/
|
|
7091
|
+
published_revision_id?: string;
|
|
7092
|
+
_created_at?: string; // date-time
|
|
7093
|
+
_updated_at?: string; // date-time
|
|
7094
|
+
}
|
|
6988
7095
|
export interface PortalConfigV3 {
|
|
6989
7096
|
/**
|
|
6990
7097
|
* Journey actions allowed on an entity by a portal user
|
|
@@ -7109,35 +7216,7 @@ declare namespace Components {
|
|
|
7109
7216
|
* false
|
|
7110
7217
|
*/
|
|
7111
7218
|
user_account_self_management?: boolean;
|
|
7112
|
-
|
|
7113
|
-
* Feature settings for the portal
|
|
7114
|
-
*/
|
|
7115
|
-
feature_settings?: {
|
|
7116
|
-
/**
|
|
7117
|
-
* Start page feature flag
|
|
7118
|
-
*/
|
|
7119
|
-
start_page?: boolean;
|
|
7120
|
-
/**
|
|
7121
|
-
* Billing feature flag
|
|
7122
|
-
*/
|
|
7123
|
-
billing?: boolean;
|
|
7124
|
-
/**
|
|
7125
|
-
* Change due date feature flag
|
|
7126
|
-
*/
|
|
7127
|
-
change_due_date?: boolean;
|
|
7128
|
-
/**
|
|
7129
|
-
* Enable or disable the new design for the portal
|
|
7130
|
-
*/
|
|
7131
|
-
new_design?: boolean;
|
|
7132
|
-
/**
|
|
7133
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
7134
|
-
*/
|
|
7135
|
-
mcp_enabled?: boolean;
|
|
7136
|
-
/**
|
|
7137
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7138
|
-
*/
|
|
7139
|
-
mcp_grant_version?: number;
|
|
7140
|
-
};
|
|
7219
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7141
7220
|
/**
|
|
7142
7221
|
* Access token for the portal
|
|
7143
7222
|
*/
|
|
@@ -7686,12 +7765,77 @@ declare namespace Components {
|
|
|
7686
7765
|
};
|
|
7687
7766
|
};
|
|
7688
7767
|
}
|
|
7768
|
+
/**
|
|
7769
|
+
* Portal-facing overrides of a stage description, configured per portal
|
|
7770
|
+
* audience in the Flows Hub. Served unresolved for the same reason as
|
|
7771
|
+
* `PortalNameOverrides`; a block falls back to `description` when its
|
|
7772
|
+
* audience's key is absent. The values are rich text, like `description`
|
|
7773
|
+
* itself.
|
|
7774
|
+
*
|
|
7775
|
+
*/
|
|
7776
|
+
export interface PortalDescriptionOverrides {
|
|
7777
|
+
/**
|
|
7778
|
+
* Description shown in the End Customer Portal
|
|
7779
|
+
*/
|
|
7780
|
+
ecp?: string;
|
|
7781
|
+
/**
|
|
7782
|
+
* Description shown in the Installer Portal
|
|
7783
|
+
*/
|
|
7784
|
+
installer?: string;
|
|
7785
|
+
}
|
|
7786
|
+
/**
|
|
7787
|
+
* Feature settings for the portal
|
|
7788
|
+
*/
|
|
7789
|
+
export interface PortalFeatureSettings {
|
|
7790
|
+
/**
|
|
7791
|
+
* Start page feature flag
|
|
7792
|
+
*/
|
|
7793
|
+
start_page?: boolean;
|
|
7794
|
+
/**
|
|
7795
|
+
* Billing feature flag
|
|
7796
|
+
*/
|
|
7797
|
+
billing?: boolean;
|
|
7798
|
+
/**
|
|
7799
|
+
* Change due date feature flag
|
|
7800
|
+
*/
|
|
7801
|
+
change_due_date?: boolean;
|
|
7802
|
+
/**
|
|
7803
|
+
* Enable or disable the new design for the portal
|
|
7804
|
+
*/
|
|
7805
|
+
new_design?: boolean;
|
|
7806
|
+
/**
|
|
7807
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
7808
|
+
*/
|
|
7809
|
+
mcp_enabled?: boolean;
|
|
7810
|
+
/**
|
|
7811
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7812
|
+
*/
|
|
7813
|
+
mcp_grant_version?: number;
|
|
7814
|
+
}
|
|
7689
7815
|
/**
|
|
7690
7816
|
* ID of the portal
|
|
7691
7817
|
* example:
|
|
7692
7818
|
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7693
7819
|
*/
|
|
7694
7820
|
export type PortalId = string;
|
|
7821
|
+
/**
|
|
7822
|
+
* Portal-facing overrides of a flow or stage title, configured per portal
|
|
7823
|
+
* audience in the Flows Hub. Served unresolved because this endpoint asks
|
|
7824
|
+
* the Workflows API for audience `all` — one cached response feeds blocks
|
|
7825
|
+
* of both audiences, so each block picks its own override and falls back
|
|
7826
|
+
* to `name` when the key is absent.
|
|
7827
|
+
*
|
|
7828
|
+
*/
|
|
7829
|
+
export interface PortalNameOverrides {
|
|
7830
|
+
/**
|
|
7831
|
+
* Title shown in the End Customer Portal
|
|
7832
|
+
*/
|
|
7833
|
+
ecp?: string;
|
|
7834
|
+
/**
|
|
7835
|
+
* Title shown in the Installer Portal
|
|
7836
|
+
*/
|
|
7837
|
+
installer?: string;
|
|
7838
|
+
}
|
|
7695
7839
|
/**
|
|
7696
7840
|
* A 360 notification addressed to a portal user.
|
|
7697
7841
|
*/
|
|
@@ -8018,35 +8162,7 @@ declare namespace Components {
|
|
|
8018
8162
|
* false
|
|
8019
8163
|
*/
|
|
8020
8164
|
user_account_self_management?: boolean;
|
|
8021
|
-
|
|
8022
|
-
* Feature settings for the portal
|
|
8023
|
-
*/
|
|
8024
|
-
feature_settings?: {
|
|
8025
|
-
/**
|
|
8026
|
-
* Start page feature flag
|
|
8027
|
-
*/
|
|
8028
|
-
start_page?: boolean;
|
|
8029
|
-
/**
|
|
8030
|
-
* Billing feature flag
|
|
8031
|
-
*/
|
|
8032
|
-
billing?: boolean;
|
|
8033
|
-
/**
|
|
8034
|
-
* Change due date feature flag
|
|
8035
|
-
*/
|
|
8036
|
-
change_due_date?: boolean;
|
|
8037
|
-
/**
|
|
8038
|
-
* Enable or disable the new design for the portal
|
|
8039
|
-
*/
|
|
8040
|
-
new_design?: boolean;
|
|
8041
|
-
/**
|
|
8042
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
8043
|
-
*/
|
|
8044
|
-
mcp_enabled?: boolean;
|
|
8045
|
-
/**
|
|
8046
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
8047
|
-
*/
|
|
8048
|
-
mcp_grant_version?: number;
|
|
8049
|
-
};
|
|
8165
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
8050
8166
|
/**
|
|
8051
8167
|
* Access token for the portal
|
|
8052
8168
|
*/
|
|
@@ -8572,10 +8688,11 @@ declare namespace Components {
|
|
|
8572
8688
|
* How a caller on this surface proves who they are.
|
|
8573
8689
|
*
|
|
8574
8690
|
* - `login`: a logged-in portal user token (the portal's own authentication).
|
|
8575
|
-
* - `registration_identifiers`: the caller supplies the
|
|
8576
|
-
*
|
|
8577
|
-
*
|
|
8578
|
-
*
|
|
8691
|
+
* - `registration_identifiers`: the caller supplies the values of the surface's
|
|
8692
|
+
* identifiers (its own `identifiers`, or the portal's `registration_identifiers`
|
|
8693
|
+
* when it sets none) to `identifyContact` and receives a short-lived contact
|
|
8694
|
+
* identification token. Anyone who knows or guesses those values can use this
|
|
8695
|
+
* surface, so its data access should be as narrow as the use case allows.
|
|
8579
8696
|
*
|
|
8580
8697
|
* `anonymous` (no proof of identity at all) is planned and not accepted yet.
|
|
8581
8698
|
*
|
|
@@ -8585,6 +8702,30 @@ declare namespace Components {
|
|
|
8585
8702
|
* Lifetime of tokens minted for this surface. Only used with `registration_identifiers`.
|
|
8586
8703
|
*/
|
|
8587
8704
|
token_ttl_seconds?: number; // int32
|
|
8705
|
+
/**
|
|
8706
|
+
* Identifier attributes a caller must supply on this surface to be identified. Only
|
|
8707
|
+
* used with `authentication: registration_identifiers`.
|
|
8708
|
+
*
|
|
8709
|
+
* Omitted or empty means the surface uses the portal's `registration_identifiers`.
|
|
8710
|
+
* When set, these replace the portal's `registration_identifiers` on this surface
|
|
8711
|
+
* only: `identifyContact` requires a value for each of them (400 listing the missing
|
|
8712
|
+
* ones otherwise), runs the contact lookup and the `registrationIdentifiersCheck`
|
|
8713
|
+
* hook on them, and refuses to issue tokens (403) unless there are at least two.
|
|
8714
|
+
* Entries without `name` or `schema` are ignored.
|
|
8715
|
+
*
|
|
8716
|
+
* example:
|
|
8717
|
+
* [
|
|
8718
|
+
* {
|
|
8719
|
+
* "name": "customer_number",
|
|
8720
|
+
* "schema": "contact"
|
|
8721
|
+
* },
|
|
8722
|
+
* {
|
|
8723
|
+
* "name": "meter_number",
|
|
8724
|
+
* "schema": "meter"
|
|
8725
|
+
* }
|
|
8726
|
+
* ]
|
|
8727
|
+
*/
|
|
8728
|
+
identifiers?: RegistrationIdentifier[];
|
|
8588
8729
|
data_access?: /* What a caller on a surface may reach. Every property is optional; omitting all of them is the portal's default scope. */ PortalSurfaceDataAccess;
|
|
8589
8730
|
}
|
|
8590
8731
|
/**
|
|
@@ -8639,6 +8780,10 @@ declare namespace Components {
|
|
|
8639
8780
|
id?: string;
|
|
8640
8781
|
journeyId?: string;
|
|
8641
8782
|
name?: string;
|
|
8783
|
+
/**
|
|
8784
|
+
* Portal-facing label configured in the Flows Hub that replaces the portal's default "Start now" button for this journey.
|
|
8785
|
+
*/
|
|
8786
|
+
portal_button_label?: string;
|
|
8642
8787
|
complete_task_automatically?: boolean;
|
|
8643
8788
|
};
|
|
8644
8789
|
}
|
|
@@ -8778,6 +8923,15 @@ declare namespace Components {
|
|
|
8778
8923
|
*
|
|
8779
8924
|
*/
|
|
8780
8925
|
PortalWorkflowStage[];
|
|
8926
|
+
portal_titles?: /**
|
|
8927
|
+
* Portal-facing overrides of a flow or stage title, configured per portal
|
|
8928
|
+
* audience in the Flows Hub. Served unresolved because this endpoint asks
|
|
8929
|
+
* the Workflows API for audience `all` — one cached response feeds blocks
|
|
8930
|
+
* of both audiences, so each block picks its own override and falls back
|
|
8931
|
+
* to `name` when the key is absent.
|
|
8932
|
+
*
|
|
8933
|
+
*/
|
|
8934
|
+
PortalNameOverrides;
|
|
8781
8935
|
}
|
|
8782
8936
|
/**
|
|
8783
8937
|
* A customer-facing stage of a flow execution, with a progress status derived
|
|
@@ -8803,15 +8957,34 @@ declare namespace Components {
|
|
|
8803
8957
|
* - COMPLETED: every task of the stage is done, and the flow has moved past it
|
|
8804
8958
|
* - IN_PROGRESS: the flow's current work is inside this stage
|
|
8805
8959
|
* - UPCOMING: the flow has not reached this stage yet
|
|
8960
|
+
* - NOT_REACHED: the flow finished (DONE or CLOSED) before reaching this stage — a run may legitimately end at any stage
|
|
8806
8961
|
*
|
|
8807
8962
|
*/
|
|
8808
|
-
status: "COMPLETED" | "IN_PROGRESS" | "UPCOMING";
|
|
8963
|
+
status: "COMPLETED" | "IN_PROGRESS" | "UPCOMING" | "NOT_REACHED";
|
|
8809
8964
|
/**
|
|
8810
8965
|
* Latest completion timestamp among the stage's tasks; set only when the
|
|
8811
8966
|
* stage is COMPLETED and at least one of its tasks recorded one
|
|
8812
8967
|
*
|
|
8813
8968
|
*/
|
|
8814
8969
|
completed_at?: string;
|
|
8970
|
+
portal_names?: /**
|
|
8971
|
+
* Portal-facing overrides of a flow or stage title, configured per portal
|
|
8972
|
+
* audience in the Flows Hub. Served unresolved because this endpoint asks
|
|
8973
|
+
* the Workflows API for audience `all` — one cached response feeds blocks
|
|
8974
|
+
* of both audiences, so each block picks its own override and falls back
|
|
8975
|
+
* to `name` when the key is absent.
|
|
8976
|
+
*
|
|
8977
|
+
*/
|
|
8978
|
+
PortalNameOverrides;
|
|
8979
|
+
portal_descriptions?: /**
|
|
8980
|
+
* Portal-facing overrides of a stage description, configured per portal
|
|
8981
|
+
* audience in the Flows Hub. Served unresolved for the same reason as
|
|
8982
|
+
* `PortalNameOverrides`; a block falls back to `description` when its
|
|
8983
|
+
* audience's key is absent. The values are rich text, like `description`
|
|
8984
|
+
* itself.
|
|
8985
|
+
*
|
|
8986
|
+
*/
|
|
8987
|
+
PortalDescriptionOverrides;
|
|
8815
8988
|
}
|
|
8816
8989
|
/**
|
|
8817
8990
|
* A single portal-visible task of a linearized workflow execution
|
|
@@ -8853,6 +9026,10 @@ declare namespace Components {
|
|
|
8853
9026
|
id?: string;
|
|
8854
9027
|
journeyId?: string;
|
|
8855
9028
|
name?: string;
|
|
9029
|
+
/**
|
|
9030
|
+
* Portal-facing label configured in the Flows Hub that replaces the portal's default "Start now" button for this journey. Blank or absent means the portal keeps its own translated default.
|
|
9031
|
+
*/
|
|
9032
|
+
portal_button_label?: string;
|
|
8856
9033
|
/**
|
|
8857
9034
|
* If true, the task is auto completed when the journey is completed
|
|
8858
9035
|
*/
|
|
@@ -10168,35 +10345,7 @@ declare namespace Components {
|
|
|
10168
10345
|
* false
|
|
10169
10346
|
*/
|
|
10170
10347
|
user_account_self_management?: boolean;
|
|
10171
|
-
|
|
10172
|
-
* Feature settings for the portal
|
|
10173
|
-
*/
|
|
10174
|
-
feature_settings?: {
|
|
10175
|
-
/**
|
|
10176
|
-
* Start page feature flag
|
|
10177
|
-
*/
|
|
10178
|
-
start_page?: boolean;
|
|
10179
|
-
/**
|
|
10180
|
-
* Billing feature flag
|
|
10181
|
-
*/
|
|
10182
|
-
billing?: boolean;
|
|
10183
|
-
/**
|
|
10184
|
-
* Change due date feature flag
|
|
10185
|
-
*/
|
|
10186
|
-
change_due_date?: boolean;
|
|
10187
|
-
/**
|
|
10188
|
-
* Enable or disable the new design for the portal
|
|
10189
|
-
*/
|
|
10190
|
-
new_design?: boolean;
|
|
10191
|
-
/**
|
|
10192
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
10193
|
-
*/
|
|
10194
|
-
mcp_enabled?: boolean;
|
|
10195
|
-
/**
|
|
10196
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
10197
|
-
*/
|
|
10198
|
-
mcp_grant_version?: number;
|
|
10199
|
-
};
|
|
10348
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
10200
10349
|
/**
|
|
10201
10350
|
* Access token for the portal
|
|
10202
10351
|
*/
|
|
@@ -10797,35 +10946,7 @@ declare namespace Components {
|
|
|
10797
10946
|
* false
|
|
10798
10947
|
*/
|
|
10799
10948
|
user_account_self_management?: boolean;
|
|
10800
|
-
|
|
10801
|
-
* Feature settings for the portal
|
|
10802
|
-
*/
|
|
10803
|
-
feature_settings?: {
|
|
10804
|
-
/**
|
|
10805
|
-
* Start page feature flag
|
|
10806
|
-
*/
|
|
10807
|
-
start_page?: boolean;
|
|
10808
|
-
/**
|
|
10809
|
-
* Billing feature flag
|
|
10810
|
-
*/
|
|
10811
|
-
billing?: boolean;
|
|
10812
|
-
/**
|
|
10813
|
-
* Change due date feature flag
|
|
10814
|
-
*/
|
|
10815
|
-
change_due_date?: boolean;
|
|
10816
|
-
/**
|
|
10817
|
-
* Enable or disable the new design for the portal
|
|
10818
|
-
*/
|
|
10819
|
-
new_design?: boolean;
|
|
10820
|
-
/**
|
|
10821
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
10822
|
-
*/
|
|
10823
|
-
mcp_enabled?: boolean;
|
|
10824
|
-
/**
|
|
10825
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
10826
|
-
*/
|
|
10827
|
-
mcp_grant_version?: number;
|
|
10828
|
-
};
|
|
10949
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
10829
10950
|
/**
|
|
10830
10951
|
* Access token for the portal
|
|
10831
10952
|
*/
|
|
@@ -14839,35 +14960,7 @@ declare namespace Paths {
|
|
|
14839
14960
|
* false
|
|
14840
14961
|
*/
|
|
14841
14962
|
user_account_self_management?: boolean;
|
|
14842
|
-
|
|
14843
|
-
* Feature settings for the portal
|
|
14844
|
-
*/
|
|
14845
|
-
feature_settings?: {
|
|
14846
|
-
/**
|
|
14847
|
-
* Start page feature flag
|
|
14848
|
-
*/
|
|
14849
|
-
start_page?: boolean;
|
|
14850
|
-
/**
|
|
14851
|
-
* Billing feature flag
|
|
14852
|
-
*/
|
|
14853
|
-
billing?: boolean;
|
|
14854
|
-
/**
|
|
14855
|
-
* Change due date feature flag
|
|
14856
|
-
*/
|
|
14857
|
-
change_due_date?: boolean;
|
|
14858
|
-
/**
|
|
14859
|
-
* Enable or disable the new design for the portal
|
|
14860
|
-
*/
|
|
14861
|
-
new_design?: boolean;
|
|
14862
|
-
/**
|
|
14863
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
14864
|
-
*/
|
|
14865
|
-
mcp_enabled?: boolean;
|
|
14866
|
-
/**
|
|
14867
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
14868
|
-
*/
|
|
14869
|
-
mcp_grant_version?: number;
|
|
14870
|
-
};
|
|
14963
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
14871
14964
|
/**
|
|
14872
14965
|
* Access token for the portal
|
|
14873
14966
|
*/
|
|
@@ -15498,35 +15591,7 @@ declare namespace Paths {
|
|
|
15498
15591
|
* false
|
|
15499
15592
|
*/
|
|
15500
15593
|
user_account_self_management?: boolean;
|
|
15501
|
-
|
|
15502
|
-
* Feature settings for the portal
|
|
15503
|
-
*/
|
|
15504
|
-
feature_settings?: {
|
|
15505
|
-
/**
|
|
15506
|
-
* Start page feature flag
|
|
15507
|
-
*/
|
|
15508
|
-
start_page?: boolean;
|
|
15509
|
-
/**
|
|
15510
|
-
* Billing feature flag
|
|
15511
|
-
*/
|
|
15512
|
-
billing?: boolean;
|
|
15513
|
-
/**
|
|
15514
|
-
* Change due date feature flag
|
|
15515
|
-
*/
|
|
15516
|
-
change_due_date?: boolean;
|
|
15517
|
-
/**
|
|
15518
|
-
* Enable or disable the new design for the portal
|
|
15519
|
-
*/
|
|
15520
|
-
new_design?: boolean;
|
|
15521
|
-
/**
|
|
15522
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
15523
|
-
*/
|
|
15524
|
-
mcp_enabled?: boolean;
|
|
15525
|
-
/**
|
|
15526
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
15527
|
-
*/
|
|
15528
|
-
mcp_grant_version?: number;
|
|
15529
|
-
};
|
|
15594
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
15530
15595
|
/**
|
|
15531
15596
|
* Access token for the portal
|
|
15532
15597
|
*/
|
|
@@ -16711,35 +16776,7 @@ declare namespace Paths {
|
|
|
16711
16776
|
* false
|
|
16712
16777
|
*/
|
|
16713
16778
|
user_account_self_management?: boolean;
|
|
16714
|
-
|
|
16715
|
-
* Feature settings for the portal
|
|
16716
|
-
*/
|
|
16717
|
-
feature_settings?: {
|
|
16718
|
-
/**
|
|
16719
|
-
* Start page feature flag
|
|
16720
|
-
*/
|
|
16721
|
-
start_page?: boolean;
|
|
16722
|
-
/**
|
|
16723
|
-
* Billing feature flag
|
|
16724
|
-
*/
|
|
16725
|
-
billing?: boolean;
|
|
16726
|
-
/**
|
|
16727
|
-
* Change due date feature flag
|
|
16728
|
-
*/
|
|
16729
|
-
change_due_date?: boolean;
|
|
16730
|
-
/**
|
|
16731
|
-
* Enable or disable the new design for the portal
|
|
16732
|
-
*/
|
|
16733
|
-
new_design?: boolean;
|
|
16734
|
-
/**
|
|
16735
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
16736
|
-
*/
|
|
16737
|
-
mcp_enabled?: boolean;
|
|
16738
|
-
/**
|
|
16739
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
16740
|
-
*/
|
|
16741
|
-
mcp_grant_version?: number;
|
|
16742
|
-
};
|
|
16779
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
16743
16780
|
/**
|
|
16744
16781
|
* Access token for the portal
|
|
16745
16782
|
*/
|
|
@@ -17971,7 +18008,7 @@ declare namespace Paths {
|
|
|
17971
18008
|
domain?: Parameters.Domain;
|
|
17972
18009
|
}
|
|
17973
18010
|
export type RequestBody = /**
|
|
17974
|
-
* ContactExistsRequest plus the surface the token is requested for.
|
|
18011
|
+
* ContactExistsRequest plus the surface the token is requested for. `registration_identifiers` carries the values of the surface's effective identifiers (keyed by schema, then attribute name): the surface's own `identifiers` when it configures any, otherwise the portal's `registration_identifiers`.
|
|
17975
18012
|
*
|
|
17976
18013
|
*/
|
|
17977
18014
|
Components.Schemas.ContactIdentifyRequest;
|
|
@@ -18095,6 +18132,23 @@ declare namespace Paths {
|
|
|
18095
18132
|
export type $500 = Components.Responses.InternalServerError;
|
|
18096
18133
|
}
|
|
18097
18134
|
}
|
|
18135
|
+
namespace ListPortalConfigSummaries {
|
|
18136
|
+
namespace Responses {
|
|
18137
|
+
export interface $200 {
|
|
18138
|
+
data?: /**
|
|
18139
|
+
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
18140
|
+
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
18141
|
+
* identity providers and certificate details are left out; read them per portal with
|
|
18142
|
+
* `getPortalConfigV3`.
|
|
18143
|
+
*
|
|
18144
|
+
*/
|
|
18145
|
+
Components.Schemas.PortalConfigSummaryV3[];
|
|
18146
|
+
}
|
|
18147
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
18148
|
+
export type $403 = Components.Responses.Forbidden;
|
|
18149
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
18150
|
+
}
|
|
18151
|
+
}
|
|
18098
18152
|
namespace ListPortalNotifications {
|
|
18099
18153
|
namespace Parameters {
|
|
18100
18154
|
export type Cursor = string;
|
|
@@ -20421,15 +20475,24 @@ interface OperationMethods {
|
|
|
20421
20475
|
/**
|
|
20422
20476
|
* identifyContact - identifyContact
|
|
20423
20477
|
*
|
|
20424
|
-
* Identify a contact by the
|
|
20425
|
-
*
|
|
20478
|
+
* Identify a contact by the surface's identifiers and, on a match, issue a short-lived
|
|
20479
|
+
* bearer token that acts as that contact.
|
|
20426
20480
|
*
|
|
20427
|
-
*
|
|
20481
|
+
* The identifiers checked are the surface's own `identifiers` when it configures any,
|
|
20482
|
+
* otherwise the portal's `registration_identifiers`. Their values are sent in the
|
|
20483
|
+
* `registration_identifiers` request property. Resolution is otherwise identical to
|
|
20484
|
+
* `checkContactExistsV3`: the same lookup, `registrationIdentifiersCheck` hook and
|
|
20485
|
+
* TIMEOUT semantics, run on the surface's identifiers. The token does not grant a portal
|
|
20428
20486
|
* session; it is accepted only on the operations listed in `allowed_operations`, and
|
|
20429
20487
|
* expires at `expires_at`. Requires `surface_id` to name a surface of the portal whose
|
|
20430
20488
|
* `authentication` is `registration_identifiers`; returns 403 otherwise. The token is
|
|
20431
20489
|
* confined to that surface's data access. Requests may be rate limited (429).
|
|
20432
20490
|
*
|
|
20491
|
+
* No portal session is expected, but the caller must present a public access token
|
|
20492
|
+
* (`token_type: journey` or `token_type: portal`) as the bearer, minted for the same
|
|
20493
|
+
* `org_id`; the request is rejected with 401 otherwise. It binds the call to the journey
|
|
20494
|
+
* or portal it comes from — the token is public, so it proves origin, not identity.
|
|
20495
|
+
*
|
|
20433
20496
|
*/
|
|
20434
20497
|
'identifyContact'(
|
|
20435
20498
|
parameters?: Parameters<Paths.IdentifyContact.QueryParameters> | null,
|
|
@@ -21515,7 +21578,10 @@ interface OperationMethods {
|
|
|
21515
21578
|
/**
|
|
21516
21579
|
* deletePortalConfig - deletePortalConfig
|
|
21517
21580
|
*
|
|
21518
|
-
* Deletes a specific portal configuration by ID
|
|
21581
|
+
* Deletes a specific portal configuration by ID, together with everything the portal owns:
|
|
21582
|
+
* its pages, revisions, email templates and widget configuration. The custom domain network
|
|
21583
|
+
* setup is torn down asynchronously afterwards.
|
|
21584
|
+
*
|
|
21519
21585
|
*/
|
|
21520
21586
|
'deletePortalConfig'(
|
|
21521
21587
|
parameters?: Parameters<Paths.DeletePortalConfig.PathParameters> | null,
|
|
@@ -21592,6 +21658,22 @@ interface OperationMethods {
|
|
|
21592
21658
|
data?: any,
|
|
21593
21659
|
config?: AxiosRequestConfig
|
|
21594
21660
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
21661
|
+
/**
|
|
21662
|
+
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
21663
|
+
*
|
|
21664
|
+
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
21665
|
+
* display and registration fields of each portal config, without pages, email
|
|
21666
|
+
* templates, grants, feature flags, identity providers or certificate details.
|
|
21667
|
+
*
|
|
21668
|
+
* Use it for portal overviews and pickers. Read a single portal with
|
|
21669
|
+
* `getPortalConfigV3` when the full configuration is needed.
|
|
21670
|
+
*
|
|
21671
|
+
*/
|
|
21672
|
+
'listPortalConfigSummaries'(
|
|
21673
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
21674
|
+
data?: any,
|
|
21675
|
+
config?: AxiosRequestConfig
|
|
21676
|
+
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
21595
21677
|
/**
|
|
21596
21678
|
* swapPortalConfig - swapPortalConfig
|
|
21597
21679
|
*
|
|
@@ -22419,15 +22501,24 @@ interface PathsDictionary {
|
|
|
22419
22501
|
/**
|
|
22420
22502
|
* identifyContact - identifyContact
|
|
22421
22503
|
*
|
|
22422
|
-
* Identify a contact by the
|
|
22423
|
-
*
|
|
22504
|
+
* Identify a contact by the surface's identifiers and, on a match, issue a short-lived
|
|
22505
|
+
* bearer token that acts as that contact.
|
|
22424
22506
|
*
|
|
22425
|
-
*
|
|
22507
|
+
* The identifiers checked are the surface's own `identifiers` when it configures any,
|
|
22508
|
+
* otherwise the portal's `registration_identifiers`. Their values are sent in the
|
|
22509
|
+
* `registration_identifiers` request property. Resolution is otherwise identical to
|
|
22510
|
+
* `checkContactExistsV3`: the same lookup, `registrationIdentifiersCheck` hook and
|
|
22511
|
+
* TIMEOUT semantics, run on the surface's identifiers. The token does not grant a portal
|
|
22426
22512
|
* session; it is accepted only on the operations listed in `allowed_operations`, and
|
|
22427
22513
|
* expires at `expires_at`. Requires `surface_id` to name a surface of the portal whose
|
|
22428
22514
|
* `authentication` is `registration_identifiers`; returns 403 otherwise. The token is
|
|
22429
22515
|
* confined to that surface's data access. Requests may be rate limited (429).
|
|
22430
22516
|
*
|
|
22517
|
+
* No portal session is expected, but the caller must present a public access token
|
|
22518
|
+
* (`token_type: journey` or `token_type: portal`) as the bearer, minted for the same
|
|
22519
|
+
* `org_id`; the request is rejected with 401 otherwise. It binds the call to the journey
|
|
22520
|
+
* or portal it comes from — the token is public, so it proves origin, not identity.
|
|
22521
|
+
*
|
|
22431
22522
|
*/
|
|
22432
22523
|
'post'(
|
|
22433
22524
|
parameters?: Parameters<Paths.IdentifyContact.QueryParameters> | null,
|
|
@@ -23683,7 +23774,10 @@ interface PathsDictionary {
|
|
|
23683
23774
|
/**
|
|
23684
23775
|
* deletePortalConfig - deletePortalConfig
|
|
23685
23776
|
*
|
|
23686
|
-
* Deletes a specific portal configuration by ID
|
|
23777
|
+
* Deletes a specific portal configuration by ID, together with everything the portal owns:
|
|
23778
|
+
* its pages, revisions, email templates and widget configuration. The custom domain network
|
|
23779
|
+
* setup is torn down asynchronously afterwards.
|
|
23780
|
+
*
|
|
23687
23781
|
*/
|
|
23688
23782
|
'delete'(
|
|
23689
23783
|
parameters?: Parameters<Paths.DeletePortalConfig.PathParameters> | null,
|
|
@@ -23769,6 +23863,24 @@ interface PathsDictionary {
|
|
|
23769
23863
|
config?: AxiosRequestConfig
|
|
23770
23864
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
23771
23865
|
}
|
|
23866
|
+
['/v3/portal/configs/summaries']: {
|
|
23867
|
+
/**
|
|
23868
|
+
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
23869
|
+
*
|
|
23870
|
+
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
23871
|
+
* display and registration fields of each portal config, without pages, email
|
|
23872
|
+
* templates, grants, feature flags, identity providers or certificate details.
|
|
23873
|
+
*
|
|
23874
|
+
* Use it for portal overviews and pickers. Read a single portal with
|
|
23875
|
+
* `getPortalConfigV3` when the full configuration is needed.
|
|
23876
|
+
*
|
|
23877
|
+
*/
|
|
23878
|
+
'get'(
|
|
23879
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
23880
|
+
data?: any,
|
|
23881
|
+
config?: AxiosRequestConfig
|
|
23882
|
+
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
23883
|
+
}
|
|
23772
23884
|
['/v3/portal/config/swap']: {
|
|
23773
23885
|
/**
|
|
23774
23886
|
* swapPortalConfig - swapPortalConfig
|
|
@@ -24013,6 +24125,8 @@ type Grant = Components.Schemas.Grant;
|
|
|
24013
24125
|
type IdentifierAttribute = Components.Schemas.IdentifierAttribute;
|
|
24014
24126
|
type InstallmentEvent = Components.Schemas.InstallmentEvent;
|
|
24015
24127
|
type JourneyActions = Components.Schemas.JourneyActions;
|
|
24128
|
+
type JourneyContextUsagesRequest = Components.Schemas.JourneyContextUsagesRequest;
|
|
24129
|
+
type JourneyContextUsagesResponse = Components.Schemas.JourneyContextUsagesResponse;
|
|
24016
24130
|
type JuiceSettings = Components.Schemas.JuiceSettings;
|
|
24017
24131
|
type Meter = Components.Schemas.Meter;
|
|
24018
24132
|
type MeterChartWidget = Components.Schemas.MeterChartWidget;
|
|
@@ -24026,6 +24140,7 @@ type MobileConfig = Components.Schemas.MobileConfig;
|
|
|
24026
24140
|
type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
|
|
24027
24141
|
type MobileOtaConfig = Components.Schemas.MobileOtaConfig;
|
|
24028
24142
|
type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
24143
|
+
type NewDesignMigrationResult = Components.Schemas.NewDesignMigrationResult;
|
|
24029
24144
|
type NotificationTriggerConfig = Components.Schemas.NotificationTriggerConfig;
|
|
24030
24145
|
type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
24031
24146
|
type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
@@ -24039,9 +24154,13 @@ type Page = Components.Schemas.Page;
|
|
|
24039
24154
|
type PageRequest = Components.Schemas.PageRequest;
|
|
24040
24155
|
type PaymentWidget = Components.Schemas.PaymentWidget;
|
|
24041
24156
|
type PortalConfig = Components.Schemas.PortalConfig;
|
|
24157
|
+
type PortalConfigSummaryV3 = Components.Schemas.PortalConfigSummaryV3;
|
|
24042
24158
|
type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
24043
24159
|
type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
24160
|
+
type PortalDescriptionOverrides = Components.Schemas.PortalDescriptionOverrides;
|
|
24161
|
+
type PortalFeatureSettings = Components.Schemas.PortalFeatureSettings;
|
|
24044
24162
|
type PortalId = Components.Schemas.PortalId;
|
|
24163
|
+
type PortalNameOverrides = Components.Schemas.PortalNameOverrides;
|
|
24045
24164
|
type PortalNotification = Components.Schemas.PortalNotification;
|
|
24046
24165
|
type PortalRevision = Components.Schemas.PortalRevision;
|
|
24047
24166
|
type PortalRevisionCreated = Components.Schemas.PortalRevisionCreated;
|
|
@@ -24118,4 +24237,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
|
|
24118
24237
|
type WorkflowExecution = Components.Schemas.WorkflowExecution;
|
|
24119
24238
|
type WorkflowStep = Components.Schemas.WorkflowStep;
|
|
24120
24239
|
|
|
24121
|
-
export { type EntityEditRule as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributes as D, type CommonConfigAttributesV3 as E, type Contact as F, type ContactCountRequest as G, type ContactExistsRequest as H, type ContactIdentifyRequest as I, type ContactIdentifyResponse as J, type ContentWidget as K, type ContextEntities as L, type ContextEntity as M, type Contract as N, type OperationMethods as O, Paths as P, type ContractIdentifier as Q, type CreateSupportRequest as R, type CreateUserRequest as S, type Currency as T, type DataRetrievalItem as U, DeleteEntityFile as V, type Direction as W, type DocumentWidget as X, type DomainSettings as Y, type EmailTemplates as Z, type Entity as _, Components as a, type
|
|
24240
|
+
export { type EntityEditRule as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributes as D, type CommonConfigAttributesV3 as E, type Contact as F, type ContactCountRequest as G, type ContactExistsRequest as H, type ContactIdentifyRequest as I, type ContactIdentifyResponse as J, type ContentWidget as K, type ContextEntities as L, type ContextEntity as M, type Contract as N, type OperationMethods as O, Paths as P, type ContractIdentifier as Q, type CreateSupportRequest as R, type CreateUserRequest as S, type Currency as T, type DataRetrievalItem as U, DeleteEntityFile as V, type Direction as W, type DocumentWidget as X, type DomainSettings as Y, type EmailTemplates as Z, type Entity as _, Components as a, type Order as a$, type EntityFileCount as a0, type EntityGetParams as a1, type EntityId as a2, type EntityItem as a3, type EntityMatchingConfig as a4, type EntityPortalWorkflows as a5, type EntityResponse as a6, type EntityResponseGroupedWithHits as a7, type EntityResponseWithHits as a8, type EntitySearchParams as a9, type File as aA, type FileItem as aB, type FilePreviewResult as aC, type Grant as aD, type IdentifierAttribute as aE, type InstallmentEvent as aF, type JourneyActions as aG, type JourneyContextUsagesRequest as aH, type JourneyContextUsagesResponse as aI, type JuiceSettings as aJ, type Meter as aK, type MeterChartWidget as aL, type MeterReading as aM, type MeterReadingPhoto as aN, type MeterReadingPhotoData as aO, type MeterReadingWidget as aP, type MobileBranding as aQ, type MobileBuildStatus as aR, type MobileConfig as aS, type MobileConfigUpdate as aT, type MobileOtaConfig as aU, type MoblieOIDCConfig as aV, type NewDesignMigrationResult as aW, type NotificationTriggerConfig as aX, type OIDCProviderConfig as aY, type OIDCProviderMetadata as aZ, type Opportunity as a_, type EntitySlug as aa, type EntitySlugConfig as ab, type EntityTemplates as ac, type EntityWidget as ad, type ErrorResp as ae, type Exists as af, type Extension as ag, type ExtensionAuthBlock as ah, type ExtensionConfig as ai, type ExtensionHook as aj, type ExtensionHookChangeEmail as ak, type ExtensionHookChangePassword as al, type ExtensionHookConsumptionDataRetrieval as am, type ExtensionHookContractIdentification as an, type ExtensionHookCostDataRetrieval as ao, type ExtensionHookDataExport as ap, type ExtensionHookDeleteAccount as aq, type ExtensionHookMeterReadingPlausibilityCheck as ar, type ExtensionHookPriceDataRetrieval as as, type ExtensionHookRegistrationIdentifiersCheck as at, type ExtensionHookSelection as au, type ExtensionHookVisualizationMetadata as av, type ExtensionSeamlessLink as aw, type ExternalLink as ax, type ExtraSchemaAttributes as ay, type FailedRuleErrorResp as az, type PathsDictionary as b, SaveEntityFile as b$, type OrganizationSettings as b0, type Origin as b1, type OtaPortal as b2, type OutstandingTask as b3, type Page as b4, type PageRequest as b5, type PaymentWidget as b6, type PortalConfig as b7, type PortalConfigSummaryV3 as b8, type PortalConfigV3 as b9, type ProviderPublicConfigV3 as bA, type ProviderSlug as bB, type PublicAppDetails as bC, type PublicChangeEmailDetails as bD, type PublicChangePasswordDetails as bE, type PublicContractIdentificationDetails as bF, type PublicDataRetrievalHookDetails as bG, type PublicDeleteAccountDetails as bH, type PublicExtensionCapabilities as bI, type PublicExtensionDetails as bJ, type PublicIdentityProvider as bK, type PublicMeterReadingPlausibilityCheckDetails as bL, type PublicSelfManagementExplanation as bM, type PublishResult as bN, type PublishRevisionRequest as bO, type ReadBy as bP, type ReadingStatus as bQ, type Reason as bR, type RegistrationIdentifier as bS, type ReimbursementEvent as bT, type RevisionPage as bU, type RevisionPageRequest as bV, type Rule as bW, type SAMLProviderConfig as bX, type SSOCallbackRequest as bY, type SSOCallbackResponse as bZ, type SSOLoginToken as b_, type PortalDataExportColumn as ba, type PortalDescriptionOverrides as bb, type PortalFeatureSettings as bc, type PortalId as bd, type PortalNameOverrides as be, type PortalNotification as bf, type PortalRevision as bg, type PortalRevisionCreated as bh, type PortalRevisionList as bi, type PortalRevisionRequest as bj, type PortalRevisionSummary as bk, type PortalSurface as bl, type PortalSurfaceDataAccess as bm, type PortalSurfaceEntityAccess as bn, type PortalTaskConfig as bo, type PortalUser as bp, type PortalUserRegistrationStatus as bq, type PortalWidget as br, type PortalWorkflow as bs, type PortalWorkflowStage as bt, type PortalWorkflowTask as bu, type Product as bv, type ProductRecommendationsWidget as bw, type ProviderConfig as bx, type ProviderDisplayName as by, type ProviderPublicConfig as bz, type AccountExistsRequest as c, type SavePortalFile as c0, type Schema as c1, type SearchIncludes as c2, type SecureProxyConfig as c3, type Source as c4, type SupportReportType as c5, type SupportRequestAttachment as c6, type SupportRequestResult as c7, type SwappableConfig as c8, type TariffType as c9, type TeaserWidget as ca, type TemplatesRef as cb, type TriggerPortalFlow as cc, type UpdateOnlyPortalConfigAttributes as cd, type UpsertPortalConfig as ce, type UpsertPortalConfigV3 as cf, UpsertPortalWidget as cg, type UserRequest as ch, type VisualizationDataRange as ci, type VisualizationMetadata as cj, type VisualizationTypeOption as ck, type WidgetAction as cl, type WidgetBase as cm, type WorfklowIdentifier as cn, type WorkflowExecution as co, type WorkflowStep as cp, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdditionalContactAttribute as j, type AdminUser as k, type AllowedFileExtensions as l, type AttributeMappingConfig as m, type AuthConfig as n, type BaseBillingEvent as o, type BaseEntity as p, type BillingAccount as q, type BillingEvent as r, type Block as s, type BlockId as t, type BlockProps as u, type BlockRequest as v, type BlockType as w, type BusinessPartnerItem as x, type CampaignWidget as y, type CleverPvContext as z };
|