@epilot/sdk 2.20.61 → 2.20.62
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/app.json +17 -44
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +566 -14
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +656 -2
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/external-values.cjs +6 -6
- package/dist/apis/external-values.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/identity.cjs +6 -6
- package/dist/apis/identity.js +1 -1
- package/dist/apis/integration-toolkit.cjs +61 -9
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +55 -3
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/phone-integration.cjs +6 -6
- package/dist/apis/phone-integration.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/app-CKQAJ7EE.js +7 -0
- package/dist/app-ERJHXY64.cjs +7 -0
- package/dist/{app.d-DbOr4uIC.d.cts → app.d-CZELwNO3.d.cts} +51 -27
- package/dist/{app.d-DbOr4uIC.d.ts → app.d-CZELwNO3.d.ts} +51 -27
- package/dist/{chunk-6LYUL3EY.cjs → chunk-4EH2X5J6.cjs} +5 -5
- package/dist/chunk-I6IC54PD.js +14 -0
- package/dist/chunk-O2XK4VD5.js +14 -0
- package/dist/chunk-QDPZZUG3.cjs +14 -0
- package/dist/chunk-UP3ZIQHB.cjs +14 -0
- package/dist/{chunk-OEDN6Y5U.js → chunk-ZM6WXMH3.js} +5 -5
- package/dist/customer-portal-2OT5REK6.cjs +7 -0
- package/dist/customer-portal-AO2K6VW2.js +7 -0
- package/dist/{customer-portal-runtime-ZTLLE6CR.cjs → customer-portal-runtime-ATHDYPZM.cjs} +2 -2
- package/dist/{customer-portal-runtime-CNW7NSCT.js → customer-portal-runtime-XISRWE3I.js} +1 -1
- package/dist/{customer-portal.d-COI3Xe4x.d.cts → customer-portal.d-CTIzvirI.d.cts} +652 -17
- package/dist/{customer-portal.d-COI3Xe4x.d.ts → customer-portal.d-CTIzvirI.d.ts} +652 -17
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/dist/integration-toolkit-FI32O7II.cjs +7 -0
- package/dist/integration-toolkit-MHULDW3E.js +7 -0
- package/dist/{integration-toolkit-runtime-3PM3MBEF.cjs → integration-toolkit-runtime-CPJT7YCA.cjs} +2 -2
- package/dist/{integration-toolkit-runtime-3LKW4ORQ.js → integration-toolkit-runtime-ZEH6X2OD.js} +1 -1
- package/dist/{integration-toolkit.d-oORkWs_H.d.cts → integration-toolkit.d-l5cgwHLa.d.cts} +658 -3
- package/dist/{integration-toolkit.d-oORkWs_H.d.ts → integration-toolkit.d-l5cgwHLa.d.ts} +658 -3
- package/docs/app.md +10 -39
- package/docs/customer-portal.md +440 -73
- package/docs/integration-toolkit.md +423 -7
- package/package.json +1 -1
- package/dist/app-R2RDF74T.js +0 -7
- package/dist/app-YIP3MOGW.cjs +0 -7
- package/dist/chunk-DQ346MRA.js +0 -14
- package/dist/chunk-FBRDBE4Y.cjs +0 -14
- package/dist/chunk-MBWCGRCK.js +0 -14
- package/dist/chunk-Y7KWK5H2.cjs +0 -14
- package/dist/customer-portal-TSJKBA37.js +0 -7
- package/dist/customer-portal-WOO2QDPR.cjs +0 -7
- package/dist/integration-toolkit-AB3GZDWM.cjs +0 -7
- package/dist/integration-toolkit-L745CJ5G.js +0 -7
package/docs/customer-portal.md
CHANGED
|
@@ -75,6 +75,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
75
75
|
- [`createPortalRevision`](#createportalrevision)
|
|
76
76
|
- [`listPortalRevisions`](#listportalrevisions)
|
|
77
77
|
- [`getPortalRevision`](#getportalrevision)
|
|
78
|
+
- [`updatePortalRevision`](#updateportalrevision)
|
|
78
79
|
- [`publishPortalRevision`](#publishportalrevision)
|
|
79
80
|
- [`listAllPortalConfigs`](#listallportalconfigs)
|
|
80
81
|
- [`listPortalConfigSummaries`](#listportalconfigsummaries)
|
|
@@ -109,6 +110,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
109
110
|
- [`ssoCallback`](#ssocallback)
|
|
110
111
|
- [`getPublicPages`](#getpublicpages)
|
|
111
112
|
- [`getUserEntryPoint`](#getuserentrypoint)
|
|
113
|
+
- [`completeTemporaryPassword`](#completetemporarypassword)
|
|
112
114
|
- [`deRegisterMLoginUser`](#deregistermloginuser)
|
|
113
115
|
- [`notifyMLoginInterestChange`](#notifymlogininterestchange)
|
|
114
116
|
|
|
@@ -305,6 +307,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
305
307
|
- [`TriggerPortalFlow`](#triggerportalflow)
|
|
306
308
|
- [`ExtensionConfig`](#extensionconfig)
|
|
307
309
|
- [`ExtensionHookSelection`](#extensionhookselection)
|
|
310
|
+
- [`WaitForEntityRule`](#waitforentityrule)
|
|
308
311
|
- [`PublicExtensionCapabilities`](#publicextensioncapabilities)
|
|
309
312
|
- [`PublicSelfManagementExplanation`](#publicselfmanagementexplanation)
|
|
310
313
|
- [`PublicChangeEmailDetails`](#publicchangeemaildetails)
|
|
@@ -377,6 +380,8 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
377
380
|
- [`RevisionPageRequest`](#revisionpagerequest)
|
|
378
381
|
- [`PortalRevisionRequest`](#portalrevisionrequest)
|
|
379
382
|
- [`PublishRevisionRequest`](#publishrevisionrequest)
|
|
383
|
+
- [`UpdatePortalRevisionRequest`](#updateportalrevisionrequest)
|
|
384
|
+
- [`RevisionSource`](#revisionsource)
|
|
380
385
|
- [`PortalRevisionSummary`](#portalrevisionsummary)
|
|
381
386
|
- [`PortalRevisionList`](#portalrevisionlist)
|
|
382
387
|
- [`PortalRevisionCreated`](#portalrevisioncreated)
|
|
@@ -384,6 +389,9 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
384
389
|
- [`PortalRevision`](#portalrevision)
|
|
385
390
|
- [`PublishResult`](#publishresult)
|
|
386
391
|
- [`SwappableConfig`](#swappableconfig)
|
|
392
|
+
- [`SwapPortalReferencesResult`](#swapportalreferencesresult)
|
|
393
|
+
- [`SwapPortalReferenceGroup`](#swapportalreferencegroup)
|
|
394
|
+
- [`SwapPortalReferenceItem`](#swapportalreferenceitem)
|
|
387
395
|
- [`PortalUserRegistrationStatus`](#portaluserregistrationstatus)
|
|
388
396
|
- [`BusinessPartnerItem`](#businesspartneritem)
|
|
389
397
|
- [`SupportReportType`](#supportreporttype)
|
|
@@ -494,10 +502,13 @@ const { data } = await client.upsertPortal(
|
|
|
494
502
|
feature_settings: {
|
|
495
503
|
start_page: true,
|
|
496
504
|
billing: true,
|
|
505
|
+
commodity_billing: true,
|
|
497
506
|
change_due_date: true,
|
|
498
507
|
new_design: true,
|
|
499
508
|
mcp_enabled: true,
|
|
500
|
-
mcp_grant_version: 0
|
|
509
|
+
mcp_grant_version: 0,
|
|
510
|
+
portal_copilot: false,
|
|
511
|
+
portal_copilot_agent_id: 'string'
|
|
501
512
|
},
|
|
502
513
|
accessToken: 'string',
|
|
503
514
|
advanced_mfa: {
|
|
@@ -745,10 +756,13 @@ const { data } = await client.upsertPortal(
|
|
|
745
756
|
"feature_settings": {
|
|
746
757
|
"start_page": true,
|
|
747
758
|
"billing": true,
|
|
759
|
+
"commodity_billing": true,
|
|
748
760
|
"change_due_date": true,
|
|
749
761
|
"new_design": true,
|
|
750
762
|
"mcp_enabled": true,
|
|
751
|
-
"mcp_grant_version": 0
|
|
763
|
+
"mcp_grant_version": 0,
|
|
764
|
+
"portal_copilot": false,
|
|
765
|
+
"portal_copilot_agent_id": "string"
|
|
752
766
|
},
|
|
753
767
|
"accessToken": "string",
|
|
754
768
|
"advanced_mfa": {
|
|
@@ -1133,10 +1147,13 @@ const { data } = await client.getPortalConfigByDomain({
|
|
|
1133
1147
|
"feature_settings": {
|
|
1134
1148
|
"start_page": true,
|
|
1135
1149
|
"billing": true,
|
|
1150
|
+
"commodity_billing": true,
|
|
1136
1151
|
"change_due_date": true,
|
|
1137
1152
|
"new_design": true,
|
|
1138
1153
|
"mcp_enabled": true,
|
|
1139
|
-
"mcp_grant_version": 0
|
|
1154
|
+
"mcp_grant_version": 0,
|
|
1155
|
+
"portal_copilot": false,
|
|
1156
|
+
"portal_copilot_agent_id": "string"
|
|
1140
1157
|
},
|
|
1141
1158
|
"accessToken": "string",
|
|
1142
1159
|
"advanced_mfa": {
|
|
@@ -1424,10 +1441,13 @@ const { data } = await client.getPortalConfig({
|
|
|
1424
1441
|
"feature_settings": {
|
|
1425
1442
|
"start_page": true,
|
|
1426
1443
|
"billing": true,
|
|
1444
|
+
"commodity_billing": true,
|
|
1427
1445
|
"change_due_date": true,
|
|
1428
1446
|
"new_design": true,
|
|
1429
1447
|
"mcp_enabled": true,
|
|
1430
|
-
"mcp_grant_version": 0
|
|
1448
|
+
"mcp_grant_version": 0,
|
|
1449
|
+
"portal_copilot": false,
|
|
1450
|
+
"portal_copilot_agent_id": "string"
|
|
1431
1451
|
},
|
|
1432
1452
|
"accessToken": "string",
|
|
1433
1453
|
"advanced_mfa": {
|
|
@@ -1819,10 +1839,12 @@ const { data } = await client.getPortalExtensions({
|
|
|
1819
1839
|
"params": {},
|
|
1820
1840
|
"headers": {},
|
|
1821
1841
|
"body": {},
|
|
1822
|
-
"result": "string"
|
|
1842
|
+
"result": "string",
|
|
1843
|
+
"result_correlation_id": "string"
|
|
1823
1844
|
},
|
|
1824
1845
|
"resolved": {
|
|
1825
1846
|
"result": "string",
|
|
1847
|
+
"result_correlation_id": "string",
|
|
1826
1848
|
"error_message_path": "error.message"
|
|
1827
1849
|
},
|
|
1828
1850
|
"use_static_ips": false,
|
|
@@ -2050,10 +2072,12 @@ const { data } = await client.getPortalExtensionsV3({
|
|
|
2050
2072
|
"params": {},
|
|
2051
2073
|
"headers": {},
|
|
2052
2074
|
"body": {},
|
|
2053
|
-
"result": "string"
|
|
2075
|
+
"result": "string",
|
|
2076
|
+
"result_correlation_id": "string"
|
|
2054
2077
|
},
|
|
2055
2078
|
"resolved": {
|
|
2056
2079
|
"result": "string",
|
|
2080
|
+
"result_correlation_id": "string",
|
|
2057
2081
|
"error_message_path": "error.message"
|
|
2058
2082
|
},
|
|
2059
2083
|
"use_static_ips": false,
|
|
@@ -2608,10 +2632,13 @@ const { data } = await client.getPublicPortalConfig({
|
|
|
2608
2632
|
"feature_settings": {
|
|
2609
2633
|
"start_page": true,
|
|
2610
2634
|
"billing": true,
|
|
2635
|
+
"commodity_billing": true,
|
|
2611
2636
|
"change_due_date": true,
|
|
2612
2637
|
"new_design": true,
|
|
2613
2638
|
"mcp_enabled": true,
|
|
2614
|
-
"mcp_grant_version": 0
|
|
2639
|
+
"mcp_grant_version": 0,
|
|
2640
|
+
"portal_copilot": false,
|
|
2641
|
+
"portal_copilot_agent_id": "string"
|
|
2615
2642
|
},
|
|
2616
2643
|
"accessToken": "string",
|
|
2617
2644
|
"advanced_mfa": {
|
|
@@ -2899,10 +2926,13 @@ const { data } = await client.getOrgPortalConfig({
|
|
|
2899
2926
|
"feature_settings": {
|
|
2900
2927
|
"start_page": true,
|
|
2901
2928
|
"billing": true,
|
|
2929
|
+
"commodity_billing": true,
|
|
2902
2930
|
"change_due_date": true,
|
|
2903
2931
|
"new_design": true,
|
|
2904
2932
|
"mcp_enabled": true,
|
|
2905
|
-
"mcp_grant_version": 0
|
|
2933
|
+
"mcp_grant_version": 0,
|
|
2934
|
+
"portal_copilot": false,
|
|
2935
|
+
"portal_copilot_agent_id": "string"
|
|
2906
2936
|
},
|
|
2907
2937
|
"accessToken": "string",
|
|
2908
2938
|
"advanced_mfa": {
|
|
@@ -3199,10 +3229,13 @@ const { data } = await client.getPublicPortalConfigV3({
|
|
|
3199
3229
|
"feature_settings": {
|
|
3200
3230
|
"start_page": true,
|
|
3201
3231
|
"billing": true,
|
|
3232
|
+
"commodity_billing": true,
|
|
3202
3233
|
"change_due_date": true,
|
|
3203
3234
|
"new_design": true,
|
|
3204
3235
|
"mcp_enabled": true,
|
|
3205
|
-
"mcp_grant_version": 0
|
|
3236
|
+
"mcp_grant_version": 0,
|
|
3237
|
+
"portal_copilot": false,
|
|
3238
|
+
"portal_copilot_agent_id": "string"
|
|
3206
3239
|
},
|
|
3207
3240
|
"accessToken": "string",
|
|
3208
3241
|
"advanced_mfa": {
|
|
@@ -3490,10 +3523,13 @@ const { data } = await client.getOrgPortalConfigV3({
|
|
|
3490
3523
|
"feature_settings": {
|
|
3491
3524
|
"start_page": true,
|
|
3492
3525
|
"billing": true,
|
|
3526
|
+
"commodity_billing": true,
|
|
3493
3527
|
"change_due_date": true,
|
|
3494
3528
|
"new_design": true,
|
|
3495
3529
|
"mcp_enabled": true,
|
|
3496
|
-
"mcp_grant_version": 0
|
|
3530
|
+
"mcp_grant_version": 0,
|
|
3531
|
+
"portal_copilot": false,
|
|
3532
|
+
"portal_copilot_agent_id": "string"
|
|
3497
3533
|
},
|
|
3498
3534
|
"accessToken": "string",
|
|
3499
3535
|
"advanced_mfa": {
|
|
@@ -4831,7 +4867,8 @@ const { data } = await client.checkContactExists(
|
|
|
4831
4867
|
contract_number: '123456'
|
|
4832
4868
|
}
|
|
4833
4869
|
},
|
|
4834
|
-
trigger_identifiers_check: true
|
|
4870
|
+
trigger_identifiers_check: true,
|
|
4871
|
+
correlation_id: '0199c0d5-6f1c-7a3b-9e21-9a9ce1d1b2c3'
|
|
4835
4872
|
},
|
|
4836
4873
|
)
|
|
4837
4874
|
```
|
|
@@ -4876,7 +4913,8 @@ const { data } = await client.checkContactExistsV3(
|
|
|
4876
4913
|
contract_number: '123456'
|
|
4877
4914
|
}
|
|
4878
4915
|
},
|
|
4879
|
-
trigger_identifiers_check: true
|
|
4916
|
+
trigger_identifiers_check: true,
|
|
4917
|
+
correlation_id: '0199c0d5-6f1c-7a3b-9e21-9a9ce1d1b2c3'
|
|
4880
4918
|
},
|
|
4881
4919
|
)
|
|
4882
4920
|
```
|
|
@@ -4889,7 +4927,9 @@ const { data } = await client.checkContactExistsV3(
|
|
|
4889
4927
|
"exists": true,
|
|
4890
4928
|
"contactId": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
4891
4929
|
"accountId": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
4892
|
-
"reason": "TIMEOUT"
|
|
4930
|
+
"reason": "TIMEOUT",
|
|
4931
|
+
"correlation_id": "string",
|
|
4932
|
+
"message": "string"
|
|
4893
4933
|
}
|
|
4894
4934
|
```
|
|
4895
4935
|
|
|
@@ -4921,6 +4961,7 @@ const { data } = await client.identifyContact(
|
|
|
4921
4961
|
}
|
|
4922
4962
|
},
|
|
4923
4963
|
trigger_identifiers_check: true,
|
|
4964
|
+
correlation_id: '0199c0d5-6f1c-7a3b-9e21-9a9ce1d1b2c3',
|
|
4924
4965
|
surface_id: 'website-journeys'
|
|
4925
4966
|
},
|
|
4926
4967
|
)
|
|
@@ -4938,7 +4979,9 @@ const { data } = await client.identifyContact(
|
|
|
4938
4979
|
"surface_id": "website-journeys",
|
|
4939
4980
|
"expires_at": "2026-08-11T10:35:00.000Z",
|
|
4940
4981
|
"allowed_operations": [],
|
|
4941
|
-
"
|
|
4982
|
+
"has_portal_user": false,
|
|
4983
|
+
"reason": "TIMEOUT",
|
|
4984
|
+
"correlation_id": "string"
|
|
4942
4985
|
}
|
|
4943
4986
|
```
|
|
4944
4987
|
|
|
@@ -5638,7 +5681,9 @@ Self-assign contract(s) by pre-configured identifiers.
|
|
|
5638
5681
|
|
|
5639
5682
|
```ts
|
|
5640
5683
|
const { data } = await client.addContractByIdentifiers(
|
|
5641
|
-
|
|
5684
|
+
{
|
|
5685
|
+
correlation_id: 'example',
|
|
5686
|
+
},
|
|
5642
5687
|
{
|
|
5643
5688
|
contract: {
|
|
5644
5689
|
contract_number: '123456'
|
|
@@ -8287,6 +8332,38 @@ const { data } = await client.getUserEntryPoint({
|
|
|
8287
8332
|
|
|
8288
8333
|
---
|
|
8289
8334
|
|
|
8335
|
+
### `completeTemporaryPassword`
|
|
8336
|
+
|
|
8337
|
+
Replaces a portal user's temporary password with the password they chose.
|
|
8338
|
+
|
|
8339
|
+
`POST /v3/portal/public/user/temporary-password/complete`
|
|
8340
|
+
|
|
8341
|
+
```ts
|
|
8342
|
+
const { data } = await client.completeTemporaryPassword(
|
|
8343
|
+
null,
|
|
8344
|
+
{
|
|
8345
|
+
org_id: '123',
|
|
8346
|
+
portal_id: '7hj28akg-97fb-4f5c-b2a1-3e4fbc1d8c7a',
|
|
8347
|
+
email: 'user@example.com',
|
|
8348
|
+
temporary_password: 'string',
|
|
8349
|
+
new_password: 'string'
|
|
8350
|
+
},
|
|
8351
|
+
)
|
|
8352
|
+
```
|
|
8353
|
+
|
|
8354
|
+
<details>
|
|
8355
|
+
<summary>Response</summary>
|
|
8356
|
+
|
|
8357
|
+
```json
|
|
8358
|
+
{
|
|
8359
|
+
"message": "Password set successfully."
|
|
8360
|
+
}
|
|
8361
|
+
```
|
|
8362
|
+
|
|
8363
|
+
</details>
|
|
8364
|
+
|
|
8365
|
+
---
|
|
8366
|
+
|
|
8290
8367
|
### `updateCampaignPortalBlockStatus`
|
|
8291
8368
|
|
|
8292
8369
|
Updates the status of a campaign portal block for multiple recipients.
|
|
@@ -8596,10 +8673,13 @@ const { data } = await client.createPortalConfig(
|
|
|
8596
8673
|
feature_settings: {
|
|
8597
8674
|
start_page: true,
|
|
8598
8675
|
billing: true,
|
|
8676
|
+
commodity_billing: true,
|
|
8599
8677
|
change_due_date: true,
|
|
8600
8678
|
new_design: true,
|
|
8601
8679
|
mcp_enabled: true,
|
|
8602
|
-
mcp_grant_version: 0
|
|
8680
|
+
mcp_grant_version: 0,
|
|
8681
|
+
portal_copilot: false,
|
|
8682
|
+
portal_copilot_agent_id: 'string'
|
|
8603
8683
|
},
|
|
8604
8684
|
accessToken: 'string',
|
|
8605
8685
|
advanced_mfa: {
|
|
@@ -8889,10 +8969,13 @@ const { data } = await client.createPortalConfig(
|
|
|
8889
8969
|
"feature_settings": {
|
|
8890
8970
|
"start_page": true,
|
|
8891
8971
|
"billing": true,
|
|
8972
|
+
"commodity_billing": true,
|
|
8892
8973
|
"change_due_date": true,
|
|
8893
8974
|
"new_design": true,
|
|
8894
8975
|
"mcp_enabled": true,
|
|
8895
|
-
"mcp_grant_version": 0
|
|
8976
|
+
"mcp_grant_version": 0,
|
|
8977
|
+
"portal_copilot": false,
|
|
8978
|
+
"portal_copilot_agent_id": "string"
|
|
8896
8979
|
},
|
|
8897
8980
|
"accessToken": "string",
|
|
8898
8981
|
"advanced_mfa": {
|
|
@@ -9217,10 +9300,13 @@ const { data } = await client.getPortalConfigV3({
|
|
|
9217
9300
|
"feature_settings": {
|
|
9218
9301
|
"start_page": true,
|
|
9219
9302
|
"billing": true,
|
|
9303
|
+
"commodity_billing": true,
|
|
9220
9304
|
"change_due_date": true,
|
|
9221
9305
|
"new_design": true,
|
|
9222
9306
|
"mcp_enabled": true,
|
|
9223
|
-
"mcp_grant_version": 0
|
|
9307
|
+
"mcp_grant_version": 0,
|
|
9308
|
+
"portal_copilot": false,
|
|
9309
|
+
"portal_copilot_agent_id": "string"
|
|
9224
9310
|
},
|
|
9225
9311
|
"accessToken": "string",
|
|
9226
9312
|
"advanced_mfa": {
|
|
@@ -9541,10 +9627,13 @@ const { data } = await client.putPortalConfig(
|
|
|
9541
9627
|
feature_settings: {
|
|
9542
9628
|
start_page: true,
|
|
9543
9629
|
billing: true,
|
|
9630
|
+
commodity_billing: true,
|
|
9544
9631
|
change_due_date: true,
|
|
9545
9632
|
new_design: true,
|
|
9546
9633
|
mcp_enabled: true,
|
|
9547
|
-
mcp_grant_version: 0
|
|
9634
|
+
mcp_grant_version: 0,
|
|
9635
|
+
portal_copilot: false,
|
|
9636
|
+
portal_copilot_agent_id: 'string'
|
|
9548
9637
|
},
|
|
9549
9638
|
accessToken: 'string',
|
|
9550
9639
|
advanced_mfa: {
|
|
@@ -9855,10 +9944,13 @@ const { data } = await client.putPortalConfig(
|
|
|
9855
9944
|
"feature_settings": {
|
|
9856
9945
|
"start_page": true,
|
|
9857
9946
|
"billing": true,
|
|
9947
|
+
"commodity_billing": true,
|
|
9858
9948
|
"change_due_date": true,
|
|
9859
9949
|
"new_design": true,
|
|
9860
9950
|
"mcp_enabled": true,
|
|
9861
|
-
"mcp_grant_version": 0
|
|
9951
|
+
"mcp_grant_version": 0,
|
|
9952
|
+
"portal_copilot": false,
|
|
9953
|
+
"portal_copilot_agent_id": "string"
|
|
9862
9954
|
},
|
|
9863
9955
|
"accessToken": "string",
|
|
9864
9956
|
"advanced_mfa": {
|
|
@@ -10194,10 +10286,13 @@ const { data } = await client.createPortalRevision(
|
|
|
10194
10286
|
feature_settings: {
|
|
10195
10287
|
start_page: true,
|
|
10196
10288
|
billing: true,
|
|
10289
|
+
commodity_billing: true,
|
|
10197
10290
|
change_due_date: true,
|
|
10198
10291
|
new_design: true,
|
|
10199
10292
|
mcp_enabled: true,
|
|
10200
|
-
mcp_grant_version: 0
|
|
10293
|
+
mcp_grant_version: 0,
|
|
10294
|
+
portal_copilot: false,
|
|
10295
|
+
portal_copilot_agent_id: 'string'
|
|
10201
10296
|
},
|
|
10202
10297
|
accessToken: 'string',
|
|
10203
10298
|
advanced_mfa: {
|
|
@@ -10370,6 +10465,10 @@ const { data } = await client.createPortalRevision(
|
|
|
10370
10465
|
origin: 'string',
|
|
10371
10466
|
global_blocks: {},
|
|
10372
10467
|
based_on_revision_id: 'string',
|
|
10468
|
+
revision_source: {
|
|
10469
|
+
type: 'blueprint_sync',
|
|
10470
|
+
blueprint_title: 'string'
|
|
10471
|
+
},
|
|
10373
10472
|
pages: [
|
|
10374
10473
|
{
|
|
10375
10474
|
id: 'c495fef9-eeca-4019-a989-8390dcd9825b',
|
|
@@ -10392,6 +10491,10 @@ const { data } = await client.createPortalRevision(
|
|
|
10392
10491
|
"created_by": "string",
|
|
10393
10492
|
"name": "FAQ page launch",
|
|
10394
10493
|
"description": "string",
|
|
10494
|
+
"source": {
|
|
10495
|
+
"type": "blueprint_sync",
|
|
10496
|
+
"blueprint_title": "string"
|
|
10497
|
+
},
|
|
10395
10498
|
"page_count": 0,
|
|
10396
10499
|
"published_at": "1970-01-01T00:00:00.000Z",
|
|
10397
10500
|
"published_by": "string",
|
|
@@ -10500,6 +10603,10 @@ const { data } = await client.listPortalRevisions({
|
|
|
10500
10603
|
"created_by": "string",
|
|
10501
10604
|
"name": "FAQ page launch",
|
|
10502
10605
|
"description": "string",
|
|
10606
|
+
"source": {
|
|
10607
|
+
"type": "blueprint_sync",
|
|
10608
|
+
"blueprint_title": "string"
|
|
10609
|
+
},
|
|
10503
10610
|
"page_count": 0,
|
|
10504
10611
|
"published_at": "1970-01-01T00:00:00.000Z",
|
|
10505
10612
|
"published_by": "string",
|
|
@@ -10537,6 +10644,10 @@ const { data } = await client.getPortalRevision({
|
|
|
10537
10644
|
"created_by": "string",
|
|
10538
10645
|
"name": "FAQ page launch",
|
|
10539
10646
|
"description": "string",
|
|
10647
|
+
"source": {
|
|
10648
|
+
"type": "blueprint_sync",
|
|
10649
|
+
"blueprint_title": "string"
|
|
10650
|
+
},
|
|
10540
10651
|
"page_count": 0,
|
|
10541
10652
|
"published_at": "1970-01-01T00:00:00.000Z",
|
|
10542
10653
|
"published_by": "string",
|
|
@@ -10604,6 +10715,49 @@ const { data } = await client.getPortalRevision({
|
|
|
10604
10715
|
|
|
10605
10716
|
---
|
|
10606
10717
|
|
|
10718
|
+
### `updatePortalRevision`
|
|
10719
|
+
|
|
10720
|
+
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
|
|
10721
|
+
|
|
10722
|
+
`PATCH /v3/portal/config/{portal_id}/revisions/{revision_id}`
|
|
10723
|
+
|
|
10724
|
+
```ts
|
|
10725
|
+
const { data } = await client.updatePortalRevision(
|
|
10726
|
+
{
|
|
10727
|
+
portal_id: 'example',
|
|
10728
|
+
revision_id: 'example',
|
|
10729
|
+
},
|
|
10730
|
+
{
|
|
10731
|
+
name: 'FAQ page launch'
|
|
10732
|
+
},
|
|
10733
|
+
)
|
|
10734
|
+
```
|
|
10735
|
+
|
|
10736
|
+
<details>
|
|
10737
|
+
<summary>Response</summary>
|
|
10738
|
+
|
|
10739
|
+
```json
|
|
10740
|
+
{
|
|
10741
|
+
"revision_id": "2026-08-25T14:03:11.482Z-a7f3c1d9",
|
|
10742
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
10743
|
+
"created_by": "string",
|
|
10744
|
+
"name": "FAQ page launch",
|
|
10745
|
+
"description": "string",
|
|
10746
|
+
"source": {
|
|
10747
|
+
"type": "blueprint_sync",
|
|
10748
|
+
"blueprint_title": "string"
|
|
10749
|
+
},
|
|
10750
|
+
"page_count": 0,
|
|
10751
|
+
"published_at": "1970-01-01T00:00:00.000Z",
|
|
10752
|
+
"published_by": "string",
|
|
10753
|
+
"is_published": true
|
|
10754
|
+
}
|
|
10755
|
+
```
|
|
10756
|
+
|
|
10757
|
+
</details>
|
|
10758
|
+
|
|
10759
|
+
---
|
|
10760
|
+
|
|
10607
10761
|
### `publishPortalRevision`
|
|
10608
10762
|
|
|
10609
10763
|
Makes one revision the portal's live configuration, atomically: either everything below takes effect or nothing does. Publish is a full-snapshot replace: it writes config, every page and email templat
|
|
@@ -10774,10 +10928,13 @@ const { data } = await client.listPortalConfigSummaries()
|
|
|
10774
10928
|
"feature_settings": {
|
|
10775
10929
|
"start_page": true,
|
|
10776
10930
|
"billing": true,
|
|
10931
|
+
"commodity_billing": true,
|
|
10777
10932
|
"change_due_date": true,
|
|
10778
10933
|
"new_design": true,
|
|
10779
10934
|
"mcp_enabled": true,
|
|
10780
|
-
"mcp_grant_version": 0
|
|
10935
|
+
"mcp_grant_version": 0,
|
|
10936
|
+
"portal_copilot": false,
|
|
10937
|
+
"portal_copilot_agent_id": "string"
|
|
10781
10938
|
},
|
|
10782
10939
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
10783
10940
|
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
@@ -10834,7 +10991,7 @@ const { data } = await client.listPortalConfigSummaries()
|
|
|
10834
10991
|
|
|
10835
10992
|
### `swapPortalConfig`
|
|
10836
10993
|
|
|
10837
|
-
Swaps the portal configuration of two portals.
|
|
10994
|
+
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 so
|
|
10838
10995
|
|
|
10839
10996
|
`POST /v3/portal/config/swap`
|
|
10840
10997
|
|
|
@@ -10844,7 +11001,8 @@ const { data } = await client.swapPortalConfig(
|
|
|
10844
11001
|
{
|
|
10845
11002
|
source_portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
10846
11003
|
target_portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
10847
|
-
items_to_swap: ['email_templates']
|
|
11004
|
+
items_to_swap: ['email_templates'],
|
|
11005
|
+
mode: 'copy'
|
|
10848
11006
|
},
|
|
10849
11007
|
)
|
|
10850
11008
|
```
|
|
@@ -10854,7 +11012,53 @@ const { data } = await client.swapPortalConfig(
|
|
|
10854
11012
|
|
|
10855
11013
|
```json
|
|
10856
11014
|
{
|
|
10857
|
-
"message": "Domain and users swapped successfully."
|
|
11015
|
+
"message": "Domain and users swapped successfully.",
|
|
11016
|
+
"portal_references": {
|
|
11017
|
+
"journeys": {
|
|
11018
|
+
"updated": [
|
|
11019
|
+
{
|
|
11020
|
+
"id": "string",
|
|
11021
|
+
"name": "string",
|
|
11022
|
+
"paths": ["steps[0].uischema.elements[2].options.portalId"],
|
|
11023
|
+
"error": "string"
|
|
11024
|
+
}
|
|
11025
|
+
],
|
|
11026
|
+
"failed": [
|
|
11027
|
+
{
|
|
11028
|
+
"id": "string",
|
|
11029
|
+
"name": "string",
|
|
11030
|
+
"paths": ["steps[0].uischema.elements[2].options.portalId"],
|
|
11031
|
+
"error": "string"
|
|
11032
|
+
}
|
|
11033
|
+
],
|
|
11034
|
+
"list_error": "string"
|
|
11035
|
+
},
|
|
11036
|
+
"automation_flows": {
|
|
11037
|
+
"updated": [
|
|
11038
|
+
{
|
|
11039
|
+
"id": "string",
|
|
11040
|
+
"name": "string",
|
|
11041
|
+
"paths": ["steps[0].uischema.elements[2].options.portalId"],
|
|
11042
|
+
"error": "string"
|
|
11043
|
+
}
|
|
11044
|
+
],
|
|
11045
|
+
"failed": [
|
|
11046
|
+
{
|
|
11047
|
+
"id": "string",
|
|
11048
|
+
"name": "string",
|
|
11049
|
+
"paths": ["steps[0].uischema.elements[2].options.portalId"],
|
|
11050
|
+
"error": "string"
|
|
11051
|
+
}
|
|
11052
|
+
],
|
|
11053
|
+
"list_error": "string"
|
|
11054
|
+
}
|
|
11055
|
+
},
|
|
11056
|
+
"revisions": [
|
|
11057
|
+
{
|
|
11058
|
+
"portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
11059
|
+
"revision_id": "string"
|
|
11060
|
+
}
|
|
11061
|
+
]
|
|
10858
11062
|
}
|
|
10859
11063
|
```
|
|
10860
11064
|
|
|
@@ -10972,10 +11176,13 @@ const { data } = await client.clonePortalConfig(
|
|
|
10972
11176
|
"feature_settings": {
|
|
10973
11177
|
"start_page": true,
|
|
10974
11178
|
"billing": true,
|
|
11179
|
+
"commodity_billing": true,
|
|
10975
11180
|
"change_due_date": true,
|
|
10976
11181
|
"new_design": true,
|
|
10977
11182
|
"mcp_enabled": true,
|
|
10978
|
-
"mcp_grant_version": 0
|
|
11183
|
+
"mcp_grant_version": 0,
|
|
11184
|
+
"portal_copilot": false,
|
|
11185
|
+
"portal_copilot_agent_id": "string"
|
|
10979
11186
|
},
|
|
10980
11187
|
"accessToken": "string",
|
|
10981
11188
|
"advanced_mfa": {
|
|
@@ -11951,6 +12158,15 @@ type UpdateOnlyPortalConfigAttributes = {
|
|
|
11951
12158
|
app_id: string
|
|
11952
12159
|
extension_id: string
|
|
11953
12160
|
hook_id: string
|
|
12161
|
+
wait_for_toolkit?: boolean
|
|
12162
|
+
wait_for_entities?: Record<string, {
|
|
12163
|
+
key?: { ... }
|
|
12164
|
+
from_identifier?: { ... }
|
|
12165
|
+
from_caller_contact?: { ... }
|
|
12166
|
+
split_on?: { ... }
|
|
12167
|
+
part?: { ... }
|
|
12168
|
+
}>
|
|
12169
|
+
wait_for_use_cases?: string[]
|
|
11954
12170
|
}>
|
|
11955
12171
|
default_user_to_notify?: {
|
|
11956
12172
|
onPendingUser?: Array<{
|
|
@@ -12059,10 +12275,13 @@ type CommonConfigAttributes = {
|
|
|
12059
12275
|
feature_settings?: {
|
|
12060
12276
|
start_page?: boolean
|
|
12061
12277
|
billing?: boolean
|
|
12278
|
+
commodity_billing?: boolean
|
|
12062
12279
|
change_due_date?: boolean
|
|
12063
12280
|
new_design?: boolean
|
|
12064
12281
|
mcp_enabled?: boolean
|
|
12065
12282
|
mcp_grant_version?: number
|
|
12283
|
+
portal_copilot?: boolean
|
|
12284
|
+
portal_copilot_agent_id?: string
|
|
12066
12285
|
}
|
|
12067
12286
|
accessToken?: string
|
|
12068
12287
|
advanced_mfa?: {
|
|
@@ -12098,9 +12317,6 @@ type CommonConfigAttributes = {
|
|
|
12098
12317
|
require_uppercase?: { ... }
|
|
12099
12318
|
require_numbers?: { ... }
|
|
12100
12319
|
require_symbols?: { ... }
|
|
12101
|
-
password_history_size?: { ... }
|
|
12102
|
-
}
|
|
12103
|
-
}
|
|
12104
12320
|
// ...
|
|
12105
12321
|
}
|
|
12106
12322
|
```
|
|
@@ -12137,6 +12353,15 @@ type UpsertPortalConfig = {
|
|
|
12137
12353
|
app_id: string
|
|
12138
12354
|
extension_id: string
|
|
12139
12355
|
hook_id: string
|
|
12356
|
+
wait_for_toolkit?: boolean
|
|
12357
|
+
wait_for_entities?: Record<string, {
|
|
12358
|
+
key?: { ... }
|
|
12359
|
+
from_identifier?: { ... }
|
|
12360
|
+
from_caller_contact?: { ... }
|
|
12361
|
+
split_on?: { ... }
|
|
12362
|
+
part?: { ... }
|
|
12363
|
+
}>
|
|
12364
|
+
wait_for_use_cases?: string[]
|
|
12140
12365
|
}>
|
|
12141
12366
|
default_user_to_notify?: {
|
|
12142
12367
|
onPendingUser?: Array<{
|
|
@@ -12210,15 +12435,6 @@ type UpsertPortalConfig = {
|
|
|
12210
12435
|
store_url?: { ... }
|
|
12211
12436
|
last_build?: { ... }
|
|
12212
12437
|
}
|
|
12213
|
-
ota?: {
|
|
12214
|
-
enabled?: { ... }
|
|
12215
|
-
channel?: { ... }
|
|
12216
|
-
auto_update?: { ... }
|
|
12217
|
-
update_strategy?: { ... }
|
|
12218
|
-
min_native_version?: { ... }
|
|
12219
|
-
}
|
|
12220
|
-
}
|
|
12221
|
-
enabled?: boolean
|
|
12222
12438
|
// ...
|
|
12223
12439
|
}
|
|
12224
12440
|
```
|
|
@@ -12284,10 +12500,13 @@ type PortalConfig = {
|
|
|
12284
12500
|
feature_settings?: {
|
|
12285
12501
|
start_page?: boolean
|
|
12286
12502
|
billing?: boolean
|
|
12503
|
+
commodity_billing?: boolean
|
|
12287
12504
|
change_due_date?: boolean
|
|
12288
12505
|
new_design?: boolean
|
|
12289
12506
|
mcp_enabled?: boolean
|
|
12290
12507
|
mcp_grant_version?: number
|
|
12508
|
+
portal_copilot?: boolean
|
|
12509
|
+
portal_copilot_agent_id?: string
|
|
12291
12510
|
}
|
|
12292
12511
|
accessToken?: string
|
|
12293
12512
|
advanced_mfa?: {
|
|
@@ -12323,9 +12542,6 @@ type PortalConfig = {
|
|
|
12323
12542
|
require_uppercase?: { ... }
|
|
12324
12543
|
require_numbers?: { ... }
|
|
12325
12544
|
require_symbols?: { ... }
|
|
12326
|
-
password_history_size?: { ... }
|
|
12327
|
-
}
|
|
12328
|
-
}
|
|
12329
12545
|
// ...
|
|
12330
12546
|
}
|
|
12331
12547
|
```
|
|
@@ -12795,6 +13011,7 @@ type ContactExistsRequest = {
|
|
|
12795
13011
|
org_id: string
|
|
12796
13012
|
registration_identifiers: Record<string, Record<string, string>>
|
|
12797
13013
|
trigger_identifiers_check?: boolean
|
|
13014
|
+
correlation_id?: string
|
|
12798
13015
|
}
|
|
12799
13016
|
```
|
|
12800
13017
|
|
|
@@ -12808,6 +13025,7 @@ type ContactIdentifyRequest = {
|
|
|
12808
13025
|
org_id: string
|
|
12809
13026
|
registration_identifiers: Record<string, Record<string, string>>
|
|
12810
13027
|
trigger_identifiers_check?: boolean
|
|
13028
|
+
correlation_id?: string
|
|
12811
13029
|
surface_id: string
|
|
12812
13030
|
}
|
|
12813
13031
|
```
|
|
@@ -12823,7 +13041,9 @@ type ContactIdentifyResponse = {
|
|
|
12823
13041
|
surface_id?: string
|
|
12824
13042
|
expires_at?: string // date-time
|
|
12825
13043
|
allowed_operations?: string[]
|
|
13044
|
+
has_portal_user?: boolean
|
|
12826
13045
|
reason?: "TIMEOUT" | "NOT_FOUND"
|
|
13046
|
+
correlation_id?: string
|
|
12827
13047
|
}
|
|
12828
13048
|
```
|
|
12829
13049
|
|
|
@@ -13618,7 +13838,7 @@ type JourneyContextUsagesResponse = {
|
|
|
13618
13838
|
status: "ok" | "partial"
|
|
13619
13839
|
scanned: number
|
|
13620
13840
|
usages: Array<{
|
|
13621
|
-
kind: "portal-config" | "portal-block"
|
|
13841
|
+
kind: "portal-config" | "portal-block"
|
|
13622
13842
|
resource: {
|
|
13623
13843
|
type: { ... }
|
|
13624
13844
|
id: { ... }
|
|
@@ -14225,6 +14445,33 @@ type ExtensionHookSelection = {
|
|
|
14225
14445
|
app_id: string
|
|
14226
14446
|
extension_id: string
|
|
14227
14447
|
hook_id: string
|
|
14448
|
+
wait_for_toolkit?: boolean
|
|
14449
|
+
wait_for_entities?: Record<string, {
|
|
14450
|
+
key?: string
|
|
14451
|
+
from_identifier?: string
|
|
14452
|
+
from_caller_contact?: string
|
|
14453
|
+
split_on?: string
|
|
14454
|
+
part?: number
|
|
14455
|
+
}>
|
|
14456
|
+
wait_for_use_cases?: string[]
|
|
14457
|
+
}
|
|
14458
|
+
```
|
|
14459
|
+
|
|
14460
|
+
### `WaitForEntityRule`
|
|
14461
|
+
|
|
14462
|
+
One requirement of a hook's correlation wait, for the entity slug it is configured under.
|
|
14463
|
+
|
|
14464
|
+
Without `key` the requirement is satisfied by any entity of that slug. That is safe for
|
|
14465
|
+
evidence, and for a linked slug only where the inbound use case writes exactly one entity
|
|
14466
|
+
of it per push - Wilken's `Busi
|
|
14467
|
+
|
|
14468
|
+
```ts
|
|
14469
|
+
type WaitForEntityRule = {
|
|
14470
|
+
key?: string
|
|
14471
|
+
from_identifier?: string
|
|
14472
|
+
from_caller_contact?: string
|
|
14473
|
+
split_on?: string
|
|
14474
|
+
part?: number
|
|
14228
14475
|
}
|
|
14229
14476
|
```
|
|
14230
14477
|
|
|
@@ -14631,9 +14878,11 @@ type ExtensionHookRegistrationIdentifiersCheck = {
|
|
|
14631
14878
|
headers: Record<string, string>
|
|
14632
14879
|
body?: object
|
|
14633
14880
|
result?: string
|
|
14881
|
+
result_correlation_id?: string
|
|
14634
14882
|
}
|
|
14635
14883
|
resolved?: {
|
|
14636
14884
|
result?: string
|
|
14885
|
+
result_correlation_id?: string
|
|
14637
14886
|
error_message_path?: string
|
|
14638
14887
|
}
|
|
14639
14888
|
use_static_ips?: boolean
|
|
@@ -14674,9 +14923,11 @@ type ExtensionHookContractIdentification = {
|
|
|
14674
14923
|
headers: Record<string, string>
|
|
14675
14924
|
body?: object
|
|
14676
14925
|
result?: string
|
|
14926
|
+
result_correlation_id?: string
|
|
14677
14927
|
}
|
|
14678
14928
|
resolved?: {
|
|
14679
14929
|
result?: string
|
|
14930
|
+
result_correlation_id?: string
|
|
14680
14931
|
error_message_path?: string
|
|
14681
14932
|
}
|
|
14682
14933
|
assignment_mode?: "contracts" | "contact_to_contracts" | "contact_to_portal_user"
|
|
@@ -15733,10 +15984,13 @@ type CommonConfigAttributesV3 = {
|
|
|
15733
15984
|
feature_settings?: {
|
|
15734
15985
|
start_page?: boolean
|
|
15735
15986
|
billing?: boolean
|
|
15987
|
+
commodity_billing?: boolean
|
|
15736
15988
|
change_due_date?: boolean
|
|
15737
15989
|
new_design?: boolean
|
|
15738
15990
|
mcp_enabled?: boolean
|
|
15739
15991
|
mcp_grant_version?: number
|
|
15992
|
+
portal_copilot?: boolean
|
|
15993
|
+
portal_copilot_agent_id?: string
|
|
15740
15994
|
}
|
|
15741
15995
|
accessToken?: string
|
|
15742
15996
|
advanced_mfa?: {
|
|
@@ -15772,9 +16026,6 @@ type CommonConfigAttributesV3 = {
|
|
|
15772
16026
|
require_uppercase?: { ... }
|
|
15773
16027
|
require_numbers?: { ... }
|
|
15774
16028
|
require_symbols?: { ... }
|
|
15775
|
-
password_history_size?: { ... }
|
|
15776
|
-
}
|
|
15777
|
-
}
|
|
15778
16029
|
// ...
|
|
15779
16030
|
}
|
|
15780
16031
|
```
|
|
@@ -15826,6 +16077,15 @@ type UpsertPortalConfigV3 = {
|
|
|
15826
16077
|
app_id: string
|
|
15827
16078
|
extension_id: string
|
|
15828
16079
|
hook_id: string
|
|
16080
|
+
wait_for_toolkit?: boolean
|
|
16081
|
+
wait_for_entities?: Record<string, {
|
|
16082
|
+
key?: { ... }
|
|
16083
|
+
from_identifier?: { ... }
|
|
16084
|
+
from_caller_contact?: { ... }
|
|
16085
|
+
split_on?: { ... }
|
|
16086
|
+
part?: { ... }
|
|
16087
|
+
}>
|
|
16088
|
+
wait_for_use_cases?: string[]
|
|
15829
16089
|
}>
|
|
15830
16090
|
default_user_to_notify?: {
|
|
15831
16091
|
onPendingUser?: Array<{
|
|
@@ -15899,15 +16159,6 @@ type UpsertPortalConfigV3 = {
|
|
|
15899
16159
|
store_url?: { ... }
|
|
15900
16160
|
last_build?: { ... }
|
|
15901
16161
|
}
|
|
15902
|
-
ota?: {
|
|
15903
|
-
enabled?: { ... }
|
|
15904
|
-
channel?: { ... }
|
|
15905
|
-
auto_update?: { ... }
|
|
15906
|
-
update_strategy?: { ... }
|
|
15907
|
-
min_native_version?: { ... }
|
|
15908
|
-
}
|
|
15909
|
-
}
|
|
15910
|
-
enabled?: boolean
|
|
15911
16162
|
// ...
|
|
15912
16163
|
}
|
|
15913
16164
|
```
|
|
@@ -15933,6 +16184,15 @@ type PortalConfigV3 = {
|
|
|
15933
16184
|
app_id: string
|
|
15934
16185
|
extension_id: string
|
|
15935
16186
|
hook_id: string
|
|
16187
|
+
wait_for_toolkit?: boolean
|
|
16188
|
+
wait_for_entities?: Record<string, {
|
|
16189
|
+
key?: { ... }
|
|
16190
|
+
from_identifier?: { ... }
|
|
16191
|
+
from_caller_contact?: { ... }
|
|
16192
|
+
split_on?: { ... }
|
|
16193
|
+
part?: { ... }
|
|
16194
|
+
}>
|
|
16195
|
+
wait_for_use_cases?: string[]
|
|
15936
16196
|
}>
|
|
15937
16197
|
default_user_to_notify?: {
|
|
15938
16198
|
onPendingUser?: Array<{
|
|
@@ -16006,15 +16266,6 @@ type PortalConfigV3 = {
|
|
|
16006
16266
|
domain?: string
|
|
16007
16267
|
is_epilot_domain?: boolean
|
|
16008
16268
|
epilot_domain?: string
|
|
16009
|
-
domain_settings?: {
|
|
16010
|
-
is_custom_domain_enabled?: boolean
|
|
16011
|
-
is_epilot_domain_enabled?: boolean
|
|
16012
|
-
is_redirection_enabled?: boolean
|
|
16013
|
-
}
|
|
16014
|
-
design_id?: string // uuid
|
|
16015
|
-
allowed_portal_entities?: string[]
|
|
16016
|
-
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
16017
|
-
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
16018
16269
|
// ...
|
|
16019
16270
|
}
|
|
16020
16271
|
```
|
|
@@ -16027,10 +16278,13 @@ Feature settings for the portal
|
|
|
16027
16278
|
type PortalFeatureSettings = {
|
|
16028
16279
|
start_page?: boolean
|
|
16029
16280
|
billing?: boolean
|
|
16281
|
+
commodity_billing?: boolean
|
|
16030
16282
|
change_due_date?: boolean
|
|
16031
16283
|
new_design?: boolean
|
|
16032
16284
|
mcp_enabled?: boolean
|
|
16033
16285
|
mcp_grant_version?: number
|
|
16286
|
+
portal_copilot?: boolean
|
|
16287
|
+
portal_copilot_agent_id?: string
|
|
16034
16288
|
}
|
|
16035
16289
|
```
|
|
16036
16290
|
|
|
@@ -16072,10 +16326,13 @@ type PortalConfigSummaryV3 = {
|
|
|
16072
16326
|
feature_settings?: {
|
|
16073
16327
|
start_page?: boolean
|
|
16074
16328
|
billing?: boolean
|
|
16329
|
+
commodity_billing?: boolean
|
|
16075
16330
|
change_due_date?: boolean
|
|
16076
16331
|
new_design?: boolean
|
|
16077
16332
|
mcp_enabled?: boolean
|
|
16078
16333
|
mcp_grant_version?: number
|
|
16334
|
+
portal_copilot?: boolean
|
|
16335
|
+
portal_copilot_agent_id?: string
|
|
16079
16336
|
}
|
|
16080
16337
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
16081
16338
|
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
@@ -16117,6 +16374,10 @@ type JuiceSettings = {
|
|
|
16117
16374
|
is_canary?: boolean
|
|
16118
16375
|
is_legacy_design?: boolean
|
|
16119
16376
|
redirect_to?: string
|
|
16377
|
+
title?: string
|
|
16378
|
+
prevent_indexing?: boolean
|
|
16379
|
+
organization_id?: string
|
|
16380
|
+
design_id?: string
|
|
16120
16381
|
}
|
|
16121
16382
|
```
|
|
16122
16383
|
|
|
@@ -16155,6 +16416,15 @@ type PortalRevisionRequest = {
|
|
|
16155
16416
|
app_id: string
|
|
16156
16417
|
extension_id: string
|
|
16157
16418
|
hook_id: string
|
|
16419
|
+
wait_for_toolkit?: boolean
|
|
16420
|
+
wait_for_entities?: Record<string, {
|
|
16421
|
+
key?: { ... }
|
|
16422
|
+
from_identifier?: { ... }
|
|
16423
|
+
from_caller_contact?: { ... }
|
|
16424
|
+
split_on?: { ... }
|
|
16425
|
+
part?: { ... }
|
|
16426
|
+
}>
|
|
16427
|
+
wait_for_use_cases?: string[]
|
|
16158
16428
|
}>
|
|
16159
16429
|
default_user_to_notify?: {
|
|
16160
16430
|
onPendingUser?: Array<{
|
|
@@ -16228,15 +16498,6 @@ type PortalRevisionRequest = {
|
|
|
16228
16498
|
store_url?: { ... }
|
|
16229
16499
|
last_build?: { ... }
|
|
16230
16500
|
}
|
|
16231
|
-
ota?: {
|
|
16232
|
-
enabled?: { ... }
|
|
16233
|
-
channel?: { ... }
|
|
16234
|
-
auto_update?: { ... }
|
|
16235
|
-
update_strategy?: { ... }
|
|
16236
|
-
min_native_version?: { ... }
|
|
16237
|
-
}
|
|
16238
|
-
}
|
|
16239
|
-
enabled?: boolean
|
|
16240
16501
|
// ...
|
|
16241
16502
|
}
|
|
16242
16503
|
```
|
|
@@ -16251,6 +16512,26 @@ type PublishRevisionRequest = {
|
|
|
16251
16512
|
}
|
|
16252
16513
|
```
|
|
16253
16514
|
|
|
16515
|
+
### `UpdatePortalRevisionRequest`
|
|
16516
|
+
|
|
16517
|
+
```ts
|
|
16518
|
+
type UpdatePortalRevisionRequest = {
|
|
16519
|
+
name: string
|
|
16520
|
+
}
|
|
16521
|
+
```
|
|
16522
|
+
|
|
16523
|
+
### `RevisionSource`
|
|
16524
|
+
|
|
16525
|
+
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.
|
|
16526
|
+
|
|
16527
|
+
|
|
16528
|
+
```ts
|
|
16529
|
+
type RevisionSource = {
|
|
16530
|
+
type: "blueprint_sync"
|
|
16531
|
+
blueprint_title?: string
|
|
16532
|
+
}
|
|
16533
|
+
```
|
|
16534
|
+
|
|
16254
16535
|
### `PortalRevisionSummary`
|
|
16255
16536
|
|
|
16256
16537
|
```ts
|
|
@@ -16260,6 +16541,10 @@ type PortalRevisionSummary = {
|
|
|
16260
16541
|
created_by?: string
|
|
16261
16542
|
name?: string
|
|
16262
16543
|
description?: string
|
|
16544
|
+
source?: {
|
|
16545
|
+
type: "blueprint_sync"
|
|
16546
|
+
blueprint_title?: string
|
|
16547
|
+
}
|
|
16263
16548
|
page_count: number
|
|
16264
16549
|
published_at?: string // date-time
|
|
16265
16550
|
published_by?: string
|
|
@@ -16277,6 +16562,10 @@ type PortalRevisionList = {
|
|
|
16277
16562
|
created_by?: string
|
|
16278
16563
|
name?: string
|
|
16279
16564
|
description?: string
|
|
16565
|
+
source?: {
|
|
16566
|
+
type: { ... }
|
|
16567
|
+
blueprint_title?: { ... }
|
|
16568
|
+
}
|
|
16280
16569
|
page_count: number
|
|
16281
16570
|
published_at?: string // date-time
|
|
16282
16571
|
published_by?: string
|
|
@@ -16295,6 +16584,10 @@ type PortalRevisionCreated = {
|
|
|
16295
16584
|
created_by?: string
|
|
16296
16585
|
name?: string
|
|
16297
16586
|
description?: string
|
|
16587
|
+
source?: {
|
|
16588
|
+
type: "blueprint_sync"
|
|
16589
|
+
blueprint_title?: string
|
|
16590
|
+
}
|
|
16298
16591
|
page_count: number
|
|
16299
16592
|
published_at?: string // date-time
|
|
16300
16593
|
published_by?: string
|
|
@@ -16354,6 +16647,10 @@ type PortalRevision = {
|
|
|
16354
16647
|
created_by?: string
|
|
16355
16648
|
name?: string
|
|
16356
16649
|
description?: string
|
|
16650
|
+
source?: {
|
|
16651
|
+
type: "blueprint_sync"
|
|
16652
|
+
blueprint_title?: string
|
|
16653
|
+
}
|
|
16357
16654
|
page_count: number
|
|
16358
16655
|
published_at?: string // date-time
|
|
16359
16656
|
published_by?: string
|
|
@@ -16432,7 +16729,77 @@ type PublishResult = {
|
|
|
16432
16729
|
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,
|
|
16433
16730
|
|
|
16434
16731
|
```ts
|
|
16435
|
-
type SwappableConfig = "email_templates"
|
|
16732
|
+
type SwappableConfig = "email_templates" | "portal_references"
|
|
16733
|
+
```
|
|
16734
|
+
|
|
16735
|
+
### `SwapPortalReferencesResult`
|
|
16736
|
+
|
|
16737
|
+
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.
|
|
16738
|
+
|
|
16739
|
+
```ts
|
|
16740
|
+
type SwapPortalReferencesResult = {
|
|
16741
|
+
journeys: {
|
|
16742
|
+
updated: Array<{
|
|
16743
|
+
id: { ... }
|
|
16744
|
+
name?: { ... }
|
|
16745
|
+
paths?: { ... }
|
|
16746
|
+
error?: { ... }
|
|
16747
|
+
}>
|
|
16748
|
+
failed: Array<{
|
|
16749
|
+
id: { ... }
|
|
16750
|
+
name?: { ... }
|
|
16751
|
+
paths?: { ... }
|
|
16752
|
+
error?: { ... }
|
|
16753
|
+
}>
|
|
16754
|
+
list_error?: string
|
|
16755
|
+
}
|
|
16756
|
+
automation_flows: {
|
|
16757
|
+
updated: Array<{
|
|
16758
|
+
id: { ... }
|
|
16759
|
+
name?: { ... }
|
|
16760
|
+
paths?: { ... }
|
|
16761
|
+
error?: { ... }
|
|
16762
|
+
}>
|
|
16763
|
+
failed: Array<{
|
|
16764
|
+
id: { ... }
|
|
16765
|
+
name?: { ... }
|
|
16766
|
+
paths?: { ... }
|
|
16767
|
+
error?: { ... }
|
|
16768
|
+
}>
|
|
16769
|
+
list_error?: string
|
|
16770
|
+
}
|
|
16771
|
+
}
|
|
16772
|
+
```
|
|
16773
|
+
|
|
16774
|
+
### `SwapPortalReferenceGroup`
|
|
16775
|
+
|
|
16776
|
+
```ts
|
|
16777
|
+
type SwapPortalReferenceGroup = {
|
|
16778
|
+
updated: Array<{
|
|
16779
|
+
id: string
|
|
16780
|
+
name?: string
|
|
16781
|
+
paths?: string[]
|
|
16782
|
+
error?: string
|
|
16783
|
+
}>
|
|
16784
|
+
failed: Array<{
|
|
16785
|
+
id: string
|
|
16786
|
+
name?: string
|
|
16787
|
+
paths?: string[]
|
|
16788
|
+
error?: string
|
|
16789
|
+
}>
|
|
16790
|
+
list_error?: string
|
|
16791
|
+
}
|
|
16792
|
+
```
|
|
16793
|
+
|
|
16794
|
+
### `SwapPortalReferenceItem`
|
|
16795
|
+
|
|
16796
|
+
```ts
|
|
16797
|
+
type SwapPortalReferenceItem = {
|
|
16798
|
+
id: string
|
|
16799
|
+
name?: string
|
|
16800
|
+
paths?: string[]
|
|
16801
|
+
error?: string
|
|
16802
|
+
}
|
|
16436
16803
|
```
|
|
16437
16804
|
|
|
16438
16805
|
### `PortalUserRegistrationStatus`
|