@epilot/sdk 2.6.0 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/definitions/customer-portal-runtime.json +1 -1
  2. package/definitions/customer-portal.json +492 -7
  3. package/definitions/email-settings-runtime.json +1 -1
  4. package/definitions/email-settings.json +86 -4
  5. package/definitions/event-catalog-runtime.json +1 -1
  6. package/definitions/event-catalog.json +256 -1
  7. package/definitions/file-runtime.json +1 -1
  8. package/definitions/file.json +262 -4
  9. package/definitions/webhooks.json +19 -4
  10. package/dist/apis/access-token.cjs +6 -6
  11. package/dist/apis/access-token.js +1 -1
  12. package/dist/apis/address-suggestions.cjs +6 -6
  13. package/dist/apis/address-suggestions.js +1 -1
  14. package/dist/apis/address.cjs +6 -6
  15. package/dist/apis/address.js +1 -1
  16. package/dist/apis/ai-agents.cjs +6 -6
  17. package/dist/apis/ai-agents.js +1 -1
  18. package/dist/apis/app.cjs +6 -6
  19. package/dist/apis/app.js +1 -1
  20. package/dist/apis/audit-logs.cjs +6 -6
  21. package/dist/apis/audit-logs.js +1 -1
  22. package/dist/apis/automation.cjs +6 -6
  23. package/dist/apis/automation.js +1 -1
  24. package/dist/apis/billing.cjs +6 -6
  25. package/dist/apis/billing.js +1 -1
  26. package/dist/apis/blueprint-manifest.cjs +6 -6
  27. package/dist/apis/blueprint-manifest.js +1 -1
  28. package/dist/apis/calendar.cjs +6 -6
  29. package/dist/apis/calendar.js +1 -1
  30. package/dist/apis/configuration-hub.cjs +6 -6
  31. package/dist/apis/configuration-hub.js +1 -1
  32. package/dist/apis/consent.cjs +6 -6
  33. package/dist/apis/consent.js +1 -1
  34. package/dist/apis/customer-portal.cjs +8 -8
  35. package/dist/apis/customer-portal.d.cts +2 -2
  36. package/dist/apis/customer-portal.d.ts +2 -2
  37. package/dist/apis/customer-portal.js +2 -2
  38. package/dist/apis/dashboard.cjs +6 -6
  39. package/dist/apis/dashboard.js +1 -1
  40. package/dist/apis/data-governance.cjs +6 -6
  41. package/dist/apis/data-governance.js +1 -1
  42. package/dist/apis/deduplication.cjs +6 -6
  43. package/dist/apis/deduplication.js +1 -1
  44. package/dist/apis/design.cjs +6 -6
  45. package/dist/apis/design.js +1 -1
  46. package/dist/apis/document.cjs +6 -6
  47. package/dist/apis/document.js +1 -1
  48. package/dist/apis/email-settings.cjs +8 -8
  49. package/dist/apis/email-settings.d.cts +2 -2
  50. package/dist/apis/email-settings.d.ts +2 -2
  51. package/dist/apis/email-settings.js +2 -2
  52. package/dist/apis/email-template.cjs +6 -6
  53. package/dist/apis/email-template.js +1 -1
  54. package/dist/apis/entity-mapping.cjs +6 -6
  55. package/dist/apis/entity-mapping.js +1 -1
  56. package/dist/apis/entity.cjs +6 -6
  57. package/dist/apis/entity.js +1 -1
  58. package/dist/apis/environments.cjs +6 -6
  59. package/dist/apis/environments.js +1 -1
  60. package/dist/apis/event-catalog.cjs +8 -8
  61. package/dist/apis/event-catalog.d.cts +2 -2
  62. package/dist/apis/event-catalog.d.ts +2 -2
  63. package/dist/apis/event-catalog.js +2 -2
  64. package/dist/apis/file.cjs +8 -8
  65. package/dist/apis/file.d.cts +2 -2
  66. package/dist/apis/file.d.ts +2 -2
  67. package/dist/apis/file.js +2 -2
  68. package/dist/apis/iban.cjs +6 -6
  69. package/dist/apis/iban.js +1 -1
  70. package/dist/apis/integration-toolkit.cjs +6 -6
  71. package/dist/apis/integration-toolkit.js +1 -1
  72. package/dist/apis/journey.cjs +6 -6
  73. package/dist/apis/journey.js +1 -1
  74. package/dist/apis/kanban.cjs +6 -6
  75. package/dist/apis/kanban.js +1 -1
  76. package/dist/apis/message.cjs +6 -6
  77. package/dist/apis/message.js +1 -1
  78. package/dist/apis/metering.cjs +6 -6
  79. package/dist/apis/metering.js +1 -1
  80. package/dist/apis/notes.cjs +6 -6
  81. package/dist/apis/notes.js +1 -1
  82. package/dist/apis/notification.cjs +6 -6
  83. package/dist/apis/notification.js +1 -1
  84. package/dist/apis/organization.cjs +6 -6
  85. package/dist/apis/organization.js +1 -1
  86. package/dist/apis/partner-directory.cjs +6 -6
  87. package/dist/apis/partner-directory.js +1 -1
  88. package/dist/apis/permissions.cjs +6 -6
  89. package/dist/apis/permissions.js +1 -1
  90. package/dist/apis/pricing-tier.cjs +6 -6
  91. package/dist/apis/pricing-tier.js +1 -1
  92. package/dist/apis/pricing.cjs +6 -6
  93. package/dist/apis/pricing.js +1 -1
  94. package/dist/apis/purpose.cjs +6 -6
  95. package/dist/apis/purpose.js +1 -1
  96. package/dist/apis/query.cjs +6 -6
  97. package/dist/apis/query.js +1 -1
  98. package/dist/apis/sandbox.cjs +6 -6
  99. package/dist/apis/sandbox.js +1 -1
  100. package/dist/apis/sharing.cjs +6 -6
  101. package/dist/apis/sharing.js +1 -1
  102. package/dist/apis/submission.cjs +6 -6
  103. package/dist/apis/submission.js +1 -1
  104. package/dist/apis/target.cjs +6 -6
  105. package/dist/apis/target.js +1 -1
  106. package/dist/apis/targeting.cjs +6 -6
  107. package/dist/apis/targeting.js +1 -1
  108. package/dist/apis/template-variables.cjs +6 -6
  109. package/dist/apis/template-variables.js +1 -1
  110. package/dist/apis/user.cjs +6 -6
  111. package/dist/apis/user.js +1 -1
  112. package/dist/apis/validation-rules.cjs +6 -6
  113. package/dist/apis/validation-rules.js +1 -1
  114. package/dist/apis/webhooks.cjs +6 -6
  115. package/dist/apis/webhooks.d.cts +2 -2
  116. package/dist/apis/webhooks.d.ts +2 -2
  117. package/dist/apis/webhooks.js +1 -1
  118. package/dist/apis/workflow-definition.cjs +6 -6
  119. package/dist/apis/workflow-definition.js +1 -1
  120. package/dist/apis/workflow.cjs +6 -6
  121. package/dist/apis/workflow.js +1 -1
  122. package/dist/bin/cli.js +1 -1
  123. package/dist/chunk-3APTSPY4.js +14 -0
  124. package/dist/{chunk-BLNXQAMX.cjs → chunk-CBDKPGO5.cjs} +1 -1
  125. package/dist/chunk-KCPVNRDL.js +14 -0
  126. package/dist/chunk-KJPOUJBU.cjs +14 -0
  127. package/dist/{chunk-TME4YJNP.js → chunk-OCMIXJWC.js} +1 -1
  128. package/dist/chunk-OPXGJKZR.cjs +14 -0
  129. package/dist/chunk-PTEJYAYJ.js +14 -0
  130. package/dist/{chunk-SDIGGISZ.cjs → chunk-R7XDTILZ.cjs} +9 -9
  131. package/dist/{chunk-QNUU4TTU.js → chunk-SCMAZ73K.js} +9 -9
  132. package/dist/chunk-YI5YGTAH.cjs +14 -0
  133. package/dist/customer-portal-7HYSBH7H.cjs +7 -0
  134. package/dist/customer-portal-X4LJX6AU.js +7 -0
  135. package/dist/{customer-portal-runtime-OEXTSMSE.cjs → customer-portal-runtime-IYHJ3RME.cjs} +2 -2
  136. package/dist/{customer-portal-runtime-N4NWQ67M.js → customer-portal-runtime-ZYU3WIXY.js} +1 -1
  137. package/dist/{customer-portal.d-ChSEioI5.d.cts → customer-portal.d-C7ZCbjiY.d.cts} +605 -11
  138. package/dist/{customer-portal.d-ChSEioI5.d.ts → customer-portal.d-C7ZCbjiY.d.ts} +605 -11
  139. package/dist/email-settings-YJ4X5VFU.cjs +7 -0
  140. package/dist/email-settings-YUK3DXFJ.js +7 -0
  141. package/dist/{email-settings-runtime-EGIJ2AVQ.js → email-settings-runtime-BXRZV4M5.js} +1 -1
  142. package/dist/{email-settings-runtime-WGVLI7N6.cjs → email-settings-runtime-FWJQBQBK.cjs} +2 -2
  143. package/dist/{email-settings.d-B7Q_xT25.d.cts → email-settings.d-UJ0C3jPI.d.cts} +108 -9
  144. package/dist/{email-settings.d-B7Q_xT25.d.ts → email-settings.d-UJ0C3jPI.d.ts} +108 -9
  145. package/dist/event-catalog-37B6JC7G.js +7 -0
  146. package/dist/event-catalog-5JBHJJ2I.cjs +7 -0
  147. package/dist/{event-catalog-runtime-5HQSAJVX.cjs → event-catalog-runtime-B2BPKQVG.cjs} +2 -2
  148. package/dist/{event-catalog-runtime-6FA3SCRI.js → event-catalog-runtime-N262TQ3Y.js} +1 -1
  149. package/dist/{event-catalog.d-ENw6HO-w.d.cts → event-catalog.d-mQJLSYUo.d.cts} +351 -6
  150. package/dist/{event-catalog.d-ENw6HO-w.d.ts → event-catalog.d-mQJLSYUo.d.ts} +351 -6
  151. package/dist/file-P2FUUER2.js +7 -0
  152. package/dist/file-XTY74SIX.cjs +7 -0
  153. package/dist/file-runtime-24S3QPA7.cjs +5 -0
  154. package/dist/{file-runtime-B6AAGZQF.js → file-runtime-BIRMXYRH.js} +1 -1
  155. package/dist/{file.d-DcTJxjp7.d.cts → file.d-DTlrbI40.d.cts} +2336 -19
  156. package/dist/{file.d-DcTJxjp7.d.ts → file.d-DTlrbI40.d.ts} +2336 -19
  157. package/dist/index.cjs +16 -16
  158. package/dist/index.d.cts +5 -5
  159. package/dist/index.d.ts +5 -5
  160. package/dist/index.js +5 -5
  161. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  162. package/dist/{webhooks-XLBUXXCS.js → webhooks-NZHJBT64.js} +1 -1
  163. package/dist/{webhooks-NZ3TM3AY.cjs → webhooks-SK2STDKR.cjs} +1 -1
  164. package/dist/{webhooks.d-D79qib9f.d.cts → webhooks.d-ByePoUWs.d.cts} +40 -4
  165. package/dist/{webhooks.d-D79qib9f.d.ts → webhooks.d-ByePoUWs.d.ts} +40 -4
  166. package/docs/customer-portal.md +417 -51
  167. package/docs/email-settings.md +67 -3
  168. package/docs/event-catalog.md +247 -1
  169. package/docs/file.md +101 -2
  170. package/docs/webhooks.md +3 -1
  171. package/package.json +1 -1
  172. package/dist/chunk-4W22EIRF.cjs +0 -14
  173. package/dist/chunk-5OBMZHRL.cjs +0 -14
  174. package/dist/chunk-E2WMGOM5.js +0 -14
  175. package/dist/chunk-EFWPEVXI.js +0 -14
  176. package/dist/chunk-KEI3GHDY.cjs +0 -14
  177. package/dist/chunk-Z6HGUGXK.js +0 -14
  178. package/dist/customer-portal-5I7ZGQDU.cjs +0 -7
  179. package/dist/customer-portal-YL2YMPZL.js +0 -7
  180. package/dist/email-settings-CKFJU4WZ.js +0 -7
  181. package/dist/email-settings-NQJJKS2P.cjs +0 -7
  182. package/dist/event-catalog-C45ISVMP.cjs +0 -7
  183. package/dist/event-catalog-D7VJ7WRS.js +0 -7
  184. package/dist/file-UOWBTDIU.cjs +0 -7
  185. package/dist/file-XSN3NAVZ.js +0 -7
  186. package/dist/file-runtime-SFZIKODF.cjs +0 -5
