@epilot/customer-portal-client 0.46.2 → 0.46.3
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 +6 -0
- package/dist/openapi.d.ts +407 -305
- package/package.json +1 -1
- package/src/openapi-runtime.json +6 -0
- package/src/openapi.json +458 -68
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
|
*/
|
|
@@ -2231,7 +2175,7 @@ declare namespace Components {
|
|
|
2231
2175
|
trigger_identifiers_check?: boolean;
|
|
2232
2176
|
}
|
|
2233
2177
|
/**
|
|
2234
|
-
* ContactExistsRequest plus the surface the token is requested for.
|
|
2178
|
+
* 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`.
|
|
2235
2179
|
*
|
|
2236
2180
|
*/
|
|
2237
2181
|
export interface ContactIdentifyRequest {
|
|
@@ -3522,6 +3466,15 @@ declare namespace Components {
|
|
|
3522
3466
|
* ]
|
|
3523
3467
|
*/
|
|
3524
3468
|
targets?: string /* uuid */[];
|
|
3469
|
+
/**
|
|
3470
|
+
* The entity must match at least one of these targets. Combined with `targets` (all of which must match) using AND.
|
|
3471
|
+
* example:
|
|
3472
|
+
* [
|
|
3473
|
+
* "3ec28ab5-8598-41ef-9486-b57fca1d5e2a",
|
|
3474
|
+
* "5f2c1e7a-6b0d-4a8e-9c3f-1d2e3f4a5b6c"
|
|
3475
|
+
* ]
|
|
3476
|
+
*/
|
|
3477
|
+
match_any_targets?: string /* uuid */[];
|
|
3525
3478
|
/**
|
|
3526
3479
|
* Optional enrichment data to side-load alongside results under the `includes` response key.
|
|
3527
3480
|
* example:
|
|
@@ -3554,6 +3507,10 @@ declare namespace Components {
|
|
|
3554
3507
|
*/
|
|
3555
3508
|
EntitySlug;
|
|
3556
3509
|
targets?: string /* uuid */[];
|
|
3510
|
+
/**
|
|
3511
|
+
* The entity must match at least one of these targets. Combined with `targets` (all of which must match) using AND.
|
|
3512
|
+
*/
|
|
3513
|
+
match_any_targets?: string /* uuid */[];
|
|
3557
3514
|
/**
|
|
3558
3515
|
* 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.
|
|
3559
3516
|
*/
|
|
@@ -5219,6 +5176,46 @@ declare namespace Components {
|
|
|
5219
5176
|
slug?: string | null;
|
|
5220
5177
|
rules?: Rule[] | null;
|
|
5221
5178
|
}
|
|
5179
|
+
export interface JourneyContextUsagesRequest {
|
|
5180
|
+
/**
|
|
5181
|
+
* Journey whose context parameters are being looked up
|
|
5182
|
+
*/
|
|
5183
|
+
journey_id: string;
|
|
5184
|
+
/**
|
|
5185
|
+
* Context parameter names (the `paramKey` of each parameter)
|
|
5186
|
+
*/
|
|
5187
|
+
param_keys: string[];
|
|
5188
|
+
/**
|
|
5189
|
+
* Accepted for a uniform adapter request shape; portals reference parameters by name only, so this is ignored.
|
|
5190
|
+
*/
|
|
5191
|
+
param_ids?: string[];
|
|
5192
|
+
}
|
|
5193
|
+
export interface JourneyContextUsagesResponse {
|
|
5194
|
+
/**
|
|
5195
|
+
* partial when the row cap, the soft deadline or a failed portal truncated the result
|
|
5196
|
+
*/
|
|
5197
|
+
status: "ok" | "partial";
|
|
5198
|
+
/**
|
|
5199
|
+
* Portals examined
|
|
5200
|
+
*/
|
|
5201
|
+
scanned: number;
|
|
5202
|
+
usages: {
|
|
5203
|
+
kind: "portal-config" | "portal-block" | "portal-widget";
|
|
5204
|
+
resource: {
|
|
5205
|
+
type: "portal";
|
|
5206
|
+
id: string;
|
|
5207
|
+
name?: string;
|
|
5208
|
+
};
|
|
5209
|
+
location: {
|
|
5210
|
+
[name: string]: any;
|
|
5211
|
+
};
|
|
5212
|
+
matched_as: {
|
|
5213
|
+
dialect: "name";
|
|
5214
|
+
token: string;
|
|
5215
|
+
at?: string;
|
|
5216
|
+
};
|
|
5217
|
+
}[];
|
|
5218
|
+
}
|
|
5222
5219
|
export interface JuiceSettings {
|
|
5223
5220
|
/**
|
|
5224
5221
|
* Whether the org is in dummy mode
|
|
@@ -5646,6 +5643,27 @@ declare namespace Components {
|
|
|
5646
5643
|
*/
|
|
5647
5644
|
client_secret?: string;
|
|
5648
5645
|
}
|
|
5646
|
+
export interface NewDesignMigrationResult {
|
|
5647
|
+
org_id?: string;
|
|
5648
|
+
portal_id?: string;
|
|
5649
|
+
origin?: string;
|
|
5650
|
+
name?: string;
|
|
5651
|
+
is_v3_item?: boolean;
|
|
5652
|
+
dry_run?: boolean;
|
|
5653
|
+
/**
|
|
5654
|
+
* True when the migration was written (false for dry_run)
|
|
5655
|
+
*/
|
|
5656
|
+
migrated?: boolean;
|
|
5657
|
+
summary?: {
|
|
5658
|
+
[name: string]: any;
|
|
5659
|
+
};
|
|
5660
|
+
/**
|
|
5661
|
+
* Stored feature_settings and pages before the migration, for rollback
|
|
5662
|
+
*/
|
|
5663
|
+
before?: {
|
|
5664
|
+
[name: string]: any;
|
|
5665
|
+
};
|
|
5666
|
+
}
|
|
5649
5667
|
export interface NotificationTriggerConfig {
|
|
5650
5668
|
/**
|
|
5651
5669
|
* The 360 event that fires this notification trigger.
|
|
@@ -6451,35 +6469,7 @@ declare namespace Components {
|
|
|
6451
6469
|
* false
|
|
6452
6470
|
*/
|
|
6453
6471
|
user_account_self_management?: boolean;
|
|
6454
|
-
|
|
6455
|
-
* Feature settings for the portal
|
|
6456
|
-
*/
|
|
6457
|
-
feature_settings?: {
|
|
6458
|
-
/**
|
|
6459
|
-
* Start page feature flag
|
|
6460
|
-
*/
|
|
6461
|
-
start_page?: boolean;
|
|
6462
|
-
/**
|
|
6463
|
-
* Billing feature flag
|
|
6464
|
-
*/
|
|
6465
|
-
billing?: boolean;
|
|
6466
|
-
/**
|
|
6467
|
-
* Change due date feature flag
|
|
6468
|
-
*/
|
|
6469
|
-
change_due_date?: boolean;
|
|
6470
|
-
/**
|
|
6471
|
-
* Enable or disable the new design for the portal
|
|
6472
|
-
*/
|
|
6473
|
-
new_design?: boolean;
|
|
6474
|
-
/**
|
|
6475
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
6476
|
-
*/
|
|
6477
|
-
mcp_enabled?: boolean;
|
|
6478
|
-
/**
|
|
6479
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
6480
|
-
*/
|
|
6481
|
-
mcp_grant_version?: number;
|
|
6482
|
-
};
|
|
6472
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
6483
6473
|
/**
|
|
6484
6474
|
* Access token for the portal
|
|
6485
6475
|
*/
|
|
@@ -6988,6 +6978,106 @@ declare namespace Components {
|
|
|
6988
6978
|
grants?: Grant[];
|
|
6989
6979
|
identity_providers?: ProviderPublicConfig[];
|
|
6990
6980
|
}
|
|
6981
|
+
/**
|
|
6982
|
+
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
6983
|
+
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
6984
|
+
* identity providers and certificate details are left out; read them per portal with
|
|
6985
|
+
* `getPortalConfigV3`.
|
|
6986
|
+
*
|
|
6987
|
+
*/
|
|
6988
|
+
export interface PortalConfigSummaryV3 {
|
|
6989
|
+
portal_id?: /**
|
|
6990
|
+
* ID of the portal
|
|
6991
|
+
* example:
|
|
6992
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
6993
|
+
*/
|
|
6994
|
+
PortalId;
|
|
6995
|
+
/**
|
|
6996
|
+
* ID of the organization
|
|
6997
|
+
* example:
|
|
6998
|
+
* 12345
|
|
6999
|
+
*/
|
|
7000
|
+
organization_id?: string;
|
|
7001
|
+
origin?: /* Origin of the portal */ Origin;
|
|
7002
|
+
/**
|
|
7003
|
+
* Name of the portal
|
|
7004
|
+
*/
|
|
7005
|
+
name?: string;
|
|
7006
|
+
/**
|
|
7007
|
+
* Whether the portal is enabled
|
|
7008
|
+
*/
|
|
7009
|
+
enabled?: boolean;
|
|
7010
|
+
/**
|
|
7011
|
+
* Custom domain of the portal
|
|
7012
|
+
*/
|
|
7013
|
+
domain?: string;
|
|
7014
|
+
/**
|
|
7015
|
+
* epilot-hosted domain of the portal
|
|
7016
|
+
*/
|
|
7017
|
+
epilot_domain?: string;
|
|
7018
|
+
is_epilot_domain?: boolean;
|
|
7019
|
+
/**
|
|
7020
|
+
* Status of the custom domain setup, when a custom domain is configured
|
|
7021
|
+
*/
|
|
7022
|
+
dnsStatus?: "CONFIGURING" | "PENDING" | "SUCCEED" | "EXPIRED" | "NEW_CERT_IN_PROGRESS";
|
|
7023
|
+
design_id?: /**
|
|
7024
|
+
* Entity ID
|
|
7025
|
+
* example:
|
|
7026
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
7027
|
+
*/
|
|
7028
|
+
EntityId /* uuid */;
|
|
7029
|
+
/**
|
|
7030
|
+
* Default 360 user to notify upon an internal notification
|
|
7031
|
+
*/
|
|
7032
|
+
default_user_to_notify?: {
|
|
7033
|
+
/**
|
|
7034
|
+
* Default admin users for pending user notification to notify
|
|
7035
|
+
*/
|
|
7036
|
+
onPendingUser?: AdminUser[];
|
|
7037
|
+
};
|
|
7038
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7039
|
+
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
7040
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
|
|
7041
|
+
block_registration_if_portal_user_exists?: boolean;
|
|
7042
|
+
/**
|
|
7043
|
+
* Entity type used as the primary identifier for self-registration
|
|
7044
|
+
*/
|
|
7045
|
+
self_registration_entity?: "contact" | "account";
|
|
7046
|
+
/**
|
|
7047
|
+
* Enable or disable user account self management
|
|
7048
|
+
*/
|
|
7049
|
+
user_account_self_management?: boolean;
|
|
7050
|
+
/**
|
|
7051
|
+
* Identifiers to identify a contact of a portal user during the registration.
|
|
7052
|
+
*/
|
|
7053
|
+
registration_identifiers?: ContractIdentifier[];
|
|
7054
|
+
/**
|
|
7055
|
+
* Surfaces this portal's data is reached from besides the portal UI itself.
|
|
7056
|
+
*/
|
|
7057
|
+
surfaces?: /**
|
|
7058
|
+
* One surface a portal's data is reached from (see `surfaces` on the portal config).
|
|
7059
|
+
*
|
|
7060
|
+
* A surface names how callers authenticate on it and what they may reach once they
|
|
7061
|
+
* have. Data access is always a subset of the portal's own: a schema not in
|
|
7062
|
+
* `allowed_portal_entities` cannot be opened up by a surface, and the portal's
|
|
7063
|
+
* contact-relation rules still apply underneath the surface's own.
|
|
7064
|
+
*
|
|
7065
|
+
* Tokens minted for a surface (currently: contact identification tokens for
|
|
7066
|
+
* `registration_identifiers` surfaces) carry the surface id. The surface's data
|
|
7067
|
+
* access is resolved from the portal config on every request, not baked into the
|
|
7068
|
+
* token, so tightening a surface applies to tokens already in circulation.
|
|
7069
|
+
*
|
|
7070
|
+
*/
|
|
7071
|
+
PortalSurface[];
|
|
7072
|
+
is_dummy?: boolean;
|
|
7073
|
+
is_v3_item?: boolean;
|
|
7074
|
+
/**
|
|
7075
|
+
* ID of the currently published revision, if the portal has been published
|
|
7076
|
+
*/
|
|
7077
|
+
published_revision_id?: string;
|
|
7078
|
+
_created_at?: string; // date-time
|
|
7079
|
+
_updated_at?: string; // date-time
|
|
7080
|
+
}
|
|
6991
7081
|
export interface PortalConfigV3 {
|
|
6992
7082
|
/**
|
|
6993
7083
|
* Journey actions allowed on an entity by a portal user
|
|
@@ -7112,35 +7202,7 @@ declare namespace Components {
|
|
|
7112
7202
|
* false
|
|
7113
7203
|
*/
|
|
7114
7204
|
user_account_self_management?: boolean;
|
|
7115
|
-
|
|
7116
|
-
* Feature settings for the portal
|
|
7117
|
-
*/
|
|
7118
|
-
feature_settings?: {
|
|
7119
|
-
/**
|
|
7120
|
-
* Start page feature flag
|
|
7121
|
-
*/
|
|
7122
|
-
start_page?: boolean;
|
|
7123
|
-
/**
|
|
7124
|
-
* Billing feature flag
|
|
7125
|
-
*/
|
|
7126
|
-
billing?: boolean;
|
|
7127
|
-
/**
|
|
7128
|
-
* Change due date feature flag
|
|
7129
|
-
*/
|
|
7130
|
-
change_due_date?: boolean;
|
|
7131
|
-
/**
|
|
7132
|
-
* Enable or disable the new design for the portal
|
|
7133
|
-
*/
|
|
7134
|
-
new_design?: boolean;
|
|
7135
|
-
/**
|
|
7136
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
7137
|
-
*/
|
|
7138
|
-
mcp_enabled?: boolean;
|
|
7139
|
-
/**
|
|
7140
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7141
|
-
*/
|
|
7142
|
-
mcp_grant_version?: number;
|
|
7143
|
-
};
|
|
7205
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
7144
7206
|
/**
|
|
7145
7207
|
* Access token for the portal
|
|
7146
7208
|
*/
|
|
@@ -7689,12 +7751,77 @@ declare namespace Components {
|
|
|
7689
7751
|
};
|
|
7690
7752
|
};
|
|
7691
7753
|
}
|
|
7754
|
+
/**
|
|
7755
|
+
* Portal-facing overrides of a stage description, configured per portal
|
|
7756
|
+
* audience in the Flows Hub. Served unresolved for the same reason as
|
|
7757
|
+
* `PortalNameOverrides`; a block falls back to `description` when its
|
|
7758
|
+
* audience's key is absent. The values are rich text, like `description`
|
|
7759
|
+
* itself.
|
|
7760
|
+
*
|
|
7761
|
+
*/
|
|
7762
|
+
export interface PortalDescriptionOverrides {
|
|
7763
|
+
/**
|
|
7764
|
+
* Description shown in the End Customer Portal
|
|
7765
|
+
*/
|
|
7766
|
+
ecp?: string;
|
|
7767
|
+
/**
|
|
7768
|
+
* Description shown in the Installer Portal
|
|
7769
|
+
*/
|
|
7770
|
+
installer?: string;
|
|
7771
|
+
}
|
|
7772
|
+
/**
|
|
7773
|
+
* Feature settings for the portal
|
|
7774
|
+
*/
|
|
7775
|
+
export interface PortalFeatureSettings {
|
|
7776
|
+
/**
|
|
7777
|
+
* Start page feature flag
|
|
7778
|
+
*/
|
|
7779
|
+
start_page?: boolean;
|
|
7780
|
+
/**
|
|
7781
|
+
* Billing feature flag
|
|
7782
|
+
*/
|
|
7783
|
+
billing?: boolean;
|
|
7784
|
+
/**
|
|
7785
|
+
* Change due date feature flag
|
|
7786
|
+
*/
|
|
7787
|
+
change_due_date?: boolean;
|
|
7788
|
+
/**
|
|
7789
|
+
* Enable or disable the new design for the portal
|
|
7790
|
+
*/
|
|
7791
|
+
new_design?: boolean;
|
|
7792
|
+
/**
|
|
7793
|
+
* Enable the MCP (AI agent) connector channel for this portal
|
|
7794
|
+
*/
|
|
7795
|
+
mcp_enabled?: boolean;
|
|
7796
|
+
/**
|
|
7797
|
+
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
7798
|
+
*/
|
|
7799
|
+
mcp_grant_version?: number;
|
|
7800
|
+
}
|
|
7692
7801
|
/**
|
|
7693
7802
|
* ID of the portal
|
|
7694
7803
|
* example:
|
|
7695
7804
|
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7696
7805
|
*/
|
|
7697
7806
|
export type PortalId = string;
|
|
7807
|
+
/**
|
|
7808
|
+
* Portal-facing overrides of a flow or stage title, configured per portal
|
|
7809
|
+
* audience in the Flows Hub. Served unresolved because this endpoint asks
|
|
7810
|
+
* the Workflows API for audience `all` — one cached response feeds blocks
|
|
7811
|
+
* of both audiences, so each block picks its own override and falls back
|
|
7812
|
+
* to `name` when the key is absent.
|
|
7813
|
+
*
|
|
7814
|
+
*/
|
|
7815
|
+
export interface PortalNameOverrides {
|
|
7816
|
+
/**
|
|
7817
|
+
* Title shown in the End Customer Portal
|
|
7818
|
+
*/
|
|
7819
|
+
ecp?: string;
|
|
7820
|
+
/**
|
|
7821
|
+
* Title shown in the Installer Portal
|
|
7822
|
+
*/
|
|
7823
|
+
installer?: string;
|
|
7824
|
+
}
|
|
7698
7825
|
/**
|
|
7699
7826
|
* A 360 notification addressed to a portal user.
|
|
7700
7827
|
*/
|
|
@@ -8021,35 +8148,7 @@ declare namespace Components {
|
|
|
8021
8148
|
* false
|
|
8022
8149
|
*/
|
|
8023
8150
|
user_account_self_management?: boolean;
|
|
8024
|
-
|
|
8025
|
-
* Feature settings for the portal
|
|
8026
|
-
*/
|
|
8027
|
-
feature_settings?: {
|
|
8028
|
-
/**
|
|
8029
|
-
* Start page feature flag
|
|
8030
|
-
*/
|
|
8031
|
-
start_page?: boolean;
|
|
8032
|
-
/**
|
|
8033
|
-
* Billing feature flag
|
|
8034
|
-
*/
|
|
8035
|
-
billing?: boolean;
|
|
8036
|
-
/**
|
|
8037
|
-
* Change due date feature flag
|
|
8038
|
-
*/
|
|
8039
|
-
change_due_date?: boolean;
|
|
8040
|
-
/**
|
|
8041
|
-
* Enable or disable the new design for the portal
|
|
8042
|
-
*/
|
|
8043
|
-
new_design?: boolean;
|
|
8044
|
-
/**
|
|
8045
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
8046
|
-
*/
|
|
8047
|
-
mcp_enabled?: boolean;
|
|
8048
|
-
/**
|
|
8049
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
8050
|
-
*/
|
|
8051
|
-
mcp_grant_version?: number;
|
|
8052
|
-
};
|
|
8151
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
8053
8152
|
/**
|
|
8054
8153
|
* Access token for the portal
|
|
8055
8154
|
*/
|
|
@@ -8575,10 +8674,11 @@ declare namespace Components {
|
|
|
8575
8674
|
* How a caller on this surface proves who they are.
|
|
8576
8675
|
*
|
|
8577
8676
|
* - `login`: a logged-in portal user token (the portal's own authentication).
|
|
8578
|
-
* - `registration_identifiers`: the caller supplies the
|
|
8579
|
-
*
|
|
8580
|
-
*
|
|
8581
|
-
*
|
|
8677
|
+
* - `registration_identifiers`: the caller supplies the values of the surface's
|
|
8678
|
+
* identifiers (its own `identifiers`, or the portal's `registration_identifiers`
|
|
8679
|
+
* when it sets none) to `identifyContact` and receives a short-lived contact
|
|
8680
|
+
* identification token. Anyone who knows or guesses those values can use this
|
|
8681
|
+
* surface, so its data access should be as narrow as the use case allows.
|
|
8582
8682
|
*
|
|
8583
8683
|
* `anonymous` (no proof of identity at all) is planned and not accepted yet.
|
|
8584
8684
|
*
|
|
@@ -8588,6 +8688,30 @@ declare namespace Components {
|
|
|
8588
8688
|
* Lifetime of tokens minted for this surface. Only used with `registration_identifiers`.
|
|
8589
8689
|
*/
|
|
8590
8690
|
token_ttl_seconds?: number; // int32
|
|
8691
|
+
/**
|
|
8692
|
+
* Identifier attributes a caller must supply on this surface to be identified. Only
|
|
8693
|
+
* used with `authentication: registration_identifiers`.
|
|
8694
|
+
*
|
|
8695
|
+
* Omitted or empty means the surface uses the portal's `registration_identifiers`.
|
|
8696
|
+
* When set, these replace the portal's `registration_identifiers` on this surface
|
|
8697
|
+
* only: `identifyContact` requires a value for each of them (400 listing the missing
|
|
8698
|
+
* ones otherwise), runs the contact lookup and the `registrationIdentifiersCheck`
|
|
8699
|
+
* hook on them, and refuses to issue tokens (403) unless there are at least two.
|
|
8700
|
+
* Entries without `name` or `schema` are ignored.
|
|
8701
|
+
*
|
|
8702
|
+
* example:
|
|
8703
|
+
* [
|
|
8704
|
+
* {
|
|
8705
|
+
* "name": "customer_number",
|
|
8706
|
+
* "schema": "contact"
|
|
8707
|
+
* },
|
|
8708
|
+
* {
|
|
8709
|
+
* "name": "meter_number",
|
|
8710
|
+
* "schema": "meter"
|
|
8711
|
+
* }
|
|
8712
|
+
* ]
|
|
8713
|
+
*/
|
|
8714
|
+
identifiers?: RegistrationIdentifier[];
|
|
8591
8715
|
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;
|
|
8592
8716
|
}
|
|
8593
8717
|
/**
|
|
@@ -8642,6 +8766,10 @@ declare namespace Components {
|
|
|
8642
8766
|
id?: string;
|
|
8643
8767
|
journeyId?: string;
|
|
8644
8768
|
name?: string;
|
|
8769
|
+
/**
|
|
8770
|
+
* Portal-facing label configured in the Flows Hub that replaces the portal's default "Start now" button for this journey.
|
|
8771
|
+
*/
|
|
8772
|
+
portal_button_label?: string;
|
|
8645
8773
|
complete_task_automatically?: boolean;
|
|
8646
8774
|
};
|
|
8647
8775
|
}
|
|
@@ -8781,6 +8909,15 @@ declare namespace Components {
|
|
|
8781
8909
|
*
|
|
8782
8910
|
*/
|
|
8783
8911
|
PortalWorkflowStage[];
|
|
8912
|
+
portal_titles?: /**
|
|
8913
|
+
* Portal-facing overrides of a flow or stage title, configured per portal
|
|
8914
|
+
* audience in the Flows Hub. Served unresolved because this endpoint asks
|
|
8915
|
+
* the Workflows API for audience `all` — one cached response feeds blocks
|
|
8916
|
+
* of both audiences, so each block picks its own override and falls back
|
|
8917
|
+
* to `name` when the key is absent.
|
|
8918
|
+
*
|
|
8919
|
+
*/
|
|
8920
|
+
PortalNameOverrides;
|
|
8784
8921
|
}
|
|
8785
8922
|
/**
|
|
8786
8923
|
* A customer-facing stage of a flow execution, with a progress status derived
|
|
@@ -8806,15 +8943,34 @@ declare namespace Components {
|
|
|
8806
8943
|
* - COMPLETED: every task of the stage is done, and the flow has moved past it
|
|
8807
8944
|
* - IN_PROGRESS: the flow's current work is inside this stage
|
|
8808
8945
|
* - UPCOMING: the flow has not reached this stage yet
|
|
8946
|
+
* - NOT_REACHED: the flow finished (DONE or CLOSED) before reaching this stage — a run may legitimately end at any stage
|
|
8809
8947
|
*
|
|
8810
8948
|
*/
|
|
8811
|
-
status: "COMPLETED" | "IN_PROGRESS" | "UPCOMING";
|
|
8949
|
+
status: "COMPLETED" | "IN_PROGRESS" | "UPCOMING" | "NOT_REACHED";
|
|
8812
8950
|
/**
|
|
8813
8951
|
* Latest completion timestamp among the stage's tasks; set only when the
|
|
8814
8952
|
* stage is COMPLETED and at least one of its tasks recorded one
|
|
8815
8953
|
*
|
|
8816
8954
|
*/
|
|
8817
8955
|
completed_at?: string;
|
|
8956
|
+
portal_names?: /**
|
|
8957
|
+
* Portal-facing overrides of a flow or stage title, configured per portal
|
|
8958
|
+
* audience in the Flows Hub. Served unresolved because this endpoint asks
|
|
8959
|
+
* the Workflows API for audience `all` — one cached response feeds blocks
|
|
8960
|
+
* of both audiences, so each block picks its own override and falls back
|
|
8961
|
+
* to `name` when the key is absent.
|
|
8962
|
+
*
|
|
8963
|
+
*/
|
|
8964
|
+
PortalNameOverrides;
|
|
8965
|
+
portal_descriptions?: /**
|
|
8966
|
+
* Portal-facing overrides of a stage description, configured per portal
|
|
8967
|
+
* audience in the Flows Hub. Served unresolved for the same reason as
|
|
8968
|
+
* `PortalNameOverrides`; a block falls back to `description` when its
|
|
8969
|
+
* audience's key is absent. The values are rich text, like `description`
|
|
8970
|
+
* itself.
|
|
8971
|
+
*
|
|
8972
|
+
*/
|
|
8973
|
+
PortalDescriptionOverrides;
|
|
8818
8974
|
}
|
|
8819
8975
|
/**
|
|
8820
8976
|
* A single portal-visible task of a linearized workflow execution
|
|
@@ -8856,6 +9012,10 @@ declare namespace Components {
|
|
|
8856
9012
|
id?: string;
|
|
8857
9013
|
journeyId?: string;
|
|
8858
9014
|
name?: string;
|
|
9015
|
+
/**
|
|
9016
|
+
* 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.
|
|
9017
|
+
*/
|
|
9018
|
+
portal_button_label?: string;
|
|
8859
9019
|
/**
|
|
8860
9020
|
* If true, the task is auto completed when the journey is completed
|
|
8861
9021
|
*/
|
|
@@ -10171,35 +10331,7 @@ declare namespace Components {
|
|
|
10171
10331
|
* false
|
|
10172
10332
|
*/
|
|
10173
10333
|
user_account_self_management?: boolean;
|
|
10174
|
-
|
|
10175
|
-
* Feature settings for the portal
|
|
10176
|
-
*/
|
|
10177
|
-
feature_settings?: {
|
|
10178
|
-
/**
|
|
10179
|
-
* Start page feature flag
|
|
10180
|
-
*/
|
|
10181
|
-
start_page?: boolean;
|
|
10182
|
-
/**
|
|
10183
|
-
* Billing feature flag
|
|
10184
|
-
*/
|
|
10185
|
-
billing?: boolean;
|
|
10186
|
-
/**
|
|
10187
|
-
* Change due date feature flag
|
|
10188
|
-
*/
|
|
10189
|
-
change_due_date?: boolean;
|
|
10190
|
-
/**
|
|
10191
|
-
* Enable or disable the new design for the portal
|
|
10192
|
-
*/
|
|
10193
|
-
new_design?: boolean;
|
|
10194
|
-
/**
|
|
10195
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
10196
|
-
*/
|
|
10197
|
-
mcp_enabled?: boolean;
|
|
10198
|
-
/**
|
|
10199
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
10200
|
-
*/
|
|
10201
|
-
mcp_grant_version?: number;
|
|
10202
|
-
};
|
|
10334
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
10203
10335
|
/**
|
|
10204
10336
|
* Access token for the portal
|
|
10205
10337
|
*/
|
|
@@ -10800,35 +10932,7 @@ declare namespace Components {
|
|
|
10800
10932
|
* false
|
|
10801
10933
|
*/
|
|
10802
10934
|
user_account_self_management?: boolean;
|
|
10803
|
-
|
|
10804
|
-
* Feature settings for the portal
|
|
10805
|
-
*/
|
|
10806
|
-
feature_settings?: {
|
|
10807
|
-
/**
|
|
10808
|
-
* Start page feature flag
|
|
10809
|
-
*/
|
|
10810
|
-
start_page?: boolean;
|
|
10811
|
-
/**
|
|
10812
|
-
* Billing feature flag
|
|
10813
|
-
*/
|
|
10814
|
-
billing?: boolean;
|
|
10815
|
-
/**
|
|
10816
|
-
* Change due date feature flag
|
|
10817
|
-
*/
|
|
10818
|
-
change_due_date?: boolean;
|
|
10819
|
-
/**
|
|
10820
|
-
* Enable or disable the new design for the portal
|
|
10821
|
-
*/
|
|
10822
|
-
new_design?: boolean;
|
|
10823
|
-
/**
|
|
10824
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
10825
|
-
*/
|
|
10826
|
-
mcp_enabled?: boolean;
|
|
10827
|
-
/**
|
|
10828
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
10829
|
-
*/
|
|
10830
|
-
mcp_grant_version?: number;
|
|
10831
|
-
};
|
|
10935
|
+
feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
|
|
10832
10936
|
/**
|
|
10833
10937
|
* Access token for the portal
|
|
10834
10938
|
*/
|
|
@@ -14842,35 +14946,7 @@ declare namespace Paths {
|
|
|
14842
14946
|
* false
|
|
14843
14947
|
*/
|
|
14844
14948
|
user_account_self_management?: boolean;
|
|
14845
|
-
|
|
14846
|
-
* Feature settings for the portal
|
|
14847
|
-
*/
|
|
14848
|
-
feature_settings?: {
|
|
14849
|
-
/**
|
|
14850
|
-
* Start page feature flag
|
|
14851
|
-
*/
|
|
14852
|
-
start_page?: boolean;
|
|
14853
|
-
/**
|
|
14854
|
-
* Billing feature flag
|
|
14855
|
-
*/
|
|
14856
|
-
billing?: boolean;
|
|
14857
|
-
/**
|
|
14858
|
-
* Change due date feature flag
|
|
14859
|
-
*/
|
|
14860
|
-
change_due_date?: boolean;
|
|
14861
|
-
/**
|
|
14862
|
-
* Enable or disable the new design for the portal
|
|
14863
|
-
*/
|
|
14864
|
-
new_design?: boolean;
|
|
14865
|
-
/**
|
|
14866
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
14867
|
-
*/
|
|
14868
|
-
mcp_enabled?: boolean;
|
|
14869
|
-
/**
|
|
14870
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
14871
|
-
*/
|
|
14872
|
-
mcp_grant_version?: number;
|
|
14873
|
-
};
|
|
14949
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
14874
14950
|
/**
|
|
14875
14951
|
* Access token for the portal
|
|
14876
14952
|
*/
|
|
@@ -15501,35 +15577,7 @@ declare namespace Paths {
|
|
|
15501
15577
|
* false
|
|
15502
15578
|
*/
|
|
15503
15579
|
user_account_self_management?: boolean;
|
|
15504
|
-
|
|
15505
|
-
* Feature settings for the portal
|
|
15506
|
-
*/
|
|
15507
|
-
feature_settings?: {
|
|
15508
|
-
/**
|
|
15509
|
-
* Start page feature flag
|
|
15510
|
-
*/
|
|
15511
|
-
start_page?: boolean;
|
|
15512
|
-
/**
|
|
15513
|
-
* Billing feature flag
|
|
15514
|
-
*/
|
|
15515
|
-
billing?: boolean;
|
|
15516
|
-
/**
|
|
15517
|
-
* Change due date feature flag
|
|
15518
|
-
*/
|
|
15519
|
-
change_due_date?: boolean;
|
|
15520
|
-
/**
|
|
15521
|
-
* Enable or disable the new design for the portal
|
|
15522
|
-
*/
|
|
15523
|
-
new_design?: boolean;
|
|
15524
|
-
/**
|
|
15525
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
15526
|
-
*/
|
|
15527
|
-
mcp_enabled?: boolean;
|
|
15528
|
-
/**
|
|
15529
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
15530
|
-
*/
|
|
15531
|
-
mcp_grant_version?: number;
|
|
15532
|
-
};
|
|
15580
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
15533
15581
|
/**
|
|
15534
15582
|
* Access token for the portal
|
|
15535
15583
|
*/
|
|
@@ -16714,35 +16762,7 @@ declare namespace Paths {
|
|
|
16714
16762
|
* false
|
|
16715
16763
|
*/
|
|
16716
16764
|
user_account_self_management?: boolean;
|
|
16717
|
-
|
|
16718
|
-
* Feature settings for the portal
|
|
16719
|
-
*/
|
|
16720
|
-
feature_settings?: {
|
|
16721
|
-
/**
|
|
16722
|
-
* Start page feature flag
|
|
16723
|
-
*/
|
|
16724
|
-
start_page?: boolean;
|
|
16725
|
-
/**
|
|
16726
|
-
* Billing feature flag
|
|
16727
|
-
*/
|
|
16728
|
-
billing?: boolean;
|
|
16729
|
-
/**
|
|
16730
|
-
* Change due date feature flag
|
|
16731
|
-
*/
|
|
16732
|
-
change_due_date?: boolean;
|
|
16733
|
-
/**
|
|
16734
|
-
* Enable or disable the new design for the portal
|
|
16735
|
-
*/
|
|
16736
|
-
new_design?: boolean;
|
|
16737
|
-
/**
|
|
16738
|
-
* Enable the MCP (AI agent) connector channel for this portal
|
|
16739
|
-
*/
|
|
16740
|
-
mcp_enabled?: boolean;
|
|
16741
|
-
/**
|
|
16742
|
-
* Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
|
|
16743
|
-
*/
|
|
16744
|
-
mcp_grant_version?: number;
|
|
16745
|
-
};
|
|
16765
|
+
feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
|
|
16746
16766
|
/**
|
|
16747
16767
|
* Access token for the portal
|
|
16748
16768
|
*/
|
|
@@ -17974,7 +17994,7 @@ declare namespace Paths {
|
|
|
17974
17994
|
domain?: Parameters.Domain;
|
|
17975
17995
|
}
|
|
17976
17996
|
export type RequestBody = /**
|
|
17977
|
-
* ContactExistsRequest plus the surface the token is requested for.
|
|
17997
|
+
* 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`.
|
|
17978
17998
|
*
|
|
17979
17999
|
*/
|
|
17980
18000
|
Components.Schemas.ContactIdentifyRequest;
|
|
@@ -18098,6 +18118,23 @@ declare namespace Paths {
|
|
|
18098
18118
|
export type $500 = Components.Responses.InternalServerError;
|
|
18099
18119
|
}
|
|
18100
18120
|
}
|
|
18121
|
+
namespace ListPortalConfigSummaries {
|
|
18122
|
+
namespace Responses {
|
|
18123
|
+
export interface $200 {
|
|
18124
|
+
data?: /**
|
|
18125
|
+
* Lightweight view of a portal config for lists and pickers. Carries the identifying,
|
|
18126
|
+
* display and registration fields only. Pages, email templates, grants, feature flags,
|
|
18127
|
+
* identity providers and certificate details are left out; read them per portal with
|
|
18128
|
+
* `getPortalConfigV3`.
|
|
18129
|
+
*
|
|
18130
|
+
*/
|
|
18131
|
+
Components.Schemas.PortalConfigSummaryV3[];
|
|
18132
|
+
}
|
|
18133
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
18134
|
+
export type $403 = Components.Responses.Forbidden;
|
|
18135
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
18136
|
+
}
|
|
18137
|
+
}
|
|
18101
18138
|
namespace ListPortalNotifications {
|
|
18102
18139
|
namespace Parameters {
|
|
18103
18140
|
export type Cursor = string;
|
|
@@ -20424,15 +20461,24 @@ export interface OperationMethods {
|
|
|
20424
20461
|
/**
|
|
20425
20462
|
* identifyContact - identifyContact
|
|
20426
20463
|
*
|
|
20427
|
-
* Identify a contact by the
|
|
20428
|
-
*
|
|
20464
|
+
* Identify a contact by the surface's identifiers and, on a match, issue a short-lived
|
|
20465
|
+
* bearer token that acts as that contact.
|
|
20429
20466
|
*
|
|
20430
|
-
*
|
|
20467
|
+
* The identifiers checked are the surface's own `identifiers` when it configures any,
|
|
20468
|
+
* otherwise the portal's `registration_identifiers`. Their values are sent in the
|
|
20469
|
+
* `registration_identifiers` request property. Resolution is otherwise identical to
|
|
20470
|
+
* `checkContactExistsV3`: the same lookup, `registrationIdentifiersCheck` hook and
|
|
20471
|
+
* TIMEOUT semantics, run on the surface's identifiers. The token does not grant a portal
|
|
20431
20472
|
* session; it is accepted only on the operations listed in `allowed_operations`, and
|
|
20432
20473
|
* expires at `expires_at`. Requires `surface_id` to name a surface of the portal whose
|
|
20433
20474
|
* `authentication` is `registration_identifiers`; returns 403 otherwise. The token is
|
|
20434
20475
|
* confined to that surface's data access. Requests may be rate limited (429).
|
|
20435
20476
|
*
|
|
20477
|
+
* No portal session is expected, but the caller must present a public access token
|
|
20478
|
+
* (`token_type: journey` or `token_type: portal`) as the bearer, minted for the same
|
|
20479
|
+
* `org_id`; the request is rejected with 401 otherwise. It binds the call to the journey
|
|
20480
|
+
* or portal it comes from — the token is public, so it proves origin, not identity.
|
|
20481
|
+
*
|
|
20436
20482
|
*/
|
|
20437
20483
|
'identifyContact'(
|
|
20438
20484
|
parameters?: Parameters<Paths.IdentifyContact.QueryParameters> | null,
|
|
@@ -21518,7 +21564,10 @@ export interface OperationMethods {
|
|
|
21518
21564
|
/**
|
|
21519
21565
|
* deletePortalConfig - deletePortalConfig
|
|
21520
21566
|
*
|
|
21521
|
-
* Deletes a specific portal configuration by ID
|
|
21567
|
+
* Deletes a specific portal configuration by ID, together with everything the portal owns:
|
|
21568
|
+
* its pages, revisions, email templates and widget configuration. The custom domain network
|
|
21569
|
+
* setup is torn down asynchronously afterwards.
|
|
21570
|
+
*
|
|
21522
21571
|
*/
|
|
21523
21572
|
'deletePortalConfig'(
|
|
21524
21573
|
parameters?: Parameters<Paths.DeletePortalConfig.PathParameters> | null,
|
|
@@ -21595,6 +21644,22 @@ export interface OperationMethods {
|
|
|
21595
21644
|
data?: any,
|
|
21596
21645
|
config?: AxiosRequestConfig
|
|
21597
21646
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
21647
|
+
/**
|
|
21648
|
+
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
21649
|
+
*
|
|
21650
|
+
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
21651
|
+
* display and registration fields of each portal config, without pages, email
|
|
21652
|
+
* templates, grants, feature flags, identity providers or certificate details.
|
|
21653
|
+
*
|
|
21654
|
+
* Use it for portal overviews and pickers. Read a single portal with
|
|
21655
|
+
* `getPortalConfigV3` when the full configuration is needed.
|
|
21656
|
+
*
|
|
21657
|
+
*/
|
|
21658
|
+
'listPortalConfigSummaries'(
|
|
21659
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
21660
|
+
data?: any,
|
|
21661
|
+
config?: AxiosRequestConfig
|
|
21662
|
+
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
21598
21663
|
/**
|
|
21599
21664
|
* swapPortalConfig - swapPortalConfig
|
|
21600
21665
|
*
|
|
@@ -22422,15 +22487,24 @@ export interface PathsDictionary {
|
|
|
22422
22487
|
/**
|
|
22423
22488
|
* identifyContact - identifyContact
|
|
22424
22489
|
*
|
|
22425
|
-
* Identify a contact by the
|
|
22426
|
-
*
|
|
22490
|
+
* Identify a contact by the surface's identifiers and, on a match, issue a short-lived
|
|
22491
|
+
* bearer token that acts as that contact.
|
|
22427
22492
|
*
|
|
22428
|
-
*
|
|
22493
|
+
* The identifiers checked are the surface's own `identifiers` when it configures any,
|
|
22494
|
+
* otherwise the portal's `registration_identifiers`. Their values are sent in the
|
|
22495
|
+
* `registration_identifiers` request property. Resolution is otherwise identical to
|
|
22496
|
+
* `checkContactExistsV3`: the same lookup, `registrationIdentifiersCheck` hook and
|
|
22497
|
+
* TIMEOUT semantics, run on the surface's identifiers. The token does not grant a portal
|
|
22429
22498
|
* session; it is accepted only on the operations listed in `allowed_operations`, and
|
|
22430
22499
|
* expires at `expires_at`. Requires `surface_id` to name a surface of the portal whose
|
|
22431
22500
|
* `authentication` is `registration_identifiers`; returns 403 otherwise. The token is
|
|
22432
22501
|
* confined to that surface's data access. Requests may be rate limited (429).
|
|
22433
22502
|
*
|
|
22503
|
+
* No portal session is expected, but the caller must present a public access token
|
|
22504
|
+
* (`token_type: journey` or `token_type: portal`) as the bearer, minted for the same
|
|
22505
|
+
* `org_id`; the request is rejected with 401 otherwise. It binds the call to the journey
|
|
22506
|
+
* or portal it comes from — the token is public, so it proves origin, not identity.
|
|
22507
|
+
*
|
|
22434
22508
|
*/
|
|
22435
22509
|
'post'(
|
|
22436
22510
|
parameters?: Parameters<Paths.IdentifyContact.QueryParameters> | null,
|
|
@@ -23686,7 +23760,10 @@ export interface PathsDictionary {
|
|
|
23686
23760
|
/**
|
|
23687
23761
|
* deletePortalConfig - deletePortalConfig
|
|
23688
23762
|
*
|
|
23689
|
-
* Deletes a specific portal configuration by ID
|
|
23763
|
+
* Deletes a specific portal configuration by ID, together with everything the portal owns:
|
|
23764
|
+
* its pages, revisions, email templates and widget configuration. The custom domain network
|
|
23765
|
+
* setup is torn down asynchronously afterwards.
|
|
23766
|
+
*
|
|
23690
23767
|
*/
|
|
23691
23768
|
'delete'(
|
|
23692
23769
|
parameters?: Parameters<Paths.DeletePortalConfig.PathParameters> | null,
|
|
@@ -23772,6 +23849,24 @@ export interface PathsDictionary {
|
|
|
23772
23849
|
config?: AxiosRequestConfig
|
|
23773
23850
|
): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
|
|
23774
23851
|
}
|
|
23852
|
+
['/v3/portal/configs/summaries']: {
|
|
23853
|
+
/**
|
|
23854
|
+
* listPortalConfigSummaries - listPortalConfigSummaries
|
|
23855
|
+
*
|
|
23856
|
+
* Lists the portals of the organization as lightweight summaries: the identifying,
|
|
23857
|
+
* display and registration fields of each portal config, without pages, email
|
|
23858
|
+
* templates, grants, feature flags, identity providers or certificate details.
|
|
23859
|
+
*
|
|
23860
|
+
* Use it for portal overviews and pickers. Read a single portal with
|
|
23861
|
+
* `getPortalConfigV3` when the full configuration is needed.
|
|
23862
|
+
*
|
|
23863
|
+
*/
|
|
23864
|
+
'get'(
|
|
23865
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
23866
|
+
data?: any,
|
|
23867
|
+
config?: AxiosRequestConfig
|
|
23868
|
+
): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
|
|
23869
|
+
}
|
|
23775
23870
|
['/v3/portal/config/swap']: {
|
|
23776
23871
|
/**
|
|
23777
23872
|
* swapPortalConfig - swapPortalConfig
|
|
@@ -24016,6 +24111,8 @@ export type Grant = Components.Schemas.Grant;
|
|
|
24016
24111
|
export type IdentifierAttribute = Components.Schemas.IdentifierAttribute;
|
|
24017
24112
|
export type InstallmentEvent = Components.Schemas.InstallmentEvent;
|
|
24018
24113
|
export type JourneyActions = Components.Schemas.JourneyActions;
|
|
24114
|
+
export type JourneyContextUsagesRequest = Components.Schemas.JourneyContextUsagesRequest;
|
|
24115
|
+
export type JourneyContextUsagesResponse = Components.Schemas.JourneyContextUsagesResponse;
|
|
24019
24116
|
export type JuiceSettings = Components.Schemas.JuiceSettings;
|
|
24020
24117
|
export type Meter = Components.Schemas.Meter;
|
|
24021
24118
|
export type MeterChartWidget = Components.Schemas.MeterChartWidget;
|
|
@@ -24029,6 +24126,7 @@ export type MobileConfig = Components.Schemas.MobileConfig;
|
|
|
24029
24126
|
export type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
|
|
24030
24127
|
export type MobileOtaConfig = Components.Schemas.MobileOtaConfig;
|
|
24031
24128
|
export type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
24129
|
+
export type NewDesignMigrationResult = Components.Schemas.NewDesignMigrationResult;
|
|
24032
24130
|
export type NotificationTriggerConfig = Components.Schemas.NotificationTriggerConfig;
|
|
24033
24131
|
export type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
24034
24132
|
export type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
@@ -24042,9 +24140,13 @@ export type Page = Components.Schemas.Page;
|
|
|
24042
24140
|
export type PageRequest = Components.Schemas.PageRequest;
|
|
24043
24141
|
export type PaymentWidget = Components.Schemas.PaymentWidget;
|
|
24044
24142
|
export type PortalConfig = Components.Schemas.PortalConfig;
|
|
24143
|
+
export type PortalConfigSummaryV3 = Components.Schemas.PortalConfigSummaryV3;
|
|
24045
24144
|
export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
24046
24145
|
export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
24146
|
+
export type PortalDescriptionOverrides = Components.Schemas.PortalDescriptionOverrides;
|
|
24147
|
+
export type PortalFeatureSettings = Components.Schemas.PortalFeatureSettings;
|
|
24047
24148
|
export type PortalId = Components.Schemas.PortalId;
|
|
24149
|
+
export type PortalNameOverrides = Components.Schemas.PortalNameOverrides;
|
|
24048
24150
|
export type PortalNotification = Components.Schemas.PortalNotification;
|
|
24049
24151
|
export type PortalRevision = Components.Schemas.PortalRevision;
|
|
24050
24152
|
export type PortalRevisionCreated = Components.Schemas.PortalRevisionCreated;
|