@epilot/sdk 2.7.0 → 2.8.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (254) hide show
  1. package/README.md +1 -0
  2. package/definitions/app.json +101 -8
  3. package/definitions/configuration-hub-runtime.json +1 -1
  4. package/definitions/configuration-hub.json +623 -0
  5. package/definitions/customer-portal-runtime.json +1 -1
  6. package/definitions/customer-portal.json +505 -6
  7. package/definitions/design-runtime.json +1 -1
  8. package/definitions/design.json +1 -11
  9. package/definitions/email-settings-runtime.json +1 -1
  10. package/definitions/email-settings.json +86 -4
  11. package/definitions/file-runtime.json +1 -1
  12. package/definitions/file.json +262 -4
  13. package/definitions/focus-pocus-runtime.json +1 -0
  14. package/definitions/focus-pocus.json +757 -0
  15. package/definitions/journey-runtime.json +1 -1
  16. package/definitions/journey.json +21 -1
  17. package/dist/README-37TXN4EL.cjs +7 -0
  18. package/dist/README-Z2WITBOR.js +7 -0
  19. package/dist/{_index-DB2VV4PQ.cjs → _index-HTUXYSTD.cjs} +4 -1
  20. package/dist/{_index-5FB6F5YY.js → _index-YTOJUFGD.js} +3 -0
  21. package/dist/apis/access-token.cjs +6 -6
  22. package/dist/apis/access-token.js +1 -1
  23. package/dist/apis/address-suggestions.cjs +6 -6
  24. package/dist/apis/address-suggestions.js +1 -1
  25. package/dist/apis/address.cjs +6 -6
  26. package/dist/apis/address.js +1 -1
  27. package/dist/apis/ai-agents.cjs +6 -6
  28. package/dist/apis/ai-agents.js +1 -1
  29. package/dist/apis/app.cjs +6 -6
  30. package/dist/apis/app.d.cts +2 -2
  31. package/dist/apis/app.d.ts +2 -2
  32. package/dist/apis/app.js +1 -1
  33. package/dist/apis/audit-logs.cjs +6 -6
  34. package/dist/apis/audit-logs.js +1 -1
  35. package/dist/apis/automation.cjs +6 -6
  36. package/dist/apis/automation.js +1 -1
  37. package/dist/apis/billing.cjs +6 -6
  38. package/dist/apis/billing.js +1 -1
  39. package/dist/apis/blueprint-manifest.cjs +6 -6
  40. package/dist/apis/blueprint-manifest.js +1 -1
  41. package/dist/apis/calendar.cjs +6 -6
  42. package/dist/apis/calendar.js +1 -1
  43. package/dist/apis/configuration-hub.cjs +8 -8
  44. package/dist/apis/configuration-hub.d.cts +2 -2
  45. package/dist/apis/configuration-hub.d.ts +2 -2
  46. package/dist/apis/configuration-hub.js +2 -2
  47. package/dist/apis/consent.cjs +6 -6
  48. package/dist/apis/consent.js +1 -1
  49. package/dist/apis/customer-portal.cjs +8 -8
  50. package/dist/apis/customer-portal.d.cts +2 -2
  51. package/dist/apis/customer-portal.d.ts +2 -2
  52. package/dist/apis/customer-portal.js +2 -2
  53. package/dist/apis/dashboard.cjs +6 -6
  54. package/dist/apis/dashboard.js +1 -1
  55. package/dist/apis/data-governance.cjs +6 -6
  56. package/dist/apis/data-governance.js +1 -1
  57. package/dist/apis/deduplication.cjs +6 -6
  58. package/dist/apis/deduplication.js +1 -1
  59. package/dist/apis/design.cjs +8 -8
  60. package/dist/apis/design.js +2 -2
  61. package/dist/apis/document.cjs +6 -6
  62. package/dist/apis/document.js +1 -1
  63. package/dist/apis/email-settings.cjs +8 -8
  64. package/dist/apis/email-settings.d.cts +2 -2
  65. package/dist/apis/email-settings.d.ts +2 -2
  66. package/dist/apis/email-settings.js +2 -2
  67. package/dist/apis/email-template.cjs +6 -6
  68. package/dist/apis/email-template.js +1 -1
  69. package/dist/apis/entity-mapping.cjs +6 -6
  70. package/dist/apis/entity-mapping.js +1 -1
  71. package/dist/apis/entity.cjs +6 -6
  72. package/dist/apis/entity.js +1 -1
  73. package/dist/apis/environments.cjs +6 -6
  74. package/dist/apis/environments.js +1 -1
  75. package/dist/apis/event-catalog.cjs +6 -6
  76. package/dist/apis/event-catalog.js +1 -1
  77. package/dist/apis/file.cjs +8 -8
  78. package/dist/apis/file.d.cts +2 -2
  79. package/dist/apis/file.d.ts +2 -2
  80. package/dist/apis/file.js +2 -2
  81. package/dist/apis/focus-pocus.cjs +38 -0
  82. package/dist/apis/focus-pocus.d.cts +18 -0
  83. package/dist/apis/focus-pocus.d.ts +18 -0
  84. package/dist/apis/focus-pocus.js +38 -0
  85. package/dist/apis/iban.cjs +6 -6
  86. package/dist/apis/iban.js +1 -1
  87. package/dist/apis/integration-toolkit.cjs +6 -6
  88. package/dist/apis/integration-toolkit.js +1 -1
  89. package/dist/apis/journey.cjs +8 -8
  90. package/dist/apis/journey.d.cts +2 -2
  91. package/dist/apis/journey.d.ts +2 -2
  92. package/dist/apis/journey.js +2 -2
  93. package/dist/apis/kanban.cjs +6 -6
  94. package/dist/apis/kanban.js +1 -1
  95. package/dist/apis/message.cjs +6 -6
  96. package/dist/apis/message.js +1 -1
  97. package/dist/apis/metering.cjs +6 -6
  98. package/dist/apis/metering.js +1 -1
  99. package/dist/apis/notes.cjs +6 -6
  100. package/dist/apis/notes.js +1 -1
  101. package/dist/apis/notification.cjs +6 -6
  102. package/dist/apis/notification.js +1 -1
  103. package/dist/apis/organization.cjs +6 -6
  104. package/dist/apis/organization.js +1 -1
  105. package/dist/apis/partner-directory.cjs +6 -6
  106. package/dist/apis/partner-directory.js +1 -1
  107. package/dist/apis/permissions.cjs +6 -6
  108. package/dist/apis/permissions.js +1 -1
  109. package/dist/apis/pricing-tier.cjs +6 -6
  110. package/dist/apis/pricing-tier.js +1 -1
  111. package/dist/apis/pricing.cjs +6 -6
  112. package/dist/apis/pricing.js +1 -1
  113. package/dist/apis/purpose.cjs +6 -6
  114. package/dist/apis/purpose.js +1 -1
  115. package/dist/apis/query.cjs +6 -6
  116. package/dist/apis/query.js +1 -1
  117. package/dist/apis/sandbox.cjs +6 -6
  118. package/dist/apis/sandbox.js +1 -1
  119. package/dist/apis/sharing.cjs +6 -6
  120. package/dist/apis/sharing.js +1 -1
  121. package/dist/apis/submission.cjs +6 -6
  122. package/dist/apis/submission.js +1 -1
  123. package/dist/apis/target.cjs +6 -6
  124. package/dist/apis/target.js +1 -1
  125. package/dist/apis/targeting.cjs +6 -6
  126. package/dist/apis/targeting.js +1 -1
  127. package/dist/apis/template-variables.cjs +6 -6
  128. package/dist/apis/template-variables.js +1 -1
  129. package/dist/apis/user.cjs +6 -6
  130. package/dist/apis/user.js +1 -1
  131. package/dist/apis/validation-rules.cjs +6 -6
  132. package/dist/apis/validation-rules.js +1 -1
  133. package/dist/apis/webhooks.cjs +6 -6
  134. package/dist/apis/webhooks.js +1 -1
  135. package/dist/apis/workflow-definition.cjs +6 -6
  136. package/dist/apis/workflow-definition.js +1 -1
  137. package/dist/apis/workflow.cjs +6 -6
  138. package/dist/apis/workflow.js +1 -1
  139. package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
  140. package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
  141. package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
  142. package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
  143. package/dist/chunk-3APTSPY4.js +14 -0
  144. package/dist/{chunk-JB7LITSP.js → chunk-54KWFSCM.js} +35 -24
  145. package/dist/chunk-A6FYGWQ7.cjs +14 -0
  146. package/dist/{chunk-35CN2YFK.cjs → chunk-F5Z6I7TF.cjs} +35 -24
  147. package/dist/chunk-JOUTFBLN.js +14 -0
  148. package/dist/chunk-KCPVNRDL.js +14 -0
  149. package/dist/chunk-KJPOUJBU.cjs +14 -0
  150. package/dist/chunk-LAWKCWVU.cjs +14 -0
  151. package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
  152. package/dist/chunk-OPXGJKZR.cjs +14 -0
  153. package/dist/chunk-P42Q6HOW.js +14 -0
  154. package/dist/chunk-P4NA7NWG.js +14 -0
  155. package/dist/chunk-PTEJYAYJ.js +14 -0
  156. package/dist/chunk-WHXYES2D.cjs +14 -0
  157. package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
  158. package/dist/chunk-YI5YGTAH.cjs +14 -0
  159. package/dist/configuration-hub-E7S4JB2T.js +7 -0
  160. package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
  161. package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
  162. package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
  163. package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
  164. package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
  165. package/dist/customer-portal-DR6XFCTQ.js +7 -0
  166. package/dist/customer-portal-PNFBVIAH.cjs +7 -0
  167. package/dist/{customer-portal-runtime-OEXTSMSE.cjs → customer-portal-runtime-IYHJ3RME.cjs} +2 -2
  168. package/dist/{customer-portal-runtime-N4NWQ67M.js → customer-portal-runtime-ZYU3WIXY.js} +1 -1
  169. package/dist/{customer-portal.d-ChSEioI5.d.cts → customer-portal.d-CTTCBAZI.d.cts} +764 -14
  170. package/dist/{customer-portal.d-ChSEioI5.d.ts → customer-portal.d-CTTCBAZI.d.ts} +764 -14
  171. package/dist/data-governance-QYFHBCNB.cjs +7 -0
  172. package/dist/data-governance-YS2NA6W4.js +7 -0
  173. package/dist/design-EWZQZ5KX.js +7 -0
  174. package/dist/design-MUUYXB2J.cjs +7 -0
  175. package/dist/design-runtime-3RHYNHUV.cjs +5 -0
  176. package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
  177. package/dist/email-settings-YJ4X5VFU.cjs +7 -0
  178. package/dist/email-settings-YUK3DXFJ.js +7 -0
  179. package/dist/{email-settings-runtime-EGIJ2AVQ.js → email-settings-runtime-BXRZV4M5.js} +1 -1
  180. package/dist/{email-settings-runtime-WGVLI7N6.cjs → email-settings-runtime-FWJQBQBK.cjs} +2 -2
  181. package/dist/{email-settings.d-B7Q_xT25.d.cts → email-settings.d-UJ0C3jPI.d.cts} +108 -9
  182. package/dist/{email-settings.d-B7Q_xT25.d.ts → email-settings.d-UJ0C3jPI.d.ts} +108 -9
  183. package/dist/file-P2FUUER2.js +7 -0
  184. package/dist/file-XTY74SIX.cjs +7 -0
  185. package/dist/file-runtime-24S3QPA7.cjs +5 -0
  186. package/dist/{file-runtime-B6AAGZQF.js → file-runtime-BIRMXYRH.js} +1 -1
  187. package/dist/{file.d-DcTJxjp7.d.cts → file.d-DTlrbI40.d.cts} +2336 -19
  188. package/dist/{file.d-DcTJxjp7.d.ts → file.d-DTlrbI40.d.ts} +2336 -19
  189. package/dist/focus-pocus-JGXH42OF.cjs +7 -0
  190. package/dist/focus-pocus-XVDVUYL6.js +7 -0
  191. package/dist/focus-pocus-runtime-QXBBYVX7.js +5 -0
  192. package/dist/focus-pocus-runtime-X6GQ3WI4.cjs +5 -0
  193. package/dist/focus-pocus.d-BRFGe53G.d.cts +489 -0
  194. package/dist/focus-pocus.d-BRFGe53G.d.ts +489 -0
  195. package/dist/index.cjs +34 -26
  196. package/dist/index.d.cts +57 -55
  197. package/dist/index.d.ts +57 -55
  198. package/dist/index.js +23 -15
  199. package/dist/journey-4DIIPRU4.js +7 -0
  200. package/dist/journey-ATC3Y5AW.cjs +7 -0
  201. package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
  202. package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
  203. package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
  204. package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
  205. package/dist/pricing-R5ENSVPQ.cjs +7 -0
  206. package/dist/pricing-X27CCRI6.js +7 -0
  207. package/dist/targeting-74BV7F7H.cjs +7 -0
  208. package/dist/targeting-W5EKJYR2.js +7 -0
  209. package/docs/app.md +34 -10
  210. package/docs/configuration-hub.md +660 -0
  211. package/docs/customer-portal.md +604 -176
  212. package/docs/data-governance.md +17 -17
  213. package/docs/design.md +1 -1
  214. package/docs/email-settings.md +67 -3
  215. package/docs/file.md +101 -2
  216. package/docs/focus-pocus.md +460 -0
  217. package/docs/journey.md +2 -0
  218. package/docs/pricing.md +1 -1
  219. package/docs/targeting.md +4 -4
  220. package/package.json +10 -1
  221. package/dist/README-46VYEGGW.js +0 -7
  222. package/dist/README-IVBISSWB.cjs +0 -7
  223. package/dist/chunk-4W22EIRF.cjs +0 -14
  224. package/dist/chunk-5OBMZHRL.cjs +0 -14
  225. package/dist/chunk-E2WMGOM5.js +0 -14
  226. package/dist/chunk-EFWPEVXI.js +0 -14
  227. package/dist/chunk-EIIIKDOJ.cjs +0 -14
  228. package/dist/chunk-KEI3GHDY.cjs +0 -14
  229. package/dist/chunk-KIWRGUKM.js +0 -14
  230. package/dist/chunk-MB6NKETA.cjs +0 -14
  231. package/dist/chunk-VSZEOCIE.js +0 -14
  232. package/dist/chunk-Z6HGUGXK.js +0 -14
  233. package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
  234. package/dist/configuration-hub-PMAW44U5.js +0 -7
  235. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  236. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  237. package/dist/customer-portal-5I7ZGQDU.cjs +0 -7
  238. package/dist/customer-portal-YL2YMPZL.js +0 -7
  239. package/dist/data-governance-2U5UU4GM.cjs +0 -7
  240. package/dist/data-governance-36Y33JVG.js +0 -7
  241. package/dist/design-DROLIWS3.js +0 -7
  242. package/dist/design-XZKOZLTR.cjs +0 -7
  243. package/dist/design-runtime-OXEXKZVG.cjs +0 -5
  244. package/dist/email-settings-CKFJU4WZ.js +0 -7
  245. package/dist/email-settings-NQJJKS2P.cjs +0 -7
  246. package/dist/file-UOWBTDIU.cjs +0 -7
  247. package/dist/file-XSN3NAVZ.js +0 -7
  248. package/dist/file-runtime-SFZIKODF.cjs +0 -5
  249. package/dist/journey-KDR5EU3W.js +0 -7
  250. package/dist/journey-REBN4TGQ.cjs +0 -7
  251. package/dist/pricing-FODHQFCB.cjs +0 -7
  252. package/dist/pricing-XRIDVZFC.js +0 -7
  253. package/dist/targeting-EYGYZD6M.cjs +0 -7
  254. package/dist/targeting-GEJTJN5Z.js +0 -7
