@epilot/sdk 2.7.3 → 2.7.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +317 -26
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-KJPOUJBU.cjs → chunk-5ZXGKLB6.cjs} +1 -1
- package/dist/{chunk-PTEJYAYJ.js → chunk-774ASAAH.js} +1 -1
- package/dist/{chunk-2FJMQLXE.js → chunk-JFMD3PPY.js} +2 -2
- package/dist/{chunk-QNMDISUR.cjs → chunk-QZON5VFY.cjs} +2 -2
- package/dist/customer-portal-4DXHY42V.js +7 -0
- package/dist/customer-portal-5OSGSYGF.cjs +7 -0
- package/dist/{customer-portal-runtime-IYHJ3RME.cjs → customer-portal-runtime-HA6CPWB4.cjs} +2 -2
- package/dist/{customer-portal-runtime-ZYU3WIXY.js → customer-portal-runtime-TDHV2YVY.js} +1 -1
- package/dist/{customer-portal.d-CTTCBAZI.d.cts → customer-portal.d-BRwiQehb.d.cts} +763 -31
- package/dist/{customer-portal.d-CTTCBAZI.d.ts → customer-portal.d-BRwiQehb.d.ts} +763 -31
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/customer-portal.md +463 -54
- package/package.json +1 -1
- package/dist/customer-portal-IBM3K2EZ.cjs +0 -7
- package/dist/customer-portal-XPYKMIIA.js +0 -7
package/docs/customer-portal.md
CHANGED
|
@@ -138,6 +138,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
138
138
|
- [`getMeterReadings`](#getmeterreadings)
|
|
139
139
|
- [`getPortalPage`](#getportalpage)
|
|
140
140
|
- [`getPortalPages`](#getportalpages)
|
|
141
|
+
- [`getTriggeredJourney`](#gettriggeredjourney)
|
|
141
142
|
- [`getPortalPageBlocks`](#getportalpageblocks)
|
|
142
143
|
- [`getPortalPageBlock`](#getportalpageblock)
|
|
143
144
|
- [`updateCampaignPortalBlockStatus`](#updatecampaignportalblockstatus)
|
|
@@ -249,6 +250,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
249
250
|
- [`EntitySearchParams`](#entitysearchparams)
|
|
250
251
|
- [`IdentifierAttribute`](#identifierattribute)
|
|
251
252
|
- [`RegistrationIdentifier`](#registrationidentifier)
|
|
253
|
+
- [`AdditionalContactAttribute`](#additionalcontactattribute)
|
|
252
254
|
- [`ContractIdentifier`](#contractidentifier)
|
|
253
255
|
- [`AcceptanceDecision`](#acceptancedecision)
|
|
254
256
|
- [`TriggerPortalFlow`](#triggerportalflow)
|
|
@@ -372,7 +374,8 @@ const { data } = await client.upsertPortal(
|
|
|
372
374
|
design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
373
375
|
allowed_portal_entities: ['contact', 'contract'],
|
|
374
376
|
self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
375
|
-
self_registration_account_setting: '
|
|
377
|
+
self_registration_account_setting: 'ALLOW_WITH_CREATION',
|
|
378
|
+
block_registration_if_portal_user_exists: true,
|
|
376
379
|
self_registration_entity: 'contact',
|
|
377
380
|
user_account_self_management: false,
|
|
378
381
|
feature_settings: {
|
|
@@ -475,10 +478,31 @@ const { data } = await client.upsertPortal(
|
|
|
475
478
|
schema: 'contract'
|
|
476
479
|
}
|
|
477
480
|
],
|
|
481
|
+
contact_identifiers_for_account: [
|
|
482
|
+
{
|
|
483
|
+
name: 'first_name',
|
|
484
|
+
schema: 'contact'
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
name: 'last_name',
|
|
488
|
+
schema: 'contact'
|
|
489
|
+
}
|
|
490
|
+
],
|
|
491
|
+
additional_contact_attributes: [
|
|
492
|
+
{
|
|
493
|
+
name: 'first_name',
|
|
494
|
+
required: true
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
name: 'last_name',
|
|
498
|
+
required: true
|
|
499
|
+
}
|
|
500
|
+
],
|
|
478
501
|
triggered_journeys: [
|
|
479
502
|
{
|
|
480
503
|
trigger_name: 'FIRST_LOGIN',
|
|
481
|
-
journey_id: '5da0a718-c822-403d-9f5d-20d4584e0528'
|
|
504
|
+
journey_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
505
|
+
context_params: [ /* ... */ ]
|
|
482
506
|
}
|
|
483
507
|
],
|
|
484
508
|
entity_edit_rules: [
|
|
@@ -539,7 +563,8 @@ const { data } = await client.upsertPortal(
|
|
|
539
563
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
540
564
|
"allowed_portal_entities": ["contact", "contract"],
|
|
541
565
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
542
|
-
"self_registration_account_setting": "
|
|
566
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
567
|
+
"block_registration_if_portal_user_exists": true,
|
|
543
568
|
"self_registration_entity": "contact",
|
|
544
569
|
"user_account_self_management": false,
|
|
545
570
|
"feature_settings": {
|
|
@@ -641,10 +666,31 @@ const { data } = await client.upsertPortal(
|
|
|
641
666
|
"schema": "contract"
|
|
642
667
|
}
|
|
643
668
|
],
|
|
669
|
+
"contact_identifiers_for_account": [
|
|
670
|
+
{
|
|
671
|
+
"name": "first_name",
|
|
672
|
+
"schema": "contact"
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
"name": "last_name",
|
|
676
|
+
"schema": "contact"
|
|
677
|
+
}
|
|
678
|
+
],
|
|
679
|
+
"additional_contact_attributes": [
|
|
680
|
+
{
|
|
681
|
+
"name": "first_name",
|
|
682
|
+
"required": true
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
"name": "last_name",
|
|
686
|
+
"required": true
|
|
687
|
+
}
|
|
688
|
+
],
|
|
644
689
|
"triggered_journeys": [
|
|
645
690
|
{
|
|
646
691
|
"trigger_name": "FIRST_LOGIN",
|
|
647
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
692
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
693
|
+
"context_params": []
|
|
648
694
|
}
|
|
649
695
|
],
|
|
650
696
|
"entity_edit_rules": [
|
|
@@ -747,6 +793,14 @@ const { data } = await client.createUserV3(
|
|
|
747
793
|
contract_number: '123456'
|
|
748
794
|
}
|
|
749
795
|
},
|
|
796
|
+
contact_identifiers_for_account: {
|
|
797
|
+
first_name: 'John',
|
|
798
|
+
last_name: 'Doe'
|
|
799
|
+
},
|
|
800
|
+
additional_contact_attributes: {
|
|
801
|
+
first_name: 'John',
|
|
802
|
+
last_name: 'Doe'
|
|
803
|
+
},
|
|
750
804
|
account_id: 'string'
|
|
751
805
|
},
|
|
752
806
|
)
|
|
@@ -835,7 +889,8 @@ const { data } = await client.getPortalConfigByDomain({
|
|
|
835
889
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
836
890
|
"allowed_portal_entities": ["contact", "contract"],
|
|
837
891
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
838
|
-
"self_registration_account_setting": "
|
|
892
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
893
|
+
"block_registration_if_portal_user_exists": true,
|
|
839
894
|
"self_registration_entity": "contact",
|
|
840
895
|
"user_account_self_management": false,
|
|
841
896
|
"feature_settings": {
|
|
@@ -937,10 +992,31 @@ const { data } = await client.getPortalConfigByDomain({
|
|
|
937
992
|
"schema": "contract"
|
|
938
993
|
}
|
|
939
994
|
],
|
|
995
|
+
"contact_identifiers_for_account": [
|
|
996
|
+
{
|
|
997
|
+
"name": "first_name",
|
|
998
|
+
"schema": "contact"
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"name": "last_name",
|
|
1002
|
+
"schema": "contact"
|
|
1003
|
+
}
|
|
1004
|
+
],
|
|
1005
|
+
"additional_contact_attributes": [
|
|
1006
|
+
{
|
|
1007
|
+
"name": "first_name",
|
|
1008
|
+
"required": true
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "last_name",
|
|
1012
|
+
"required": true
|
|
1013
|
+
}
|
|
1014
|
+
],
|
|
940
1015
|
"triggered_journeys": [
|
|
941
1016
|
{
|
|
942
1017
|
"trigger_name": "FIRST_LOGIN",
|
|
943
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
1018
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
1019
|
+
"context_params": []
|
|
944
1020
|
}
|
|
945
1021
|
],
|
|
946
1022
|
"entity_edit_rules": [
|
|
@@ -1042,7 +1118,8 @@ const { data } = await client.getPortalConfig({
|
|
|
1042
1118
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
1043
1119
|
"allowed_portal_entities": ["contact", "contract"],
|
|
1044
1120
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
1045
|
-
"self_registration_account_setting": "
|
|
1121
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
1122
|
+
"block_registration_if_portal_user_exists": true,
|
|
1046
1123
|
"self_registration_entity": "contact",
|
|
1047
1124
|
"user_account_self_management": false,
|
|
1048
1125
|
"feature_settings": {
|
|
@@ -1144,10 +1221,31 @@ const { data } = await client.getPortalConfig({
|
|
|
1144
1221
|
"schema": "contract"
|
|
1145
1222
|
}
|
|
1146
1223
|
],
|
|
1224
|
+
"contact_identifiers_for_account": [
|
|
1225
|
+
{
|
|
1226
|
+
"name": "first_name",
|
|
1227
|
+
"schema": "contact"
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
"name": "last_name",
|
|
1231
|
+
"schema": "contact"
|
|
1232
|
+
}
|
|
1233
|
+
],
|
|
1234
|
+
"additional_contact_attributes": [
|
|
1235
|
+
{
|
|
1236
|
+
"name": "first_name",
|
|
1237
|
+
"required": true
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
"name": "last_name",
|
|
1241
|
+
"required": true
|
|
1242
|
+
}
|
|
1243
|
+
],
|
|
1147
1244
|
"triggered_journeys": [
|
|
1148
1245
|
{
|
|
1149
1246
|
"trigger_name": "FIRST_LOGIN",
|
|
1150
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
1247
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
1248
|
+
"context_params": []
|
|
1151
1249
|
}
|
|
1152
1250
|
],
|
|
1153
1251
|
"entity_edit_rules": [
|
|
@@ -1325,6 +1423,10 @@ const { data } = await client.getPortalExtensions({
|
|
|
1325
1423
|
"body": {},
|
|
1326
1424
|
"result": "string"
|
|
1327
1425
|
},
|
|
1426
|
+
"resolved": {
|
|
1427
|
+
"result": "string",
|
|
1428
|
+
"error_message_path": "error.message"
|
|
1429
|
+
},
|
|
1328
1430
|
"use_static_ips": false,
|
|
1329
1431
|
"secure_proxy": {
|
|
1330
1432
|
"integration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
@@ -1387,6 +1489,10 @@ const { data } = await client.getPublicPortalExtensionDetails({
|
|
|
1387
1489
|
}
|
|
1388
1490
|
],
|
|
1389
1491
|
"contractIdentification": {
|
|
1492
|
+
"app": {
|
|
1493
|
+
"app_id": "string",
|
|
1494
|
+
"name": {}
|
|
1495
|
+
},
|
|
1390
1496
|
"extension": {
|
|
1391
1497
|
"id": "string",
|
|
1392
1498
|
"name": {}
|
|
@@ -1503,6 +1609,10 @@ const { data } = await client.getPortalExtensionsV3({
|
|
|
1503
1609
|
"body": {},
|
|
1504
1610
|
"result": "string"
|
|
1505
1611
|
},
|
|
1612
|
+
"resolved": {
|
|
1613
|
+
"result": "string",
|
|
1614
|
+
"error_message_path": "error.message"
|
|
1615
|
+
},
|
|
1506
1616
|
"use_static_ips": false,
|
|
1507
1617
|
"secure_proxy": {
|
|
1508
1618
|
"integration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
@@ -1569,6 +1679,10 @@ const { data } = await client.getPublicPortalExtensionDetailsV3({
|
|
|
1569
1679
|
}
|
|
1570
1680
|
],
|
|
1571
1681
|
"contractIdentification": {
|
|
1682
|
+
"app": {
|
|
1683
|
+
"app_id": "string",
|
|
1684
|
+
"name": {}
|
|
1685
|
+
},
|
|
1572
1686
|
"extension": {
|
|
1573
1687
|
"id": "string",
|
|
1574
1688
|
"name": {}
|
|
@@ -1954,7 +2068,8 @@ const { data } = await client.getPublicPortalConfig({
|
|
|
1954
2068
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
1955
2069
|
"allowed_portal_entities": ["contact", "contract"],
|
|
1956
2070
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
1957
|
-
"self_registration_account_setting": "
|
|
2071
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
2072
|
+
"block_registration_if_portal_user_exists": true,
|
|
1958
2073
|
"self_registration_entity": "contact",
|
|
1959
2074
|
"user_account_self_management": false,
|
|
1960
2075
|
"feature_settings": {
|
|
@@ -2056,10 +2171,31 @@ const { data } = await client.getPublicPortalConfig({
|
|
|
2056
2171
|
"schema": "contract"
|
|
2057
2172
|
}
|
|
2058
2173
|
],
|
|
2174
|
+
"contact_identifiers_for_account": [
|
|
2175
|
+
{
|
|
2176
|
+
"name": "first_name",
|
|
2177
|
+
"schema": "contact"
|
|
2178
|
+
},
|
|
2179
|
+
{
|
|
2180
|
+
"name": "last_name",
|
|
2181
|
+
"schema": "contact"
|
|
2182
|
+
}
|
|
2183
|
+
],
|
|
2184
|
+
"additional_contact_attributes": [
|
|
2185
|
+
{
|
|
2186
|
+
"name": "first_name",
|
|
2187
|
+
"required": true
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"name": "last_name",
|
|
2191
|
+
"required": true
|
|
2192
|
+
}
|
|
2193
|
+
],
|
|
2059
2194
|
"triggered_journeys": [
|
|
2060
2195
|
{
|
|
2061
2196
|
"trigger_name": "FIRST_LOGIN",
|
|
2062
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
2197
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2198
|
+
"context_params": []
|
|
2063
2199
|
}
|
|
2064
2200
|
],
|
|
2065
2201
|
"entity_edit_rules": [
|
|
@@ -2161,7 +2297,8 @@ const { data } = await client.getOrgPortalConfig({
|
|
|
2161
2297
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2162
2298
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2163
2299
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2164
|
-
"self_registration_account_setting": "
|
|
2300
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
2301
|
+
"block_registration_if_portal_user_exists": true,
|
|
2165
2302
|
"self_registration_entity": "contact",
|
|
2166
2303
|
"user_account_self_management": false,
|
|
2167
2304
|
"feature_settings": {
|
|
@@ -2263,10 +2400,31 @@ const { data } = await client.getOrgPortalConfig({
|
|
|
2263
2400
|
"schema": "contract"
|
|
2264
2401
|
}
|
|
2265
2402
|
],
|
|
2403
|
+
"contact_identifiers_for_account": [
|
|
2404
|
+
{
|
|
2405
|
+
"name": "first_name",
|
|
2406
|
+
"schema": "contact"
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"name": "last_name",
|
|
2410
|
+
"schema": "contact"
|
|
2411
|
+
}
|
|
2412
|
+
],
|
|
2413
|
+
"additional_contact_attributes": [
|
|
2414
|
+
{
|
|
2415
|
+
"name": "first_name",
|
|
2416
|
+
"required": true
|
|
2417
|
+
},
|
|
2418
|
+
{
|
|
2419
|
+
"name": "last_name",
|
|
2420
|
+
"required": true
|
|
2421
|
+
}
|
|
2422
|
+
],
|
|
2266
2423
|
"triggered_journeys": [
|
|
2267
2424
|
{
|
|
2268
2425
|
"trigger_name": "FIRST_LOGIN",
|
|
2269
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
2426
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2427
|
+
"context_params": []
|
|
2270
2428
|
}
|
|
2271
2429
|
],
|
|
2272
2430
|
"entity_edit_rules": [
|
|
@@ -2376,7 +2534,8 @@ const { data } = await client.getPublicPortalConfigV3({
|
|
|
2376
2534
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2377
2535
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2378
2536
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2379
|
-
"self_registration_account_setting": "
|
|
2537
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
2538
|
+
"block_registration_if_portal_user_exists": true,
|
|
2380
2539
|
"self_registration_entity": "contact",
|
|
2381
2540
|
"user_account_self_management": false,
|
|
2382
2541
|
"feature_settings": {
|
|
@@ -2478,10 +2637,31 @@ const { data } = await client.getPublicPortalConfigV3({
|
|
|
2478
2637
|
"schema": "contract"
|
|
2479
2638
|
}
|
|
2480
2639
|
],
|
|
2640
|
+
"contact_identifiers_for_account": [
|
|
2641
|
+
{
|
|
2642
|
+
"name": "first_name",
|
|
2643
|
+
"schema": "contact"
|
|
2644
|
+
},
|
|
2645
|
+
{
|
|
2646
|
+
"name": "last_name",
|
|
2647
|
+
"schema": "contact"
|
|
2648
|
+
}
|
|
2649
|
+
],
|
|
2650
|
+
"additional_contact_attributes": [
|
|
2651
|
+
{
|
|
2652
|
+
"name": "first_name",
|
|
2653
|
+
"required": true
|
|
2654
|
+
},
|
|
2655
|
+
{
|
|
2656
|
+
"name": "last_name",
|
|
2657
|
+
"required": true
|
|
2658
|
+
}
|
|
2659
|
+
],
|
|
2481
2660
|
"triggered_journeys": [
|
|
2482
2661
|
{
|
|
2483
2662
|
"trigger_name": "FIRST_LOGIN",
|
|
2484
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
2663
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2664
|
+
"context_params": []
|
|
2485
2665
|
}
|
|
2486
2666
|
],
|
|
2487
2667
|
"entity_edit_rules": [
|
|
@@ -2583,7 +2763,8 @@ const { data } = await client.getOrgPortalConfigV3({
|
|
|
2583
2763
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2584
2764
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2585
2765
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2586
|
-
"self_registration_account_setting": "
|
|
2766
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
2767
|
+
"block_registration_if_portal_user_exists": true,
|
|
2587
2768
|
"self_registration_entity": "contact",
|
|
2588
2769
|
"user_account_self_management": false,
|
|
2589
2770
|
"feature_settings": {
|
|
@@ -2685,10 +2866,31 @@ const { data } = await client.getOrgPortalConfigV3({
|
|
|
2685
2866
|
"schema": "contract"
|
|
2686
2867
|
}
|
|
2687
2868
|
],
|
|
2869
|
+
"contact_identifiers_for_account": [
|
|
2870
|
+
{
|
|
2871
|
+
"name": "first_name",
|
|
2872
|
+
"schema": "contact"
|
|
2873
|
+
},
|
|
2874
|
+
{
|
|
2875
|
+
"name": "last_name",
|
|
2876
|
+
"schema": "contact"
|
|
2877
|
+
}
|
|
2878
|
+
],
|
|
2879
|
+
"additional_contact_attributes": [
|
|
2880
|
+
{
|
|
2881
|
+
"name": "first_name",
|
|
2882
|
+
"required": true
|
|
2883
|
+
},
|
|
2884
|
+
{
|
|
2885
|
+
"name": "last_name",
|
|
2886
|
+
"required": true
|
|
2887
|
+
}
|
|
2888
|
+
],
|
|
2688
2889
|
"triggered_journeys": [
|
|
2689
2890
|
{
|
|
2690
2891
|
"trigger_name": "FIRST_LOGIN",
|
|
2691
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
2892
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2893
|
+
"context_params": []
|
|
2692
2894
|
}
|
|
2693
2895
|
],
|
|
2694
2896
|
"entity_edit_rules": [
|
|
@@ -2793,7 +2995,8 @@ const { data } = await client.getAllPortalConfigs()
|
|
|
2793
2995
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2794
2996
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2795
2997
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2796
|
-
"self_registration_account_setting": "
|
|
2998
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
2999
|
+
"block_registration_if_portal_user_exists": true,
|
|
2797
3000
|
"self_registration_entity": "contact",
|
|
2798
3001
|
"user_account_self_management": false,
|
|
2799
3002
|
"feature_settings": {},
|
|
@@ -2810,6 +3013,8 @@ const { data } = await client.getAllPortalConfigs()
|
|
|
2810
3013
|
"contract_identifiers": [],
|
|
2811
3014
|
"contract_selector_config": {},
|
|
2812
3015
|
"registration_identifiers": [],
|
|
3016
|
+
"contact_identifiers_for_account": [],
|
|
3017
|
+
"additional_contact_attributes": [],
|
|
2813
3018
|
"triggered_journeys": [],
|
|
2814
3019
|
"entity_edit_rules": [],
|
|
2815
3020
|
"allowed_file_extensions": {},
|
|
@@ -6294,6 +6499,42 @@ const { data } = await client.interpolatePortalPages(
|
|
|
6294
6499
|
|
|
6295
6500
|
---
|
|
6296
6501
|
|
|
6502
|
+
### `getTriggeredJourney`
|
|
6503
|
+
|
|
6504
|
+
Returns the auto-triggered journey configured for the given trigger
|
|
6505
|
+
with handlebars templates in `context_params` already resolved.
|
|
6506
|
+
Uses the caller's auth context (contact, portal user) plus any
|
|
6507
|
+
`cont
|
|
6508
|
+
|
|
6509
|
+
`GET /v2/portal/config/triggered-journeys/{trigger_name}`
|
|
6510
|
+
|
|
6511
|
+
```ts
|
|
6512
|
+
const { data } = await client.getTriggeredJourney({
|
|
6513
|
+
trigger_name: 'example',
|
|
6514
|
+
context_entities: 'example',
|
|
6515
|
+
})
|
|
6516
|
+
```
|
|
6517
|
+
|
|
6518
|
+
<details>
|
|
6519
|
+
<summary>Response</summary>
|
|
6520
|
+
|
|
6521
|
+
```json
|
|
6522
|
+
{
|
|
6523
|
+
"trigger_name": "FIRST_LOGIN",
|
|
6524
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
6525
|
+
"context_params": [
|
|
6526
|
+
{
|
|
6527
|
+
"key": "string",
|
|
6528
|
+
"value": "string"
|
|
6529
|
+
}
|
|
6530
|
+
]
|
|
6531
|
+
}
|
|
6532
|
+
```
|
|
6533
|
+
|
|
6534
|
+
</details>
|
|
6535
|
+
|
|
6536
|
+
---
|
|
6537
|
+
|
|
6297
6538
|
### `getDefaultPages`
|
|
6298
6539
|
|
|
6299
6540
|
Fetch all default portal pages
|
|
@@ -6787,7 +7028,8 @@ const { data } = await client.createPortalConfig(
|
|
|
6787
7028
|
design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
6788
7029
|
allowed_portal_entities: ['contact', 'contract'],
|
|
6789
7030
|
self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
6790
|
-
self_registration_account_setting: '
|
|
7031
|
+
self_registration_account_setting: 'ALLOW_WITH_CREATION',
|
|
7032
|
+
block_registration_if_portal_user_exists: true,
|
|
6791
7033
|
self_registration_entity: 'contact',
|
|
6792
7034
|
user_account_self_management: false,
|
|
6793
7035
|
feature_settings: {
|
|
@@ -6890,10 +7132,31 @@ const { data } = await client.createPortalConfig(
|
|
|
6890
7132
|
schema: 'contract'
|
|
6891
7133
|
}
|
|
6892
7134
|
],
|
|
7135
|
+
contact_identifiers_for_account: [
|
|
7136
|
+
{
|
|
7137
|
+
name: 'first_name',
|
|
7138
|
+
schema: 'contact'
|
|
7139
|
+
},
|
|
7140
|
+
{
|
|
7141
|
+
name: 'last_name',
|
|
7142
|
+
schema: 'contact'
|
|
7143
|
+
}
|
|
7144
|
+
],
|
|
7145
|
+
additional_contact_attributes: [
|
|
7146
|
+
{
|
|
7147
|
+
name: 'first_name',
|
|
7148
|
+
required: true
|
|
7149
|
+
},
|
|
7150
|
+
{
|
|
7151
|
+
name: 'last_name',
|
|
7152
|
+
required: true
|
|
7153
|
+
}
|
|
7154
|
+
],
|
|
6893
7155
|
triggered_journeys: [
|
|
6894
7156
|
{
|
|
6895
7157
|
trigger_name: 'FIRST_LOGIN',
|
|
6896
|
-
journey_id: '5da0a718-c822-403d-9f5d-20d4584e0528'
|
|
7158
|
+
journey_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
7159
|
+
context_params: [ /* ... */ ]
|
|
6897
7160
|
}
|
|
6898
7161
|
],
|
|
6899
7162
|
entity_edit_rules: [
|
|
@@ -7004,7 +7267,8 @@ const { data } = await client.createPortalConfig(
|
|
|
7004
7267
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7005
7268
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7006
7269
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7007
|
-
"self_registration_account_setting": "
|
|
7270
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
7271
|
+
"block_registration_if_portal_user_exists": true,
|
|
7008
7272
|
"self_registration_entity": "contact",
|
|
7009
7273
|
"user_account_self_management": false,
|
|
7010
7274
|
"feature_settings": {
|
|
@@ -7106,10 +7370,31 @@ const { data } = await client.createPortalConfig(
|
|
|
7106
7370
|
"schema": "contract"
|
|
7107
7371
|
}
|
|
7108
7372
|
],
|
|
7373
|
+
"contact_identifiers_for_account": [
|
|
7374
|
+
{
|
|
7375
|
+
"name": "first_name",
|
|
7376
|
+
"schema": "contact"
|
|
7377
|
+
},
|
|
7378
|
+
{
|
|
7379
|
+
"name": "last_name",
|
|
7380
|
+
"schema": "contact"
|
|
7381
|
+
}
|
|
7382
|
+
],
|
|
7383
|
+
"additional_contact_attributes": [
|
|
7384
|
+
{
|
|
7385
|
+
"name": "first_name",
|
|
7386
|
+
"required": true
|
|
7387
|
+
},
|
|
7388
|
+
{
|
|
7389
|
+
"name": "last_name",
|
|
7390
|
+
"required": true
|
|
7391
|
+
}
|
|
7392
|
+
],
|
|
7109
7393
|
"triggered_journeys": [
|
|
7110
7394
|
{
|
|
7111
7395
|
"trigger_name": "FIRST_LOGIN",
|
|
7112
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
7396
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7397
|
+
"context_params": []
|
|
7113
7398
|
}
|
|
7114
7399
|
],
|
|
7115
7400
|
"entity_edit_rules": [
|
|
@@ -7256,7 +7541,8 @@ const { data } = await client.getPortalConfigV3({
|
|
|
7256
7541
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7257
7542
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7258
7543
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7259
|
-
"self_registration_account_setting": "
|
|
7544
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
7545
|
+
"block_registration_if_portal_user_exists": true,
|
|
7260
7546
|
"self_registration_entity": "contact",
|
|
7261
7547
|
"user_account_self_management": false,
|
|
7262
7548
|
"feature_settings": {
|
|
@@ -7358,10 +7644,31 @@ const { data } = await client.getPortalConfigV3({
|
|
|
7358
7644
|
"schema": "contract"
|
|
7359
7645
|
}
|
|
7360
7646
|
],
|
|
7647
|
+
"contact_identifiers_for_account": [
|
|
7648
|
+
{
|
|
7649
|
+
"name": "first_name",
|
|
7650
|
+
"schema": "contact"
|
|
7651
|
+
},
|
|
7652
|
+
{
|
|
7653
|
+
"name": "last_name",
|
|
7654
|
+
"schema": "contact"
|
|
7655
|
+
}
|
|
7656
|
+
],
|
|
7657
|
+
"additional_contact_attributes": [
|
|
7658
|
+
{
|
|
7659
|
+
"name": "first_name",
|
|
7660
|
+
"required": true
|
|
7661
|
+
},
|
|
7662
|
+
{
|
|
7663
|
+
"name": "last_name",
|
|
7664
|
+
"required": true
|
|
7665
|
+
}
|
|
7666
|
+
],
|
|
7361
7667
|
"triggered_journeys": [
|
|
7362
7668
|
{
|
|
7363
7669
|
"trigger_name": "FIRST_LOGIN",
|
|
7364
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
7670
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7671
|
+
"context_params": []
|
|
7365
7672
|
}
|
|
7366
7673
|
],
|
|
7367
7674
|
"entity_edit_rules": [
|
|
@@ -7503,7 +7810,8 @@ const { data } = await client.putPortalConfig(
|
|
|
7503
7810
|
design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
7504
7811
|
allowed_portal_entities: ['contact', 'contract'],
|
|
7505
7812
|
self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
7506
|
-
self_registration_account_setting: '
|
|
7813
|
+
self_registration_account_setting: 'ALLOW_WITH_CREATION',
|
|
7814
|
+
block_registration_if_portal_user_exists: true,
|
|
7507
7815
|
self_registration_entity: 'contact',
|
|
7508
7816
|
user_account_self_management: false,
|
|
7509
7817
|
feature_settings: {
|
|
@@ -7606,10 +7914,31 @@ const { data } = await client.putPortalConfig(
|
|
|
7606
7914
|
schema: 'contract'
|
|
7607
7915
|
}
|
|
7608
7916
|
],
|
|
7917
|
+
contact_identifiers_for_account: [
|
|
7918
|
+
{
|
|
7919
|
+
name: 'first_name',
|
|
7920
|
+
schema: 'contact'
|
|
7921
|
+
},
|
|
7922
|
+
{
|
|
7923
|
+
name: 'last_name',
|
|
7924
|
+
schema: 'contact'
|
|
7925
|
+
}
|
|
7926
|
+
],
|
|
7927
|
+
additional_contact_attributes: [
|
|
7928
|
+
{
|
|
7929
|
+
name: 'first_name',
|
|
7930
|
+
required: true
|
|
7931
|
+
},
|
|
7932
|
+
{
|
|
7933
|
+
name: 'last_name',
|
|
7934
|
+
required: true
|
|
7935
|
+
}
|
|
7936
|
+
],
|
|
7609
7937
|
triggered_journeys: [
|
|
7610
7938
|
{
|
|
7611
7939
|
trigger_name: 'FIRST_LOGIN',
|
|
7612
|
-
journey_id: '5da0a718-c822-403d-9f5d-20d4584e0528'
|
|
7940
|
+
journey_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
7941
|
+
context_params: [ /* ... */ ]
|
|
7613
7942
|
}
|
|
7614
7943
|
],
|
|
7615
7944
|
entity_edit_rules: [
|
|
@@ -7741,7 +8070,8 @@ const { data } = await client.putPortalConfig(
|
|
|
7741
8070
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7742
8071
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7743
8072
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7744
|
-
"self_registration_account_setting": "
|
|
8073
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
8074
|
+
"block_registration_if_portal_user_exists": true,
|
|
7745
8075
|
"self_registration_entity": "contact",
|
|
7746
8076
|
"user_account_self_management": false,
|
|
7747
8077
|
"feature_settings": {
|
|
@@ -7843,10 +8173,31 @@ const { data } = await client.putPortalConfig(
|
|
|
7843
8173
|
"schema": "contract"
|
|
7844
8174
|
}
|
|
7845
8175
|
],
|
|
8176
|
+
"contact_identifiers_for_account": [
|
|
8177
|
+
{
|
|
8178
|
+
"name": "first_name",
|
|
8179
|
+
"schema": "contact"
|
|
8180
|
+
},
|
|
8181
|
+
{
|
|
8182
|
+
"name": "last_name",
|
|
8183
|
+
"schema": "contact"
|
|
8184
|
+
}
|
|
8185
|
+
],
|
|
8186
|
+
"additional_contact_attributes": [
|
|
8187
|
+
{
|
|
8188
|
+
"name": "first_name",
|
|
8189
|
+
"required": true
|
|
8190
|
+
},
|
|
8191
|
+
{
|
|
8192
|
+
"name": "last_name",
|
|
8193
|
+
"required": true
|
|
8194
|
+
}
|
|
8195
|
+
],
|
|
7846
8196
|
"triggered_journeys": [
|
|
7847
8197
|
{
|
|
7848
8198
|
"trigger_name": "FIRST_LOGIN",
|
|
7849
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
8199
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
8200
|
+
"context_params": []
|
|
7850
8201
|
}
|
|
7851
8202
|
],
|
|
7852
8203
|
"entity_edit_rules": [
|
|
@@ -7977,7 +8328,8 @@ const { data } = await client.listAllPortalConfigs()
|
|
|
7977
8328
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7978
8329
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7979
8330
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7980
|
-
"self_registration_account_setting": "
|
|
8331
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
8332
|
+
"block_registration_if_portal_user_exists": true,
|
|
7981
8333
|
"self_registration_entity": "contact",
|
|
7982
8334
|
"user_account_self_management": false,
|
|
7983
8335
|
"feature_settings": {},
|
|
@@ -7994,6 +8346,8 @@ const { data } = await client.listAllPortalConfigs()
|
|
|
7994
8346
|
"contract_identifiers": [],
|
|
7995
8347
|
"contract_selector_config": {},
|
|
7996
8348
|
"registration_identifiers": [],
|
|
8349
|
+
"contact_identifiers_for_account": [],
|
|
8350
|
+
"additional_contact_attributes": [],
|
|
7997
8351
|
"triggered_journeys": [],
|
|
7998
8352
|
"entity_edit_rules": [],
|
|
7999
8353
|
"allowed_file_extensions": {},
|
|
@@ -8115,7 +8469,8 @@ const { data } = await client.clonePortalConfig(
|
|
|
8115
8469
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
8116
8470
|
"allowed_portal_entities": ["contact", "contract"],
|
|
8117
8471
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
8118
|
-
"self_registration_account_setting": "
|
|
8472
|
+
"self_registration_account_setting": "ALLOW_WITH_CREATION",
|
|
8473
|
+
"block_registration_if_portal_user_exists": true,
|
|
8119
8474
|
"self_registration_entity": "contact",
|
|
8120
8475
|
"user_account_self_management": false,
|
|
8121
8476
|
"feature_settings": {
|
|
@@ -8217,10 +8572,31 @@ const { data } = await client.clonePortalConfig(
|
|
|
8217
8572
|
"schema": "contract"
|
|
8218
8573
|
}
|
|
8219
8574
|
],
|
|
8575
|
+
"contact_identifiers_for_account": [
|
|
8576
|
+
{
|
|
8577
|
+
"name": "first_name",
|
|
8578
|
+
"schema": "contact"
|
|
8579
|
+
},
|
|
8580
|
+
{
|
|
8581
|
+
"name": "last_name",
|
|
8582
|
+
"schema": "contact"
|
|
8583
|
+
}
|
|
8584
|
+
],
|
|
8585
|
+
"additional_contact_attributes": [
|
|
8586
|
+
{
|
|
8587
|
+
"name": "first_name",
|
|
8588
|
+
"required": true
|
|
8589
|
+
},
|
|
8590
|
+
{
|
|
8591
|
+
"name": "last_name",
|
|
8592
|
+
"required": true
|
|
8593
|
+
}
|
|
8594
|
+
],
|
|
8220
8595
|
"triggered_journeys": [
|
|
8221
8596
|
{
|
|
8222
8597
|
"trigger_name": "FIRST_LOGIN",
|
|
8223
|
-
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
8598
|
+
"journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
8599
|
+
"context_params": []
|
|
8224
8600
|
}
|
|
8225
8601
|
],
|
|
8226
8602
|
"entity_edit_rules": [
|
|
@@ -8748,7 +9124,7 @@ type UpdateOnlyPortalConfigAttributes = {
|
|
|
8748
9124
|
type CommonConfigAttributes = {
|
|
8749
9125
|
enabled?: boolean
|
|
8750
9126
|
name?: string
|
|
8751
|
-
domain
|
|
9127
|
+
domain?: string
|
|
8752
9128
|
is_epilot_domain?: boolean
|
|
8753
9129
|
epilot_domain?: string
|
|
8754
9130
|
domain_settings?: {
|
|
@@ -8759,7 +9135,8 @@ type CommonConfigAttributes = {
|
|
|
8759
9135
|
design_id?: string // uuid
|
|
8760
9136
|
allowed_portal_entities?: string[]
|
|
8761
9137
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
8762
|
-
self_registration_account_setting?: "
|
|
9138
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
9139
|
+
block_registration_if_portal_user_exists?: boolean
|
|
8763
9140
|
self_registration_entity?: "contact" | "account"
|
|
8764
9141
|
user_account_self_management?: boolean
|
|
8765
9142
|
feature_settings?: {
|
|
@@ -8844,7 +9221,6 @@ type CommonConfigAttributes = {
|
|
|
8844
9221
|
}
|
|
8845
9222
|
registration_identifiers?: Array<{
|
|
8846
9223
|
name?: string
|
|
8847
|
-
schema?: string
|
|
8848
9224
|
// ...
|
|
8849
9225
|
}
|
|
8850
9226
|
```
|
|
@@ -8915,7 +9291,7 @@ type UpsertPortalConfig = {
|
|
|
8915
9291
|
}>
|
|
8916
9292
|
enabled?: boolean
|
|
8917
9293
|
name?: string
|
|
8918
|
-
domain
|
|
9294
|
+
domain?: string
|
|
8919
9295
|
is_epilot_domain?: boolean
|
|
8920
9296
|
epilot_domain?: string
|
|
8921
9297
|
domain_settings?: {
|
|
@@ -8926,7 +9302,8 @@ type UpsertPortalConfig = {
|
|
|
8926
9302
|
design_id?: string // uuid
|
|
8927
9303
|
allowed_portal_entities?: string[]
|
|
8928
9304
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
8929
|
-
self_registration_account_setting?: "
|
|
9305
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
9306
|
+
block_registration_if_portal_user_exists?: boolean
|
|
8930
9307
|
self_registration_entity?: "contact" | "account"
|
|
8931
9308
|
user_account_self_management?: boolean
|
|
8932
9309
|
feature_settings?: {
|
|
@@ -8951,7 +9328,6 @@ type UpsertPortalConfig = {
|
|
|
8951
9328
|
cognito_user_pool_client_id?: string
|
|
8952
9329
|
cognito_user_pool_arn?: string
|
|
8953
9330
|
cognito_user_pool_id?: string
|
|
8954
|
-
timeouts?: {
|
|
8955
9331
|
// ...
|
|
8956
9332
|
}
|
|
8957
9333
|
```
|
|
@@ -8962,7 +9338,7 @@ type UpsertPortalConfig = {
|
|
|
8962
9338
|
type PortalConfig = {
|
|
8963
9339
|
enabled?: boolean
|
|
8964
9340
|
name?: string
|
|
8965
|
-
domain
|
|
9341
|
+
domain?: string
|
|
8966
9342
|
is_epilot_domain?: boolean
|
|
8967
9343
|
epilot_domain?: string
|
|
8968
9344
|
domain_settings?: {
|
|
@@ -8973,7 +9349,8 @@ type PortalConfig = {
|
|
|
8973
9349
|
design_id?: string // uuid
|
|
8974
9350
|
allowed_portal_entities?: string[]
|
|
8975
9351
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
8976
|
-
self_registration_account_setting?: "
|
|
9352
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
9353
|
+
block_registration_if_portal_user_exists?: boolean
|
|
8977
9354
|
self_registration_entity?: "contact" | "account"
|
|
8978
9355
|
user_account_self_management?: boolean
|
|
8979
9356
|
feature_settings?: {
|
|
@@ -9058,7 +9435,6 @@ type PortalConfig = {
|
|
|
9058
9435
|
}
|
|
9059
9436
|
registration_identifiers?: Array<{
|
|
9060
9437
|
name?: string
|
|
9061
|
-
schema?: string
|
|
9062
9438
|
// ...
|
|
9063
9439
|
}
|
|
9064
9440
|
```
|
|
@@ -9562,6 +9938,8 @@ type CreateUserRequest = {
|
|
|
9562
9938
|
password?: string
|
|
9563
9939
|
contactIdentifiers?: Record<string, string>
|
|
9564
9940
|
registration_identifiers?: Record<string, Record<string, string>>
|
|
9941
|
+
contact_identifiers_for_account?: Record<string, string>
|
|
9942
|
+
additional_contact_attributes?: Record<string, string>
|
|
9565
9943
|
account_id?: string
|
|
9566
9944
|
}
|
|
9567
9945
|
```
|
|
@@ -10447,6 +10825,20 @@ type RegistrationIdentifier = {
|
|
|
10447
10825
|
}
|
|
10448
10826
|
```
|
|
10449
10827
|
|
|
10828
|
+
### `AdditionalContactAttribute`
|
|
10829
|
+
|
|
10830
|
+
A contact attribute that is collected from the user during self-registration
|
|
10831
|
+
and written onto the newly created contact, but is NOT used to identify
|
|
10832
|
+
an existing contact.
|
|
10833
|
+
|
|
10834
|
+
|
|
10835
|
+
```ts
|
|
10836
|
+
type AdditionalContactAttribute = {
|
|
10837
|
+
name: string
|
|
10838
|
+
required?: boolean
|
|
10839
|
+
}
|
|
10840
|
+
```
|
|
10841
|
+
|
|
10450
10842
|
### `ContractIdentifier`
|
|
10451
10843
|
|
|
10452
10844
|
```ts
|
|
@@ -10567,6 +10959,10 @@ type PublicExtensionCapabilities = {
|
|
|
10567
10959
|
}
|
|
10568
10960
|
}>
|
|
10569
10961
|
contractIdentification?: {
|
|
10962
|
+
app?: {
|
|
10963
|
+
app_id?: { ... }
|
|
10964
|
+
name?: { ... }
|
|
10965
|
+
}
|
|
10570
10966
|
extension?: {
|
|
10571
10967
|
id?: { ... }
|
|
10572
10968
|
name?: { ... }
|
|
@@ -10838,6 +11234,10 @@ type ExtensionHookRegistrationIdentifiersCheck = {
|
|
|
10838
11234
|
body?: object
|
|
10839
11235
|
result?: string
|
|
10840
11236
|
}
|
|
11237
|
+
resolved?: {
|
|
11238
|
+
result?: string
|
|
11239
|
+
error_message_path?: string
|
|
11240
|
+
}
|
|
10841
11241
|
use_static_ips?: boolean
|
|
10842
11242
|
secure_proxy?: {
|
|
10843
11243
|
integration_id: string // uuid
|
|
@@ -10877,6 +11277,10 @@ type ExtensionHookContractIdentification = {
|
|
|
10877
11277
|
body?: object
|
|
10878
11278
|
result?: string
|
|
10879
11279
|
}
|
|
11280
|
+
resolved?: {
|
|
11281
|
+
result?: string
|
|
11282
|
+
error_message_path?: string
|
|
11283
|
+
}
|
|
10880
11284
|
assignment_mode?: "contracts" | "contact_to_contracts" | "contact_to_portal_user"
|
|
10881
11285
|
contact_relation_attribute?: string
|
|
10882
11286
|
explanation?: {
|
|
@@ -10919,12 +11323,13 @@ type ExtensionHookMeterReadingPlausibilityCheck = {
|
|
|
10919
11323
|
headers: Record<string, string>
|
|
10920
11324
|
}
|
|
10921
11325
|
resolved: {
|
|
11326
|
+
data_path?: string
|
|
10922
11327
|
dataPath?: string
|
|
10923
11328
|
counter_identifiers?: string | Record<string, string>
|
|
10924
11329
|
valid?: string
|
|
10925
11330
|
upper_limit?: string
|
|
10926
11331
|
lower_limit?: string
|
|
10927
|
-
|
|
11332
|
+
error_message_path?: string
|
|
10928
11333
|
}
|
|
10929
11334
|
use_static_ips?: boolean
|
|
10930
11335
|
secure_proxy?: {
|
|
@@ -10962,8 +11367,9 @@ type ExtensionHookPriceDataRetrieval = {
|
|
|
10962
11367
|
body?: Record<string, string>
|
|
10963
11368
|
}
|
|
10964
11369
|
resolved?: {
|
|
11370
|
+
data_path?: string
|
|
10965
11371
|
dataPath?: string
|
|
10966
|
-
|
|
11372
|
+
error_message_path?: string
|
|
10967
11373
|
}
|
|
10968
11374
|
use_static_ips?: boolean
|
|
10969
11375
|
secure_proxy?: {
|
|
@@ -11001,8 +11407,9 @@ type ExtensionHookConsumptionDataRetrieval = {
|
|
|
11001
11407
|
body?: Record<string, string>
|
|
11002
11408
|
}
|
|
11003
11409
|
resolved?: {
|
|
11410
|
+
data_path?: string
|
|
11004
11411
|
dataPath?: string
|
|
11005
|
-
|
|
11412
|
+
error_message_path?: string
|
|
11006
11413
|
}
|
|
11007
11414
|
use_static_ips?: boolean
|
|
11008
11415
|
secure_proxy?: {
|
|
@@ -11039,7 +11446,7 @@ type ExtensionHookDataExport = {
|
|
|
11039
11446
|
body?: Record<string, string>
|
|
11040
11447
|
}
|
|
11041
11448
|
resolved?: {
|
|
11042
|
-
|
|
11449
|
+
error_message_path?: string
|
|
11043
11450
|
}
|
|
11044
11451
|
use_static_ips?: boolean
|
|
11045
11452
|
secure_proxy?: {
|
|
@@ -11076,8 +11483,9 @@ type ExtensionHookVisualizationMetadata = {
|
|
|
11076
11483
|
body?: Record<string, string>
|
|
11077
11484
|
}
|
|
11078
11485
|
resolved?: {
|
|
11486
|
+
data_path?: string
|
|
11079
11487
|
dataPath?: string
|
|
11080
|
-
|
|
11488
|
+
error_message_path?: string
|
|
11081
11489
|
}
|
|
11082
11490
|
use_static_ips?: boolean
|
|
11083
11491
|
secure_proxy?: {
|
|
@@ -11115,8 +11523,9 @@ type ExtensionHookCostDataRetrieval = {
|
|
|
11115
11523
|
body?: Record<string, string>
|
|
11116
11524
|
}
|
|
11117
11525
|
resolved?: {
|
|
11526
|
+
data_path?: string
|
|
11118
11527
|
dataPath?: string
|
|
11119
|
-
|
|
11528
|
+
error_message_path?: string
|
|
11120
11529
|
}
|
|
11121
11530
|
use_static_ips?: boolean
|
|
11122
11531
|
secure_proxy?: {
|
|
@@ -11329,7 +11738,7 @@ type ProviderConfig = {
|
|
|
11329
11738
|
test_auth_username?: { ... }
|
|
11330
11739
|
test_auth_password?: { ... }
|
|
11331
11740
|
}
|
|
11332
|
-
prompt?: "login" | "select_account" | "consent"
|
|
11741
|
+
prompt?: "login" | "select_account" | "consent" | "signup"
|
|
11333
11742
|
}
|
|
11334
11743
|
mobile_oidc_config?: {
|
|
11335
11744
|
client_id?: string
|
|
@@ -11364,7 +11773,7 @@ type ProviderPublicConfig = {
|
|
|
11364
11773
|
test_auth_username?: { ... }
|
|
11365
11774
|
test_auth_password?: { ... }
|
|
11366
11775
|
}
|
|
11367
|
-
prompt?: "login" | "select_account" | "consent"
|
|
11776
|
+
prompt?: "login" | "select_account" | "consent" | "signup"
|
|
11368
11777
|
}
|
|
11369
11778
|
mobile_oidc_config?: {
|
|
11370
11779
|
client_id?: string
|
|
@@ -11449,7 +11858,7 @@ type OIDCProviderConfig = {
|
|
|
11449
11858
|
test_auth_username?: string
|
|
11450
11859
|
test_auth_password?: string
|
|
11451
11860
|
}
|
|
11452
|
-
prompt?: "login" | "select_account" | "consent"
|
|
11861
|
+
prompt?: "login" | "select_account" | "consent" | "signup"
|
|
11453
11862
|
}
|
|
11454
11863
|
```
|
|
11455
11864
|
|
|
@@ -11712,7 +12121,8 @@ type CommonConfigAttributesV3 = {
|
|
|
11712
12121
|
design_id?: string // uuid
|
|
11713
12122
|
allowed_portal_entities?: string[]
|
|
11714
12123
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
11715
|
-
self_registration_account_setting?: "
|
|
12124
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
12125
|
+
block_registration_if_portal_user_exists?: boolean
|
|
11716
12126
|
self_registration_entity?: "contact" | "account"
|
|
11717
12127
|
user_account_self_management?: boolean
|
|
11718
12128
|
feature_settings?: {
|
|
@@ -11797,7 +12207,6 @@ type CommonConfigAttributesV3 = {
|
|
|
11797
12207
|
}
|
|
11798
12208
|
registration_identifiers?: Array<{
|
|
11799
12209
|
name?: string
|
|
11800
|
-
schema?: string
|
|
11801
12210
|
// ...
|
|
11802
12211
|
}
|
|
11803
12212
|
```
|
|
@@ -11887,7 +12296,8 @@ type UpsertPortalConfigV3 = {
|
|
|
11887
12296
|
design_id?: string // uuid
|
|
11888
12297
|
allowed_portal_entities?: string[]
|
|
11889
12298
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
11890
|
-
self_registration_account_setting?: "
|
|
12299
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
12300
|
+
block_registration_if_portal_user_exists?: boolean
|
|
11891
12301
|
self_registration_entity?: "contact" | "account"
|
|
11892
12302
|
user_account_self_management?: boolean
|
|
11893
12303
|
feature_settings?: {
|
|
@@ -11912,7 +12322,6 @@ type UpsertPortalConfigV3 = {
|
|
|
11912
12322
|
cognito_user_pool_client_id?: string
|
|
11913
12323
|
cognito_user_pool_arn?: string
|
|
11914
12324
|
cognito_user_pool_id?: string
|
|
11915
|
-
timeouts?: {
|
|
11916
12325
|
// ...
|
|
11917
12326
|
}
|
|
11918
12327
|
```
|
|
@@ -11982,7 +12391,8 @@ type PortalConfigV3 = {
|
|
|
11982
12391
|
design_id?: string // uuid
|
|
11983
12392
|
allowed_portal_entities?: string[]
|
|
11984
12393
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
11985
|
-
self_registration_account_setting?: "
|
|
12394
|
+
self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY"
|
|
12395
|
+
block_registration_if_portal_user_exists?: boolean
|
|
11986
12396
|
self_registration_entity?: "contact" | "account"
|
|
11987
12397
|
user_account_self_management?: boolean
|
|
11988
12398
|
feature_settings?: {
|
|
@@ -12019,7 +12429,6 @@ type PortalConfigV3 = {
|
|
|
12019
12429
|
}
|
|
12020
12430
|
password_policy?: {
|
|
12021
12431
|
minimum_length?: { ... }
|
|
12022
|
-
maximum_length?: { ... }
|
|
12023
12432
|
// ...
|
|
12024
12433
|
}
|
|
12025
12434
|
```
|