@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.
Files changed (124) hide show
  1. package/definitions/customer-portal-runtime.json +1 -1
  2. package/definitions/customer-portal.json +317 -26
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/configuration-hub.cjs +6 -6
  24. package/dist/apis/configuration-hub.js +1 -1
  25. package/dist/apis/consent.cjs +6 -6
  26. package/dist/apis/consent.js +1 -1
  27. package/dist/apis/customer-portal.cjs +8 -8
  28. package/dist/apis/customer-portal.d.cts +2 -2
  29. package/dist/apis/customer-portal.d.ts +2 -2
  30. package/dist/apis/customer-portal.js +2 -2
  31. package/dist/apis/dashboard.cjs +6 -6
  32. package/dist/apis/dashboard.js +1 -1
  33. package/dist/apis/data-governance.cjs +6 -6
  34. package/dist/apis/data-governance.js +1 -1
  35. package/dist/apis/deduplication.cjs +6 -6
  36. package/dist/apis/deduplication.js +1 -1
  37. package/dist/apis/design.cjs +6 -6
  38. package/dist/apis/design.js +1 -1
  39. package/dist/apis/document.cjs +6 -6
  40. package/dist/apis/document.js +1 -1
  41. package/dist/apis/email-settings.cjs +6 -6
  42. package/dist/apis/email-settings.js +1 -1
  43. package/dist/apis/email-template.cjs +6 -6
  44. package/dist/apis/email-template.js +1 -1
  45. package/dist/apis/entity-mapping.cjs +6 -6
  46. package/dist/apis/entity-mapping.js +1 -1
  47. package/dist/apis/entity.cjs +6 -6
  48. package/dist/apis/entity.js +1 -1
  49. package/dist/apis/environments.cjs +6 -6
  50. package/dist/apis/environments.js +1 -1
  51. package/dist/apis/event-catalog.cjs +6 -6
  52. package/dist/apis/event-catalog.js +1 -1
  53. package/dist/apis/file.cjs +6 -6
  54. package/dist/apis/file.js +1 -1
  55. package/dist/apis/iban.cjs +6 -6
  56. package/dist/apis/iban.js +1 -1
  57. package/dist/apis/integration-toolkit.cjs +6 -6
  58. package/dist/apis/integration-toolkit.js +1 -1
  59. package/dist/apis/journey.cjs +6 -6
  60. package/dist/apis/journey.js +1 -1
  61. package/dist/apis/kanban.cjs +6 -6
  62. package/dist/apis/kanban.js +1 -1
  63. package/dist/apis/message.cjs +6 -6
  64. package/dist/apis/message.js +1 -1
  65. package/dist/apis/metering.cjs +6 -6
  66. package/dist/apis/metering.js +1 -1
  67. package/dist/apis/notes.cjs +6 -6
  68. package/dist/apis/notes.js +1 -1
  69. package/dist/apis/notification.cjs +6 -6
  70. package/dist/apis/notification.js +1 -1
  71. package/dist/apis/organization.cjs +6 -6
  72. package/dist/apis/organization.js +1 -1
  73. package/dist/apis/partner-directory.cjs +6 -6
  74. package/dist/apis/partner-directory.js +1 -1
  75. package/dist/apis/permissions.cjs +6 -6
  76. package/dist/apis/permissions.js +1 -1
  77. package/dist/apis/pricing-tier.cjs +6 -6
  78. package/dist/apis/pricing-tier.js +1 -1
  79. package/dist/apis/pricing.cjs +6 -6
  80. package/dist/apis/pricing.js +1 -1
  81. package/dist/apis/purpose.cjs +6 -6
  82. package/dist/apis/purpose.js +1 -1
  83. package/dist/apis/query.cjs +6 -6
  84. package/dist/apis/query.js +1 -1
  85. package/dist/apis/sandbox.cjs +6 -6
  86. package/dist/apis/sandbox.js +1 -1
  87. package/dist/apis/sharing.cjs +6 -6
  88. package/dist/apis/sharing.js +1 -1
  89. package/dist/apis/submission.cjs +6 -6
  90. package/dist/apis/submission.js +1 -1
  91. package/dist/apis/target.cjs +6 -6
  92. package/dist/apis/target.js +1 -1
  93. package/dist/apis/targeting.cjs +6 -6
  94. package/dist/apis/targeting.js +1 -1
  95. package/dist/apis/template-variables.cjs +6 -6
  96. package/dist/apis/template-variables.js +1 -1
  97. package/dist/apis/user.cjs +6 -6
  98. package/dist/apis/user.js +1 -1
  99. package/dist/apis/validation-rules.cjs +6 -6
  100. package/dist/apis/validation-rules.js +1 -1
  101. package/dist/apis/webhooks.cjs +6 -6
  102. package/dist/apis/webhooks.js +1 -1
  103. package/dist/apis/workflow-definition.cjs +6 -6
  104. package/dist/apis/workflow-definition.js +1 -1
  105. package/dist/apis/workflow.cjs +6 -6
  106. package/dist/apis/workflow.js +1 -1
  107. package/dist/{chunk-KJPOUJBU.cjs → chunk-5ZXGKLB6.cjs} +1 -1
  108. package/dist/{chunk-PTEJYAYJ.js → chunk-774ASAAH.js} +1 -1
  109. package/dist/{chunk-2FJMQLXE.js → chunk-JFMD3PPY.js} +2 -2
  110. package/dist/{chunk-QNMDISUR.cjs → chunk-QZON5VFY.cjs} +2 -2
  111. package/dist/customer-portal-4DXHY42V.js +7 -0
  112. package/dist/customer-portal-5OSGSYGF.cjs +7 -0
  113. package/dist/{customer-portal-runtime-IYHJ3RME.cjs → customer-portal-runtime-HA6CPWB4.cjs} +2 -2
  114. package/dist/{customer-portal-runtime-ZYU3WIXY.js → customer-portal-runtime-TDHV2YVY.js} +1 -1
  115. package/dist/{customer-portal.d-CTTCBAZI.d.cts → customer-portal.d-BRwiQehb.d.cts} +763 -31
  116. package/dist/{customer-portal.d-CTTCBAZI.d.ts → customer-portal.d-BRwiQehb.d.ts} +763 -31
  117. package/dist/index.cjs +10 -10
  118. package/dist/index.d.cts +1 -1
  119. package/dist/index.d.ts +1 -1
  120. package/dist/index.js +2 -2
  121. package/docs/customer-portal.md +463 -54
  122. package/package.json +1 -1
  123. package/dist/customer-portal-IBM3K2EZ.cjs +0 -7
  124. package/dist/customer-portal-XPYKMIIA.js +0 -7
@@ -226,6 +226,22 @@ declare namespace Components {
226
226
  caller?: ActivityCallerContext;
227
227
  };
228
228
  }
