@epilot/customer-portal-client 0.47.0 → 0.47.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/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 {
@@ -5232,6 +5176,46 @@ declare namespace Components {
5232
5176
  slug?: string | null;
5233
5177
  rules?: Rule[] | null;
5234
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
+ }
5235
5219
  export interface JuiceSettings {
5236
5220
  /**
5237
5221
  * Whether the org is in dummy mode
@@ -5659,6 +5643,27 @@ declare namespace Components {
5659
5643
  */
5660
5644
  client_secret?: string;
5661
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
+ }
5662
5667
  export interface NotificationTriggerConfig {
5663
5668
  /**
5664
5669
  * The 360 event that fires this notification trigger.
@@ -6464,35 +6469,7 @@ declare namespace Components {
6464
6469
  * false
6465
6470
  */
6466
6471
  user_account_self_management?: boolean;
6467
- /**
6468
- * Feature settings for the portal
6469
- */
6470
- feature_settings?: {
6471
- /**
6472
- * Start page feature flag
6473
- */
6474
- start_page?: boolean;
6475
- /**
6476
- * Billing feature flag
6477
- */
6478
- billing?: boolean;
6479
- /**
6480
- * Change due date feature flag
6481
- */
6482
- change_due_date?: boolean;
6483
- /**
6484
- * Enable or disable the new design for the portal
6485
- */
6486
- new_design?: boolean;
6487
- /**
6488
- * Enable the MCP (AI agent) connector channel for this portal
6489
- */
6490
- mcp_enabled?: boolean;
6491
- /**
6492
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
6493
- */
6494
- mcp_grant_version?: number;
6495
- };
6472
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
6496
6473
  /**
6497
6474
  * Access token for the portal
6498
6475
  */
@@ -7001,6 +6978,106 @@ declare namespace Components {
7001
6978
  grants?: Grant[];
7002
6979
  identity_providers?: ProviderPublicConfig[];
7003
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
+ }
7004
7081
  export interface PortalConfigV3 {
7005
7082
  /**
7006
7083
  * Journey actions allowed on an entity by a portal user
@@ -7125,35 +7202,7 @@ declare namespace Components {
7125
7202
  * false
7126
7203
  */
7127
7204
  user_account_self_management?: boolean;
7128
- /**
7129
- * Feature settings for the portal
7130
- */
7131
- feature_settings?: {
7132
- /**
7133
- * Start page feature flag
7134
- */
7135
- start_page?: boolean;
7136
- /**
7137
- * Billing feature flag
7138
- */
7139
- billing?: boolean;
7140
- /**
7141
- * Change due date feature flag
7142
- */
7143
- change_due_date?: boolean;
7144
- /**
7145
- * Enable or disable the new design for the portal
7146
- */
7147
- new_design?: boolean;
7148
- /**
7149
- * Enable the MCP (AI agent) connector channel for this portal
7150
- */
7151
- mcp_enabled?: boolean;
7152
- /**
7153
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
7154
- */
7155
- mcp_grant_version?: number;
7156
- };
7205
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
7157
7206
  /**
7158
7207
  * Access token for the portal
7159
7208
  */
@@ -7720,6 +7769,35 @@ declare namespace Components {
7720
7769
  */
7721
7770
  installer?: string;
7722
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
+ }
7723
7801
  /**
7724
7802
  * ID of the portal
7725
7803
  * example:
@@ -8070,35 +8148,7 @@ declare namespace Components {
8070
8148
  * false
8071
8149
  */
8072
8150
  user_account_self_management?: boolean;
8073
- /**
8074
- * Feature settings for the portal
8075
- */
8076
- feature_settings?: {
8077
- /**
8078
- * Start page feature flag
8079
- */
8080
- start_page?: boolean;
8081
- /**
8082
- * Billing feature flag
8083
- */
8084
- billing?: boolean;
8085
- /**
8086
- * Change due date feature flag
8087
- */
8088
- change_due_date?: boolean;
8089
- /**
8090
- * Enable or disable the new design for the portal
8091
- */
8092
- new_design?: boolean;
8093
- /**
8094
- * Enable the MCP (AI agent) connector channel for this portal
8095
- */
8096
- mcp_enabled?: boolean;
8097
- /**
8098
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
8099
- */
8100
- mcp_grant_version?: number;
8101
- };
8151
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
8102
8152
  /**
8103
8153
  * Access token for the portal
8104
8154
  */
@@ -8624,10 +8674,11 @@ declare namespace Components {
8624
8674
  * How a caller on this surface proves who they are.
8625
8675
  *
8626
8676
  * - `login`: a logged-in portal user token (the portal's own authentication).
8627
- * - `registration_identifiers`: the caller supplies the portal's
8628
- * `registration_identifiers` to `identifyContact` and receives a short-lived
8629
- * contact identification token. Anyone who knows or guesses those values can
8630
- * use this surface, so its data access should be as narrow as the use case allows.
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.
8631
8682
  *
8632
8683
  * `anonymous` (no proof of identity at all) is planned and not accepted yet.
8633
8684
  *
@@ -8637,6 +8688,30 @@ declare namespace Components {
8637
8688
  * Lifetime of tokens minted for this surface. Only used with `registration_identifiers`.
8638
8689
  */
8639
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[];
8640
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;
8641
8716
  }
8642
8717
  /**
@@ -10256,35 +10331,7 @@ declare namespace Components {
10256
10331
  * false
10257
10332
  */
10258
10333
  user_account_self_management?: boolean;
10259
- /**
10260
- * Feature settings for the portal
10261
- */
10262
- feature_settings?: {
10263
- /**
10264
- * Start page feature flag
10265
- */
10266
- start_page?: boolean;
10267
- /**
10268
- * Billing feature flag
10269
- */
10270
- billing?: boolean;
10271
- /**
10272
- * Change due date feature flag
10273
- */
10274
- change_due_date?: boolean;
10275
- /**
10276
- * Enable or disable the new design for the portal
10277
- */
10278
- new_design?: boolean;
10279
- /**
10280
- * Enable the MCP (AI agent) connector channel for this portal
10281
- */
10282
- mcp_enabled?: boolean;
10283
- /**
10284
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
10285
- */
10286
- mcp_grant_version?: number;
10287
- };
10334
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
10288
10335
  /**
10289
10336
  * Access token for the portal
10290
10337
  */
@@ -10885,35 +10932,7 @@ declare namespace Components {
10885
10932
  * false
10886
10933
  */
10887
10934
  user_account_self_management?: boolean;
10888
- /**
10889
- * Feature settings for the portal
10890
- */
10891
- feature_settings?: {
10892
- /**
10893
- * Start page feature flag
10894
- */
10895
- start_page?: boolean;
10896
- /**
10897
- * Billing feature flag
10898
- */
10899
- billing?: boolean;
10900
- /**
10901
- * Change due date feature flag
10902
- */
10903
- change_due_date?: boolean;
10904
- /**
10905
- * Enable or disable the new design for the portal
10906
- */
10907
- new_design?: boolean;
10908
- /**
10909
- * Enable the MCP (AI agent) connector channel for this portal
10910
- */
10911
- mcp_enabled?: boolean;
10912
- /**
10913
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
10914
- */
10915
- mcp_grant_version?: number;
10916
- };
10935
+ feature_settings?: /* Feature settings for the portal */ PortalFeatureSettings;
10917
10936
  /**
10918
10937
  * Access token for the portal
10919
10938
  */
@@ -14927,35 +14946,7 @@ declare namespace Paths {
14927
14946
  * false
14928
14947
  */
14929
14948
  user_account_self_management?: boolean;
14930
- /**
14931
- * Feature settings for the portal
14932
- */
14933
- feature_settings?: {
14934
- /**
14935
- * Start page feature flag
14936
- */
14937
- start_page?: boolean;
14938
- /**
14939
- * Billing feature flag
14940
- */
14941
- billing?: boolean;
14942
- /**
14943
- * Change due date feature flag
14944
- */
14945
- change_due_date?: boolean;
14946
- /**
14947
- * Enable or disable the new design for the portal
14948
- */
14949
- new_design?: boolean;
14950
- /**
14951
- * Enable the MCP (AI agent) connector channel for this portal
14952
- */
14953
- mcp_enabled?: boolean;
14954
- /**
14955
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
14956
- */
14957
- mcp_grant_version?: number;
14958
- };
14949
+ feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
14959
14950
  /**
14960
14951
  * Access token for the portal
14961
14952
  */
@@ -15586,35 +15577,7 @@ declare namespace Paths {
15586
15577
  * false
15587
15578
  */
15588
15579
  user_account_self_management?: boolean;
15589
- /**
15590
- * Feature settings for the portal
15591
- */
15592
- feature_settings?: {
15593
- /**
15594
- * Start page feature flag
15595
- */
15596
- start_page?: boolean;
15597
- /**
15598
- * Billing feature flag
15599
- */
15600
- billing?: boolean;
15601
- /**
15602
- * Change due date feature flag
15603
- */
15604
- change_due_date?: boolean;
15605
- /**
15606
- * Enable or disable the new design for the portal
15607
- */
15608
- new_design?: boolean;
15609
- /**
15610
- * Enable the MCP (AI agent) connector channel for this portal
15611
- */
15612
- mcp_enabled?: boolean;
15613
- /**
15614
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
15615
- */
15616
- mcp_grant_version?: number;
15617
- };
15580
+ feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
15618
15581
  /**
15619
15582
  * Access token for the portal
15620
15583
  */
@@ -16799,35 +16762,7 @@ declare namespace Paths {
16799
16762
  * false
16800
16763
  */
16801
16764
  user_account_self_management?: boolean;
16802
- /**
16803
- * Feature settings for the portal
16804
- */
16805
- feature_settings?: {
16806
- /**
16807
- * Start page feature flag
16808
- */
16809
- start_page?: boolean;
16810
- /**
16811
- * Billing feature flag
16812
- */
16813
- billing?: boolean;
16814
- /**
16815
- * Change due date feature flag
16816
- */
16817
- change_due_date?: boolean;
16818
- /**
16819
- * Enable or disable the new design for the portal
16820
- */
16821
- new_design?: boolean;
16822
- /**
16823
- * Enable the MCP (AI agent) connector channel for this portal
16824
- */
16825
- mcp_enabled?: boolean;
16826
- /**
16827
- * Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled
16828
- */
16829
- mcp_grant_version?: number;
16830
- };
16765
+ feature_settings?: /* Feature settings for the portal */ Components.Schemas.PortalFeatureSettings;
16831
16766
  /**
16832
16767
  * Access token for the portal
16833
16768
  */
@@ -18059,7 +17994,7 @@ declare namespace Paths {
18059
17994
  domain?: Parameters.Domain;
18060
17995
  }
18061
17996
  export type RequestBody = /**
18062
- * 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`.
18063
17998
  *
18064
17999
  */
18065
18000
  Components.Schemas.ContactIdentifyRequest;
@@ -18183,6 +18118,23 @@ declare namespace Paths {
18183
18118
  export type $500 = Components.Responses.InternalServerError;
18184
18119
  }
18185
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
+ }
18186
18138
  namespace ListPortalNotifications {
18187
18139
  namespace Parameters {
18188
18140
  export type Cursor = string;
@@ -20509,10 +20461,14 @@ export interface OperationMethods {
20509
20461
  /**
20510
20462
  * identifyContact - identifyContact
20511
20463
  *
20512
- * Identify a contact by the portal's configured registration identifiers and, on a match,
20513
- * issue a short-lived bearer token that acts as that contact.
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.
20514
20466
  *
20515
- * Resolution is identical to `checkContactExistsV3`. The token does not grant a portal
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
20516
20472
  * session; it is accepted only on the operations listed in `allowed_operations`, and
20517
20473
  * expires at `expires_at`. Requires `surface_id` to name a surface of the portal whose
20518
20474
  * `authentication` is `registration_identifiers`; returns 403 otherwise. The token is
@@ -21688,6 +21644,22 @@ export interface OperationMethods {
21688
21644
  data?: any,
21689
21645
  config?: AxiosRequestConfig
21690
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>
21691
21663
  /**
21692
21664
  * swapPortalConfig - swapPortalConfig
21693
21665
  *
@@ -22515,10 +22487,14 @@ export interface PathsDictionary {
22515
22487
  /**
22516
22488
  * identifyContact - identifyContact
22517
22489
  *
22518
- * Identify a contact by the portal's configured registration identifiers and, on a match,
22519
- * issue a short-lived bearer token that acts as that contact.
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.
22520
22492
  *
22521
- * Resolution is identical to `checkContactExistsV3`. The token does not grant a portal
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
22522
22498
  * session; it is accepted only on the operations listed in `allowed_operations`, and
22523
22499
  * expires at `expires_at`. Requires `surface_id` to name a surface of the portal whose
22524
22500
  * `authentication` is `registration_identifiers`; returns 403 otherwise. The token is
@@ -23873,6 +23849,24 @@ export interface PathsDictionary {
23873
23849
  config?: AxiosRequestConfig
23874
23850
  ): OperationResponse<Paths.ListAllPortalConfigs.Responses.$200>
23875
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
+ }
23876
23870
  ['/v3/portal/config/swap']: {
23877
23871
  /**
23878
23872
  * swapPortalConfig - swapPortalConfig
@@ -24117,6 +24111,8 @@ export type Grant = Components.Schemas.Grant;
24117
24111
  export type IdentifierAttribute = Components.Schemas.IdentifierAttribute;
24118
24112
  export type InstallmentEvent = Components.Schemas.InstallmentEvent;
24119
24113
  export type JourneyActions = Components.Schemas.JourneyActions;
24114
+ export type JourneyContextUsagesRequest = Components.Schemas.JourneyContextUsagesRequest;
24115
+ export type JourneyContextUsagesResponse = Components.Schemas.JourneyContextUsagesResponse;
24120
24116
  export type JuiceSettings = Components.Schemas.JuiceSettings;
24121
24117
  export type Meter = Components.Schemas.Meter;
24122
24118
  export type MeterChartWidget = Components.Schemas.MeterChartWidget;
@@ -24130,6 +24126,7 @@ export type MobileConfig = Components.Schemas.MobileConfig;
24130
24126
  export type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
24131
24127
  export type MobileOtaConfig = Components.Schemas.MobileOtaConfig;
24132
24128
  export type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
24129
+ export type NewDesignMigrationResult = Components.Schemas.NewDesignMigrationResult;
24133
24130
  export type NotificationTriggerConfig = Components.Schemas.NotificationTriggerConfig;
24134
24131
  export type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
24135
24132
  export type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
@@ -24143,9 +24140,11 @@ export type Page = Components.Schemas.Page;
24143
24140
  export type PageRequest = Components.Schemas.PageRequest;
24144
24141
  export type PaymentWidget = Components.Schemas.PaymentWidget;
24145
24142
  export type PortalConfig = Components.Schemas.PortalConfig;
24143
+ export type PortalConfigSummaryV3 = Components.Schemas.PortalConfigSummaryV3;
24146
24144
  export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
24147
24145
  export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
24148
24146
  export type PortalDescriptionOverrides = Components.Schemas.PortalDescriptionOverrides;
24147
+ export type PortalFeatureSettings = Components.Schemas.PortalFeatureSettings;
24149
24148
  export type PortalId = Components.Schemas.PortalId;
24150
24149
  export type PortalNameOverrides = Components.Schemas.PortalNameOverrides;
24151
24150
  export type PortalNotification = Components.Schemas.PortalNotification;