@@ -46,6 +46,31 @@ declare namespace Components {
46
46
  */
47
47
  decision: "accept" | "decline";
48
48
  }
49
+ export interface AccountExistsRequest {
50
+ /**
51
+ * ID of the organization
52
+ * example:
53
+ * 728
54
+ */
55
+ org_id: string;
56
+ /**
57
+ * Identifier-value pairs per schema to identify an account during portal user registration
58
+ * example:
59
+ * {
60
+ * "account": {
61
+ * "customer_number": "ACC-123456"
62
+ * },
63
+ * "contract": {
64
+ * "contract_number": "123456"
65
+ * }
66
+ * }
67
+ */
68
+ registration_identifiers: {
69
+ [name: string]: {
70
+ [name: string]: string;
71
+ };
72
+ };
73
+ }
49
74
  export interface ActionLabel {
50
75
  en?: string | null;
51
76
  de?: string | null;
@@ -904,6 +929,13 @@ declare namespace Components {
904
929
  * Mark true if the domain is an Epilot domain
905
930
  */
906
931
  is_epilot_domain?: boolean;
932
+ /**
933
+ * The URL on which the portal is accessible
934
+ * example:
935
+ * example-portal-12345.ecp.epilot.cloud
936
+ */
937
+ epilot_domain?: string;
938
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
907
939
  /**
908
940
  * ID of the design used to build the portal
909
941
  */
@@ -923,6 +955,14 @@ declare namespace Components {
923
955
  */
924
956
  allowed_portal_entities?: string[];
925
957
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
958
+ /**
959
+ * Controls behavior of self-registration when account is used as the registration entity
960
+ */
961
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
962
+ /**
963
+ * Entity type used as the primary identifier for self-registration
964
+ */
965
+ self_registration_entity?: "contact" | "account";
926
966
  /**
927
967
  * Enable or disable user account self management
928
968
  * example:
@@ -1303,6 +1343,12 @@ declare namespace Components {
1303
1343
  pages?: {
1304
1344
  [name: string]: Page;
1305
1345
  };
1346
+ /**
1347
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
1348
+ */
1349
+ global_blocks?: {
1350
+ [name: string]: Block;
1351
+ };
1306
1352
  }
1307
1353
  export interface CommonConfigAttributesV3 {
1308
1354
  /**
@@ -1325,6 +1371,13 @@ declare namespace Components {
1325
1371
  * Mark true if the domain is an Epilot domain
1326
1372
  */
1327
1373
  is_epilot_domain?: boolean;
1374
+ /**
1375
+ * The Epilot domain on which the portal is accessible
1376
+ * example:
1377
+ * example-portal-1.ecp.epilot.io
1378
+ */
1379
+ epilot_domain?: string;
1380
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
1328
1381
  /**
1329
1382
  * ID of the design used to build the portal
1330
1383
  */
@@ -1344,6 +1397,14 @@ declare namespace Components {
1344
1397
  */
1345
1398
  allowed_portal_entities?: string[];
1346
1399
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
1400
+ /**
1401
+ * Controls behavior of self-registration when account is used as the registration entity
1402
+ */
1403
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
1404
+ /**
1405
+ * Entity type used as the primary identifier for self-registration
1406
+ */
1407
+ self_registration_entity?: "contact" | "account";
1347
1408
  /**
1348
1409
  * Enable or disable user account self management
1349
1410
  * example:
@@ -1721,6 +1782,12 @@ declare namespace Components {
1721
1782
  */
1722
1783
  portal_sk_v3?: string;
1723
1784
  origin?: /* Origin of the portal */ Origin;
1785
+ /**
1786
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
1787
+ */
1788
+ global_blocks?: {
1789
+ [name: string]: Block;
1790
+ };
1724
1791
  }
1725
1792
  /**
1726
1793
  * The mapped contact of the portal user
@@ -2207,6 +2274,23 @@ declare namespace Components {
2207
2274
  de?: string;
2208
2275
  };
2209
2276
  }
2277
+ /**
2278
+ * Domain settings for the portal
2279
+ */
2280
+ export interface DomainSettings {
2281
+ /**
2282
+ * Whether the custom domain is enabled
2283
+ */
2284
+ is_custom_domain_enabled?: boolean;
2285
+ /**
2286
+ * Whether the Epilot domain is enabled
2287
+ */
2288
+ is_epilot_domain_enabled?: boolean;
2289
+ /**
2290
+ * Whether the redirection is enabled
2291
+ */
2292
+ is_redirection_enabled?: boolean;
2293
+ }
2210
2294
  /**
2211
2295
  * Email templates used for authentication and internal processes
2212
2296
  */
@@ -4215,6 +4299,12 @@ declare namespace Components {
4215
4299
  * Whether the org is in canary mode
4216
4300
  */
4217
4301
  is_canary?: boolean;
4302
+ /**
4303
+ * The URL to redirect to
4304
+ * example:
4305
+ * https://example.com
4306
+ */
4307
+ redirect_to?: string;
4218
4308
  }
4219
4309
  /**
4220
4310
  * The meter entity
@@ -4470,40 +4560,57 @@ declare namespace Components {
4470
4560
  };
4471
4561
  schema?: string;
4472
4562
  }
4563
+ /**
4564
+ * Mobile OIDC configuration. All string fields support env var interpolation
4565
+ * (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
4566
+ *
4567
+ */
4473
4568
  export interface MoblieOIDCConfig {
4474
4569
  /**
4475
- * Client ID for the mobile app
4570
+ * Client ID for the mobile app. Supports env var interpolation.
4476
4571
  * example:
4477
4572
  * 123456
4478
4573
  */
4479
4574
  client_id?: string;
4480
4575
  /**
4481
- * Client Secret for the mobile app
4576
+ * Client Secret for the mobile app. Supports env var interpolation (incl. secrets),
4577
+ * e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
4578
+ *
4482
4579
  * example:
4483
4580
  * 123456
4484
4581
  */
4485
4582
  client_secret?: string;
4486
4583
  }
4584
+ /**
4585
+ * OIDC provider configuration. All string fields support env var interpolation
4586
+ * (incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
4587
+ *
4588
+ */
4487
4589
  export interface OIDCProviderConfig {
4488
4590
  type?: "authorization_code" | "implicit";
4489
4591
  /**
4490
- * Issuing Authority URL
4592
+ * Issuing Authority URL. Supports env var interpolation, e.g. `{{ env.MY_ISSUER }}`.
4491
4593
  * example:
4492
4594
  * https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
4493
4595
  */
4494
4596
  oidc_issuer: string;
4495
4597
  /**
4496
- * Redirect URI for the OIDC flow
4598
+ * Redirect URI for the OIDC flow. Supports env var interpolation.
4497
4599
  * example:
4498
4600
  * https://customer-portal.com/login
4499
4601
  */
4500
4602
  redirect_uri?: string;
4501
4603
  /**
4604
+ * Supports env var interpolation, e.g. `{{ env.MY_CLIENT_ID }}`.
4502
4605
  * example:
4503
4606
  * ab81daf8-8b1f-42d6-94ca-c51621054c75
4504
4607
  */
4505
4608
  client_id: string;
4506
4609
  /**
4610
+ * Client Secret. Supports env var interpolation (incl. secrets), e.g.
4611
+ * `{{ env.MY_CLIENT_SECRET }}`. Prefer storing the actual secret as an org
4612
+ * env var and referencing it here.
4613
+ *
4507
4614
  * example:
4508
4615
  * 7BIUnn~6shh.7fNtXb..3k1Mp3s6k6WK3B
4509
4616
  */
@@ -4565,16 +4672,61 @@ declare namespace Components {
4565
4672
  */
4566
4673
  mobile_redirect_uri?: string;
4567
4674
  /**
4568
- * The username for the test auth, only used for testing on auth code flow
4675
+ * The username for the test auth, only used for testing on auth code flow.
4676
+ * Supports env var interpolation, e.g. `{{ env.MY_TEST_AUTH_USERNAME }}`.
4677
+ *
4569
4678
  * example:
4570
4679
  * test@epilot.io
4571
4680
  */
4572
4681
  test_auth_username?: string;
4573
4682
  /**
4574
- * The password for the test auth, only used for testing on auth code flow
4683
+ * The password for the test auth, only used for testing on auth code flow.
4684
+ * Supports env var interpolation (incl. secrets), e.g. `{{ env.MY_TEST_AUTH_PASSWORD }}`.
4685
+ *
4575
4686
  */
4576
4687
  test_auth_password?: string;
4577
4688
  }
4689
+ /**
4690
+ * Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
4691
+ * the `client_secret` field — it is kept server-side and only used to exchange the
4692
+ * authorization code at the SSO callback. String fields are returned with env var
4693
+ * placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
4694
+ *
4695
+ */
4696
+ export interface OIDCProviderPublicConfig {
4697
+ type?: "authorization_code" | "implicit";
4698
+ /**
4699
+ * Issuing Authority URL
4700
+ * example:
4701
+ * https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
4702
+ */
4703
+ oidc_issuer: string;
4704
+ /**
4705
+ * Redirect URI for the OIDC flow
4706
+ * example:
4707
+ * https://customer-portal.com/login
4708
+ */
4709
+ redirect_uri?: string;
4710
+ /**
4711
+ * example:
4712
+ * ab81daf8-8b1f-42d6-94ca-c51621054c75
4713
+ */
4714
+ client_id: string;
4715
+ /**
4716
+ * Whether the client secret is present (the value itself is kept server-side)
4717
+ * example:
4718
+ * true
4719
+ */
4720
+ has_client_secret?: boolean;
4721
+ /**
4722
+ * Space-separated list of OAuth 2.0 scopes to request from OpenID Connect
4723
+ * example:
4724
+ * openid email
4725
+ */
4726
+ scope: string;
4727
+ metadata?: OIDCProviderMetadata;
4728
+ prompt?: "login" | "select_account" | "consent";
4729
+ }
4578
4730
  /**
4579
4731
  * The opportunity entity
4580
4732
  */
@@ -5140,6 +5292,13 @@ declare namespace Components {
5140
5292
  * Mark true if the domain is an Epilot domain
5141
5293
  */
5142
5294
  is_epilot_domain?: boolean;
5295
+ /**
5296
+ * The URL on which the portal is accessible
5297
+ * example:
5298
+ * example-portal-12345.ecp.epilot.cloud
5299
+ */
5300
+ epilot_domain?: string;
5301
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
5143
5302
  design_id?: /**
5144
5303
  * Entity ID
5145
5304
  * example:
@@ -5156,6 +5315,14 @@ declare namespace Components {
5156
5315
  */
5157
5316
  allowed_portal_entities?: string[];
5158
5317
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
5318
+ /**
5319
+ * Controls behavior of self-registration when account is used as the registration entity
5320
+ */
5321
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
5322
+ /**
5323
+ * Entity type used as the primary identifier for self-registration
5324
+ */
5325
+ self_registration_entity?: "contact" | "account";
5159
5326
  /**
5160
5327
  * Enable or disable user account self management
5161
5328
  * example:
@@ -5536,6 +5703,12 @@ declare namespace Components {
5536
5703
  pages?: {
5537
5704
  [name: string]: Page;
5538
5705
  };
5706
+ /**
5707
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
5708
+ */
5709
+ global_blocks?: {
5710
+ [name: string]: Block;
5711
+ };
5539
5712
  /**
5540
5713
  * ID of the organization
5541
5714
  * example:
@@ -5644,6 +5817,13 @@ declare namespace Components {
5644
5817
  * Mark true if the domain is an Epilot domain
5645
5818
  */
5646
5819
  is_epilot_domain?: boolean;
5820
+ /**
5821
+ * The Epilot domain on which the portal is accessible
5822
+ * example:
5823
+ * example-portal-1.ecp.epilot.io
5824
+ */
5825
+ epilot_domain?: string;
5826
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
5647
5827
  design_id?: /**
5648
5828
  * Entity ID
5649
5829
  * example:
@@ -5660,6 +5840,14 @@ declare namespace Components {
5660
5840
  */
5661
5841
  allowed_portal_entities?: string[];
5662
5842
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
5843
+ /**
5844
+ * Controls behavior of self-registration when account is used as the registration entity
5845
+ */
5846
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
5847
+ /**
5848
+ * Entity type used as the primary identifier for self-registration
5849
+ */
5850
+ self_registration_entity?: "contact" | "account";
5663
5851
  /**
5664
5852
  * Enable or disable user account self management
5665
5853
  * example:
@@ -6037,6 +6225,12 @@ declare namespace Components {
6037
6225
  */
6038
6226
  portal_sk_v3?: string;
6039
6227
  origin?: /* Origin of the portal */ Origin;
6228
+ /**
6229
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
6230
+ */
6231
+ global_blocks?: {
6232
+ [name: string]: Block;
6233
+ };
6040
6234
  /**
6041
6235
  * ID of the organization
6042
6236
  * example:
@@ -6249,6 +6443,20 @@ declare namespace Components {
6249
6443
  */
6250
6444
  campaign_id?: string;
6251
6445
  }
6446
+ /**
6447
+ * SSO identity provider configuration.
6448
+ *
6449
+ * Env var interpolation: only string fields under `oidc_config` and
6450
+ * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
6451
+ * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
6452
+ * get resolved at runtime against the organization's environment.
6453
+ *
6454
+ * The following fields are used as literal values and MUST NOT contain
6455
+ * template syntax: `slug`, `display_name`, `provider_type`, all keys and
6456
+ * values under `attribute_mappings` (used as JSONPath-like accessors into
6457
+ * token claims), and all keys and values under `entity_matching`.
6458
+ *
6459
+ */
6252
6460
  export interface ProviderConfig {
6253
6461
  slug?: /**
6254
6462
  * URL-friendly slug to use as organization-unique identifier for Provider
@@ -6265,8 +6473,18 @@ declare namespace Components {
6265
6473
  provider_type: "OIDC";
6266
6474
  attribute_mappings?: /* Dictionary of epilot user attributes to claims */ AttributeMappingConfig;
6267
6475
  entity_matching?: /* Configuration for matching existing entities during SSO login using token claims */ EntityMatchingConfig;
6268
- oidc_config?: OIDCProviderConfig;
6269
- mobile_oidc_config?: MoblieOIDCConfig;
6476
+ oidc_config?: /**
6477
+ * OIDC provider configuration. All string fields support env var interpolation
6478
+ * (incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
6479
+ *
6480
+ */
6481
+ OIDCProviderConfig;
6482
+ mobile_oidc_config?: /**
6483
+ * Mobile OIDC configuration. All string fields support env var interpolation
6484
+ * (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
6485
+ *
6486
+ */
6487
+ MoblieOIDCConfig;
6270
6488
  }
6271
6489
  /**
6272
6490
  * Human-readable display name for identity provider shown in login
@@ -6287,8 +6505,20 @@ declare namespace Components {
6287
6505
  * Office 365 Login
6288
6506
  */
6289
6507
  ProviderDisplayName;
6290
- oidc_config?: OIDCProviderConfig;
6291
- mobile_oidc_config?: MoblieOIDCConfig;
6508
+ oidc_config?: /**
6509
+ * Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
6510
+ * the `client_secret` field — it is kept server-side and only used to exchange the
6511
+ * authorization code at the SSO callback. String fields are returned with env var
6512
+ * placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
6513
+ *
6514
+ */
6515
+ OIDCProviderPublicConfig;
6516
+ mobile_oidc_config?: /**
6517
+ * Mobile OIDC configuration. All string fields support env var interpolation
6518
+ * (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
6519
+ *
6520
+ */
6521
+ MoblieOIDCConfig;
6292
6522
  }
6293
6523
  /**
6294
6524
  * URL-friendly slug to use as organization-unique identifier for Provider
@@ -6884,6 +7114,13 @@ declare namespace Components {
6884
7114
  * Mark true if the domain is an Epilot domain
6885
7115
  */
6886
7116
  is_epilot_domain?: boolean;
7117
+ /**
7118
+ * The URL on which the portal is accessible
7119
+ * example:
7120
+ * example-portal-12345.ecp.epilot.cloud
7121
+ */
7122
+ epilot_domain?: string;
7123
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
6887
7124
  design_id?: /**
6888
7125
  * Entity ID
6889
7126
  * example:
@@ -6900,6 +7137,14 @@ declare namespace Components {
6900
7137
  */
6901
7138
  allowed_portal_entities?: string[];
6902
7139
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7140
+ /**
7141
+ * Controls behavior of self-registration when account is used as the registration entity
7142
+ */
7143
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
7144
+ /**
7145
+ * Entity type used as the primary identifier for self-registration
7146
+ */
7147
+ self_registration_entity?: "contact" | "account";
6903
7148
  /**
6904
7149
  * Enable or disable user account self management
6905
7150
  * example:
@@ -7280,6 +7525,12 @@ declare namespace Components {
7280
7525
  pages?: {
7281
7526
  [name: string]: Page;
7282
7527
  };
7528
+ /**
7529
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
7530
+ */
7531
+ global_blocks?: {
7532
+ [name: string]: Block;
7533
+ };
7283
7534
  }
7284
7535
  export interface UpsertPortalConfigV3 {
7285
7536
  /**
@@ -7342,6 +7593,13 @@ declare namespace Components {
7342
7593
  * Mark true if the domain is an Epilot domain
7343
7594
  */
7344
7595
  is_epilot_domain?: boolean;
7596
+ /**
7597
+ * The Epilot domain on which the portal is accessible
7598
+ * example:
7599
+ * example-portal-1.ecp.epilot.io
7600
+ */
7601
+ epilot_domain?: string;
7602
+ domain_settings?: /* Domain settings for the portal */ DomainSettings;
7345
7603
  design_id?: /**
7346
7604
  * Entity ID
7347
7605
  * example:
@@ -7358,6 +7616,14 @@ declare namespace Components {
7358
7616
  */
7359
7617
  allowed_portal_entities?: string[];
7360
7618
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
7619
+ /**
7620
+ * Controls behavior of self-registration when account is used as the registration entity
7621
+ */
7622
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
7623
+ /**
7624
+ * Entity type used as the primary identifier for self-registration
7625
+ */
7626
+ self_registration_entity?: "contact" | "account";
7361
7627
  /**
7362
7628
  * Enable or disable user account self management
7363
7629
  * example:
@@ -7735,6 +8001,12 @@ declare namespace Components {
7735
8001
  */
7736
8002
  portal_sk_v3?: string;
7737
8003
  origin?: /* Origin of the portal */ Origin;
8004
+ /**
8005
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
8006
+ */
8007
+ global_blocks?: {
8008
+ [name: string]: Block;
8009
+ };
7738
8010
  pages?: PageRequest[];
7739
8011
  }
7740
8012
  export interface UpsertPortalWidget {
@@ -8027,6 +8299,44 @@ declare namespace Paths {
8027
8299
  }
8028
8300
  }
8029
8301
  }
8302
+ namespace CheckAccountExists {
8303
+ namespace Parameters {
8304
+ export type Domain = string;
8305
+ export type PortalId = /**
8306
+ * ID of the portal
8307
+ * example:
8308
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
8309
+ */
8310
+ Components.Schemas.PortalId;
8311
+ }
8312
+ export interface QueryParameters {
8313
+ portal_id?: Parameters.PortalId;
8314
+ domain?: Parameters.Domain;
8315
+ }
8316
+ export type RequestBody = Components.Schemas.AccountExistsRequest;
8317
+ namespace Responses {
8318
+ export interface $200 {
8319
+ /**
8320
+ * Whether the account exists with the given identifier values
8321
+ * example:
8322
+ * true
8323
+ */
8324
+ exists?: boolean;
8325
+ /**
8326
+ * ID of the account if exists
8327
+ */
8328
+ accountId?: /**
8329
+ * Entity ID
8330
+ * example:
8331
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
8332
+ */
8333
+ Components.Schemas.EntityId /* uuid */;
8334
+ }
8335
+ export type $400 = Components.Responses.InvalidRequest;
8336
+ export type $404 = Components.Responses.NotFound;
8337
+ export type $500 = Components.Responses.InternalServerError;
8338
+ }
8339
+ }
8030
8340
  namespace CheckContactExists {
8031
8341
  namespace Parameters {
8032
8342
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
@@ -8090,6 +8400,15 @@ declare namespace Paths {
8090
8400
  * 5da0a718-c822-403d-9f5d-20d4584e0528
8091
8401
  */
8092
8402
  Components.Schemas.EntityId /* uuid */;
8403
+ /**
8404
+ * ID of the resolved account when the portal is configured for account-based registration
8405
+ */
8406
+ accountId?: /**
8407
+ * Entity ID
8408
+ * example:
8409
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
8410
+ */
8411
+ Components.Schemas.EntityId /* uuid */;
8093
8412
  }
8094
8413
  export type $400 = Components.Responses.InvalidRequest;
8095
8414
  export type $404 = Components.Responses.NotFound;
@@ -10127,6 +10446,13 @@ declare namespace Paths {
10127
10446
  * Mark true if the domain is an Epilot domain
10128
10447
  */
10129
10448
  is_epilot_domain?: boolean;
10449
+ /**
10450
+ * The URL on which the portal is accessible
10451
+ * example:
10452
+ * example-portal-12345.ecp.epilot.cloud
10453
+ */
10454
+ epilot_domain?: string;
10455
+ domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
10130
10456
  design_id?: /**
10131
10457
  * Entity ID
10132
10458
  * example:
@@ -10143,6 +10469,14 @@ declare namespace Paths {
10143
10469
  */
10144
10470
  allowed_portal_entities?: string[];
10145
10471
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
10472
+ /**
10473
+ * Controls behavior of self-registration when account is used as the registration entity
10474
+ */
10475
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
10476
+ /**
10477
+ * Entity type used as the primary identifier for self-registration
10478
+ */
10479
+ self_registration_entity?: "contact" | "account";
10146
10480
  /**
10147
10481
  * Enable or disable user account self management
10148
10482
  * example:
@@ -10523,6 +10857,12 @@ declare namespace Paths {
10523
10857
  pages?: {
10524
10858
  [name: string]: Components.Schemas.Page;
10525
10859
  };
10860
+ /**
10861
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
10862
+ */
10863
+ global_blocks?: {
10864
+ [name: string]: Components.Schemas.Block;
10865
+ };
10526
10866
  /**
10527
10867
  * ID of the organization
10528
10868
  * example:
@@ -10621,6 +10961,13 @@ declare namespace Paths {
10621
10961
  * Mark true if the domain is an Epilot domain
10622
10962
  */
10623
10963
  is_epilot_domain?: boolean;
10964
+ /**
10965
+ * The URL on which the portal is accessible
10966
+ * example:
10967
+ * example-portal-12345.ecp.epilot.cloud
10968
+ */
10969
+ epilot_domain?: string;
10970
+ domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
10624
10971
  design_id?: /**
10625
10972
  * Entity ID
10626
10973
  * example:
@@ -10637,6 +10984,14 @@ declare namespace Paths {
10637
10984
  */
10638
10985
  allowed_portal_entities?: string[];
10639
10986
  self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
10987
+ /**
10988
+ * Controls behavior of self-registration when account is used as the registration entity
10989
+ */
10990
+ self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
10991
+ /**
10992
+ * Entity type used as the primary identifier for self-registration
10993
+ */
10994
+ self_registration_entity?: "contact" | "account";
10640
10995
  /**
10641
10996
  * Enable or disable user account self management
10642
10997
  * example:
@@ -11017,6 +11372,12 @@ declare namespace Paths {
11017
11372
  pages?: {
11018
11373
  [name: string]: Components.Schemas.Page;
11019
11374
  };
11375
+ /**
11376
+ * Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
11377
+ */
11378
+ global_blocks?: {
11379
+ [name: string]: Components.Schemas.Block;
11380
+ };
11020
11381
  /**
11021
11382
  * ID of the organization
11022
11383
  * example:
@@ -11925,6 +12286,48 @@ declare namespace Paths {
11925
12286
  export type $500 = Components.Responses.InternalServerError;
11926
12287
  }
11927
12288
  }
12289
+ namespace GetSSOProvider {
12290
+ namespace Parameters {
12291
+ export type Domain = string;
12292
+ /**
12293
+ * example:
12294
+ * 123
12295
+ */
12296
+ export type OrgId = string;
12297
+ export type Origin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
12298
+ export type PortalId = /**
12299
+ * ID of the portal
12300
+ * example:
12301
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
12302
+ */
12303
+ Components.Schemas.PortalId;
12304
+ export type ProviderSlug = /**
12305
+ * URL-friendly slug to use as organization-unique identifier for Provider
12306
+ * example:
12307
+ * office-365-login
12308
+ */
12309
+ Components.Schemas.ProviderSlug /* [0-9a-z-]+ */;
12310
+ }
12311
+ export interface PathParameters {
12312
+ provider_slug: Parameters.ProviderSlug;
12313
+ }
12314
+ export interface QueryParameters {
12315
+ org_id?: /**
12316
+ * example:
12317
+ * 123
12318
+ */
12319
+ Parameters.OrgId;
12320
+ origin?: Parameters.Origin;
12321
+ portal_id?: Parameters.PortalId;
12322
+ domain?: Parameters.Domain;
12323
+ }
12324
+ namespace Responses {
12325
+ export type $200 = Components.Schemas.ProviderPublicConfig;
12326
+ export type $400 = Components.Responses.InvalidRequest;
12327
+ export type $404 = Components.Responses.NotFound;
12328
+ export type $500 = Components.Responses.InternalServerError;
12329
+ }
12330
+ }
11928
12331
  namespace GetSchemas {
11929
12332
  namespace Responses {
11930
12333
  export interface $200 {
@@ -12339,6 +12742,42 @@ declare namespace Paths {
12339
12742
  export type $500 = Components.Responses.InternalServerError;
12340
12743
  }
12341
12744
  }
12745
+ namespace PortalProxyExecute {
12746
+ export interface RequestBody {
12747
+ /**
12748
+ * Integration ID containing the managed-call use case
12749
+ */
12750
+ integration_id: string; // uuid
12751
+ /**
12752
+ * Use case slug (acts as the RPC method name)
12753
+ */
12754
+ use_case_slug: string;
12755
+ /**
12756
+ * Input data for the managed-call operation
12757
+ */
12758
+ payload?: {
12759
+ [name: string]: any;
12760
+ };
12761
+ }
12762
+ namespace Responses {
12763
+ export interface $200 {
12764
+ success: boolean;
12765
+ /**
12766
+ * Managed-call response payload. Shape is defined by the use
12767
+ * case's JSONata response_mapping; if no mapping is
12768
+ * configured the raw external API response is returned.
12769
+ *
12770
+ */
12771
+ data?: {
12772
+ [name: string]: any;
12773
+ };
12774
+ }
12775
+ export type $400 = Components.Responses.InvalidRequest;
12776
+ export type $401 = Components.Responses.Unauthorized;
12777
+ export type $403 = Components.Responses.Forbidden;
12778
+ export type $500 = Components.Responses.InternalServerError;
12779
+ }
12780
+ }
12342
12781
  namespace PostOrderAcceptance {
12343
12782
  namespace Parameters {
12344
12783
  export type Id = /**
@@ -13697,6 +14136,34 @@ declare namespace Paths {
13697
14136
  export type $500 = Components.Responses.InternalServerError;
13698
14137
  }
13699
14138
  }
14139
+ namespace VerifyDns {
14140
+ namespace Parameters {
14141
+ export type PortalId = /**
14142
+ * ID of the portal
14143
+ * example:
14144
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
14145
+ */
14146
+ Components.Schemas.PortalId;
14147
+ }
14148
+ export interface QueryParameters {
14149
+ portal_id: Parameters.PortalId;
14150
+ }
14151
+ namespace Responses {
14152
+ export interface $200 {
14153
+ /**
14154
+ * The status of the custom domain verification
14155
+ */
14156
+ domain_status?: "PENDING" | "SUCCEED";
14157
+ /**
14158
+ * A message describing the result
14159
+ */
14160
+ message?: string;
14161
+ }
14162
+ export type $401 = Components.Responses.Unauthorized;
14163
+ export type $403 = Components.Responses.Forbidden;
14164
+ export type $500 = Components.Responses.InternalServerError;
14165
+ }
14166
+ }
13700
14167
  }
13701
14168
 
13702
14169
 
@@ -14243,6 +14710,20 @@ interface OperationMethods {
14243
14710
  data?: Paths.CheckContactExistsV3.RequestBody,
14244
14711
  config?: AxiosRequestConfig
14245
14712
  ): OperationResponse<Paths.CheckContactExistsV3.Responses.$200>
14713
+ /**
14714
+ * checkAccountExists - checkAccountExists
14715
+ *
14716
+ * True if account with given identifiers exists.
14717
+ * Supports two identification methods:
14718
+ * 1. Using portal_id
14719
+ * 2. Using domain
14720
+ *
14721
+ */
14722
+ 'checkAccountExists'(
14723
+ parameters?: Parameters<Paths.CheckAccountExists.QueryParameters> | null,
14724
+ data?: Paths.CheckAccountExists.RequestBody,
14725
+ config?: AxiosRequestConfig
14726
+ ): OperationResponse<Paths.CheckAccountExists.Responses.$200>
14246
14727
  /**
14247
14728
  * getValidSecondaryAttributes - getValidSecondaryAttributes
14248
14729
  *
@@ -14835,6 +15316,28 @@ interface OperationMethods {
14835
15316
  data?: Paths.GetMeterReadings.RequestBody,
14836
15317
  config?: AxiosRequestConfig
14837
15318
  ): OperationResponse<Paths.GetMeterReadings.Responses.$200>
15319
+ /**
15320
+ * getSSOProvider - getSSOProvider
15321
+ *
15322
+ * Returns the public configuration of a single SSO identity provider with env var
15323
+ * placeholders (incl. secrets) already resolved against the organization's environment.
15324
+ *
15325
+ * Use this endpoint at SSO initiation time (i.e. when the end user clicks "Sign in with X")
15326
+ * to obtain the resolved OIDC settings needed to construct the authorization URL.
15327
+ * The web `client_secret` is intentionally never returned — it is used server-side by
15328
+ * the SSO callback to exchange the authorization code for tokens.
15329
+ *
15330
+ * Supports three identification methods:
15331
+ * 1. `org_id` + `origin`
15332
+ * 2. `org_id` + `portal_id`
15333
+ * 3. `domain`
15334
+ *
15335
+ */
15336
+ 'getSSOProvider'(
15337
+ parameters?: Parameters<Paths.GetSSOProvider.QueryParameters & Paths.GetSSOProvider.PathParameters> | null,
15338
+ data?: any,
15339
+ config?: AxiosRequestConfig
15340
+ ): OperationResponse<Paths.GetSSOProvider.Responses.$200>
14838
15341
  /**
14839
15342
  * ssoLogin - ssoLogin
14840
15343
  *
@@ -15203,6 +15706,28 @@ interface OperationMethods {
15203
15706
  data?: any,
15204
15707
  config?: AxiosRequestConfig
15205
15708
  ): OperationResponse<Paths.EnablePartner.Responses.$200>
15709
+ /**
15710
+ * verifyDns - verifyDns
15711
+ *
15712
+ * Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
15713
+ */
15714
+ 'verifyDns'(
15715
+ parameters?: Parameters<Paths.VerifyDns.QueryParameters> | null,
15716
+ data?: any,
15717
+ config?: AxiosRequestConfig
15718
+ ): OperationResponse<Paths.VerifyDns.Responses.$200>
15719
+ /**
15720
+ * portalProxyExecute - portalProxyExecute
15721
+ *
15722
+ * Execute an Integration Hub managed-call use case on behalf of a portal user.
15723
+ * Bridges PortalAuth to the Integration API by generating an internal token.
15724
+ *
15725
+ */
15726
+ 'portalProxyExecute'(
15727
+ parameters?: Parameters<UnknownParamsObject> | null,
15728
+ data?: Paths.PortalProxyExecute.RequestBody,
15729
+ config?: AxiosRequestConfig
15730
+ ): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
15206
15731
  }
15207
15732
 
15208
15733
  interface PathsDictionary {
@@ -15840,6 +16365,22 @@ interface PathsDictionary {
15840
16365
  config?: AxiosRequestConfig
15841
16366
  ): OperationResponse<Paths.CheckContactExistsV3.Responses.$200>
15842
16367
  }
16368
+ ['/v3/portal/public/account/exists']: {
16369
+ /**
16370
+ * checkAccountExists - checkAccountExists
16371
+ *
16372
+ * True if account with given identifiers exists.
16373
+ * Supports two identification methods:
16374
+ * 1. Using portal_id
16375
+ * 2. Using domain
16376
+ *
16377
+ */
16378
+ 'post'(
16379
+ parameters?: Parameters<Paths.CheckAccountExists.QueryParameters> | null,
16380
+ data?: Paths.CheckAccountExists.RequestBody,
16381
+ config?: AxiosRequestConfig
16382
+ ): OperationResponse<Paths.CheckAccountExists.Responses.$200>
16383
+ }
15843
16384
  ['/v2/portal/contact/valid/secondary/attributes']: {
15844
16385
  /**
15845
16386
  * getValidSecondaryAttributes - getValidSecondaryAttributes
@@ -16534,6 +17075,30 @@ interface PathsDictionary {
16534
17075
  config?: AxiosRequestConfig
16535
17076
  ): OperationResponse<Paths.GetMeterReadings.Responses.$200>
16536
17077
  }
17078
+ ['/v2/portal/public/sso/providers/{provider_slug}']: {
17079
+ /**
17080
+ * getSSOProvider - getSSOProvider
17081
+ *
17082
+ * Returns the public configuration of a single SSO identity provider with env var
17083
+ * placeholders (incl. secrets) already resolved against the organization's environment.
17084
+ *
17085
+ * Use this endpoint at SSO initiation time (i.e. when the end user clicks "Sign in with X")
17086
+ * to obtain the resolved OIDC settings needed to construct the authorization URL.
17087
+ * The web `client_secret` is intentionally never returned — it is used server-side by
17088
+ * the SSO callback to exchange the authorization code for tokens.
17089
+ *
17090
+ * Supports three identification methods:
17091
+ * 1. `org_id` + `origin`
17092
+ * 2. `org_id` + `portal_id`
17093
+ * 3. `domain`
17094
+ *
17095
+ */
17096
+ 'get'(
17097
+ parameters?: Parameters<Paths.GetSSOProvider.QueryParameters & Paths.GetSSOProvider.PathParameters> | null,
17098
+ data?: any,
17099
+ config?: AxiosRequestConfig
17100
+ ): OperationResponse<Paths.GetSSOProvider.Responses.$200>
17101
+ }
16537
17102
  ['/v2/portal/public/sso/login']: {
16538
17103
  /**
16539
17104
  * ssoLogin - ssoLogin
@@ -16956,12 +17521,39 @@ interface PathsDictionary {
16956
17521
  config?: AxiosRequestConfig
16957
17522
  ): OperationResponse<Paths.EnablePartner.Responses.$200>
16958
17523
  }
17524
+ ['/v3/portal/verify-dns']: {
17525
+ /**
17526
+ * verifyDns - verifyDns
17527
+ *
17528
+ * Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
17529
+ */
17530
+ 'post'(
17531
+ parameters?: Parameters<Paths.VerifyDns.QueryParameters> | null,
17532
+ data?: any,
17533
+ config?: AxiosRequestConfig
17534
+ ): OperationResponse<Paths.VerifyDns.Responses.$200>
17535
+ }
17536
+ ['/v2/portal/proxy/execute']: {
17537
+ /**
17538
+ * portalProxyExecute - portalProxyExecute
17539
+ *
17540
+ * Execute an Integration Hub managed-call use case on behalf of a portal user.
17541
+ * Bridges PortalAuth to the Integration API by generating an internal token.
17542
+ *
17543
+ */
17544
+ 'post'(
17545
+ parameters?: Parameters<UnknownParamsObject> | null,
17546
+ data?: Paths.PortalProxyExecute.RequestBody,
17547
+ config?: AxiosRequestConfig
17548
+ ): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
17549
+ }
16959
17550
  }
16960
17551
 
16961
17552
  type Client = OpenAPIClient<OperationMethods, PathsDictionary>
16962
17553
 
16963
17554
 
16964
17555
  type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
17556
+ type AccountExistsRequest = Components.Schemas.AccountExistsRequest;
16965
17557
  type ActionLabel = Components.Schemas.ActionLabel;
16966
17558
  type ActionWidget = Components.Schemas.ActionWidget;
16967
17559
  type Activity = Components.Schemas.Activity;
@@ -17000,6 +17592,7 @@ type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
17000
17592
  type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
17001
17593
  type Direction = Components.Schemas.Direction;
17002
17594
  type DocumentWidget = Components.Schemas.DocumentWidget;
17595
+ type DomainSettings = Components.Schemas.DomainSettings;
17003
17596
  type EmailTemplates = Components.Schemas.EmailTemplates;
17004
17597
  type Entity = Components.Schemas.Entity;
17005
17598
  type EntityEditRule = Components.Schemas.EntityEditRule;
@@ -17051,6 +17644,7 @@ type MeterReadingWidget = Components.Schemas.MeterReadingWidget;
17051
17644
  type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
17052
17645
  type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
17053
17646
  type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
17647
+ type OIDCProviderPublicConfig = Components.Schemas.OIDCProviderPublicConfig;
17054
17648
  type Opportunity = Components.Schemas.Opportunity;
17055
17649
  type Order = Components.Schemas.Order;
17056
17650
  type OrganizationSettings = Components.Schemas.OrganizationSettings;
@@ -17110,4 +17704,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
17110
17704
  type WorkflowExecution = Components.Schemas.WorkflowExecution;
17111
17705
  type WorkflowStep = Components.Schemas.WorkflowStep;
17112
17706
 
17113
- export { type EntityResponseGroupedWithHits as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type ContactCountRequest as D, type ContactExistsRequest as E, type ContentWidget as F, type ContextEntities as G, type ContextEntity as H, type Contract as I, type ContractIdentifier as J, type CreateUserRequest as K, type Currency as L, type DataRetrievalItem as M, DeleteEntityFile as N, type OperationMethods as O, Paths as P, type Direction as Q, type DocumentWidget as R, type EmailTemplates as S, type Entity as T, type EntityEditRule as U, type EntityFileCount as V, type EntityGetParams as W, type EntityId as X, type EntityItem as Y, type EntityMatchingConfig as Z, type EntityResponse as _, Components as a, type PublicExtensionCapabilities as a$, type EntityResponseWithHits as a0, type EntitySearchParams as a1, type EntitySlug as a2, type EntitySlugConfig as a3, type EntityTemplates as a4, type EntityWidget as a5, type ErrorResp as a6, type Exists as a7, type Extension as a8, type ExtensionAuthBlock as a9, type MeterReadingPhotoData as aA, type MeterReadingWidget as aB, type MoblieOIDCConfig as aC, type OIDCProviderConfig as aD, type OIDCProviderMetadata as aE, type Opportunity as aF, type Order as aG, type OrganizationSettings as aH, type Origin as aI, type Page as aJ, type PageRequest as aK, type PaymentWidget as aL, type PortalConfig as aM, type PortalConfigV3 as aN, type PortalId as aO, type PortalUser as aP, type PortalUserRegistrationStatus as aQ, type PortalWidget as aR, type Product as aS, type ProductRecommendationsWidget as aT, type ProviderConfig as aU, type ProviderDisplayName as aV, type ProviderPublicConfig as aW, type ProviderSlug as aX, type PublicAppDetails as aY, type PublicContractIdentificationDetails as aZ, type PublicDataRetrievalHookDetails as a_, type ExtensionConfig as aa, type ExtensionHook as ab, type ExtensionHookConsumptionDataRetrieval as ac, type ExtensionHookContractIdentification as ad, type ExtensionHookCostDataRetrieval as ae, type ExtensionHookDataExport as af, type ExtensionHookMeterReadingPlausibilityCheck as ag, type ExtensionHookPriceDataRetrieval as ah, type ExtensionHookRegistrationIdentifiersCheck as ai, type ExtensionHookSelection as aj, type ExtensionHookVisualizationMetadata as ak, type ExtensionSeamlessLink as al, type ExternalLink as am, type ExtraSchemaAttributes as an, type FailedRuleErrorResp as ao, type File as ap, type FileItem as aq, type Grant as ar, type IdentifierAttribute as as, type InstallmentEvent as at, type JourneyActions as au, type JuiceSettings as av, type Meter as aw, type MeterChartWidget as ax, type MeterReading as ay, type MeterReadingPhoto as az, type PathsDictionary as b, type PublicExtensionDetails as b0, type PublicMeterReadingPlausibilityCheckDetails as b1, type ReadBy as b2, type ReadingStatus as b3, type Reason as b4, type RegistrationIdentifier as b5, type ReimbursementEvent as b6, type Rule as b7, type SAMLProviderConfig as b8, type SSOCallbackRequest as b9, type SSOCallbackResponse as ba, type SSOLoginToken as bb, SaveEntityFile as bc, type SavePortalFile as bd, type Schema as be, type SearchIncludes as bf, type SecureProxyConfig as bg, type Source as bh, type SwappableConfig as bi, type TariffType as bj, type TeaserWidget as bk, type TriggerPortalFlow as bl, type UpdateOnlyPortalConfigAttributes as bm, type UpsertPortalConfig as bn, type UpsertPortalConfigV3 as bo, UpsertPortalWidget as bp, type UserRequest as bq, type VisualizationDataRange as br, type VisualizationMetadata as bs, type VisualizationTypeOption as bt, type WidgetAction as bu, type WidgetBase as bv, type WorfklowIdentifier as bw, type WorkflowExecution as bx, type WorkflowStep as by, type ActionLabel as c, type ActionWidget as d, type Activity as e, type ActivityCallerContext as f, type ActivityId as g, type ActivityItem as h, type AdminUser as i, type AllowedFileExtensions as j, type AttributeMappingConfig as k, type AuthConfig as l, type BaseBillingEvent as m, type BaseEntity as n, type BillingAccount as o, type BillingEvent as p, type Block as q, type BlockId as r, type BlockProps as s, type BlockRequest as t, type BlockType as u, type BusinessPartnerItem as v, type CampaignWidget as w, type CommonConfigAttributes as x, type CommonConfigAttributesV3 as y, type Contact as z };
17707
+ 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 PublicAppDetails 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 OIDCProviderPublicConfig 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 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 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 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 };