229
+ /**
230
+ * A contact attribute that is collected from the user during self-registration
231
+ * and written onto the newly created contact, but is NOT used to identify
232
+ * an existing contact.
233
+ *
234
+ */
235
+ export interface AdditionalContactAttribute {
236
+ /**
237
+ * Name of the contact attribute
238
+ */
239
+ name: string;
240
+ /**
241
+ * Whether the user must provide a value for this attribute
242
+ */
243
+ required?: boolean;
244
+ }
229
245
  export interface AdminUser {
230
246
  [name: string]: any;
231
247
  /**
@@ -924,7 +940,7 @@ declare namespace Components {
924
940
  * example:
925
941
  * abc.com
926
942
  */
927
- domain: string;
943
+ domain?: string;
928
944
  /**
929
945
  * Mark true if the domain is an Epilot domain
930
946
  */
@@ -956,9 +972,21 @@ declare namespace Components {
956
972
  allowed_portal_entities?: string[];
957
973
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
958
974
  /**
959
- * Controls behavior of self-registration when account is used as the registration entity
975
+ * Controls behavior of self-registration when account is the registration
976
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
977
+ * rejects the request when any portal user is already linked to that
978
+ * account (no creation). Blocking can also be enabled on the other
979
+ * non-create modes via `block_registration_if_portal_user_exists`.
980
+ *
981
+ */
982
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
983
+ /**
984
+ * Account-mode only. Reject registration when the resolved account already
985
+ * has any portal user (any portal user whose mapped contact is linked to
986
+ * the account).
987
+ *
960
988
  */
961
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
989
+ block_registration_if_portal_user_exists?: boolean;
962
990
  /**
963
991
  * Entity type used as the primary identifier for self-registration
964
992
  */
@@ -1246,6 +1274,49 @@ declare namespace Components {
1246
1274
  * ]
1247
1275
  */
1248
1276
  registration_identifiers?: ContractIdentifier[];
1277
+ /**
1278
+ * Account-mode only. Identifiers on the contact entity of the primarily
1279
+ * identified account. Used to pick an existing related contact within the
1280
+ * resolved account; if none matches, the values are written onto the new
1281
+ * contact that is created and linked to the account.
1282
+ *
1283
+ * example:
1284
+ * [
1285
+ * {
1286
+ * "name": "first_name",
1287
+ * "schema": "contact"
1288
+ * },
1289
+ * {
1290
+ * "name": "last_name",
1291
+ * "schema": "contact"
1292
+ * }
1293
+ * ]
1294
+ */
1295
+ contact_identifiers_for_account?: RegistrationIdentifier[];
1296
+ /**
1297
+ * Contact attributes collected from the user during self-registration that are
1298
+ * written onto the newly created contact but are not used to identify an
1299
+ * existing one.
1300
+ *
1301
+ * example:
1302
+ * [
1303
+ * {
1304
+ * "name": "first_name",
1305
+ * "required": true
1306
+ * },
1307
+ * {
1308
+ * "name": "last_name",
1309
+ * "required": true
1310
+ * }
1311
+ * ]
1312
+ */
1313
+ additional_contact_attributes?: /**
1314
+ * A contact attribute that is collected from the user during self-registration
1315
+ * and written onto the newly created contact, but is NOT used to identify
1316
+ * an existing contact.
1317
+ *
1318
+ */
1319
+ AdditionalContactAttribute[];
1249
1320
  /**
1250
1321
  * Journeys automatically opened on a portal user action
1251
1322
  */
@@ -1257,6 +1328,21 @@ declare namespace Components {
1257
1328
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1258
1329
  */
1259
1330
  EntityId /* uuid */;
1331
+ /**
1332
+ * Context parameters forwarded to the journey when it is
1333
+ * auto-triggered. Values may contain handlebars templates
1334
+ * that reference the available context (e.g.
1335
+ * `{{contact._id}}`, `{{portal_user.email}}`,
1336
+ * `{{order._id}}`) — these are resolved at trigger time by
1337
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
1338
+ * using the caller's auth context plus runtime entities
1339
+ * supplied via the `context_entities` query param.
1340
+ *
1341
+ */
1342
+ context_params?: {
1343
+ key?: string;
1344
+ value?: string;
1345
+ }[];
1260
1346
  }[];
1261
1347
  /**
1262
1348
  * Rules for editing an entity by a portal user
@@ -1398,9 +1484,21 @@ declare namespace Components {
1398
1484
  allowed_portal_entities?: string[];
1399
1485
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
1400
1486
  /**
1401
- * Controls behavior of self-registration when account is used as the registration entity
1487
+ * Controls behavior of self-registration when account is the registration
1488
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
1489
+ * rejects the request when any portal user is already linked to that
1490
+ * account (no creation). Blocking can also be enabled on the other
1491
+ * non-create modes via `block_registration_if_portal_user_exists`.
1492
+ *
1493
+ */
1494
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
1495
+ /**
1496
+ * Account-mode only. Reject registration when the resolved account already
1497
+ * has any portal user (any portal user whose mapped contact is linked to
1498
+ * the account).
1499
+ *
1402
1500
  */
1403
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
1501
+ block_registration_if_portal_user_exists?: boolean;
1404
1502
  /**
1405
1503
  * Entity type used as the primary identifier for self-registration
1406
1504
  */
@@ -1688,6 +1786,49 @@ declare namespace Components {
1688
1786
  * ]
1689
1787
  */
1690
1788
  registration_identifiers?: ContractIdentifier[];
1789
+ /**
1790
+ * Account-mode only. Identifiers on the contact entity of the primarily
1791
+ * identified account. Used to pick an existing related contact within the
1792
+ * resolved account; if none matches, the values are written onto the new
1793
+ * contact that is created and linked to the account.
1794
+ *
1795
+ * example:
1796
+ * [
1797
+ * {
1798
+ * "name": "first_name",
1799
+ * "schema": "contact"
1800
+ * },
1801
+ * {
1802
+ * "name": "last_name",
1803
+ * "schema": "contact"
1804
+ * }
1805
+ * ]
1806
+ */
1807
+ contact_identifiers_for_account?: RegistrationIdentifier[];
1808
+ /**
1809
+ * Contact attributes collected from the user during self-registration that are
1810
+ * written onto the newly created contact but are not used to identify an
1811
+ * existing one.
1812
+ *
1813
+ * example:
1814
+ * [
1815
+ * {
1816
+ * "name": "first_name",
1817
+ * "required": true
1818
+ * },
1819
+ * {
1820
+ * "name": "last_name",
1821
+ * "required": true
1822
+ * }
1823
+ * ]
1824
+ */
1825
+ additional_contact_attributes?: /**
1826
+ * A contact attribute that is collected from the user during self-registration
1827
+ * and written onto the newly created contact, but is NOT used to identify
1828
+ * an existing contact.
1829
+ *
1830
+ */
1831
+ AdditionalContactAttribute[];
1691
1832
  /**
1692
1833
  * Journeys automatically opened on a portal user action
1693
1834
  */
@@ -1699,6 +1840,21 @@ declare namespace Components {
1699
1840
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1700
1841
  */
1701
1842
  EntityId /* uuid */;
1843
+ /**
1844
+ * Context parameters forwarded to the journey when it is
1845
+ * auto-triggered. Values may contain handlebars templates
1846
+ * that reference the available context (e.g.
1847
+ * `{{contact._id}}`, `{{portal_user.email}}`,
1848
+ * `{{order._id}}`) — these are resolved at trigger time by
1849
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
1850
+ * using the caller's auth context plus runtime entities
1851
+ * supplied via the `context_entities` query param.
1852
+ *
1853
+ */
1854
+ context_params?: {
1855
+ key?: string;
1856
+ value?: string;
1857
+ }[];
1702
1858
  }[];
1703
1859
  /**
1704
1860
  * Rules for editing an entity by a portal user
@@ -2210,6 +2366,36 @@ declare namespace Components {
2210
2366
  [name: string]: string;
2211
2367
  };
2212
2368
  };
2369
+ /**
2370
+ * Account-mode only. Values for the contact identifiers configured
2371
+ * under `contact_identifiers_for_account` on the portal. Used to
2372
+ * find an existing related contact within the resolved account, or
2373
+ * written onto the new contact if none matches.
2374
+ *
2375
+ * example:
2376
+ * {
2377
+ * "first_name": "John",
2378
+ * "last_name": "Doe"
2379
+ * }
2380
+ */
2381
+ contact_identifiers_for_account?: {
2382
+ [name: string]: string;
2383
+ };
2384
+ /**
2385
+ * Values for the contact attributes configured under
2386
+ * `additional_contact_attributes` on the portal. These are written
2387
+ * onto the newly created contact but are not used to identify an
2388
+ * existing one.
2389
+ *
2390
+ * example:
2391
+ * {
2392
+ * "first_name": "John",
2393
+ * "last_name": "Doe"
2394
+ * }
2395
+ */
2396
+ additional_contact_attributes?: {
2397
+ [name: string]: string;
2398
+ };
2213
2399
  /**
2214
2400
  * ID of the account
2215
2401
  */
@@ -3383,6 +3569,10 @@ declare namespace Components {
3383
3569
  /**
3384
3570
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
3385
3571
  */
3572
+ data_path?: string;
3573
+ /**
3574
+ * Deprecated. Use `data_path` instead.
3575
+ */
3386
3576
  dataPath?: string;
3387
3577
  /**
3388
3578
  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -3391,7 +3581,7 @@ declare namespace Components {
3391
3581
  * example:
3392
3582
  * error.message
3393
3583
  */
3394
- errorMessagePath?: string;
3584
+ error_message_path?: string;
3395
3585
  };
3396
3586
  /**
3397
3587
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3446,10 +3636,24 @@ declare namespace Components {
3446
3636
  [key: string]: any;
3447
3637
  };
3448
3638
  /**
3449
- * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
3639
+ * Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
3450
3640
  */
3451
3641
  result?: string;
3452
3642
  };
3643
+ resolved?: {
3644
+ /**
3645
+ * Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`.
3646
+ */
3647
+ result?: string;
3648
+ /**
3649
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
3650
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
3651
+ *
3652
+ * example:
3653
+ * error.message
3654
+ */
3655
+ error_message_path?: string;
3656
+ };
3453
3657
  /**
3454
3658
  * Mode of contract assignment. See hook description for mode details.
3455
3659
  */
@@ -3520,6 +3724,10 @@ declare namespace Components {
3520
3724
  /**
3521
3725
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
3522
3726
  */
3727
+ data_path?: string;
3728
+ /**
3729
+ * Deprecated. Use `data_path` instead.
3730
+ */
3523
3731
  dataPath?: string;
3524
3732
  /**
3525
3733
  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -3528,7 +3736,7 @@ declare namespace Components {
3528
3736
  * example:
3529
3737
  * error.message
3530
3738
  */
3531
- errorMessagePath?: string;
3739
+ error_message_path?: string;
3532
3740
  };
3533
3741
  /**
3534
3742
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3590,7 +3798,7 @@ declare namespace Components {
3590
3798
  * example:
3591
3799
  * error.message
3592
3800
  */
3593
- errorMessagePath?: string;
3801
+ error_message_path?: string;
3594
3802
  };