@@ -73,6 +73,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
73
73
  - [`listAllPortalConfigs`](#listallportalconfigs)
74
74
  - [`swapPortalConfig`](#swapportalconfig)
75
75
  - [`clonePortalConfig`](#cloneportalconfig)
76
+ - [`verifyDns`](#verifydns)
76
77
 
77
78
  **Public**
78
79
  - [`createUserV3`](#createuserv3)
@@ -87,10 +88,12 @@ const { data } = await customerPortalClient.upsertPortal(...)
87
88
  - [`getOrganizationSettingsByDomain`](#getorganizationsettingsbydomain)
88
89
  - [`checkContactExists`](#checkcontactexists)
89
90
  - [`checkContactExistsV3`](#checkcontactexistsv3)
91
+ - [`checkAccountExists`](#checkaccountexists)
90
92
  - [`confirmUser`](#confirmuser)
91
93
  - [`confirmUserWithUserId`](#confirmuserwithuserid)
92
94
  - [`userExists`](#userexists)
93
95
  - [`userExistsV3`](#userexistsv3)
96
+ - [`getSSOProvider`](#getssoprovider)
94
97
  - [`ssoRedirect`](#ssoredirect)
95
98
  - [`ssoCallback`](#ssocallback)
96
99
  - [`getPublicPages`](#getpublicpages)
@@ -145,6 +148,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
145
148
  - [`revokePartner`](#revokepartner)
146
149
  - [`disablePartner`](#disablepartner)
147
150
  - [`enablePartner`](#enablepartner)
151
+ - [`portalProxyExecute`](#portalproxyexecute)
148
152
 
149
153
  **Activity**
150
154
  - [`getEntityActivityFeed`](#getentityactivityfeed)
@@ -176,6 +180,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
176
180
  - [`UpsertPortalConfig`](#upsertportalconfig)
177
181
  - [`PortalConfig`](#portalconfig)
178
182
  - [`UpsertPortalWidget`](#upsertportalwidget)
183
+ - [`DomainSettings`](#domainsettings)
179
184
  - [`WidgetBase`](#widgetbase)
180
185
  - [`EntityWidget`](#entitywidget)
181
186
  - [`MeterReadingWidget`](#meterreadingwidget)
@@ -191,6 +196,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
191
196
  - [`PortalWidget`](#portalwidget)
192
197
  - [`ContactCountRequest`](#contactcountrequest)
193
198
  - [`ContactExistsRequest`](#contactexistsrequest)
199
+ - [`AccountExistsRequest`](#accountexistsrequest)
194
200
  - [`UserRequest`](#userrequest)
195
201
  - [`CreateUserRequest`](#createuserrequest)
196
202
  - [`OrganizationSettings`](#organizationsettings)
@@ -342,13 +348,32 @@ const { data } = await client.upsertPortal(
342
348
  { /* ... */ }
343
349
  ]
344
350
  },
351
+ identity_providers: [
352
+ {
353
+ slug: 'office-365-login',
354
+ display_name: 'Office 365 Login',
355
+ provider_type: 'OIDC',
356
+ attribute_mappings: { /* ... */ },
357
+ entity_matching: { /* ... */ },
358
+ oidc_config: { /* ... */ },
359
+ mobile_oidc_config: { /* ... */ }
360
+ }
361
+ ],
345
362
  enabled: true,
346
363
  name: 'Installer Portal',
347
364
  domain: 'abc.com',
348
365
  is_epilot_domain: true,
366
+ epilot_domain: 'example-portal-12345.ecp.epilot.cloud',
367
+ domain_settings: {
368
+ is_custom_domain_enabled: true,
369
+ is_epilot_domain_enabled: true,
370
+ is_redirection_enabled: true
371
+ },
349
372
  design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
350
373
  allowed_portal_entities: ['contact', 'contract'],
351
374
  self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
375
+ self_registration_account_setting: 'ALLOW_WITH_CONTACT_CREATION',
376
+ self_registration_entity: 'contact',
352
377
  user_account_self_management: false,
353
378
  feature_settings: {
354
379
  start_page: true,
@@ -490,7 +515,8 @@ const { data } = await client.upsertPortal(
490
515
  portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
491
516
  portal_sk_v3: 'PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c',
492
517
  origin: 'string',
493
- pages: {}
518
+ pages: {},
519
+ global_blocks: {}
494
520
  },
495
521
  )
496
522
  ```
@@ -504,9 +530,17 @@ const { data } = await client.upsertPortal(
504
530
  "name": "Installer Portal",
505
531
  "domain": "abc.com",
506
532
  "is_epilot_domain": true,
533
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
534
+ "domain_settings": {
535
+ "is_custom_domain_enabled": true,
536
+ "is_epilot_domain_enabled": true,
537
+ "is_redirection_enabled": true
538
+ },
507
539
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
508
540
  "allowed_portal_entities": ["contact", "contract"],
509
541
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
542
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
543
+ "self_registration_entity": "contact",
510
544
  "user_account_self_management": false,
511
545
  "feature_settings": {
512
546
  "start_page": true,
@@ -648,6 +682,7 @@ const { data } = await client.upsertPortal(
648
682
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
649
683
  "origin": "string",
650
684
  "pages": {},
685
+ "global_blocks": {},
651
686
  "id": 12345,
652
687
  "organization_id": 12345,
653
688
  "org_settings": {
@@ -791,9 +826,17 @@ const { data } = await client.getPortalConfigByDomain({
791
826
  "name": "Installer Portal",
792
827
  "domain": "abc.com",
793
828
  "is_epilot_domain": true,
829
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
830
+ "domain_settings": {
831
+ "is_custom_domain_enabled": true,
832
+ "is_epilot_domain_enabled": true,
833
+ "is_redirection_enabled": true
834
+ },
794
835
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
795
836
  "allowed_portal_entities": ["contact", "contract"],
796
837
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
838
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
839
+ "self_registration_entity": "contact",
797
840
  "user_account_self_management": false,
798
841
  "feature_settings": {
799
842
  "start_page": true,
@@ -935,6 +978,7 @@ const { data } = await client.getPortalConfigByDomain({
935
978
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
936
979
  "origin": "string",
937
980
  "pages": {},
981
+ "global_blocks": {},
938
982
  "id": 12345,
939
983
  "organization_id": 12345,
940
984
  "org_settings": {
@@ -989,9 +1033,17 @@ const { data } = await client.getPortalConfig({
989
1033
  "name": "Installer Portal",
990
1034
  "domain": "abc.com",
991
1035
  "is_epilot_domain": true,
1036
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
1037
+ "domain_settings": {
1038
+ "is_custom_domain_enabled": true,
1039
+ "is_epilot_domain_enabled": true,
1040
+ "is_redirection_enabled": true
1041
+ },
992
1042
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
993
1043
  "allowed_portal_entities": ["contact", "contract"],
994
1044
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
1045
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
1046
+ "self_registration_entity": "contact",
995
1047
  "user_account_self_management": false,
996
1048
  "feature_settings": {
997
1049
  "start_page": true,
@@ -1133,6 +1185,7 @@ const { data } = await client.getPortalConfig({
1133
1185
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
1134
1186
  "origin": "string",
1135
1187
  "pages": {},
1188
+ "global_blocks": {},
1136
1189
  "id": 12345,
1137
1190
  "organization_id": 12345,
1138
1191
  "org_settings": {
@@ -1892,9 +1945,17 @@ const { data } = await client.getPublicPortalConfig({
1892
1945
  "name": "Installer Portal",
1893
1946
  "domain": "abc.com",
1894
1947
  "is_epilot_domain": true,
1948
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
1949
+ "domain_settings": {
1950
+ "is_custom_domain_enabled": true,
1951
+ "is_epilot_domain_enabled": true,
1952
+ "is_redirection_enabled": true
1953
+ },
1895
1954
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
1896
1955
  "allowed_portal_entities": ["contact", "contract"],
1897
1956
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
1957
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
1958
+ "self_registration_entity": "contact",
1898
1959
  "user_account_self_management": false,
1899
1960
  "feature_settings": {
1900
1961
  "start_page": true,
@@ -2036,6 +2097,7 @@ const { data } = await client.getPublicPortalConfig({
2036
2097
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
2037
2098
  "origin": "string",
2038
2099
  "pages": {},
2100
+ "global_blocks": {},
2039
2101
  "id": 12345,
2040
2102
  "organization_id": 12345,
2041
2103
  "org_settings": {
@@ -2090,9 +2152,17 @@ const { data } = await client.getOrgPortalConfig({
2090
2152
  "name": "Installer Portal",
2091
2153
  "domain": "abc.com",
2092
2154
  "is_epilot_domain": true,
2155
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
2156
+ "domain_settings": {
2157
+ "is_custom_domain_enabled": true,
2158
+ "is_epilot_domain_enabled": true,
2159
+ "is_redirection_enabled": true
2160
+ },
2093
2161
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
2094
2162
  "allowed_portal_entities": ["contact", "contract"],
2095
2163
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
2164
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
2165
+ "self_registration_entity": "contact",
2096
2166
  "user_account_self_management": false,
2097
2167
  "feature_settings": {
2098
2168
  "start_page": true,
@@ -2234,6 +2304,7 @@ const { data } = await client.getOrgPortalConfig({
2234
2304
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
2235
2305
  "origin": "string",
2236
2306
  "pages": {},
2307
+ "global_blocks": {},
2237
2308
  "id": 12345,
2238
2309
  "organization_id": 12345,
2239
2310
  "org_settings": {
@@ -2257,7 +2328,10 @@ const { data } = await client.getOrgPortalConfig({
2257
2328
  "slug": "office-365-login",
2258
2329
  "display_name": "Office 365 Login",
2259
2330
  "oidc_config": {},
2260
- "mobile_oidc_config": {}
2331
+ "mobile_oidc_config": {},
2332
+ "provider_type": "OIDC",
2333
+ "attribute_mappings": {},
2334
+ "entity_matching": {}
2261
2335
  }
2262
2336
  ],
2263
2337
  "certificate_details": {
@@ -2293,9 +2367,17 @@ const { data } = await client.getPublicPortalConfigV3({
2293
2367
  "name": "Installer Portal",
2294
2368
  "domain": "abc.com",
2295
2369
  "is_epilot_domain": true,
2370
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
2371
+ "domain_settings": {
2372
+ "is_custom_domain_enabled": true,
2373
+ "is_epilot_domain_enabled": true,
2374
+ "is_redirection_enabled": true
2375
+ },
2296
2376
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
2297
2377
  "allowed_portal_entities": ["contact", "contract"],
2298
2378
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
2379
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
2380
+ "self_registration_entity": "contact",
2299
2381
  "user_account_self_management": false,
2300
2382
  "feature_settings": {
2301
2383
  "start_page": true,
@@ -2437,6 +2519,7 @@ const { data } = await client.getPublicPortalConfigV3({
2437
2519
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
2438
2520
  "origin": "string",
2439
2521
  "pages": {},
2522
+ "global_blocks": {},
2440
2523
  "id": 12345,
2441
2524
  "organization_id": 12345,
2442
2525
  "org_settings": {
@@ -2491,9 +2574,17 @@ const { data } = await client.getOrgPortalConfigV3({
2491
2574
  "name": "Installer Portal",
2492
2575
  "domain": "abc.com",
2493
2576
  "is_epilot_domain": true,
2577
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
2578
+ "domain_settings": {
2579
+ "is_custom_domain_enabled": true,
2580
+ "is_epilot_domain_enabled": true,
2581
+ "is_redirection_enabled": true
2582
+ },
2494
2583
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
2495
2584
  "allowed_portal_entities": ["contact", "contract"],
2496
2585
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
2586
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
2587
+ "self_registration_entity": "contact",
2497
2588
  "user_account_self_management": false,
2498
2589
  "feature_settings": {
2499
2590
  "start_page": true,
@@ -2635,6 +2726,7 @@ const { data } = await client.getOrgPortalConfigV3({
2635
2726
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
2636
2727
  "origin": "string",
2637
2728
  "pages": {},
2729
+ "global_blocks": {},
2638
2730
  "id": 12345,
2639
2731
  "organization_id": 12345,
2640
2732
  "org_settings": {
@@ -2658,7 +2750,10 @@ const { data } = await client.getOrgPortalConfigV3({
2658
2750
  "slug": "office-365-login",
2659
2751
  "display_name": "Office 365 Login",
2660
2752
  "oidc_config": {},
2661
- "mobile_oidc_config": {}
2753
+ "mobile_oidc_config": {},
2754
+ "provider_type": "OIDC",
2755
+ "attribute_mappings": {},
2756
+ "entity_matching": {}
2662
2757
  }
2663
2758
  ],
2664
2759
  "certificate_details": {
@@ -2693,9 +2788,13 @@ const { data } = await client.getAllPortalConfigs()
2693
2788
  "name": "Installer Portal",
2694
2789
  "domain": "abc.com",
2695
2790
  "is_epilot_domain": true,
2791
+ "epilot_domain": "example-portal-12345.ecp.epilot.cloud",
2792
+ "domain_settings": {},
2696
2793
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
2697
2794
  "allowed_portal_entities": ["contact", "contract"],
2698
2795
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
2796
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
2797
+ "self_registration_entity": "contact",
2699
2798
  "user_account_self_management": false,
2700
2799
  "feature_settings": {},
2701
2800
  "accessToken": "string",
@@ -2723,6 +2822,7 @@ const { data } = await client.getAllPortalConfigs()
2723
2822
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
2724
2823
  "origin": "string",
2725
2824
  "pages": {},
2825
+ "global_blocks": {},
2726
2826
  "id": 12345,
2727
2827
  "organization_id": 12345,
2728
2828
  "org_settings": {},
@@ -3760,7 +3860,51 @@ const { data } = await client.checkContactExistsV3(
3760
3860
  ```json
3761
3861
  {
3762
3862
  "exists": true,
3763
- "contactId": "5da0a718-c822-403d-9f5d-20d4584e0528"
3863
+ "contactId": "5da0a718-c822-403d-9f5d-20d4584e0528",
3864
+ "accountId": "5da0a718-c822-403d-9f5d-20d4584e0528"
3865
+ }
3866
+ ```
3867
+
3868
+ </details>
3869
+
3870
+ ---
3871
+
3872
+ ### `checkAccountExists`
3873
+
3874
+ True if account with given identifiers exists.
3875
+ Supports two identification methods:
3876
+ 1. Using portal_id
3877
+ 2. Using domain
3878
+
3879
+ `POST /v3/portal/public/account/exists`
3880
+
3881
+ ```ts
3882
+ const { data } = await client.checkAccountExists(
3883
+ {
3884
+ portal_id: 'example',
3885
+ domain: 'example',
3886
+ },
3887
+ {
3888
+ org_id: 728,
3889
+ registration_identifiers: {
3890
+ account: {
3891
+ customer_number: 'ACC-123456'
3892
+ },
3893
+ contract: {
3894
+ contract_number: '123456'
3895
+ }
3896
+ }
3897
+ },
3898
+ )
3899
+ ```
3900
+
3901
+ <details>
3902
+ <summary>Response</summary>
3903
+
3904
+ ```json
3905
+ {
3906
+ "exists": true,
3907
+ "accountId": "5da0a718-c822-403d-9f5d-20d4584e0528"
3764
3908
  }
3765
3909
  ```
3766
3910
 
@@ -4778,8 +4922,8 @@ const { data } = await client.getBillingEvents({
4778
4922
  }
4779
4923
  ],
4780
4924
  "type": "installment",
4781
- "due_date": "1970-01-01",
4782
- "paid_date": "1970-01-01"
4925
+ "due_date": "string",
4926
+ "paid_date": "string"
4783
4927
  }
4784
4928
  ],
4785
4929
  "hits": 50
@@ -5525,6 +5669,63 @@ const { data } = await client.getMeterReadings(
5525
5669
 
5526
5670
  ---
5527
5671
 
5672
+ ### `getSSOProvider`
5673
+
5674
+ Returns the public configuration of a single SSO identity provider with env var
5675
+ placeholders (incl. secrets) already resolved against the organization's environment.
5676
+
5677
+ `GET /v2/portal/public/sso/providers/{provider_slug}`
5678
+
5679
+ ```ts
5680
+ const { data } = await client.getSSOProvider({
5681
+ provider_slug: 'example',
5682
+ org_id: 'example',
5683
+ origin: 'example',
5684
+ portal_id: 'example',
5685
+ domain: 'example',
5686
+ })
5687
+ ```
5688
+
5689
+ <details>
5690
+ <summary>Response</summary>
5691
+
5692
+ ```json
5693
+ {
5694
+ "slug": "office-365-login",
5695
+ "display_name": "Office 365 Login",
5696
+ "oidc_config": {
5697
+ "type": "implicit",
5698
+ "oidc_issuer": "https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0",
5699
+ "redirect_uri": "https://customer-portal.com/login",
5700
+ "client_id": "ab81daf8-8b1f-42d6-94ca-c51621054c75",
5701
+ "client_secret": "7BIUnn~6shh.7fNtXb..3k1Mp3s6k6WK3B",
5702
+ "has_client_secret": true,
5703
+ "scope": "openid email",
5704
+ "metadata": {
5705
+ "response_modes_supported": ["form_post"],
5706
+ "authorization_endpoint": "https://www.facebook.com/v12.0/dialog/oauth",
5707
+ "token_endpoint": "https://graph.facebook.com/v12.0/oauth/access_token",
5708
+ "userinfo_endpoint": "https://graph.facebook.com/me",
5709
+ "logout_uri": "https://login.microsoftonline.com/common/oauth2/v2.0/logout",
5710
+ "logout_redirect_uri": "https://customer-portal.com/login",
5711
+ "skip_login_as_logout": false,
5712
+ "mobile_redirect_uri": "msauth.io.epilot.ecp://auth",
5713
+ "test_auth_username": "test@epilot.io",
5714
+ "test_auth_password": "string"
5715
+ },
5716
+ "prompt": "login"
5717
+ },
5718
+ "mobile_oidc_config": {
5719
+ "client_id": 123456,
5720
+ "client_secret": 123456
5721
+ }
5722
+ }
5723
+ ```
5724
+
5725
+ </details>
5726
+
5727
+ ---
5728
+
5528
5729
  ### `ssoLogin`
5529
5730
 
5530
5731
  Initiate login using external SSO identity.
@@ -6562,13 +6763,32 @@ const { data } = await client.createPortalConfig(
6562
6763
  { /* ... */ }
6563
6764
  ]
6564
6765
  },
6766
+ identity_providers: [
6767
+ {
6768
+ slug: 'office-365-login',
6769
+ display_name: 'Office 365 Login',
6770
+ provider_type: 'OIDC',
6771
+ attribute_mappings: { /* ... */ },
6772
+ entity_matching: { /* ... */ },
6773
+ oidc_config: { /* ... */ },
6774
+ mobile_oidc_config: { /* ... */ }
6775
+ }
6776
+ ],
6565
6777
  enabled: true,
6566
6778
  name: 'Installer Portal',
6567
6779
  domain: 'abc.com',
6568
6780
  is_epilot_domain: true,
6781
+ epilot_domain: 'example-portal-1.ecp.epilot.io',
6782
+ domain_settings: {
6783
+ is_custom_domain_enabled: true,
6784
+ is_epilot_domain_enabled: true,
6785
+ is_redirection_enabled: true
6786
+ },
6569
6787
  design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
6570
6788
  allowed_portal_entities: ['contact', 'contract'],
6571
6789
  self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
6790
+ self_registration_account_setting: 'ALLOW_WITH_CONTACT_CREATION',
6791
+ self_registration_entity: 'contact',
6572
6792
  user_account_self_management: false,
6573
6793
  feature_settings: {
6574
6794
  start_page: true,
@@ -6710,6 +6930,7 @@ const { data } = await client.createPortalConfig(
6710
6930
  portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
6711
6931
  portal_sk_v3: 'PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c',
6712
6932
  origin: 'string',
6933
+ global_blocks: {},
6713
6934
  pages: [
6714
6935
  {
6715
6936
  slug: 'dashboard',
@@ -6759,13 +6980,32 @@ const { data } = await client.createPortalConfig(
6759
6980
  {}
6760
6981
  ]
6761
6982
  },
6983
+ "identity_providers": [
6984
+ {
6985
+ "slug": "office-365-login",
6986
+ "display_name": "Office 365 Login",
6987
+ "provider_type": "OIDC",
6988
+ "attribute_mappings": {},
6989
+ "entity_matching": {},
6990
+ "oidc_config": {},
6991
+ "mobile_oidc_config": {}
6992
+ }
6993
+ ],
6762
6994
  "enabled": true,
6763
6995
  "name": "Installer Portal",
6764
6996
  "domain": "abc.com",
6765
6997
  "is_epilot_domain": true,
6998
+ "epilot_domain": "example-portal-1.ecp.epilot.io",
6999
+ "domain_settings": {
7000
+ "is_custom_domain_enabled": true,
7001
+ "is_epilot_domain_enabled": true,
7002
+ "is_redirection_enabled": true
7003
+ },
6766
7004
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
6767
7005
  "allowed_portal_entities": ["contact", "contract"],
6768
7006
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
7007
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
7008
+ "self_registration_entity": "contact",
6769
7009
  "user_account_self_management": false,
6770
7010
  "feature_settings": {
6771
7011
  "start_page": true,
@@ -6906,6 +7146,7 @@ const { data } = await client.createPortalConfig(
6906
7146
  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
6907
7147
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
6908
7148
  "origin": "string",
7149
+ "global_blocks": {},
6909
7150
  "organization_id": 12345,
6910
7151
  "org_settings": {
6911
7152
  "canary": {
@@ -6923,14 +7164,6 @@ const { data } = await client.createPortalConfig(
6923
7164
  "effect": "allow"
6924
7165
  }
6925
7166
  ],
6926
- "identity_providers": [
6927
- {
6928
- "slug": "office-365-login",
6929
- "display_name": "Office 365 Login",
6930
- "oidc_config": {},
6931
- "mobile_oidc_config": {}
6932
- }
6933
- ],
6934
7167
  "pages": [
6935
7168
  {
6936
7169
  "slug": "dashboard",
@@ -6999,13 +7232,32 @@ const { data } = await client.getPortalConfigV3({
6999
7232
  {}
7000
7233
  ]
7001
7234
  },
7235
+ "identity_providers": [
7236
+ {
7237
+ "slug": "office-365-login",
7238
+ "display_name": "Office 365 Login",
7239
+ "provider_type": "OIDC",
7240
+ "attribute_mappings": {},
7241
+ "entity_matching": {},
7242
+ "oidc_config": {},
7243
+ "mobile_oidc_config": {}
7244
+ }
7245
+ ],
7002
7246
  "enabled": true,
7003
7247
  "name": "Installer Portal",
7004
7248
  "domain": "abc.com",
7005
7249
  "is_epilot_domain": true,
7250
+ "epilot_domain": "example-portal-1.ecp.epilot.io",
7251
+ "domain_settings": {
7252
+ "is_custom_domain_enabled": true,
7253
+ "is_epilot_domain_enabled": true,
7254
+ "is_redirection_enabled": true
7255
+ },
7006
7256
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
7007
7257
  "allowed_portal_entities": ["contact", "contract"],
7008
7258
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
7259
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
7260
+ "self_registration_entity": "contact",
7009
7261
  "user_account_self_management": false,
7010
7262
  "feature_settings": {
7011
7263
  "start_page": true,
@@ -7146,6 +7398,7 @@ const { data } = await client.getPortalConfigV3({
7146
7398
  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7147
7399
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7148
7400
  "origin": "string",
7401
+ "global_blocks": {},
7149
7402
  "organization_id": 12345,
7150
7403
  "org_settings": {
7151
7404
  "canary": {
@@ -7163,14 +7416,6 @@ const { data } = await client.getPortalConfigV3({
7163
7416
  "effect": "allow"
7164
7417
  }
7165
7418
  ],
7166
- "identity_providers": [
7167
- {
7168
- "slug": "office-365-login",
7169
- "display_name": "Office 365 Login",
7170
- "oidc_config": {},
7171
- "mobile_oidc_config": {}
7172
- }
7173
- ],
7174
7419
  "pages": [
7175
7420
  {
7176
7421
  "slug": "dashboard",
@@ -7234,13 +7479,32 @@ const { data } = await client.putPortalConfig(
7234
7479
  { /* ... */ }
7235
7480
  ]
7236
7481
  },
7482
+ identity_providers: [
7483
+ {
7484
+ slug: 'office-365-login',
7485
+ display_name: 'Office 365 Login',
7486
+ provider_type: 'OIDC',
7487
+ attribute_mappings: { /* ... */ },
7488
+ entity_matching: { /* ... */ },
7489
+ oidc_config: { /* ... */ },
7490
+ mobile_oidc_config: { /* ... */ }
7491
+ }
7492
+ ],
7237
7493
  enabled: true,
7238
7494
  name: 'Installer Portal',
7239
7495
  domain: 'abc.com',
7240
7496
  is_epilot_domain: true,
7497
+ epilot_domain: 'example-portal-1.ecp.epilot.io',
7498
+ domain_settings: {
7499
+ is_custom_domain_enabled: true,
7500
+ is_epilot_domain_enabled: true,
7501
+ is_redirection_enabled: true
7502
+ },
7241
7503
  design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
7242
7504
  allowed_portal_entities: ['contact', 'contract'],
7243
7505
  self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
7506
+ self_registration_account_setting: 'ALLOW_WITH_CONTACT_CREATION',
7507
+ self_registration_entity: 'contact',
7244
7508
  user_account_self_management: false,
7245
7509
  feature_settings: {
7246
7510
  start_page: true,
@@ -7382,6 +7646,7 @@ const { data } = await client.putPortalConfig(
7382
7646
  portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
7383
7647
  portal_sk_v3: 'PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c',
7384
7648
  origin: 'string',
7649
+ global_blocks: {},
7385
7650
  organization_id: 12345,
7386
7651
  org_settings: {
7387
7652
  canary: {
@@ -7399,14 +7664,6 @@ const { data } = await client.putPortalConfig(
7399
7664
  effect: 'allow'
7400
7665
  }
7401
7666
  ],
7402
- identity_providers: [
7403
- {
7404
- slug: 'office-365-login',
7405
- display_name: 'Office 365 Login',
7406
- oidc_config: { /* ... */ },
7407
- mobile_oidc_config: { /* ... */ }
7408
- }
7409
- ],
7410
7667
  pages: [
7411
7668
  {
7412
7669
  slug: 'dashboard',
@@ -7460,13 +7717,32 @@ const { data } = await client.putPortalConfig(
7460
7717
  {}
7461
7718
  ]
7462
7719
  },
7720
+ "identity_providers": [
7721
+ {
7722
+ "slug": "office-365-login",
7723
+ "display_name": "Office 365 Login",
7724
+ "provider_type": "OIDC",
7725
+ "attribute_mappings": {},
7726
+ "entity_matching": {},
7727
+ "oidc_config": {},
7728
+ "mobile_oidc_config": {}
7729
+ }
7730
+ ],
7463
7731
  "enabled": true,
7464
7732
  "name": "Installer Portal",
7465
7733
  "domain": "abc.com",
7466
7734
  "is_epilot_domain": true,
7735
+ "epilot_domain": "example-portal-1.ecp.epilot.io",
7736
+ "domain_settings": {
7737
+ "is_custom_domain_enabled": true,
7738
+ "is_epilot_domain_enabled": true,
7739
+ "is_redirection_enabled": true
7740
+ },
7467
7741
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
7468
7742
  "allowed_portal_entities": ["contact", "contract"],
7469
7743
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
7744
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
7745
+ "self_registration_entity": "contact",
7470
7746
  "user_account_self_management": false,
7471
7747
  "feature_settings": {
7472
7748
  "start_page": true,
@@ -7607,6 +7883,7 @@ const { data } = await client.putPortalConfig(
7607
7883
  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7608
7884
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7609
7885
  "origin": "string",
7886
+ "global_blocks": {},
7610
7887
  "organization_id": 12345,
7611
7888
  "org_settings": {
7612
7889
  "canary": {
@@ -7624,14 +7901,6 @@ const { data } = await client.putPortalConfig(
7624
7901
  "effect": "allow"
7625
7902
  }
7626
7903
  ],
7627
- "identity_providers": [
7628
- {
7629
- "slug": "office-365-login",
7630
- "display_name": "Office 365 Login",
7631
- "oidc_config": {},
7632
- "mobile_oidc_config": {}
7633
- }
7634
- ],
7635
7904
  "pages": [
7636
7905
  {
7637
7906
  "slug": "dashboard",
@@ -7698,13 +7967,18 @@ const { data } = await client.listAllPortalConfigs()
7698
7967
  "extensions": [],
7699
7968
  "extension_hooks": {},
7700
7969
  "default_user_to_notify": {},
7970
+ "identity_providers": [],
7701
7971
  "enabled": true,
7702
7972
  "name": "Installer Portal",
7703
7973
  "domain": "abc.com",
7704
7974
  "is_epilot_domain": true,
7975
+ "epilot_domain": "example-portal-1.ecp.epilot.io",
7976
+ "domain_settings": {},
7705
7977
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
7706
7978
  "allowed_portal_entities": ["contact", "contract"],
7707
7979
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
7980
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
7981
+ "self_registration_entity": "contact",
7708
7982
  "user_account_self_management": false,
7709
7983
  "feature_settings": {},
7710
7984
  "accessToken": "string",
@@ -7731,11 +8005,11 @@ const { data } = await client.listAllPortalConfigs()
7731
8005
  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7732
8006
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7733
8007
  "origin": "string",
8008
+ "global_blocks": {},
7734
8009
  "organization_id": 12345,
7735
8010
  "org_settings": {},
7736
8011
  "feature_flags": {},
7737
8012
  "grants": [],
7738
- "identity_providers": [],
7739
8013
  "pages": []
7740
8014
  }
7741
8015
  ]
@@ -7817,13 +8091,32 @@ const { data } = await client.clonePortalConfig(
7817
8091
  {}
7818
8092
  ]
7819
8093
  },
8094
+ "identity_providers": [
8095
+ {
8096
+ "slug": "office-365-login",
8097
+ "display_name": "Office 365 Login",
8098
+ "provider_type": "OIDC",
8099
+ "attribute_mappings": {},
8100
+ "entity_matching": {},
8101
+ "oidc_config": {},
8102
+ "mobile_oidc_config": {}
8103
+ }
8104
+ ],
7820
8105
  "enabled": true,
7821
8106
  "name": "Installer Portal",
7822
8107
  "domain": "abc.com",
7823
8108
  "is_epilot_domain": true,
8109
+ "epilot_domain": "example-portal-1.ecp.epilot.io",
8110
+ "domain_settings": {
8111
+ "is_custom_domain_enabled": true,
8112
+ "is_epilot_domain_enabled": true,
8113
+ "is_redirection_enabled": true
8114
+ },
7824
8115
  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
7825
8116
  "allowed_portal_entities": ["contact", "contract"],
7826
8117
  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
8118
+ "self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
8119
+ "self_registration_entity": "contact",
7827
8120
  "user_account_self_management": false,
7828
8121
  "feature_settings": {
7829
8122
  "start_page": true,
@@ -7964,6 +8257,7 @@ const { data } = await client.clonePortalConfig(
7964
8257
  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7965
8258
  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
7966
8259
  "origin": "string",
8260
+ "global_blocks": {},
7967
8261
  "organization_id": 12345,
7968
8262
  "org_settings": {
7969
8263
  "canary": {
@@ -7981,14 +8275,6 @@ const { data } = await client.clonePortalConfig(
7981
8275
  "effect": "allow"
7982
8276
  }
7983
8277
  ],
7984
- "identity_providers": [
7985
- {
7986
- "slug": "office-365-login",
7987
- "display_name": "Office 365 Login",
7988
- "oidc_config": {},
7989
- "mobile_oidc_config": {}
7990
- }
7991
- ],
7992
8278
  "pages": [
7993
8279
  {
7994
8280
  "slug": "dashboard",
@@ -8185,6 +8471,64 @@ const { data } = await client.enablePartner({
8185
8471
 
8186
8472
  ---
8187
8473
 
8474
+ ### `verifyDns`
8475
+
8476
+ Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
8477
+
8478
+ `POST /v3/portal/verify-dns`
8479
+
8480
+ ```ts
8481
+ const { data } = await client.verifyDns({
8482
+ portal_id: 'example',
8483
+ })
8484
+ ```
8485
+
8486
+ <details>
8487
+ <summary>Response</summary>
8488
+
8489
+ ```json
8490
+ {
8491
+ "domain_status": "PENDING",
8492
+ "message": "string"
8493
+ }
8494
+ ```
8495
+
8496
+ </details>
8497
+
8498
+ ---
8499
+
8500
+ ### `portalProxyExecute`
8501
+
8502
+ Execute an Integration Hub managed-call use case on behalf of a portal user.
8503
+ Bridges PortalAuth to the Integration API by generating an internal token.
8504
+
8505
+ `POST /v2/portal/proxy/execute`
8506
+
8507
+ ```ts
8508
+ const { data } = await client.portalProxyExecute(
8509
+ null,
8510
+ {
8511
+ integration_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
8512
+ use_case_slug: 'string',
8513
+ payload: {}
8514
+ },
8515
+ )
8516
+ ```
8517
+
8518
+ <details>
8519
+ <summary>Response</summary>
8520
+
8521
+ ```json
8522
+ {
8523
+ "success": true,
8524
+ "data": {}
8525
+ }
8526
+ ```
8527
+
8528
+ </details>
8529
+
8530
+ ---
8531
+
8188
8532
  ## Schemas
8189
8533
 
8190
8534
  ### `ContextEntity`
@@ -8364,6 +8708,37 @@ type UpdateOnlyPortalConfigAttributes = {
8364
8708
  phone?: { ... }
8365
8709
  }>
8366
8710
  }
8711
+ identity_providers?: Array<{
8712
+ slug?: string
8713
+ display_name: string
8714
+ provider_type: "OIDC"
8715
+ attribute_mappings?: {
8716
+ contact: { ... }
8717
+ account?: { ... }
8718
+ portal_user?: { ... }
8719
+ concession_attributes?: { ... }
8720
+ }
8721
+ entity_matching?: {
8722
+ portal_user?: { ... }
8723
+ contact?: { ... }
8724
+ auto_create_cognito_user?: { ... }
8725
+ }
8726
+ oidc_config?: {
8727
+ type?: { ... }
8728
+ oidc_issuer: { ... }
8729
+ redirect_uri?: { ... }
8730
+ client_id: { ... }
8731
+ client_secret?: { ... }
8732
+ has_client_secret?: { ... }
8733
+ scope: { ... }
8734
+ metadata?: { ... }
8735
+ prompt?: { ... }
8736
+ }
8737
+ mobile_oidc_config?: {
8738
+ client_id?: { ... }
8739
+ client_secret?: { ... }
8740
+ }
8741
+ }>
8367
8742
  }
8368
8743
  ```
8369
8744
 
@@ -8375,9 +8750,17 @@ type CommonConfigAttributes = {
8375
8750
  name?: string
8376
8751
  domain: string
8377
8752
  is_epilot_domain?: boolean
8753
+ epilot_domain?: string
8754
+ domain_settings?: {
8755
+ is_custom_domain_enabled?: boolean
8756
+ is_epilot_domain_enabled?: boolean
8757
+ is_redirection_enabled?: boolean
8758
+ }
8378
8759
  design_id?: string // uuid
8379
8760
  allowed_portal_entities?: string[]
8380
8761
  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?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
8763
+ self_registration_entity?: "contact" | "account"
8381
8764
  user_account_self_management?: boolean
8382
8765
  feature_settings?: {
8383
8766
  start_page?: boolean
@@ -8462,14 +8845,6 @@ type CommonConfigAttributes = {
8462
8845
  registration_identifiers?: Array<{
8463
8846
  name?: string
8464
8847
  schema?: string
8465
- }>
8466
- triggered_journeys?: Array<{
8467
- trigger_name?: "FIRST_LOGIN" | "ACCEPT_ORDER" | "DECLINE_ORDER"
8468
- journey_id?: string // uuid
8469
- }>
8470
- entity_edit_rules?: Array<{
8471
- slug?: string
8472
- attribute?: string
8473
8848
  // ...
8474
8849
  }
8475
8850
  ```
@@ -8507,13 +8882,52 @@ type UpsertPortalConfig = {
8507
8882
  phone?: { ... }
8508
8883
  }>
8509
8884
  }
8885
+ identity_providers?: Array<{
8886
+ slug?: string
8887
+ display_name: string
8888
+ provider_type: "OIDC"
8889
+ attribute_mappings?: {
8890
+ contact: { ... }
8891
+ account?: { ... }
8892
+ portal_user?: { ... }
8893
+ concession_attributes?: { ... }
8894
+ }
8895
+ entity_matching?: {
8896
+ portal_user?: { ... }
8897
+ contact?: { ... }
8898
+ auto_create_cognito_user?: { ... }
8899
+ }
8900
+ oidc_config?: {
8901
+ type?: { ... }
8902
+ oidc_issuer: { ... }
8903
+ redirect_uri?: { ... }
8904
+ client_id: { ... }
8905
+ client_secret?: { ... }
8906
+ has_client_secret?: { ... }
8907
+ scope: { ... }
8908
+ metadata?: { ... }
8909
+ prompt?: { ... }
8910
+ }
8911
+ mobile_oidc_config?: {
8912
+ client_id?: { ... }
8913
+ client_secret?: { ... }
8914
+ }
8915
+ }>
8510
8916
  enabled?: boolean
8511
8917
  name?: string
8512
8918
  domain: string
8513
8919
  is_epilot_domain?: boolean
8920
+ epilot_domain?: string
8921
+ domain_settings?: {
8922
+ is_custom_domain_enabled?: boolean
8923
+ is_epilot_domain_enabled?: boolean
8924
+ is_redirection_enabled?: boolean
8925
+ }
8514
8926
  design_id?: string // uuid
8515
8927
  allowed_portal_entities?: string[]
8516
8928
  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?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
8930
+ self_registration_entity?: "contact" | "account"
8517
8931
  user_account_self_management?: boolean
8518
8932
  feature_settings?: {
8519
8933
  start_page?: boolean
@@ -8538,45 +8952,6 @@ type UpsertPortalConfig = {
8538
8952
  cognito_user_pool_arn?: string
8539
8953
  cognito_user_pool_id?: string
8540
8954
  timeouts?: {
8541
- refresh_token?: { ... }
8542
- access_token?: { ... }
8543
- id_token?: { ... }
8544
- }
8545
- advanced_authentication?: {
8546
- user_activity_logging?: { ... }
8547
- adaptive_authentication?: { ... }
8548
- compromised_credentials_detection?: { ... }
8549
- }
8550
- password_policy?: {
8551
- minimum_length?: { ... }
8552
- maximum_length?: { ... }
8553
- require_lowercase?: { ... }
8554
- require_uppercase?: { ... }
8555
- require_numbers?: { ... }
8556
- require_symbols?: { ... }
8557
- }
8558
- }
8559
- config?: string
8560
- contact_identifiers?: string[]
8561
- approval_state_attributes?: Record<string, string[]>
8562
- email_templates?: {
8563
- confirmAccount?: string // uuid
8564
- advancedAuth?: string // uuid
8565
- advancedMFA?: string // uuid
8566
- journeySignUp?: string // uuid
8567
- journeySignInOneTimePassword?: string // uuid
8568
- journeyLoginOTP?: string // uuid
8569
- forgotPassword?: string // uuid
8570
- invitation?: string // uuid
8571
- partnerInvitation?: string // uuid
8572
- onNewQuote?: string // uuid
8573
- onMapAPendingUser?: string // uuid
8574
- onDocUpload?: string // uuid
8575
- onWorkflowStepAssigned?: string // uuid
8576
- confirmEmailUpdate?: string // uuid
8577
- verifyCodeToSetPassword?: string // uuid
8578
- }
8579
- images?: {
8580
8955
  // ...
8581
8956
  }
8582
8957
  ```
@@ -8589,9 +8964,17 @@ type PortalConfig = {
8589
8964
  name?: string
8590
8965
  domain: string
8591
8966
  is_epilot_domain?: boolean
8967
+ epilot_domain?: string
8968
+ domain_settings?: {
8969
+ is_custom_domain_enabled?: boolean
8970
+ is_epilot_domain_enabled?: boolean
8971
+ is_redirection_enabled?: boolean
8972
+ }
8592
8973
  design_id?: string // uuid
8593
8974
  allowed_portal_entities?: string[]
8594
8975
  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?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
8977
+ self_registration_entity?: "contact" | "account"
8595
8978
  user_account_self_management?: boolean
8596
8979
  feature_settings?: {
8597
8980
  start_page?: boolean
@@ -8676,14 +9059,6 @@ type PortalConfig = {
8676
9059
  registration_identifiers?: Array<{
8677
9060
  name?: string
8678
9061
  schema?: string
8679
- }>
8680
- triggered_journeys?: Array<{
8681
- trigger_name?: "FIRST_LOGIN" | "ACCEPT_ORDER" | "DECLINE_ORDER"
8682
- journey_id?: string // uuid
8683
- }>
8684
- entity_edit_rules?: Array<{
8685
- slug?: string
8686
- attribute?: string
8687
9062
  // ...
8688
9063
  }
8689
9064
  ```
@@ -8795,6 +9170,18 @@ type UpsertPortalWidget = {
8795
9170
  }
8796
9171
  ```
8797
9172
 
9173
+ ### `DomainSettings`
9174
+
9175
+ Domain settings for the portal
9176
+
9177
+ ```ts
9178
+ type DomainSettings = {
9179
+ is_custom_domain_enabled?: boolean
9180
+ is_epilot_domain_enabled?: boolean
9181
+ is_redirection_enabled?: boolean
9182
+ }
9183
+ ```
9184
+
8798
9185
  ### `WidgetBase`
8799
9186
 
8800
9187
  ```ts
@@ -9143,6 +9530,15 @@ type ContactExistsRequest = {
9143
9530
  }
9144
9531
  ```
9145
9532
 
9533
+ ### `AccountExistsRequest`
9534
+
9535
+ ```ts
9536
+ type AccountExistsRequest = {
9537
+ org_id: string
9538
+ registration_identifiers: Record<string, Record<string, string>>
9539
+ }
9540
+ ```
9541
+
9146
9542
  ### `UserRequest`
9147
9543
 
9148
9544
  ```ts
@@ -10528,6 +10924,7 @@ type ExtensionHookMeterReadingPlausibilityCheck = {
10528
10924
  valid?: string
10529
10925
  upper_limit?: string
10530
10926
  lower_limit?: string
10927
+ errorMessagePath?: string
10531
10928
  }
10532
10929
  use_static_ips?: boolean
10533
10930
  secure_proxy?: {
@@ -10566,6 +10963,7 @@ type ExtensionHookPriceDataRetrieval = {
10566
10963
  }
10567
10964
  resolved?: {
10568
10965
  dataPath?: string
10966
+ errorMessagePath?: string
10569
10967
  }
10570
10968
  use_static_ips?: boolean
10571
10969
  secure_proxy?: {
@@ -10604,6 +11002,7 @@ type ExtensionHookConsumptionDataRetrieval = {
10604
11002
  }
10605
11003
  resolved?: {
10606
11004
  dataPath?: string
11005
+ errorMessagePath?: string
10607
11006
  }
10608
11007
  use_static_ips?: boolean
10609
11008
  secure_proxy?: {
@@ -10639,6 +11038,9 @@ type ExtensionHookDataExport = {
10639
11038
  headers?: Record<string, string>
10640
11039
  body?: Record<string, string>
10641
11040
  }
11041
+ resolved?: {
11042
+ errorMessagePath?: string
11043
+ }
10642
11044
  use_static_ips?: boolean
10643
11045
  secure_proxy?: {
10644
11046
  integration_id: string // uuid
@@ -10675,6 +11077,7 @@ type ExtensionHookVisualizationMetadata = {
10675
11077
  }
10676
11078
  resolved?: {
10677
11079
  dataPath?: string
11080
+ errorMessagePath?: string
10678
11081
  }
10679
11082
  use_static_ips?: boolean
10680
11083
  secure_proxy?: {
@@ -10713,6 +11116,7 @@ type ExtensionHookCostDataRetrieval = {
10713
11116
  }
10714
11117
  resolved?: {
10715
11118
  dataPath?: string
11119
+ errorMessagePath?: string
10716
11120
  }
10717
11121
  use_static_ips?: boolean
10718
11122
  secure_proxy?: {
@@ -10861,6 +11265,13 @@ type ProviderDisplayName = string
10861
11265
 
10862
11266
  ### `ProviderConfig`
10863
11267
 
11268
+ SSO identity provider configuration.
11269
+
11270
+ Env var interpolation: only string fields under `oidc_config` and
11271
+ `mobile_oidc_config` (incl. their nested `metadata`) are passed through
11272
+ Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
11273
+ get resolved at runtime against the organization's
11274
+
10864
11275
  ```ts
10865
11276
  type ProviderConfig = {
10866
11277
  slug?: string
@@ -10907,6 +11318,7 @@ type ProviderConfig = {
10907
11318
  has_client_secret?: boolean
10908
11319
  scope: string
10909
11320
  metadata?: {
11321
+ response_modes_supported?: { ... }
10910
11322
  authorization_endpoint?: { ... }
10911
11323
  token_endpoint?: { ... }
10912
11324
  userinfo_endpoint?: { ... }
@@ -10941,6 +11353,7 @@ type ProviderPublicConfig = {
10941
11353
  has_client_secret?: boolean
10942
11354
  scope: string
10943
11355
  metadata?: {
11356
+ response_modes_supported?: { ... }
10944
11357
  authorization_endpoint?: { ... }
10945
11358
  token_endpoint?: { ... }
10946
11359
  userinfo_endpoint?: { ... }
@@ -11008,6 +11421,13 @@ type EntityMatchingConfig = {
11008
11421
 
11009
11422
  ### `OIDCProviderConfig`
11010
11423
 
11424
+ OIDC provider configuration. Values are resolved at SSO invocation time
11425
+ (login / callback), so the fields below may reference org env vars via
11426
+ mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
11427
+
11428
+ Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
11429
+ `ProviderConfig.
11430
+
11011
11431
  ```ts
11012
11432
  type OIDCProviderConfig = {
11013
11433
  type?: "authorization_code" | "implicit"
@@ -11018,6 +11438,7 @@ type OIDCProviderConfig = {
11018
11438
  has_client_secret?: boolean
11019
11439
  scope: string
11020
11440
  metadata?: {
11441
+ response_modes_supported?: "form_post" | "fragment" | "query"[]
11021
11442
  authorization_endpoint?: string
11022
11443
  token_endpoint?: string
11023
11444
  userinfo_endpoint?: string
@@ -11034,6 +11455,11 @@ type OIDCProviderConfig = {
11034
11455
 
11035
11456
  ### `MoblieOIDCConfig`
11036
11457
 
11458
+ Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
11459
+ fields below may reference org env vars via mustache-like templates, e.g.
11460
+ `{{ env.MOBILE_CLIENT_SECRET }}`.
11461
+
11462
+
11037
11463
  ```ts
11038
11464
  type MoblieOIDCConfig = {
11039
11465
  client_id?: string
@@ -11045,6 +11471,7 @@ type MoblieOIDCConfig = {
11045
11471
 
11046
11472
  ```ts
11047
11473
  type OIDCProviderMetadata = {
11474
+ response_modes_supported?: "form_post" | "fragment" | "query"[]
11048
11475
  authorization_endpoint?: string
11049
11476
  token_endpoint?: string
11050
11477
  userinfo_endpoint?: string
@@ -11276,9 +11703,17 @@ type CommonConfigAttributesV3 = {
11276
11703
  name?: string
11277
11704
  domain?: string
11278
11705
  is_epilot_domain?: boolean
11706
+ epilot_domain?: string
11707
+ domain_settings?: {
11708
+ is_custom_domain_enabled?: boolean
11709
+ is_epilot_domain_enabled?: boolean
11710
+ is_redirection_enabled?: boolean
11711
+ }
11279
11712
  design_id?: string // uuid
11280
11713
  allowed_portal_entities?: string[]
11281
11714
  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?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
11716
+ self_registration_entity?: "contact" | "account"
11282
11717
  user_account_self_management?: boolean
11283
11718
  feature_settings?: {
11284
11719
  start_page?: boolean
@@ -11363,14 +11798,6 @@ type CommonConfigAttributesV3 = {
11363
11798
  registration_identifiers?: Array<{
11364
11799
  name?: string
11365
11800
  schema?: string
11366
- }>
11367
- triggered_journeys?: Array<{
11368
- trigger_name?: "FIRST_LOGIN" | "ACCEPT_ORDER" | "DECLINE_ORDER"
11369
- journey_id?: string // uuid
11370
- }>
11371
- entity_edit_rules?: Array<{
11372
- slug?: string
11373
- attribute?: string
11374
11801
  // ...
11375
11802
  }
11376
11803
  ```
@@ -11416,13 +11843,52 @@ type UpsertPortalConfigV3 = {
11416
11843
  phone?: { ... }
11417
11844
  }>
11418
11845
  }
11846
+ identity_providers?: Array<{
11847
+ slug?: string
11848
+ display_name: string
11849
+ provider_type: "OIDC"
11850
+ attribute_mappings?: {
11851
+ contact: { ... }
11852
+ account?: { ... }
11853
+ portal_user?: { ... }
11854
+ concession_attributes?: { ... }
11855
+ }
11856
+ entity_matching?: {
11857
+ portal_user?: { ... }
11858
+ contact?: { ... }
11859
+ auto_create_cognito_user?: { ... }
11860
+ }
11861
+ oidc_config?: {
11862
+ type?: { ... }
11863
+ oidc_issuer: { ... }
11864
+ redirect_uri?: { ... }
11865
+ client_id: { ... }
11866
+ client_secret?: { ... }
11867
+ has_client_secret?: { ... }
11868
+ scope: { ... }
11869
+ metadata?: { ... }
11870
+ prompt?: { ... }
11871
+ }
11872
+ mobile_oidc_config?: {
11873
+ client_id?: { ... }
11874
+ client_secret?: { ... }
11875
+ }
11876
+ }>
11419
11877
  enabled?: boolean
11420
11878
  name?: string
11421
11879
  domain?: string
11422
11880
  is_epilot_domain?: boolean
11881
+ epilot_domain?: string
11882
+ domain_settings?: {
11883
+ is_custom_domain_enabled?: boolean
11884
+ is_epilot_domain_enabled?: boolean
11885
+ is_redirection_enabled?: boolean
11886
+ }
11423
11887
  design_id?: string // uuid
11424
11888
  allowed_portal_entities?: string[]
11425
11889
  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?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
11891
+ self_registration_entity?: "contact" | "account"
11426
11892
  user_account_self_management?: boolean
11427
11893
  feature_settings?: {
11428
11894
  start_page?: boolean
@@ -11447,45 +11913,6 @@ type UpsertPortalConfigV3 = {
11447
11913
  cognito_user_pool_arn?: string
11448
11914
  cognito_user_pool_id?: string
11449
11915
  timeouts?: {
11450
- refresh_token?: { ... }
11451
- access_token?: { ... }
11452
- id_token?: { ... }
11453
- }
11454
- advanced_authentication?: {
11455
- user_activity_logging?: { ... }
11456
- adaptive_authentication?: { ... }
11457
- compromised_credentials_detection?: { ... }
11458
- }
11459
- password_policy?: {
11460
- minimum_length?: { ... }
11461
- maximum_length?: { ... }
11462
- require_lowercase?: { ... }
11463
- require_uppercase?: { ... }
11464
- require_numbers?: { ... }
11465
- require_symbols?: { ... }
11466
- }
11467
- }
11468
- config?: string
11469
- contact_identifiers?: string[]
11470
- approval_state_attributes?: Record<string, string[]>
11471
- email_templates?: {
11472
- confirmAccount?: string // uuid
11473
- advancedAuth?: string // uuid
11474
- advancedMFA?: string // uuid
11475
- journeySignUp?: string // uuid
11476
- journeySignInOneTimePassword?: string // uuid
11477
- journeyLoginOTP?: string // uuid
11478
- forgotPassword?: string // uuid
11479
- invitation?: string // uuid
11480
- partnerInvitation?: string // uuid
11481
- onNewQuote?: string // uuid
11482
- onMapAPendingUser?: string // uuid
11483
- onDocUpload?: string // uuid
11484
- onWorkflowStepAssigned?: string // uuid
11485
- confirmEmailUpdate?: string // uuid
11486
- verifyCodeToSetPassword?: string // uuid
11487
- }
11488
- images?: {
11489
11916
  // ...
11490
11917
  }
11491
11918
  ```
@@ -11523,13 +11950,40 @@ type PortalConfigV3 = {
11523
11950
  phone?: { ... }
11524
11951
  }>
11525
11952
  }
11953
+ identity_providers?: Array<{
11954
+ slug: string
11955
+ display_name: string
11956
+ oidc_config?: {
11957
+ type?: { ... }
11958
+ oidc_issuer: { ... }
11959
+ redirect_uri?: { ... }
11960
+ client_id: { ... }
11961
+ client_secret?: { ... }
11962
+ has_client_secret?: { ... }
11963
+ scope: { ... }
11964
+ metadata?: { ... }
11965
+ prompt?: { ... }
11966
+ }
11967
+ mobile_oidc_config?: {
11968
+ client_id?: { ... }
11969
+ client_secret?: { ... }
11970
+ }
11971
+ }>
11526
11972
  enabled?: boolean
11527
11973
  name?: string
11528
11974
  domain?: string
11529
11975
  is_epilot_domain?: boolean
11976
+ epilot_domain?: string
11977
+ domain_settings?: {
11978
+ is_custom_domain_enabled?: boolean
11979
+ is_epilot_domain_enabled?: boolean
11980
+ is_redirection_enabled?: boolean
11981
+ }
11530
11982
  design_id?: string // uuid
11531
11983
  allowed_portal_entities?: string[]
11532
11984
  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?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
11986
+ self_registration_entity?: "contact" | "account"
11533
11987
  user_account_self_management?: boolean
11534
11988
  feature_settings?: {
11535
11989
  start_page?: boolean
@@ -11566,33 +12020,6 @@ type PortalConfigV3 = {
11566
12020
  password_policy?: {
11567
12021
  minimum_length?: { ... }
11568
12022
  maximum_length?: { ... }
11569
- require_lowercase?: { ... }
11570
- require_uppercase?: { ... }
11571
- require_numbers?: { ... }
11572
- require_symbols?: { ... }
11573
- }
11574
- }
11575
- config?: string
11576
- contact_identifiers?: string[]
11577
- approval_state_attributes?: Record<string, string[]>
11578
- email_templates?: {
11579
- confirmAccount?: string // uuid
11580
- advancedAuth?: string // uuid
11581
- advancedMFA?: string // uuid
11582
- journeySignUp?: string // uuid
11583
- journeySignInOneTimePassword?: string // uuid
11584
- journeyLoginOTP?: string // uuid
11585
- forgotPassword?: string // uuid
11586
- invitation?: string // uuid
11587
- partnerInvitation?: string // uuid
11588
- onNewQuote?: string // uuid
11589
- onMapAPendingUser?: string // uuid
11590
- onDocUpload?: string // uuid
11591
- onWorkflowStepAssigned?: string // uuid
11592
- confirmEmailUpdate?: string // uuid
11593
- verifyCodeToSetPassword?: string // uuid
11594
- }
11595
- images?: {
11596
12023
  // ...
11597
12024
  }
11598
12025
  ```
@@ -11603,6 +12030,7 @@ type PortalConfigV3 = {
11603
12030
  type JuiceSettings = {
11604
12031
  is_dummy?: boolean
11605
12032
  is_canary?: boolean
12033
+ redirect_to?: string
11606
12034
  }
11607
12035
  ```
11608
12036