@epilot/customer-portal-client 0.48.0 → 0.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/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
  */
@@ -1335,6 +1307,13 @@ declare namespace Components {
1335
1307
  * ]
1336
1308
  */
1337
1309
  contract_identifiers?: ContractIdentifier[];
1310
+ /**
1311
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
1312
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
1313
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
1314
+ *
1315
+ */
1316
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
1338
1317
  /**
1339
1318
  * Configuration for contract selector in the portal
1340
1319
  */
@@ -1635,35 +1614,7 @@ declare namespace Components {
1635
1614
  * false
1636
1615
  */
1637
1616
  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
- };
1617
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
1667
1618
  /**
1668
1619
  * Access token for the portal
1669
1620
  */
@@ -1903,6 +1854,13 @@ declare namespace Components {
1903
1854
  * ]
1904
1855
  */
1905
1856
  contract_identifiers?: ContractIdentifier[];
1857
+ /**
1858
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
1859
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
1860
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
1861
+ *
1862
+ */
1863
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
1906
1864
  /**
1907
1865
  * Configuration for contract selector in the portal
1908
1866
  */
@@ -2333,6 +2291,15 @@ declare namespace Components {
2333
2291
  * []
2334
2292
  */
2335
2293
  allowed_operations?: string[];
2294
+ /**
2295
+ * Whether the identified contact already has a portal user on this portal, so the caller
2296
+ * can skip offering account creation. Present only on a match; omitted when it could not
2297
+ * be determined.
2298
+ *
2299
+ * example:
2300
+ * false
2301
+ */
2302
+ has_portal_user?: boolean;
2336
2303
  /**
2337
2304
  * Present only when no token was issued. NOT_FOUND means the given identifiers did not
2338
2305
  * match any contact (definitive - the client should not retry). TIMEOUT means the contact
@@ -5256,7 +5223,7 @@ declare namespace Components {
5256
5223
  */
5257
5224
  scanned: number;
5258
5225
  usages: {
5259
- kind: "portal-config" | "portal-block" | "portal-widget";
5226
+ kind: "portal-config" | "portal-block";
5260
5227
  resource: {
5261
5228
  type: "portal";
5262
5229
  id: string;
@@ -5291,6 +5258,32 @@ declare namespace Components {
5291
5258
  * https://example.com
5292
5259
  */
5293
5260
  redirect_to?: string;
5261
+ /**
5262
+ * Portal name, served as the document title before the app boots
5263
+ * example:
5264
+ * Kundenportal
5265
+ */
5266
+ title?: string;
5267
+ /**
5268
+ * Whether the served document should carry a `noindex, nofollow` robots meta tag
5269
+ */
5270
+ prevent_indexing?: boolean;
5271
+ /**
5272
+ * Organization of the portal, used to preload its design from the served document
5273
+ * example:
5274
+ * 123
5275
+ */
5276
+ organization_id?: string;
5277
+ /**
5278
+ * Design of the portal, used to preload it from the served document
5279
+ */
5280
+ design_id?: string;
5281
+ /**
5282
+ * The portal design as returned by design-builder parse (theme=NEW), for the served document; absent when the design could not be read
5283
+ */
5284
+ design?: {
5285
+ [name: string]: any;
5286
+ } | null;
5294
5287
  }
5295
5288
  /**
5296
5289
  * The meter entity
@@ -6525,35 +6518,7 @@ declare namespace Components {
6525
6518
  * false
6526
6519
  */
6527
6520
  user_account_self_management?: boolean;
6528
- /**
6529
- * Feature settings for the portal
6530
- */
6531
- feature_settings?: {
6532
- /**
6533
- * Start page feature flag
6534
- */
6535
- start_page?: boolean;
6536
- /**
6537
- * Billing feature flag
6538
- */
6539
- billing?: boolean;
6540
- /**
6541
- * Change due date feature flag
6542
- */
6543
- change_due_date?: boolean;
6544
- /**
6545
- * Enable or disable the new design for the portal
6546
- */
6547
- new_design?: boolean;
6548
- /**
6549
- * Enable the MCP (AI agent) connector channel for this portal
6550
- */
6551
- mcp_enabled?: boolean;
6552
- /**
6553
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
6554
- */
6555
- mcp_grant_version?: number;
6556
- };
6521
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
6557
6522
  /**
6558
6523
  * Access token for the portal
6559
6524
  */
@@ -6793,6 +6758,13 @@ declare namespace Components {
6793
6758
  * ]
6794
6759
  */
6795
6760
  contract_identifiers?: ContractIdentifier[];
6761
+ /**
6762
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
6763
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
6764
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
6765
+ *
6766
+ */
6767
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
6796
6768
  /**
6797
6769
  * Configuration for contract selector in the portal
6798
6770
  */
@@ -7062,6 +7034,123 @@ declare namespace Components {
7062
7034
  grants?: Grant[];
7063
7035
  identity_providers?: ProviderPublicConfig[];
7064
7036
  }
7037
+ /**
7038
+ * Lightweight view of a portal config for lists and pickers. Carries the identifying,
7039
+ * display and registration fields only. Pages, email templates, grants, feature flags,
7040
+ * identity providers and certificate details are left out; read them per portal with
7041
+ * `getPortalConfigV3`.
7042
+ *
7043
+ */
7044
+ export interface PortalConfigSummaryV3 {
7045
+ portal_id?: /**
7046
+ * ID of the portal
7047
+ * example:
7048
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
7049
+ */
7050
+ PortalId;
7051
+ /**
7052
+ * ID of the organization
7053
+ * example:
7054
+ * 12345
7055
+ */
7056
+ organization_id?: string;
7057
+ origin?: /* Origin of the portal */ Origin;
7058
+ /**
7059
+ * Name of the portal
7060
+ */
7061
+ name?: string;
7062
+ /**
7063
+ * Whether the portal is enabled
7064
+ */
7065
+ enabled?: boolean;
7066
+ /**
7067
+ * Custom domain of the portal
7068
+ */
7069
+ domain?: string;
7070
+ /**
7071
+ * epilot-hosted domain of the portal
7072
+ */
7073
+ epilot_domain?: string;
7074
+ is_epilot_domain?: boolean;
7075
+ /**
7076
+ * Status of the custom domain setup, when a custom domain is configured
7077
+ */
7078
+ dnsStatus?: "CONFIGURING" | "PENDING" | "SUCCEED" | "EXPIRED" | "NEW_CERT_IN_PROGRESS";
7079
+ design_id?: /**
7080
+ * Entity ID
7081
+ * example:
7082
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
7083
+ */
7084
+ EntityId /* uuid */;
7085
+ /**
7086
+ * The logo to show for the portal in lists: the `logoImage` of the first page
7087
+ * that sets one. Absent when no page carries a logo; fall back to the design.
7088
+ *
7089
+ */
7090
+ logo_image?: {
7091
+ /**
7092
+ * Logo for the light theme
7093
+ * example:
7094
+ * https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/logo.png
7095
+ */
7096
+ url?: string;
7097
+ /**
7098
+ * Logo for the dark theme
7099
+ */
7100
+ dark_url?: string;
7101
+ };
7102
+ /**
7103
+ * Default 360 user to notify upon an internal notification
7104
+ */
7105
+ default_user_to_notify?: {
7106
+ /**
7107
+ * Default admin users for pending user notification to notify
7108
+ */
7109
+ onPendingUser?: AdminUser[];
7110
+ };
7111
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
7112
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7113
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
7114
+ block_registration_if_portal_user_exists?: boolean;
7115
+ /**
7116
+ * Entity type used as the primary identifier for self-registration
7117
+ */
7118
+ self_registration_entity?: "contact" | "account";
7119
+ /**
7120
+ * Enable or disable user account self management
7121
+ */
7122
+ user_account_self_management?: boolean;
7123
+ /**
7124
+ * Identifiers to identify a contact of a portal user during the registration.
7125
+ */
7126
+ registration_identifiers?: ContractIdentifier[];
7127
+ /**
7128
+ * Surfaces this portal's data is reached from besides the portal UI itself.
7129
+ */
7130
+ surfaces?: /**
7131
+ * One surface a portal's data is reached from (see `surfaces` on the portal config).
7132
+ *
7133
+ * A surface names how callers authenticate on it and what they may reach once they
7134
+ * have. Data access is always a subset of the portal's own: a schema not in
7135
+ * `allowed_portal_entities` cannot be opened up by a surface, and the portal's
7136
+ * contact-relation rules still apply underneath the surface's own.
7137
+ *
7138
+ * Tokens minted for a surface (currently: contact identification tokens for
7139
+ * `registration_identifiers` surfaces) carry the surface id. The surface's data
7140
+ * access is resolved from the portal config on every request, not baked into the
7141
+ * token, so tightening a surface applies to tokens already in circulation.
7142
+ *
7143
+ */
7144
+ PortalSurface[];
7145
+ is_dummy?: boolean;
7146
+ is_v3_item?: boolean;
7147
+ /**
7148
+ * ID of the currently published revision, if the portal has been published
7149
+ */
7150
+ published_revision_id?: string;
7151
+ _created_at?: string; // date-time
7152
+ _updated_at?: string; // date-time
7153
+ }
7065
7154
  export interface PortalConfigV3 {
7066
7155
  /**
7067
7156
  * Journey actions allowed on an entity by a portal user
@@ -7186,35 +7275,7 @@ declare namespace Components {
7186
7275
  * false
7187
7276
  */
7188
7277
  user_account_self_management?: boolean;
7189
- /**
7190
- * Feature settings for the portal
7191
- */
7192
- feature_settings?: {
7193
- /**
7194
- * Start page feature flag
7195
- */
7196
- start_page?: boolean;
7197
- /**
7198
- * Billing feature flag
7199
- */
7200
- billing?: boolean;
7201
- /**
7202
- * Change due date feature flag
7203
- */
7204
- change_due_date?: boolean;
7205
- /**
7206
- * Enable or disable the new design for the portal
7207
- */
7208
- new_design?: boolean;
7209
- /**
7210
- * Enable the MCP (AI agent) connector channel for this portal
7211
- */
7212
- mcp_enabled?: boolean;
7213
- /**
7214
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
7215
- */
7216
- mcp_grant_version?: number;
7217
- };
7278
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
7218
7279
  /**
7219
7280
  * Access token for the portal
7220
7281
  */
@@ -7454,6 +7515,13 @@ declare namespace Components {
7454
7515
  * ]
7455
7516
  */
7456
7517
  contract_identifiers?: ContractIdentifier[];
7518
+ /**
7519
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
7520
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
7521
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
7522
+ *
7523
+ */
7524
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
7457
7525
  /**
7458
7526
  * Configuration for contract selector in the portal
7459
7527
  */
@@ -7781,6 +7849,47 @@ declare namespace Components {
7781
7849
  */
7782
7850
  installer?: string;
7783
7851
  }
7852
+ /**
7853
+ * Feature settings for the portal
7854
+ */
7855
+ export interface PortalFeatureSettings {
7856
+ /**
7857
+ * Retired, not read. A portal shows a start page by having a `dashboard` page.
7858
+ */
7859
+ start_page?: boolean;
7860
+ /**
7861
+ * Retired, not read. Billing follows the organization's `commodity_billing` setting.
7862
+ */
7863
+ billing?: boolean;
7864
+ /**
7865
+ * Retired, not read. Billing pages and blocks follow the organization's `commodity_billing` setting.
7866
+ */
7867
+ commodity_billing?: boolean;
7868
+ /**
7869
+ * Retired, not read.
7870
+ */
7871
+ change_due_date?: boolean;
7872
+ /**
7873
+ * Enable or disable the new design for the portal
7874
+ */
7875
+ new_design?: boolean;
7876
+ /**
7877
+ * Enable the MCP (AI agent) connector channel for this portal
7878
+ */
7879
+ mcp_enabled?: boolean;
7880
+ /**
7881
+ * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
7882
+ */
7883
+ mcp_grant_version?: number;
7884
+ /**
7885
+ * Enable the portal copilot chat for this portal
7886
+ */
7887
+ portal_copilot?: boolean;
7888
+ /**
7889
+ * ID of the Agent Builder portal agent this portal's copilot chat runs, set by Agent Builder. When unset, or when the agent no longer exists in the portal's organization, the chat runs the default portal copilot.
7890
+ */
7891
+ portal_copilot_agent_id?: string;
7892
+ }
7784
7893
  /**
7785
7894
  * ID of the portal
7786
7895
  * example:
@@ -7868,13 +7977,18 @@ declare namespace Components {
7868
7977
  */
7869
7978
  created_by?: string;
7870
7979
  /**
7871
- * Set at publish time only, and only when the publish request carried one. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
7980
+ * Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
7872
7981
  *
7873
7982
  * example:
7874
7983
  * FAQ page launch
7875
7984
  */
7876
7985
  name?: string;
7877
7986
  description?: string;
7987
+ source?: /**
7988
+ * Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
7989
+ *
7990
+ */
7991
+ RevisionSource;
7878
7992
  page_count: number;
7879
7993
  /**
7880
7994
  * The last time this revision was published. NOT the same question as `is_published`: a revision that was live yesterday still carries a `published_at`.
@@ -7943,13 +8057,18 @@ declare namespace Components {
7943
8057
  */
7944
8058
  created_by?: string;
7945
8059
  /**
7946
- * Set at publish time only, and only when the publish request carried one. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
8060
+ * Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
7947
8061
  *
7948
8062
  * example:
7949
8063
  * FAQ page launch
7950
8064
  */
7951
8065
  name?: string;
7952
8066
  description?: string;
8067
+ source?: /**
8068
+ * Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
8069
+ *
8070
+ */
8071
+ RevisionSource;
7953
8072
  page_count: number;
7954
8073
  /**
7955
8074
  * The last time this revision was published. NOT the same question as `is_published`: a revision that was live yesterday still carries a `published_at`.
@@ -8131,35 +8250,7 @@ declare namespace Components {
8131
8250
  * false
8132
8251
  */
8133
8252
  user_account_self_management?: boolean;
8134
- /**
8135
- * Feature settings for the portal
8136
- */
8137
- feature_settings?: {
8138
- /**
8139
- * Start page feature flag
8140
- */
8141
- start_page?: boolean;
8142
- /**
8143
- * Billing feature flag
8144
- */
8145
- billing?: boolean;
8146
- /**
8147
- * Change due date feature flag
8148
- */
8149
- change_due_date?: boolean;
8150
- /**
8151
- * Enable or disable the new design for the portal
8152
- */
8153
- new_design?: boolean;
8154
- /**
8155
- * Enable the MCP (AI agent) connector channel for this portal
8156
- */
8157
- mcp_enabled?: boolean;
8158
- /**
8159
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
8160
- */
8161
- mcp_grant_version?: number;
8162
- };
8253
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
8163
8254
  /**
8164
8255
  * Access token for the portal
8165
8256
  */
@@ -8399,6 +8490,13 @@ declare namespace Components {
8399
8490
  * ]
8400
8491
  */
8401
8492
  contract_identifiers?: ContractIdentifier[];
8493
+ /**
8494
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
8495
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
8496
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
8497
+ *
8498
+ */
8499
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
8402
8500
  /**
8403
8501
  * Configuration for contract selector in the portal
8404
8502
  */
@@ -8611,6 +8709,11 @@ declare namespace Components {
8611
8709
  [name: string]: Block;
8612
8710
  };
8613
8711
  based_on_revision_id?: string;
8712
+ revision_source?: /**
8713
+ * Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
8714
+ *
8715
+ */
8716
+ RevisionSource;
8614
8717
  pages: /**
8615
8718
  * A page inside a revision snapshot. `additionalProperties` is true on purpose — a page carries fields this schema does not name and they must survive into the snapshot and back onto the live page when it is published.
8616
8719
  *
@@ -8629,13 +8732,18 @@ declare namespace Components {
8629
8732
  */
8630
8733
  created_by?: string;
8631
8734
  /**
8632
- * Set at publish time only, and only when the publish request carried one. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
8735
+ * Set at publish time when the publish request carries one, or by renaming the revision with `updatePortalRevision`. A revision can have been published and still have no name; `published_at` is the signal that a revision was live at some point, not this field.
8633
8736
  *
8634
8737
  * example:
8635
8738
  * FAQ page launch
8636
8739
  */
8637
8740
  name?: string;
8638
8741
  description?: string;
8742
+ source?: /**
8743
+ * Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
8744
+ *
8745
+ */
8746
+ RevisionSource;
8639
8747
  page_count: number;
8640
8748
  /**
8641
8749
  * The last time this revision was published. NOT the same question as `is_published`: a revision that was live yesterday still carries a `published_at`.
@@ -8852,6 +8960,28 @@ declare namespace Components {
8852
8960
  _schema: "portal_user";
8853
8961
  }
8854
8962
  export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
8963
+ /**
8964
+ * A portal whose design_id is the design asked about.
8965
+ */
8966
+ export interface PortalUsingDesign {
8967
+ portal_id: /**
8968
+ * ID of the portal
8969
+ * example:
8970
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
8971
+ */
8972
+ PortalId;
8973
+ /**
8974
+ * example:
8975
+ * Kundenportal
8976
+ */
8977
+ name?: string;
8978
+ origin?: /* Origin of the portal */ Origin;
8979
+ /**
8980
+ * example:
8981
+ * 9ba94f20-b872-11ed-b30a-b3e3bf2dc8ab
8982
+ */
8983
+ design_id?: string;
8984
+ }
8855
8985
  export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
8856
8986
  /**
8857
8987
  * A portal-facing projection of a workflow execution (V1 or V2), with the execution
@@ -9822,6 +9952,14 @@ declare namespace Components {
9822
9952
  [name: string]: any;
9823
9953
  };
9824
9954
  }
9955
+ /**
9956
+ * Where a revision came from, when it was not saved in the builder. Not part of the portal config. The builder renders it in the viewer's language for an unnamed revision.
9957
+ *
9958
+ */
9959
+ export interface RevisionSource {
9960
+ type: "blueprint_sync";
9961
+ blueprint_title?: string;
9962
+ }
9825
9963
  export interface Rule {
9826
9964
  entity?: string | null;
9827
9965
  attribute?: string | null;
@@ -10060,10 +10198,52 @@ declare namespace Components {
10060
10198
  */
10061
10199
  status: string;
10062
10200
  }
10201
+ export interface SwapPortalReferenceGroup {
10202
+ /**
10203
+ * Items whose references now point at the target portal.
10204
+ */
10205
+ updated: SwapPortalReferenceItem[];
10206
+ /**
10207
+ * Items that reference the source portal but could not be updated.
10208
+ */
10209
+ failed: SwapPortalReferenceItem[];
10210
+ /**
10211
+ * Set when the items could not be listed, so none of them were checked.
10212
+ */
10213
+ list_error?: string;
10214
+ }
10215
+ export interface SwapPortalReferenceItem {
10216
+ /**
10217
+ * Journey id or automation flow id.
10218
+ */
10219
+ id: string;
10220
+ name?: string;
10221
+ /**
10222
+ * Where the reference sat in the item.
10223
+ * example:
10224
+ * [
10225
+ * "steps[0].uischema.elements[2].options.portalId"
10226
+ * ]
10227
+ */
10228
+ paths?: string[];
10229
+ /**
10230
+ * Why the update failed. Only set on failed items.
10231
+ */
10232
+ error?: string;
10233
+ }
10234
+ /**
10235
+ * Outcome of the `portal_references` swap option. Only present when that option was requested. The swap itself has already succeeded when this is returned, so failures here do not undo it.
10236
+ */
10237
+ export interface SwapPortalReferencesResult {
10238
+ journeys: SwapPortalReferenceGroup;
10239
+ automation_flows: SwapPortalReferenceGroup;
10240
+ }
10063
10241
  /**
10064
10242
  * Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
10243
+ * - `email_templates`: swap the email templates of the two portals.
10244
+ * - `portal_references`: after the swap, re-point configuration in other services from the source portal to the target portal: the portal on journey login (AuthControl) blocks and in file upload portal access, and the portal of automation flow portal triggers. One-directional: references to the target portal are left unchanged, because the target keeps its domain and users. System flows are not changed. Uses the caller's permissions; the outcome is returned in `portal_references`.
10065
10245
  */
10066
- export type SwappableConfig = "email_templates";
10246
+ export type SwappableConfig = "email_templates" | "portal_references";
10067
10247
  export type TariffType = "ht" | "nt";
10068
10248
  export interface TeaserWidget {
10069
10249
  id: string;
@@ -10204,6 +10384,15 @@ declare namespace Components {
10204
10384
  */
10205
10385
  ProviderConfig[];
10206
10386
  }
10387
+ export interface UpdatePortalRevisionRequest {
10388
+ /**
10389
+ * New label for the revision. Trimmed by the server; an empty name after trimming removes the revision's name.
10390
+ *
10391
+ * example:
10392
+ * FAQ page launch
10393
+ */
10394
+ name: string;
10395
+ }
10207
10396
  export interface UpsertPortalConfig {
10208
10397
  /**
10209
10398
  * Journey actions allowed on an entity by a portal user
@@ -10342,35 +10531,7 @@ declare namespace Components {
10342
10531
  * false
10343
10532
  */
10344
10533
  user_account_self_management?: boolean;
10345
- /**
10346
- * Feature settings for the portal
10347
- */
10348
- feature_settings?: {
10349
- /**
10350
- * Start page feature flag
10351
- */
10352
- start_page?: boolean;
10353
- /**
10354
- * Billing feature flag
10355
- */
10356
- billing?: boolean;
10357
- /**
10358
- * Change due date feature flag
10359
- */
10360
- change_due_date?: boolean;
10361
- /**
10362
- * Enable or disable the new design for the portal
10363
- */
10364
- new_design?: boolean;
10365
- /**
10366
- * Enable the MCP (AI agent) connector channel for this portal
10367
- */
10368
- mcp_enabled?: boolean;
10369
- /**
10370
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
10371
- */
10372
- mcp_grant_version?: number;
10373
- };
10534
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
10374
10535
  /**
10375
10536
  * Access token for the portal
10376
10537
  */
@@ -10610,6 +10771,13 @@ declare namespace Components {
10610
10771
  * ]
10611
10772
  */
10612
10773
  contract_identifiers?: ContractIdentifier[];
10774
+ /**
10775
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
10776
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
10777
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
10778
+ *
10779
+ */
10780
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
10613
10781
  /**
10614
10782
  * Configuration for contract selector in the portal
10615
10783
  */
@@ -10971,35 +11139,7 @@ declare namespace Components {
10971
11139
  * false
10972
11140
  */
10973
11141
  user_account_self_management?: boolean;
10974
- /**
10975
- * Feature settings for the portal
10976
- */
10977
- feature_settings?: {
10978
- /**
10979
- * Start page feature flag
10980
- */
10981
- start_page?: boolean;
10982
- /**
10983
- * Billing feature flag
10984
- */
10985
- billing?: boolean;
10986
- /**
10987
- * Change due date feature flag
10988
- */
10989
- change_due_date?: boolean;
10990
- /**
10991
- * Enable or disable the new design for the portal
10992
- */
10993
- new_design?: boolean;
10994
- /**
10995
- * Enable the MCP (AI agent) connector channel for this portal
10996
- */
10997
- mcp_enabled?: boolean;
10998
- /**
10999
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
11000
- */
11001
- mcp_grant_version?: number;
11002
- };
11142
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
11003
11143
  /**
11004
11144
  * Access token for the portal
11005
11145
  */
@@ -11239,6 +11379,13 @@ declare namespace Components {
11239
11379
  * ]
11240
11380
  */
11241
11381
  contract_identifiers?: ContractIdentifier[];
11382
+ /**
11383
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
11384
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
11385
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
11386
+ *
11387
+ */
11388
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
11242
11389
  /**
11243
11390
  * Configuration for contract selector in the portal
11244
11391
  */
@@ -11920,6 +12067,48 @@ declare namespace Paths {
11920
12067
  export type $500 = Components.Responses.InternalServerError;
11921
12068
  }
11922
12069
  }
12070
+ namespace CompleteTemporaryPassword {
12071
+ export interface RequestBody {
12072
+ /**
12073
+ * Organization ID
12074
+ * example:
12075
+ * 123
12076
+ */
12077
+ org_id: string;
12078
+ /**
12079
+ * ID of the portal the user belongs to
12080
+ * example:
12081
+ * 7hj28akg-97fb-4f5c-b2a1-3e4fbc1d8c7a
12082
+ */
12083
+ portal_id: string;
12084
+ /**
12085
+ * Email address of the portal user
12086
+ * example:
12087
+ * user@example.com
12088
+ */
12089
+ email: string;
12090
+ /**
12091
+ * Temporary password from the email
12092
+ */
12093
+ temporary_password: string;
12094
+ /**
12095
+ * New password, must match the portal's password policy
12096
+ */
12097
+ new_password: string;
12098
+ }
12099
+ namespace Responses {
12100
+ export interface $200 {
12101
+ /**
12102
+ * example:
12103
+ * Password set successfully.
12104
+ */
12105
+ message?: string;
12106
+ }
12107
+ export type $400 = Components.Responses.InvalidRequest;
12108
+ export type $429 = Components.Responses.TooManyRequests;
12109
+ export type $500 = Components.Responses.InternalServerError;
12110
+ }
12111
+ }
11923
12112
  namespace ConfigureDistribution {
11924
12113
  namespace Parameters {
11925
12114
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
@@ -15013,35 +15202,7 @@ declare namespace Paths {
15013
15202
  * false
15014
15203
  */
15015
15204
  user_account_self_management?: boolean;
15016
- /**
15017
- * Feature settings for the portal
15018
- */
15019
- feature_settings?: {
15020
- /**
15021
- * Start page feature flag
15022
- */
15023
- start_page?: boolean;
15024
- /**
15025
- * Billing feature flag
15026
- */
15027
- billing?: boolean;
15028
- /**
15029
- * Change due date feature flag
15030
- */
15031
- change_due_date?: boolean;
15032
- /**
15033
- * Enable or disable the new design for the portal
15034
- */
15035
- new_design?: boolean;
15036
- /**
15037
- * Enable the MCP (AI agent) connector channel for this portal
15038
- */
15039
- mcp_enabled?: boolean;
15040
- /**
15041
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
15042
- */
15043
- mcp_grant_version?: number;
15044
- };
15205
+ feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
15045
15206
  /**
15046
15207
  * Access token for the portal
15047
15208
  */
@@ -15281,6 +15442,13 @@ declare namespace Paths {
15281
15442
  * ]
15282
15443
  */
15283
15444
  contract_identifiers?: Components.Schemas.ContractIdentifier[];
15445
+ /**
15446
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
15447
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
15448
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
15449
+ *
15450
+ */
15451
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
15284
15452
  /**
15285
15453
  * Configuration for contract selector in the portal
15286
15454
  */
@@ -15672,35 +15840,7 @@ declare namespace Paths {
15672
15840
  * false
15673
15841
  */
15674
15842
  user_account_self_management?: boolean;
15675
- /**
15676
- * Feature settings for the portal
15677
- */
15678
- feature_settings?: {
15679
- /**
15680
- * Start page feature flag
15681
- */
15682
- start_page?: boolean;
15683
- /**
15684
- * Billing feature flag
15685
- */
15686
- billing?: boolean;
15687
- /**
15688
- * Change due date feature flag
15689
- */
15690
- change_due_date?: boolean;
15691
- /**
15692
- * Enable or disable the new design for the portal
15693
- */
15694
- new_design?: boolean;
15695
- /**
15696
- * Enable the MCP (AI agent) connector channel for this portal
15697
- */
15698
- mcp_enabled?: boolean;
15699
- /**
15700
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
15701
- */
15702
- mcp_grant_version?: number;
15703
- };
15843
+ feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
15704
15844
  /**
15705
15845
  * Access token for the portal
15706
15846
  */
@@ -15940,6 +16080,13 @@ declare namespace Paths {
15940
16080
  * ]
15941
16081
  */
15942
16082
  contract_identifiers?: Components.Schemas.ContractIdentifier[];
16083
+ /**
16084
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
16085
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
16086
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
16087
+ *
16088
+ */
16089
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
15943
16090
  /**
15944
16091
  * Configuration for contract selector in the portal
15945
16092
  */
@@ -16885,35 +17032,7 @@ declare namespace Paths {
16885
17032
  * false
16886
17033
  */
16887
17034
  user_account_self_management?: boolean;
16888
- /**
16889
- * Feature settings for the portal
16890
- */
16891
- feature_settings?: {
16892
- /**
16893
- * Start page feature flag
16894
- */
16895
- start_page?: boolean;
16896
- /**
16897
- * Billing feature flag
16898
- */
16899
- billing?: boolean;
16900
- /**
16901
- * Change due date feature flag
16902
- */
16903
- change_due_date?: boolean;
16904
- /**
16905
- * Enable or disable the new design for the portal
16906
- */
16907
- new_design?: boolean;
16908
- /**
16909
- * Enable the MCP (AI agent) connector channel for this portal
16910
- */
16911
- mcp_enabled?: boolean;
16912
- /**
16913
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
16914
- */
16915
- mcp_grant_version?: number;
16916
- };
17035
+ feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
16917
17036
  /**
16918
17037
  * Access token for the portal
16919
17038
  */
@@ -17153,6 +17272,13 @@ declare namespace Paths {
17153
17272
  * ]
17154
17273
  */
17155
17274
  contract_identifiers?: Components.Schemas.ContractIdentifier[];
17275
+ /**
17276
+ * What the built-in self-assignment (without a contractIdentification hook) assigns once the `contract_identifiers` match a Contract:
17277
+ * - `contracts`: the user's Contact is added as a customer of the Contract.
17278
+ * - `customer_to_portal_user`: the Contract's customers (Contacts and Accounts) are added to the Portal User's `represents`. The Portal User sees all their data, including Contracts, transitively. Mirrors the `contact_to_portal_user` assignment mode of the contractIdentification hook.
17279
+ *
17280
+ */
17281
+ self_assignment_mode?: "contracts" | "customer_to_portal_user";
17156
17282
  /**
17157
17283
  * Configuration for contract selector in the portal
17158
17284
  */
@@ -18269,6 +18395,23 @@ declare namespace Paths {
18269
18395
  export type $500 = Components.Responses.InternalServerError;
18270
18396
  }
18271
18397
  }
18398
+ namespace ListPortalConfigSummaries {
18399
+ namespace Responses {
18400
+ export interface $200 {
18401
+ data?: /**
18402
+ * Lightweight view of a portal config for lists and pickers. Carries the identifying,
18403
+ * display and registration fields only. Pages, email templates, grants, feature flags,
18404
+ * identity providers and certificate details are left out; read them per portal with
18405
+ * `getPortalConfigV3`.
18406
+ *
18407
+ */
18408
+ Components.Schemas.PortalConfigSummaryV3[];
18409
+ }
18410
+ export type $401 = Components.Responses.Unauthorized;
18411
+ export type $403 = Components.Responses.Forbidden;
18412
+ export type $500 = Components.Responses.InternalServerError;
18413
+ }
18414
+ }
18272
18415
  namespace ListPortalNotifications {
18273
18416
  namespace Parameters {
18274
18417
  export type Cursor = string;
@@ -19152,9 +19295,18 @@ declare namespace Paths {
19152
19295
  */
19153
19296
  Components.Schemas.PortalId;
19154
19297
  /**
19155
- * Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped.
19298
+ * Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped. With `mode` the listed items are included in the draft revisions.
19299
+ */
19300
+ items_to_swap?: /**
19301
+ * Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
19302
+ * - `email_templates`: swap the email templates of the two portals.
19303
+ * - `portal_references`: after the swap, re-point configuration in other services from the source portal to the target portal: the portal on journey login (AuthControl) blocks and in file upload portal access, and the portal of automation flow portal triggers. One-directional: references to the target portal are left unchanged, because the target keeps its domain and users. System flows are not changed. Uses the caller's permissions; the outcome is returned in `portal_references`.
19304
+ */
19305
+ Components.Schemas.SwappableConfig[];
19306
+ /**
19307
+ * Requires portal versioning (flag on, V3 target portal), otherwise 400. `copy` saves an unpublished revision on the target holding the source's setup; neither portal changes live and the source is untouched. Omit for the original live swap. Cannot be combined with the `portal_references` item, which only applies to a live swap.
19156
19308
  */
19157
- items_to_swap?: /* Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum. */ Components.Schemas.SwappableConfig[];
19309
+ mode?: "copy";
19158
19310
  }
19159
19311
  namespace Responses {
19160
19312
  export interface $200 {
@@ -19163,6 +19315,19 @@ declare namespace Paths {
19163
19315
  * Domain and users swapped successfully.
19164
19316
  */
19165
19317
  message?: string;
19318
+ portal_references?: /* Outcome of the `portal_references` swap option. Only present when that option was requested. The swap itself has already succeeded when this is returned, so failures here do not undo it. */ Components.Schemas.SwapPortalReferencesResult;
19319
+ /**
19320
+ * Only with `mode`. The draft revision created on the target.
19321
+ */
19322
+ revisions?: {
19323
+ portal_id?: /**
19324
+ * ID of the portal
19325
+ * example:
19326
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
19327
+ */
19328
+ Components.Schemas.PortalId;
19329
+ revision_id?: string;
19330
+ }[];
19166
19331
  }
19167
19332
  export type $400 = Components.Responses.InvalidRequest;
19168
19333
  export type $401 = Components.Responses.Unauthorized;
@@ -19465,6 +19630,41 @@ declare namespace Paths {
19465
19630
  export type $500 = Components.Responses.InternalServerError;
19466
19631
  }
19467
19632
  }
19633
+ namespace UpdatePortalRevision {
19634
+ namespace Parameters {
19635
+ /**
19636
+ * example:
19637
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
19638
+ */
19639
+ export type PortalId = string; // uuid
19640
+ /**
19641
+ * example:
19642
+ * 2026-08-25T14:03:11.482Z-a7f3c1d9
19643
+ */
19644
+ export type RevisionId = string;
19645
+ }
19646
+ export interface PathParameters {
19647
+ portal_id: /**
19648
+ * example:
19649
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
19650
+ */
19651
+ Parameters.PortalId /* uuid */;
19652
+ revision_id: /**
19653
+ * example:
19654
+ * 2026-08-25T14:03:11.482Z-a7f3c1d9
19655
+ */
19656
+ Parameters.RevisionId;
19657
+ }
19658
+ export type RequestBody = Components.Schemas.UpdatePortalRevisionRequest;
19659
+ namespace Responses {
19660
+ export type $200 = Components.Schemas.PortalRevisionSummary;
19661
+ export type $400 = Components.Responses.InvalidRequest;
19662
+ export type $401 = Components.Responses.Unauthorized;
19663
+ export type $403 = Components.Responses.Forbidden;
19664
+ export type $404 = Components.Responses.NotFound;
19665
+ export type $500 = Components.Responses.InternalServerError;
19666
+ }
19667
+ }
19468
19668
  namespace UpdatePortalUser {
19469
19669
  export type RequestBody = Components.Schemas.Entity;
19470
19670
  namespace Responses {
@@ -21585,6 +21785,16 @@ export interface OperationMethods {
21585
21785
  data?: any,
21586
21786
  config?: AxiosRequestConfig
21587
21787
  ): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
21788
+ /**
21789
+ * completeTemporaryPassword - completeTemporaryPassword
21790
+ *
21791
+ * Replaces a portal user's temporary password with the password they chose.
21792
+ */
21793
+ 'completeTemporaryPassword'(
21794
+ parameters?: Parameters<UnknownParamsObject> | null,
21795
+ data?: Paths.CompleteTemporaryPassword.RequestBody,
21796
+ config?: AxiosRequestConfig
21797
+ ): OperationResponse<Paths.CompleteTemporaryPassword.Responses.$200>
21588
21798
  /**
21589
21799
  * updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
21590
21800
  *
@@ -21751,6 +21961,19 @@ export interface OperationMethods {
21751
21961
  data?: any,
21752
21962
  config?: AxiosRequestConfig
21753
21963
  ): OperationResponse<Paths.GetPortalRevision.Responses.$200>
21964
+ /**
21965
+ * updatePortalRevision - updatePortalRevision
21966
+ *
21967
+ * Renames a revision without publishing it. Any revision can be renamed, published or not. Only the revision's `name` changes: its content, `published_at`, `published_by` and which revision is live stay as they are.
21968
+ *
21969
+ * The server trims `name`. An empty name after trimming removes the revision's name, and clients fall back to a label derived from `published_at` / `created_at`. A later publish without a `name` keeps the renamed name.
21970
+ *
21971
+ */
21972
+ 'updatePortalRevision'(
21973
+ parameters?: Parameters<Paths.UpdatePortalRevision.PathParameters> | null,
21974
+ data?: Paths.UpdatePortalRevision.RequestBody,
21975
+ config?: AxiosRequestConfig
21976
+ ): OperationResponse<Paths.UpdatePortalRevision.Responses.$200>
21754
21977
  /**
21755
21978
  * publishPortalRevision - publishPortalRevision
21756
21979
  *
@@ -21778,10 +22001,26 @@ export interface OperationMethods {
21778
22001
  data?: any,
21779
22002
  config?: AxiosRequestConfig
21780
22003
  ): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
22004
+ /**
22005
+ * listPortalConfigSummaries - listPortalConfigSummaries
22006
+ *
22007
+ * Lists the portals of the organization as lightweight summaries: the identifying,
22008
+ * display and registration fields of each portal config, without pages, email
22009
+ * templates, grants, feature flags, identity providers or certificate details.
22010
+ *
22011
+ * Use it for portal overviews and pickers. Read a single portal with
22012
+ * `getPortalConfigV3` when the full configuration is needed.
22013
+ *
22014
+ */
22015
+ 'listPortalConfigSummaries'(
22016
+ parameters?: Parameters<UnknownParamsObject> | null,
22017
+ data?: any,
22018
+ config?: AxiosRequestConfig
22019
+ ): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
21781
22020
  /**
21782
22021
  * swapPortalConfig - swapPortalConfig
21783
22022
  *
21784
- * Swaps the portal configuration of two portals.
22023
+ * Swaps the portal configuration of two portals. Without `mode` both portals exchange pages and experience config live, as before. With `mode: copy` (portal versioning only) nothing live changes: the source's setup is saved as an unpublished revision on the target to review and publish. Domain and access/security settings never move.
21785
22024
  */
21786
22025
  'swapPortalConfig'(
21787
22026
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -23746,6 +23985,18 @@ export interface PathsDictionary {
23746
23985
  config?: AxiosRequestConfig
23747
23986
  ): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
23748
23987
  }
23988
+ ['/v3/portal/public/user/temporary-password/complete']: {
23989
+ /**
23990
+ * completeTemporaryPassword - completeTemporaryPassword
23991
+ *
23992
+ * Replaces a portal user's temporary password with the password they chose.
23993
+ */
23994
+ 'post'(
23995
+ parameters?: Parameters<UnknownParamsObject> | null,
23996
+ data?: Paths.CompleteTemporaryPassword.RequestBody,
23997
+ config?: AxiosRequestConfig
23998
+ ): OperationResponse<Paths.CompleteTemporaryPassword.Responses.$200>
23999
+ }
23749
24000
  ['/v2/portal/campaign/{campaign_id}/entity:status']: {
23750
24001
  /**
23751
24002
  * updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
@@ -23935,6 +24186,19 @@ export interface PathsDictionary {
23935
24186
  data?: any,
23936
24187
  config?: AxiosRequestConfig
23937
24188
  ): OperationResponse<Paths.GetPortalRevision.Responses.$200>
24189
+ /**
24190
+ * updatePortalRevision - updatePortalRevision
24191
+ *
24192
+ * Renames a revision without publishing it. Any revision can be renamed, published or not. Only the revision's `name` changes: its content, `published_at`, `published_by` and which revision is live stay as they are.
24193
+ *
24194
+ * The server trims `name`. An empty name after trimming removes the revision's name, and clients fall back to a label derived from `published_at` / `created_at`. A later publish without a `name` keeps the renamed name.
24195
+ *
24196
+ */
24197
+ 'patch'(
24198
+ parameters?: Parameters<Paths.UpdatePortalRevision.PathParameters> | null,
24199
+ data?: Paths.UpdatePortalRevision.RequestBody,
24200
+ config?: AxiosRequestConfig
24201
+ ): OperationResponse<Paths.UpdatePortalRevision.Responses.$200>
23938
24202
  }
23939
24203
  ['/v3/portal/config/{portal_id}/publish']: {
23940
24204
  /**
@@ -23967,11 +24231,29 @@ export interface PathsDictionary {
23967
24231
  config?: AxiosRequestConfig
23968
24232
  ): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
23969
24233
  }
24234
+ ['/v3/portal/configs/summaries']: {
24235
+ /**
24236
+ * listPortalConfigSummaries - listPortalConfigSummaries
24237
+ *
24238
+ * Lists the portals of the organization as lightweight summaries: the identifying,
24239
+ * display and registration fields of each portal config, without pages, email
24240
+ * templates, grants, feature flags, identity providers or certificate details.
24241
+ *
24242
+ * Use it for portal overviews and pickers. Read a single portal with
24243
+ * `getPortalConfigV3` when the full configuration is needed.
24244
+ *
24245
+ */
24246
+ 'get'(
24247
+ parameters?: Parameters<UnknownParamsObject> | null,
24248
+ data?: any,
24249
+ config?: AxiosRequestConfig
24250
+ ): OperationResponse<Paths.ListPortalConfigSummaries.Responses.$200>
24251
+ }
23970
24252
  ['/v3/portal/config/swap']: {
23971
24253
  /**
23972
24254
  * swapPortalConfig - swapPortalConfig
23973
24255
  *
23974
- * Swaps the portal configuration of two portals.
24256
+ * Swaps the portal configuration of two portals. Without `mode` both portals exchange pages and experience config live, as before. With `mode: copy` (portal versioning only) nothing live changes: the source's setup is saved as an unpublished revision on the target to review and publish. Domain and access/security settings never move.
23975
24257
  */
23976
24258
  'post'(
23977
24259
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -24240,9 +24522,11 @@ export type Page = Components.Schemas.Page;
24240
24522
  export type PageRequest = Components.Schemas.PageRequest;
24241
24523
  export type PaymentWidget = Components.Schemas.PaymentWidget;
24242
24524
  export type PortalConfig = Components.Schemas.PortalConfig;
24525
+ export type PortalConfigSummaryV3 = Components.Schemas.PortalConfigSummaryV3;
24243
24526
  export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
24244
24527
  export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
24245
24528
  export type PortalDescriptionOverrides = Components.Schemas.PortalDescriptionOverrides;
24529
+ export type PortalFeatureSettings = Components.Schemas.PortalFeatureSettings;
24246
24530
  export type PortalId = Components.Schemas.PortalId;
24247
24531
  export type PortalNameOverrides = Components.Schemas.PortalNameOverrides;
24248
24532
  export type PortalNotification = Components.Schemas.PortalNotification;
@@ -24257,6 +24541,7 @@ export type PortalSurfaceEntityAccess = Components.Schemas.PortalSurfaceEntityAc
24257
24541
  export type PortalTaskConfig = Components.Schemas.PortalTaskConfig;
24258
24542
  export type PortalUser = Components.Schemas.PortalUser;
24259
24543
  export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
24544
+ export type PortalUsingDesign = Components.Schemas.PortalUsingDesign;
24260
24545
  export type PortalWidget = Components.Schemas.PortalWidget;
24261
24546
  export type PortalWorkflow = Components.Schemas.PortalWorkflow;
24262
24547
  export type PortalWorkflowStage = Components.Schemas.PortalWorkflowStage;
@@ -24288,6 +24573,7 @@ export type RegistrationIdentifier = Components.Schemas.RegistrationIdentifier;
24288
24573
  export type ReimbursementEvent = Components.Schemas.ReimbursementEvent;
24289
24574
  export type RevisionPage = Components.Schemas.RevisionPage;
24290
24575
  export type RevisionPageRequest = Components.Schemas.RevisionPageRequest;
24576
+ export type RevisionSource = Components.Schemas.RevisionSource;
24291
24577
  export type Rule = Components.Schemas.Rule;
24292
24578
  export type SAMLProviderConfig = Components.Schemas.SAMLProviderConfig;
24293
24579
  export type SSOCallbackRequest = Components.Schemas.SSOCallbackRequest;
@@ -24302,12 +24588,16 @@ export type Source = Components.Schemas.Source;
24302
24588
  export type SupportReportType = Components.Schemas.SupportReportType;
24303
24589
  export type SupportRequestAttachment = Components.Schemas.SupportRequestAttachment;
24304
24590
  export type SupportRequestResult = Components.Schemas.SupportRequestResult;
24591
+ export type SwapPortalReferenceGroup = Components.Schemas.SwapPortalReferenceGroup;
24592
+ export type SwapPortalReferenceItem = Components.Schemas.SwapPortalReferenceItem;
24593
+ export type SwapPortalReferencesResult = Components.Schemas.SwapPortalReferencesResult;
24305
24594
  export type SwappableConfig = Components.Schemas.SwappableConfig;
24306
24595
  export type TariffType = Components.Schemas.TariffType;
24307
24596
  export type TeaserWidget = Components.Schemas.TeaserWidget;
24308
24597
  export type TemplatesRef = Components.Schemas.TemplatesRef;
24309
24598
  export type TriggerPortalFlow = Components.Schemas.TriggerPortalFlow;
24310
24599
  export type UpdateOnlyPortalConfigAttributes = Components.Schemas.UpdateOnlyPortalConfigAttributes;
24600
+ export type UpdatePortalRevisionRequest = Components.Schemas.UpdatePortalRevisionRequest;
24311
24601
  export type UpsertPortalConfig = Components.Schemas.UpsertPortalConfig;
24312
24602
  export type UpsertPortalConfigV3 = Components.Schemas.UpsertPortalConfigV3;
24313
24603
  export type UpsertPortalWidget = Components.Schemas.UpsertPortalWidget;