3595
3803
  /**
3596
3804
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3649,6 +3857,10 @@ declare namespace Components {
3649
3857
  * example:
3650
3858
  * data.results
3651
3859
  */
3860
+ data_path?: string;
3861
+ /**
3862
+ * Deprecated. Use `data_path` instead.
3863
+ */
3652
3864
  dataPath?: string;
3653
3865
  /**
3654
3866
  * Counter identifier(s) used to match against the meter's counters.
@@ -3692,7 +3904,7 @@ declare namespace Components {
3692
3904
  * example:
3693
3905
  * error.message
3694
3906
  */
3695
- errorMessagePath?: string;
3907
+ error_message_path?: string;
3696
3908
  };
3697
3909
  /**
3698
3910
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3742,6 +3954,10 @@ declare namespace Components {
3742
3954
  /**
3743
3955
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
3744
3956
  */
3957
+ data_path?: string;
3958
+ /**
3959
+ * Deprecated. Use `data_path` instead.
3960
+ */
3745
3961
  dataPath?: string;
3746
3962
  /**
3747
3963
  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -3750,7 +3966,7 @@ declare namespace Components {
3750
3966
  * example:
3751
3967
  * error.message
3752
3968
  */
3753
- errorMessagePath?: string;
3969
+ error_message_path?: string;
3754
3970
  };
3755
3971
  /**
3756
3972
  * Deprecated. Prefer `secure_proxy` instead.
@@ -3797,10 +4013,24 @@ declare namespace Components {
3797
4013
  [key: string]: any;
3798
4014
  };
3799
4015
  /**
3800
- * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
4016
+ * Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
3801
4017
  */
3802
4018
  result?: string;
3803
4019
  };
4020
+ resolved?: {
4021
+ /**
4022
+ * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`.
4023
+ */
4024
+ result?: string;
4025
+ /**
4026
+ * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
4027
+ * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
4028
+ *
4029
+ * example:
4030
+ * error.message
4031
+ */
4032
+ error_message_path?: string;
4033
+ };
3804
4034
  /**
3805
4035
  * Deprecated. Prefer `secure_proxy` instead.
3806
4036
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
@@ -3862,6 +4092,10 @@ declare namespace Components {
3862
4092
  /**
3863
4093
  * Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
3864
4094
  */
4095
+ data_path?: string;
4096
+ /**
4097
+ * Deprecated. Use `data_path` instead.
4098
+ */
3865
4099
  dataPath?: string;
3866
4100
  /**
3867
4101
  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -3870,7 +4104,7 @@ declare namespace Components {
3870
4104
  * example:
3871
4105
  * error.message
3872
4106
  */
3873
- errorMessagePath?: string;
4107
+ error_message_path?: string;
3874
4108
  };
3875
4109
  /**
3876
4110
  * Deprecated. Prefer `secure_proxy` instead.
@@ -4683,7 +4917,7 @@ declare namespace Components {
4683
4917
  */
4684
4918
  scope: string;
4685
4919
  metadata?: OIDCProviderMetadata;
4686
- prompt?: "login" | "select_account" | "consent";
4920
+ prompt?: "login" | "select_account" | "consent" | "signup";
4687
4921
  }
4688
4922
  export interface OIDCProviderMetadata {
4689
4923
  /**
@@ -5305,7 +5539,7 @@ declare namespace Components {
5305
5539
  * example:
5306
5540
  * abc.com
5307
5541
  */
5308
- domain: string;
5542
+ domain?: string;
5309
5543
  /**
5310
5544
  * Mark true if the domain is an Epilot domain
5311
5545
  */
@@ -5334,9 +5568,21 @@ declare namespace Components {
5334
5568
  allowed_portal_entities?: string[];
5335
5569
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
5336
5570
  /**
5337
- * Controls behavior of self-registration when account is used as the registration entity
5571
+ * Controls behavior of self-registration when account is the registration
5572
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
5573
+ * rejects the request when any portal user is already linked to that
5574
+ * account (no creation). Blocking can also be enabled on the other
5575
+ * non-create modes via `block_registration_if_portal_user_exists`.
5576
+ *
5577
+ */
5578
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
5579
+ /**
5580
+ * Account-mode only. Reject registration when the resolved account already
5581
+ * has any portal user (any portal user whose mapped contact is linked to
5582
+ * the account).
5583
+ *
5338
5584
  */
5339
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
5585
+ block_registration_if_portal_user_exists?: boolean;
5340
5586
  /**
5341
5587
  * Entity type used as the primary identifier for self-registration
5342
5588
  */
@@ -5624,6 +5870,49 @@ declare namespace Components {
5624
5870
  * ]
5625
5871
  */
5626
5872
  registration_identifiers?: ContractIdentifier[];
5873
+ /**
5874
+ * Account-mode only. Identifiers on the contact entity of the primarily
5875
+ * identified account. Used to pick an existing related contact within the
5876
+ * resolved account; if none matches, the values are written onto the new
5877
+ * contact that is created and linked to the account.
5878
+ *
5879
+ * example:
5880
+ * [
5881
+ * {
5882
+ * "name": "first_name",
5883
+ * "schema": "contact"
5884
+ * },
5885
+ * {
5886
+ * "name": "last_name",
5887
+ * "schema": "contact"
5888
+ * }
5889
+ * ]
5890
+ */
5891
+ contact_identifiers_for_account?: RegistrationIdentifier[];
5892
+ /**
5893
+ * Contact attributes collected from the user during self-registration that are
5894
+ * written onto the newly created contact but are not used to identify an
5895
+ * existing one.
5896
+ *
5897
+ * example:
5898
+ * [
5899
+ * {
5900
+ * "name": "first_name",
5901
+ * "required": true
5902
+ * },
5903
+ * {
5904
+ * "name": "last_name",
5905
+ * "required": true
5906
+ * }
5907
+ * ]
5908
+ */
5909
+ additional_contact_attributes?: /**
5910
+ * A contact attribute that is collected from the user during self-registration
5911
+ * and written onto the newly created contact, but is NOT used to identify
5912
+ * an existing contact.
5913
+ *
5914
+ */
5915
+ AdditionalContactAttribute[];
5627
5916
  /**
5628
5917
  * Journeys automatically opened on a portal user action
5629
5918
  */
@@ -5635,6 +5924,21 @@ declare namespace Components {
5635
5924
  * 5da0a718-c822-403d-9f5d-20d4584e0528
5636
5925
  */
5637
5926
  EntityId /* uuid */;
5927
+ /**
5928
+ * Context parameters forwarded to the journey when it is
5929
+ * auto-triggered. Values may contain handlebars templates
5930
+ * that reference the available context (e.g.
5931
+ * `{{contact._id}}`, `{{portal_user.email}}`,
5932
+ * `{{order._id}}`) — these are resolved at trigger time by
5933
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
5934
+ * using the caller's auth context plus runtime entities
5935
+ * supplied via the `context_entities` query param.
5936
+ *
5937
+ */
5938
+ context_params?: {
5939
+ key?: string;
5940
+ value?: string;
5941
+ }[];
5638
5942
  }[];
5639
5943
  /**
5640
5944
  * Rules for editing an entity by a portal user
@@ -5871,9 +6175,21 @@ declare namespace Components {
5871
6175
  allowed_portal_entities?: string[];
5872
6176
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
5873
6177
  /**
5874
- * Controls behavior of self-registration when account is used as the registration entity
6178
+ * Controls behavior of self-registration when account is the registration
6179
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
6180
+ * rejects the request when any portal user is already linked to that
6181
+ * account (no creation). Blocking can also be enabled on the other
6182
+ * non-create modes via `block_registration_if_portal_user_exists`.
6183
+ *
6184
+ */
6185
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
6186
+ /**
6187
+ * Account-mode only. Reject registration when the resolved account already
6188
+ * has any portal user (any portal user whose mapped contact is linked to
6189
+ * the account).
6190
+ *
5875
6191
  */
5876
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
6192
+ block_registration_if_portal_user_exists?: boolean;
5877
6193
  /**
5878
6194
  * Entity type used as the primary identifier for self-registration
5879
6195
  */
@@ -6161,6 +6477,49 @@ declare namespace Components {
6161
6477
  * ]
6162
6478
  */
6163
6479
  registration_identifiers?: ContractIdentifier[];
6480
+ /**
6481
+ * Account-mode only. Identifiers on the contact entity of the primarily
6482
+ * identified account. Used to pick an existing related contact within the
6483
+ * resolved account; if none matches, the values are written onto the new
6484
+ * contact that is created and linked to the account.
6485
+ *
6486
+ * example:
6487
+ * [
6488
+ * {
6489
+ * "name": "first_name",
6490
+ * "schema": "contact"
6491
+ * },
6492
+ * {
6493
+ * "name": "last_name",
6494
+ * "schema": "contact"
6495
+ * }
6496
+ * ]
6497
+ */
6498
+ contact_identifiers_for_account?: RegistrationIdentifier[];
6499
+ /**
6500
+ * Contact attributes collected from the user during self-registration that are
6501
+ * written onto the newly created contact but are not used to identify an
6502
+ * existing one.
6503
+ *
6504
+ * example:
6505
+ * [
6506
+ * {
6507
+ * "name": "first_name",
6508
+ * "required": true
6509
+ * },
6510
+ * {
6511
+ * "name": "last_name",
6512
+ * "required": true
6513
+ * }
6514
+ * ]
6515
+ */
6516
+ additional_contact_attributes?: /**
6517
+ * A contact attribute that is collected from the user during self-registration
6518
+ * and written onto the newly created contact, but is NOT used to identify
6519
+ * an existing contact.
6520
+ *
6521
+ */
6522
+ AdditionalContactAttribute[];
6164
6523
  /**
6165
6524
  * Journeys automatically opened on a portal user action
6166
6525
  */
@@ -6172,6 +6531,21 @@ declare namespace Components {
6172
6531
  * 5da0a718-c822-403d-9f5d-20d4584e0528
6173
6532
  */
6174
6533
  EntityId /* uuid */;
6534
+ /**
6535
+ * Context parameters forwarded to the journey when it is
6536
+ * auto-triggered. Values may contain handlebars templates
6537
+ * that reference the available context (e.g.
6538
+ * `{{contact._id}}`, `{{portal_user.email}}`,
6539
+ * `{{order._id}}`) — these are resolved at trigger time by
6540
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
6541
+ * using the caller's auth context plus runtime entities
6542
+ * supplied via the `context_entities` query param.
6543
+ *
6544
+ */
6545
+ context_params?: {
6546
+ key?: string;
6547
+ value?: string;
6548
+ }[];
6175
6549
  }[];
6176
6550
  /**
6177
6551
  * Rules for editing an entity by a portal user
@@ -6620,6 +6994,7 @@ declare namespace Components {
6620
6994
  priceDataRetrieval?: DataRetrievalItem[];
6621
6995
  costDataRetrieval?: DataRetrievalItem[];
6622
6996
  contractIdentification?: {
6997
+ app?: PublicAppDetails;
6623
6998
  extension?: PublicExtensionDetails;
6624
6999
  hook?: PublicContractIdentificationDetails;
6625
7000
  };
@@ -7198,7 +7573,7 @@ declare namespace Components {
7198
7573
  * example:
7199
7574
  * abc.com
7200
7575
  */
7201
- domain: string;
7576
+ domain?: string;
7202
7577
  /**
7203
7578
  * Mark true if the domain is an Epilot domain
7204
7579
  */
@@ -7227,9 +7602,21 @@ declare namespace Components {
7227
7602
  allowed_portal_entities?: string[];
7228
7603
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7229
7604
  /**
7230
- * Controls behavior of self-registration when account is used as the registration entity
7605
+ * Controls behavior of self-registration when account is the registration
7606
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
7607
+ * rejects the request when any portal user is already linked to that
7608
+ * account (no creation). Blocking can also be enabled on the other
7609
+ * non-create modes via `block_registration_if_portal_user_exists`.
7610
+ *
7611
+ */
7612
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
7613
+ /**
7614
+ * Account-mode only. Reject registration when the resolved account already
7615
+ * has any portal user (any portal user whose mapped contact is linked to
7616
+ * the account).
7617
+ *
7231
7618
  */
7232
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
7619
+ block_registration_if_portal_user_exists?: boolean;
7233
7620
  /**
7234
7621
  * Entity type used as the primary identifier for self-registration
7235
7622
  */
@@ -7517,6 +7904,49 @@ declare namespace Components {
7517
7904
  * ]
7518
7905
  */
7519
7906
  registration_identifiers?: ContractIdentifier[];
7907
+ /**
7908
+ * Account-mode only. Identifiers on the contact entity of the primarily
7909
+ * identified account. Used to pick an existing related contact within the
7910
+ * resolved account; if none matches, the values are written onto the new
7911
+ * contact that is created and linked to the account.
7912
+ *
7913
+ * example:
7914
+ * [
7915
+ * {
7916
+ * "name": "first_name",
7917
+ * "schema": "contact"
7918
+ * },
7919
+ * {
7920
+ * "name": "last_name",
7921
+ * "schema": "contact"
7922
+ * }
7923
+ * ]
7924
+ */
7925
+ contact_identifiers_for_account?: RegistrationIdentifier[];
7926
+ /**
7927
+ * Contact attributes collected from the user during self-registration that are
7928
+ * written onto the newly created contact but are not used to identify an
7929
+ * existing one.
7930
+ *
7931
+ * example:
7932
+ * [
7933
+ * {
7934
+ * "name": "first_name",
7935
+ * "required": true
7936
+ * },
7937
+ * {
7938
+ * "name": "last_name",
7939
+ * "required": true
7940
+ * }
7941
+ * ]
7942
+ */
7943
+ additional_contact_attributes?: /**
7944
+ * A contact attribute that is collected from the user during self-registration
7945
+ * and written onto the newly created contact, but is NOT used to identify
7946
+ * an existing contact.
7947
+ *
7948
+ */
7949
+ AdditionalContactAttribute[];
7520
7950
  /**
7521
7951
  * Journeys automatically opened on a portal user action
7522
7952
  */
@@ -7528,6 +7958,21 @@ declare namespace Components {
7528
7958
  * 5da0a718-c822-403d-9f5d-20d4584e0528
7529
7959
  */
7530
7960
  EntityId /* uuid */;
7961
+ /**
7962
+ * Context parameters forwarded to the journey when it is
7963
+ * auto-triggered. Values may contain handlebars templates
7964
+ * that reference the available context (e.g.
7965
+ * `{{contact._id}}`, `{{portal_user.email}}`,
7966
+ * `{{order._id}}`) — these are resolved at trigger time by
7967
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
7968
+ * using the caller's auth context plus runtime entities
7969
+ * supplied via the `context_entities` query param.
7970
+ *
7971
+ */
7972
+ context_params?: {
7973
+ key?: string;
7974
+ value?: string;
7975
+ }[];
7531
7976
  }[];
7532
7977
  /**
7533
7978
  * Rules for editing an entity by a portal user
@@ -7732,9 +8177,21 @@ declare namespace Components {
7732
8177
  allowed_portal_entities?: string[];
7733
8178
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7734
8179
  /**
7735
- * Controls behavior of self-registration when account is used as the registration entity
8180
+ * Controls behavior of self-registration when account is the registration
8181
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
8182
+ * rejects the request when any portal user is already linked to that
8183
+ * account (no creation). Blocking can also be enabled on the other
8184
+ * non-create modes via `block_registration_if_portal_user_exists`.
8185
+ *
8186
+ */
8187
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
8188
+ /**
8189
+ * Account-mode only. Reject registration when the resolved account already
8190
+ * has any portal user (any portal user whose mapped contact is linked to
8191
+ * the account).
8192
+ *
7736
8193
  */
7737
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
8194
+ block_registration_if_portal_user_exists?: boolean;
7738
8195
  /**
7739
8196
  * Entity type used as the primary identifier for self-registration
7740
8197
  */
@@ -8022,6 +8479,49 @@ declare namespace Components {
8022
8479
  * ]
8023
8480
  */
8024
8481
  registration_identifiers?: ContractIdentifier[];
8482
+ /**
8483
+ * Account-mode only. Identifiers on the contact entity of the primarily
8484
+ * identified account. Used to pick an existing related contact within the
8485
+ * resolved account; if none matches, the values are written onto the new
8486
+ * contact that is created and linked to the account.
8487
+ *
8488
+ * example:
8489
+ * [
8490
+ * {
8491
+ * "name": "first_name",
8492
+ * "schema": "contact"
8493
+ * },
8494
+ * {
8495
+ * "name": "last_name",
8496
+ * "schema": "contact"
8497
+ * }
8498
+ * ]
8499
+ */
8500
+ contact_identifiers_for_account?: RegistrationIdentifier[];
8501
+ /**
8502
+ * Contact attributes collected from the user during self-registration that are
8503
+ * written onto the newly created contact but are not used to identify an
8504
+ * existing one.
8505
+ *
8506
+ * example:
8507
+ * [
8508
+ * {
8509
+ * "name": "first_name",
8510
+ * "required": true
8511
+ * },
8512
+ * {
8513
+ * "name": "last_name",
8514
+ * "required": true
8515
+ * }
8516
+ * ]
8517
+ */
8518
+ additional_contact_attributes?: /**
8519
+ * A contact attribute that is collected from the user during self-registration
8520
+ * and written onto the newly created contact, but is NOT used to identify
8521
+ * an existing contact.
8522
+ *
8523
+ */
8524
+ AdditionalContactAttribute[];
8025
8525
  /**
8026
8526
  * Journeys automatically opened on a portal user action
8027
8527
  */
@@ -8033,6 +8533,21 @@ declare namespace Components {
8033
8533
  * 5da0a718-c822-403d-9f5d-20d4584e0528
8034
8534
  */
8035
8535
  EntityId /* uuid */;
8536
+ /**
8537
+ * Context parameters forwarded to the journey when it is
8538
+ * auto-triggered. Values may contain handlebars templates
8539
+ * that reference the available context (e.g.
8540
+ * `{{contact._id}}`, `{{portal_user.email}}`,
8541
+ * `{{order._id}}`) — these are resolved at trigger time by
8542
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
8543
+ * using the caller's auth context plus runtime entities
8544
+ * supplied via the `context_entities` query param.
8545
+ *
8546
+ */
8547
+ context_params?: {
8548
+ key?: string;
8549
+ value?: string;
8550
+ }[];
8036
8551
  }[];
8037
8552
  /**
8038
8553
  * Rules for editing an entity by a portal user
@@ -10556,7 +11071,7 @@ declare namespace Paths {
10556
11071
  * example:
10557
11072
  * abc.com
10558
11073
  */
10559
- domain: string;
11074
+ domain?: string;
10560
11075
  /**
10561
11076
  * Mark true if the domain is an Epilot domain
10562
11077
  */
@@ -10585,9 +11100,21 @@ declare namespace Paths {
10585
11100
  allowed_portal_entities?: string[];
10586
11101
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
10587
11102
  /**
10588
- * Controls behavior of self-registration when account is used as the registration entity
11103
+ * Controls behavior of self-registration when account is the registration
11104
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
11105
+ * rejects the request when any portal user is already linked to that
11106
+ * account (no creation). Blocking can also be enabled on the other
11107
+ * non-create modes via `block_registration_if_portal_user_exists`.
11108
+ *
11109
+ */
11110
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
11111
+ /**
11112
+ * Account-mode only. Reject registration when the resolved account already
11113
+ * has any portal user (any portal user whose mapped contact is linked to
11114
+ * the account).
11115
+ *
10589
11116
  */
10590
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
11117
+ block_registration_if_portal_user_exists?: boolean;
10591
11118
  /**
10592
11119
  * Entity type used as the primary identifier for self-registration
10593
11120
  */
@@ -10875,6 +11402,49 @@ declare namespace Paths {
10875
11402
  * ]
10876
11403
  */
10877
11404
  registration_identifiers?: Components.Schemas.ContractIdentifier[];
11405
+ /**
11406
+ * Account-mode only. Identifiers on the contact entity of the primarily
11407
+ * identified account. Used to pick an existing related contact within the
11408
+ * resolved account; if none matches, the values are written onto the new
11409
+ * contact that is created and linked to the account.
11410
+ *
11411
+ * example:
11412
+ * [
11413
+ * {
11414
+ * "name": "first_name",
11415
+ * "schema": "contact"
11416
+ * },
11417
+ * {
11418
+ * "name": "last_name",
11419
+ * "schema": "contact"
11420
+ * }
11421
+ * ]
11422
+ */
11423
+ contact_identifiers_for_account?: Components.Schemas.RegistrationIdentifier[];
11424
+ /**
11425
+ * Contact attributes collected from the user during self-registration that are
11426
+ * written onto the newly created contact but are not used to identify an
11427
+ * existing one.
11428
+ *
11429
+ * example:
11430
+ * [
11431
+ * {
11432
+ * "name": "first_name",
11433
+ * "required": true
11434
+ * },
11435
+ * {
11436
+ * "name": "last_name",
11437
+ * "required": true
11438
+ * }
11439
+ * ]
11440
+ */
11441
+ additional_contact_attributes?: /**
11442
+ * A contact attribute that is collected from the user during self-registration
11443
+ * and written onto the newly created contact, but is NOT used to identify
11444
+ * an existing contact.
11445
+ *
11446
+ */
11447
+ Components.Schemas.AdditionalContactAttribute[];
10878
11448
  /**
10879
11449
  * Journeys automatically opened on a portal user action
10880
11450
  */
@@ -10886,6 +11456,21 @@ declare namespace Paths {
10886
11456
  * 5da0a718-c822-403d-9f5d-20d4584e0528
10887
11457
  */
10888
11458
  Components.Schemas.EntityId /* uuid */;
11459
+ /**
11460
+ * Context parameters forwarded to the journey when it is
11461
+ * auto-triggered. Values may contain handlebars templates
11462
+ * that reference the available context (e.g.
11463
+ * `{{contact._id}}`, `{{portal_user.email}}`,
11464
+ * `{{order._id}}`) — these are resolved at trigger time by
11465
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
11466
+ * using the caller's auth context plus runtime entities
11467
+ * supplied via the `context_entities` query param.
11468
+ *
11469
+ */
11470
+ context_params?: {
11471
+ key?: string;
11472
+ value?: string;
11473
+ }[];
10889
11474
  }[];
10890
11475
  /**
10891
11476
  * Rules for editing an entity by a portal user
@@ -11092,7 +11677,7 @@ declare namespace Paths {
11092
11677
  * example:
11093
11678
  * abc.com
11094
11679
  */
11095
- domain: string;
11680
+ domain?: string;
11096
11681
  /**
11097
11682
  * Mark true if the domain is an Epilot domain
11098
11683
  */
@@ -11121,9 +11706,21 @@ declare namespace Paths {
11121
11706
  allowed_portal_entities?: string[];
11122
11707
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
11123
11708
  /**
11124
- * Controls behavior of self-registration when account is used as the registration entity
11709
+ * Controls behavior of self-registration when account is the registration
11710
+ * entity. `BLOCK_IF_PORTAL_USER_EXISTS` matches an existing account and
11711
+ * rejects the request when any portal user is already linked to that
11712
+ * account (no creation). Blocking can also be enabled on the other
11713
+ * non-create modes via `block_registration_if_portal_user_exists`.
11714
+ *
11715
+ */
11716
+ self_registration_account_setting?: "ALLOW_WITH_CREATION" | "DENY" | "ALWAYS_CREATE" | "BLOCK_IF_PORTAL_USER_EXISTS" | "DISALLOW_COMPLETELY";
11717
+ /**
11718
+ * Account-mode only. Reject registration when the resolved account already
11719
+ * has any portal user (any portal user whose mapped contact is linked to
11720
+ * the account).
11721
+ *
11125
11722
  */
11126
- self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
11723
+ block_registration_if_portal_user_exists?: boolean;
11127
11724
  /**
11128
11725
  * Entity type used as the primary identifier for self-registration
11129
11726
  */
@@ -11411,6 +12008,49 @@ declare namespace Paths {
11411
12008
  * ]
11412
12009
  */
11413
12010
  registration_identifiers?: Components.Schemas.ContractIdentifier[];
12011
+ /**
12012
+ * Account-mode only. Identifiers on the contact entity of the primarily
12013
+ * identified account. Used to pick an existing related contact within the
12014
+ * resolved account; if none matches, the values are written onto the new
12015
+ * contact that is created and linked to the account.
12016
+ *
12017
+ * example:
12018
+ * [
12019
+ * {
12020
+ * "name": "first_name",
12021
+ * "schema": "contact"
12022
+ * },
12023
+ * {
12024
+ * "name": "last_name",
12025
+ * "schema": "contact"
12026
+ * }
12027
+ * ]
12028
+ */
12029
+ contact_identifiers_for_account?: Components.Schemas.RegistrationIdentifier[];
12030
+ /**
12031
+ * Contact attributes collected from the user during self-registration that are
12032
+ * written onto the newly created contact but are not used to identify an
12033
+ * existing one.
12034
+ *
12035
+ * example:
12036
+ * [
12037
+ * {
12038
+ * "name": "first_name",
12039
+ * "required": true
12040
+ * },
12041
+ * {
12042
+ * "name": "last_name",
12043
+ * "required": true
12044
+ * }
12045
+ * ]
12046
+ */
12047
+ additional_contact_attributes?: /**
12048
+ * A contact attribute that is collected from the user during self-registration
12049
+ * and written onto the newly created contact, but is NOT used to identify
12050
+ * an existing contact.
12051
+ *
12052
+ */
12053
+ Components.Schemas.AdditionalContactAttribute[];
11414
12054
  /**
11415
12055
  * Journeys automatically opened on a portal user action
11416
12056
  */
@@ -11422,6 +12062,21 @@ declare namespace Paths {
11422
12062
  * 5da0a718-c822-403d-9f5d-20d4584e0528
11423
12063
  */
11424
12064
  Components.Schemas.EntityId /* uuid */;
12065
+ /**
12066
+ * Context parameters forwarded to the journey when it is
12067
+ * auto-triggered. Values may contain handlebars templates
12068
+ * that reference the available context (e.g.
12069
+ * `{{contact._id}}`, `{{portal_user.email}}`,
12070
+ * `{{order._id}}`) — these are resolved at trigger time by
12071
+ * `GET /v2/portal/config/triggered-journeys/{trigger_name}`
12072
+ * using the caller's auth context plus runtime entities
12073
+ * supplied via the `context_entities` query param.
12074
+ *
12075
+ */
12076
+ context_params?: {
12077
+ key?: string;
12078
+ value?: string;
12079
+ }[];
11425
12080
  }[];
11426
12081
  /**
11427
12082
  * Rules for editing an entity by a portal user
@@ -12607,6 +13262,42 @@ declare namespace Paths {
12607
13262
  export type $500 = Components.Responses.InternalServerError;
12608
13263
  }
12609
13264
  }
13265
+ namespace GetTriggeredJourney {
13266
+ namespace Parameters {
13267
+ export type ContextEntities = /**
13268
+ * Additional entities to include in the context for variable interpolation. Portal User and Contact entities are automatically part of the context.
13269
+ * example:
13270
+ * [
13271
+ * {
13272
+ * "entity_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
13273
+ * "entity_schema": "contract"
13274
+ * }
13275
+ * ]
13276
+ */
13277
+ Components.Schemas.ContextEntities;
13278
+ }
13279
+ export interface QueryParameters {
13280
+ context_entities?: Parameters.ContextEntities;
13281
+ }
13282
+ namespace Responses {
13283
+ export interface $200 {
13284
+ trigger_name?: "FIRST_LOGIN" | "ACCEPT_ORDER" | "DECLINE_ORDER";
13285
+ journey_id?: /**
13286
+ * Entity ID
13287
+ * example:
13288
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
13289
+ */
13290
+ Components.Schemas.EntityId /* uuid */;
13291
+ context_params?: {
13292
+ key?: string;
13293
+ value?: string;
13294
+ }[];
13295
+ }
13296
+ export type $401 = Components.Responses.Unauthorized;
13297
+ export type $404 = Components.Responses.NotFound;
13298
+ export type $500 = Components.Responses.InternalServerError;
13299
+ }
13300
+ }
12610
13301
  namespace GetUserEntryPoint {
12611
13302
  namespace Parameters {
12612
13303
  /**
@@ -14118,6 +14809,14 @@ declare namespace Paths {
14118
14809
  Parameters.Id /* uuid */;
14119
14810
  }
14120
14811
  }
14812
+ namespace V2PortalConfigTriggeredJourneys$TriggerName {
14813
+ namespace Parameters {
14814
+ export type TriggerName = "FIRST_LOGIN" | "ACCEPT_ORDER" | "DECLINE_ORDER";
14815
+ }
14816
+ export interface PathParameters {
14817
+ trigger_name: Parameters.TriggerName;
14818
+ }
14819
+ }
14121
14820
  namespace V2PortalPages {
14122
14821
  namespace Parameters {
14123
14822
  /**
@@ -15623,6 +16322,21 @@ interface OperationMethods {
15623
16322
  data?: Paths.InterpolatePortalPages.RequestBody,
15624
16323
  config?: AxiosRequestConfig
15625
16324
  ): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
16325
+ /**
16326
+ * getTriggeredJourney - getTriggeredJourney
16327
+ *
16328
+ * Returns the auto-triggered journey configured for the given trigger
16329
+ * with handlebars templates in `context_params` already resolved.
16330
+ * Uses the caller's auth context (contact, portal user) plus any
16331
+ * `context_entities` supplied at trigger time (e.g. the order being
16332
+ * accepted) — same resolver as `getPortalPages`.
16333
+ *
16334
+ */
16335
+ 'getTriggeredJourney'(
16336
+ parameters?: Parameters<Paths.GetTriggeredJourney.QueryParameters & Paths.V2PortalConfigTriggeredJourneys$TriggerName.PathParameters> | null,
16337
+ data?: any,
16338
+ config?: AxiosRequestConfig
16339
+ ): OperationResponse<Paths.GetTriggeredJourney.Responses.$200>
15626
16340
  /**
15627
16341
  * getDefaultPages - getDefaultPages
15628
16342
  *
@@ -17400,6 +18114,23 @@ interface PathsDictionary {
17400
18114
  config?: AxiosRequestConfig
17401
18115
  ): OperationResponse<Paths.InterpolatePortalPages.Responses.$200>
17402
18116
  }
18117
+ ['/v2/portal/config/triggered-journeys/{trigger_name}']: {
18118
+ /**
18119
+ * getTriggeredJourney - getTriggeredJourney
18120
+ *
18121
+ * Returns the auto-triggered journey configured for the given trigger
18122
+ * with handlebars templates in `context_params` already resolved.
18123
+ * Uses the caller's auth context (contact, portal user) plus any
18124
+ * `context_entities` supplied at trigger time (e.g. the order being
18125
+ * accepted) — same resolver as `getPortalPages`.
18126
+ *
18127
+ */
18128
+ 'get'(
18129
+ parameters?: Parameters<Paths.GetTriggeredJourney.QueryParameters & Paths.V2PortalConfigTriggeredJourneys$TriggerName.PathParameters> | null,
18130
+ data?: any,
18131
+ config?: AxiosRequestConfig
18132
+ ): OperationResponse<Paths.GetTriggeredJourney.Responses.$200>
18133
+ }
17403
18134
  ['/v2/portal/pages/default']: {
17404
18135
  /**
17405
18136
  * getDefaultPages - getDefaultPages
@@ -17717,6 +18448,7 @@ type Activity = Components.Schemas.Activity;
17717
18448
  type ActivityCallerContext = Components.Schemas.ActivityCallerContext;
17718
18449
  type ActivityId = Components.Schemas.ActivityId;
17719
18450
  type ActivityItem = Components.Schemas.ActivityItem;
18451
+ type AdditionalContactAttribute = Components.Schemas.AdditionalContactAttribute;
17720
18452
  type AdminUser = Components.Schemas.AdminUser;
17721
18453
  type AllowedFileExtensions = Components.Schemas.AllowedFileExtensions;
17722
18454
  type AttributeMappingConfig = Components.Schemas.AttributeMappingConfig;
@@ -17860,4 +18592,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
17860
18592
  type WorkflowExecution = Components.Schemas.WorkflowExecution;
17861
18593
  type WorkflowStep = Components.Schemas.WorkflowStep;
17862
18594
 
17863
- export { type EntityMatchingConfig as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type Contact as D, type ContactCountRequest as E, type ContactExistsRequest as F, type ContentWidget as G, type ContextEntities as H, type ContextEntity as I, type Contract as J, type ContractIdentifier as K, type CreateUserRequest as L, type Currency as M, type DataRetrievalItem as N, type OperationMethods as O, Paths as P, DeleteEntityFile as Q, type Direction as R, type DocumentWidget as S, type DomainSettings as T, type EmailTemplates as U, type Entity as V, type EntityEditRule as W, type EntityFileCount as X, type EntityGetParams as Y, type EntityId as Z, type EntityItem as _, Components as a, type PublicContractIdentificationDetails as a$, type EntityResponse as a0, type EntityResponseGroupedWithHits as a1, type EntityResponseWithHits as a2, type EntitySearchParams as a3, type EntitySlug as a4, type EntitySlugConfig as a5, type EntityTemplates as a6, type EntityWidget as a7, type ErrorResp as a8, type Exists as a9, type MeterReading as aA, type MeterReadingPhoto as aB, type MeterReadingPhotoData as aC, type MeterReadingWidget as aD, type MoblieOIDCConfig as aE, type OIDCProviderConfig as aF, type OIDCProviderMetadata as aG, type Opportunity as aH, type Order as aI, type OrganizationSettings as aJ, type Origin as aK, type Page as aL, type PageRequest as aM, type PaymentWidget as aN, type PortalConfig as aO, type PortalConfigV3 as aP, type PortalId as aQ, type PortalUser as aR, type PortalUserRegistrationStatus as aS, type PortalWidget as aT, type Product as aU, type ProductRecommendationsWidget as aV, type ProviderConfig as aW, type ProviderDisplayName as aX, type ProviderPublicConfig as aY, type ProviderSlug as aZ, type PublicAppDetails as a_, type Extension as aa, type ExtensionAuthBlock as ab, type ExtensionConfig as ac, type ExtensionHook as ad, type ExtensionHookConsumptionDataRetrieval as ae, type ExtensionHookContractIdentification as af, type ExtensionHookCostDataRetrieval as ag, type ExtensionHookDataExport as ah, type ExtensionHookMeterReadingPlausibilityCheck as ai, type ExtensionHookPriceDataRetrieval as aj, type ExtensionHookRegistrationIdentifiersCheck as ak, type ExtensionHookSelection as al, type ExtensionHookVisualizationMetadata as am, type ExtensionSeamlessLink as an, type ExternalLink as ao, type ExtraSchemaAttributes as ap, type FailedRuleErrorResp as aq, type File as ar, type FileItem as as, type Grant as at, type IdentifierAttribute as au, type InstallmentEvent as av, type JourneyActions as aw, type JuiceSettings as ax, type Meter as ay, type MeterChartWidget as az, type PathsDictionary as b, type PublicDataRetrievalHookDetails as b0, type PublicExtensionCapabilities as b1, type PublicExtensionDetails as b2, type PublicMeterReadingPlausibilityCheckDetails as b3, type ReadBy as b4, type ReadingStatus as b5, type Reason as b6, type RegistrationIdentifier as b7, type ReimbursementEvent as b8, type Rule as b9, type WorkflowStep as bA, type SAMLProviderConfig as ba, type SSOCallbackRequest as bb, type SSOCallbackResponse as bc, type SSOLoginToken as bd, SaveEntityFile as be, type SavePortalFile as bf, type Schema as bg, type SearchIncludes as bh, type SecureProxyConfig as bi, type Source as bj, type SwappableConfig as bk, type TariffType as bl, type TeaserWidget as bm, type TriggerPortalFlow as bn, type UpdateOnlyPortalConfigAttributes as bo, type UpsertPortalConfig as bp, type UpsertPortalConfigV3 as bq, UpsertPortalWidget as br, type UserRequest as bs, type VisualizationDataRange as bt, type VisualizationMetadata as bu, type VisualizationTypeOption as bv, type WidgetAction as bw, type WidgetBase as bx, type WorfklowIdentifier as by, type WorkflowExecution as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdminUser as j, type AllowedFileExtensions as k, type AttributeMappingConfig as l, type AuthConfig as m, type BaseBillingEvent as n, type BaseEntity as o, type BillingAccount as p, type BillingEvent as q, type Block as r, type BlockId as s, type BlockProps as t, type BlockRequest as u, type BlockType as v, type BusinessPartnerItem as w, type CampaignWidget as x, type CommonConfigAttributes as y, type CommonConfigAttributesV3 as z };
18595
+ export { type EntityItem as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributesV3 as D, type Contact as E, type ContactCountRequest as F, type ContactExistsRequest as G, type ContentWidget as H, type ContextEntities as I, type ContextEntity as J, type Contract as K, type ContractIdentifier as L, type CreateUserRequest as M, type Currency as N, type OperationMethods as O, Paths as P, type DataRetrievalItem as Q, DeleteEntityFile as R, type Direction as S, type DocumentWidget as T, type DomainSettings as U, type EmailTemplates as V, type Entity as W, type EntityEditRule as X, type EntityFileCount as Y, type EntityGetParams as Z, type EntityId as _, Components as a, type PublicAppDetails as a$, type EntityMatchingConfig as a0, type EntityResponse as a1, type EntityResponseGroupedWithHits as a2, type EntityResponseWithHits as a3, type EntitySearchParams as a4, type EntitySlug as a5, type EntitySlugConfig as a6, type EntityTemplates as a7, type EntityWidget as a8, type ErrorResp as a9, type MeterChartWidget as aA, type MeterReading as aB, type MeterReadingPhoto as aC, type MeterReadingPhotoData as aD, type MeterReadingWidget as aE, type MoblieOIDCConfig as aF, type OIDCProviderConfig as aG, type OIDCProviderMetadata as aH, type Opportunity as aI, type Order as aJ, type OrganizationSettings as aK, type Origin as aL, type Page as aM, type PageRequest as aN, type PaymentWidget as aO, type PortalConfig as aP, type PortalConfigV3 as aQ, type PortalId as aR, type PortalUser as aS, type PortalUserRegistrationStatus as aT, type PortalWidget as aU, type Product as aV, type ProductRecommendationsWidget as aW, type ProviderConfig as aX, type ProviderDisplayName as aY, type ProviderPublicConfig as aZ, type ProviderSlug as a_, type Exists as aa, type Extension as ab, type ExtensionAuthBlock as ac, type ExtensionConfig as ad, type ExtensionHook as ae, type ExtensionHookConsumptionDataRetrieval as af, type ExtensionHookContractIdentification as ag, type ExtensionHookCostDataRetrieval as ah, type ExtensionHookDataExport as ai, type ExtensionHookMeterReadingPlausibilityCheck as aj, type ExtensionHookPriceDataRetrieval as ak, type ExtensionHookRegistrationIdentifiersCheck as al, type ExtensionHookSelection as am, type ExtensionHookVisualizationMetadata as an, type ExtensionSeamlessLink as ao, type ExternalLink as ap, type ExtraSchemaAttributes as aq, type FailedRuleErrorResp as ar, type File as as, type FileItem as at, type Grant as au, type IdentifierAttribute as av, type InstallmentEvent as aw, type JourneyActions as ax, type JuiceSettings as ay, type Meter as az, type PathsDictionary as b, type PublicContractIdentificationDetails as b0, type PublicDataRetrievalHookDetails as b1, type PublicExtensionCapabilities as b2, type PublicExtensionDetails as b3, type PublicMeterReadingPlausibilityCheckDetails as b4, type ReadBy as b5, type ReadingStatus as b6, type Reason as b7, type RegistrationIdentifier as b8, type ReimbursementEvent as b9, type WorkflowExecution as bA, type WorkflowStep as bB, type Rule as ba, type SAMLProviderConfig as bb, type SSOCallbackRequest as bc, type SSOCallbackResponse as bd, type SSOLoginToken as be, SaveEntityFile as bf, type SavePortalFile as bg, type Schema as bh, type SearchIncludes as bi, type SecureProxyConfig as bj, type Source as bk, type SwappableConfig as bl, type TariffType as bm, type TeaserWidget as bn, type TriggerPortalFlow as bo, type UpdateOnlyPortalConfigAttributes as bp, type UpsertPortalConfig as bq, type UpsertPortalConfigV3 as br, UpsertPortalWidget as bs, type UserRequest as bt, type VisualizationDataRange as bu, type VisualizationMetadata as bv, type VisualizationTypeOption as bw, type WidgetAction as bx, type WidgetBase as by, type WorfklowIdentifier as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdditionalContactAttribute as j, type AdminUser as k, type AllowedFileExtensions as l, type AttributeMappingConfig as m, type AuthConfig as n, type BaseBillingEvent as o, type BaseEntity as p, type BillingAccount as q, type BillingEvent as r, type Block as s, type BlockId as t, type BlockProps as u, type BlockRequest as v, type BlockType as w, type BusinessPartnerItem as x, type CampaignWidget as y, type CommonConfigAttributes as z };