@epilot/sdk 2.7.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.
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +492 -7
- package/definitions/email-settings-runtime.json +1 -1
- package/definitions/email-settings.json +86 -4
- package/definitions/file-runtime.json +1 -1
- package/definitions/file.json +262 -4
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +2 -2
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +8 -8
- package/dist/apis/file.d.cts +2 -2
- package/dist/apis/file.d.ts +2 -2
- package/dist/apis/file.js +2 -2
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/chunk-3APTSPY4.js +14 -0
- package/dist/chunk-KCPVNRDL.js +14 -0
- package/dist/chunk-KJPOUJBU.cjs +14 -0
- package/dist/chunk-OPXGJKZR.cjs +14 -0
- package/dist/chunk-PTEJYAYJ.js +14 -0
- package/dist/{chunk-35CN2YFK.cjs → chunk-R7XDTILZ.cjs} +6 -6
- package/dist/{chunk-JB7LITSP.js → chunk-SCMAZ73K.js} +6 -6
- package/dist/chunk-YI5YGTAH.cjs +14 -0
- package/dist/customer-portal-7HYSBH7H.cjs +7 -0
- package/dist/customer-portal-X4LJX6AU.js +7 -0
- package/dist/{customer-portal-runtime-OEXTSMSE.cjs → customer-portal-runtime-IYHJ3RME.cjs} +2 -2
- package/dist/{customer-portal-runtime-N4NWQ67M.js → customer-portal-runtime-ZYU3WIXY.js} +1 -1
- package/dist/{customer-portal.d-ChSEioI5.d.cts → customer-portal.d-C7ZCbjiY.d.cts} +605 -11
- package/dist/{customer-portal.d-ChSEioI5.d.ts → customer-portal.d-C7ZCbjiY.d.ts} +605 -11
- package/dist/email-settings-YJ4X5VFU.cjs +7 -0
- package/dist/email-settings-YUK3DXFJ.js +7 -0
- package/dist/{email-settings-runtime-EGIJ2AVQ.js → email-settings-runtime-BXRZV4M5.js} +1 -1
- package/dist/{email-settings-runtime-WGVLI7N6.cjs → email-settings-runtime-FWJQBQBK.cjs} +2 -2
- package/dist/{email-settings.d-B7Q_xT25.d.cts → email-settings.d-UJ0C3jPI.d.cts} +108 -9
- package/dist/{email-settings.d-B7Q_xT25.d.ts → email-settings.d-UJ0C3jPI.d.ts} +108 -9
- package/dist/file-P2FUUER2.js +7 -0
- package/dist/file-XTY74SIX.cjs +7 -0
- package/dist/file-runtime-24S3QPA7.cjs +5 -0
- package/dist/{file-runtime-B6AAGZQF.js → file-runtime-BIRMXYRH.js} +1 -1
- package/dist/{file.d-DcTJxjp7.d.cts → file.d-DTlrbI40.d.cts} +2336 -19
- package/dist/{file.d-DcTJxjp7.d.ts → file.d-DTlrbI40.d.ts} +2336 -19
- package/dist/index.cjs +14 -14
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +4 -4
- package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
- package/docs/customer-portal.md +417 -51
- package/docs/email-settings.md +67 -3
- package/docs/file.md +101 -2
- package/package.json +1 -1
- package/dist/chunk-4W22EIRF.cjs +0 -14
- package/dist/chunk-5OBMZHRL.cjs +0 -14
- package/dist/chunk-E2WMGOM5.js +0 -14
- package/dist/chunk-EFWPEVXI.js +0 -14
- package/dist/chunk-KEI3GHDY.cjs +0 -14
- package/dist/chunk-Z6HGUGXK.js +0 -14
- package/dist/customer-portal-5I7ZGQDU.cjs +0 -7
- package/dist/customer-portal-YL2YMPZL.js +0 -7
- package/dist/email-settings-CKFJU4WZ.js +0 -7
- package/dist/email-settings-NQJJKS2P.cjs +0 -7
- package/dist/file-UOWBTDIU.cjs +0 -7
- package/dist/file-XSN3NAVZ.js +0 -7
- package/dist/file-runtime-SFZIKODF.cjs +0 -5
package/docs/customer-portal.md
CHANGED
|
@@ -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)
|
|
@@ -288,6 +294,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
|
|
|
288
294
|
- [`AttributeMappingConfig`](#attributemappingconfig)
|
|
289
295
|
- [`EntityMatchingConfig`](#entitymatchingconfig)
|
|
290
296
|
- [`OIDCProviderConfig`](#oidcproviderconfig)
|
|
297
|
+
- [`OIDCProviderPublicConfig`](#oidcproviderpublicconfig)
|
|
291
298
|
- [`MoblieOIDCConfig`](#moblieoidcconfig)
|
|
292
299
|
- [`OIDCProviderMetadata`](#oidcprovidermetadata)
|
|
293
300
|
- [`SAMLProviderConfig`](#samlproviderconfig)
|
|
@@ -346,9 +353,17 @@ const { data } = await client.upsertPortal(
|
|
|
346
353
|
name: 'Installer Portal',
|
|
347
354
|
domain: 'abc.com',
|
|
348
355
|
is_epilot_domain: true,
|
|
356
|
+
epilot_domain: 'example-portal-12345.ecp.epilot.cloud',
|
|
357
|
+
domain_settings: {
|
|
358
|
+
is_custom_domain_enabled: true,
|
|
359
|
+
is_epilot_domain_enabled: true,
|
|
360
|
+
is_redirection_enabled: true
|
|
361
|
+
},
|
|
349
362
|
design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
350
363
|
allowed_portal_entities: ['contact', 'contract'],
|
|
351
364
|
self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
365
|
+
self_registration_account_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
366
|
+
self_registration_entity: 'contact',
|
|
352
367
|
user_account_self_management: false,
|
|
353
368
|
feature_settings: {
|
|
354
369
|
start_page: true,
|
|
@@ -490,7 +505,8 @@ const { data } = await client.upsertPortal(
|
|
|
490
505
|
portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
491
506
|
portal_sk_v3: 'PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
492
507
|
origin: 'string',
|
|
493
|
-
pages: {}
|
|
508
|
+
pages: {},
|
|
509
|
+
global_blocks: {}
|
|
494
510
|
},
|
|
495
511
|
)
|
|
496
512
|
```
|
|
@@ -504,9 +520,17 @@ const { data } = await client.upsertPortal(
|
|
|
504
520
|
"name": "Installer Portal",
|
|
505
521
|
"domain": "abc.com",
|
|
506
522
|
"is_epilot_domain": true,
|
|
523
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
524
|
+
"domain_settings": {
|
|
525
|
+
"is_custom_domain_enabled": true,
|
|
526
|
+
"is_epilot_domain_enabled": true,
|
|
527
|
+
"is_redirection_enabled": true
|
|
528
|
+
},
|
|
507
529
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
508
530
|
"allowed_portal_entities": ["contact", "contract"],
|
|
509
531
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
532
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
533
|
+
"self_registration_entity": "contact",
|
|
510
534
|
"user_account_self_management": false,
|
|
511
535
|
"feature_settings": {
|
|
512
536
|
"start_page": true,
|
|
@@ -648,6 +672,7 @@ const { data } = await client.upsertPortal(
|
|
|
648
672
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
649
673
|
"origin": "string",
|
|
650
674
|
"pages": {},
|
|
675
|
+
"global_blocks": {},
|
|
651
676
|
"id": 12345,
|
|
652
677
|
"organization_id": 12345,
|
|
653
678
|
"org_settings": {
|
|
@@ -791,9 +816,17 @@ const { data } = await client.getPortalConfigByDomain({
|
|
|
791
816
|
"name": "Installer Portal",
|
|
792
817
|
"domain": "abc.com",
|
|
793
818
|
"is_epilot_domain": true,
|
|
819
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
820
|
+
"domain_settings": {
|
|
821
|
+
"is_custom_domain_enabled": true,
|
|
822
|
+
"is_epilot_domain_enabled": true,
|
|
823
|
+
"is_redirection_enabled": true
|
|
824
|
+
},
|
|
794
825
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
795
826
|
"allowed_portal_entities": ["contact", "contract"],
|
|
796
827
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
828
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
829
|
+
"self_registration_entity": "contact",
|
|
797
830
|
"user_account_self_management": false,
|
|
798
831
|
"feature_settings": {
|
|
799
832
|
"start_page": true,
|
|
@@ -935,6 +968,7 @@ const { data } = await client.getPortalConfigByDomain({
|
|
|
935
968
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
936
969
|
"origin": "string",
|
|
937
970
|
"pages": {},
|
|
971
|
+
"global_blocks": {},
|
|
938
972
|
"id": 12345,
|
|
939
973
|
"organization_id": 12345,
|
|
940
974
|
"org_settings": {
|
|
@@ -989,9 +1023,17 @@ const { data } = await client.getPortalConfig({
|
|
|
989
1023
|
"name": "Installer Portal",
|
|
990
1024
|
"domain": "abc.com",
|
|
991
1025
|
"is_epilot_domain": true,
|
|
1026
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
1027
|
+
"domain_settings": {
|
|
1028
|
+
"is_custom_domain_enabled": true,
|
|
1029
|
+
"is_epilot_domain_enabled": true,
|
|
1030
|
+
"is_redirection_enabled": true
|
|
1031
|
+
},
|
|
992
1032
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
993
1033
|
"allowed_portal_entities": ["contact", "contract"],
|
|
994
1034
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
1035
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
1036
|
+
"self_registration_entity": "contact",
|
|
995
1037
|
"user_account_self_management": false,
|
|
996
1038
|
"feature_settings": {
|
|
997
1039
|
"start_page": true,
|
|
@@ -1133,6 +1175,7 @@ const { data } = await client.getPortalConfig({
|
|
|
1133
1175
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
1134
1176
|
"origin": "string",
|
|
1135
1177
|
"pages": {},
|
|
1178
|
+
"global_blocks": {},
|
|
1136
1179
|
"id": 12345,
|
|
1137
1180
|
"organization_id": 12345,
|
|
1138
1181
|
"org_settings": {
|
|
@@ -1892,9 +1935,17 @@ const { data } = await client.getPublicPortalConfig({
|
|
|
1892
1935
|
"name": "Installer Portal",
|
|
1893
1936
|
"domain": "abc.com",
|
|
1894
1937
|
"is_epilot_domain": true,
|
|
1938
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
1939
|
+
"domain_settings": {
|
|
1940
|
+
"is_custom_domain_enabled": true,
|
|
1941
|
+
"is_epilot_domain_enabled": true,
|
|
1942
|
+
"is_redirection_enabled": true
|
|
1943
|
+
},
|
|
1895
1944
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
1896
1945
|
"allowed_portal_entities": ["contact", "contract"],
|
|
1897
1946
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
1947
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
1948
|
+
"self_registration_entity": "contact",
|
|
1898
1949
|
"user_account_self_management": false,
|
|
1899
1950
|
"feature_settings": {
|
|
1900
1951
|
"start_page": true,
|
|
@@ -2036,6 +2087,7 @@ const { data } = await client.getPublicPortalConfig({
|
|
|
2036
2087
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
2037
2088
|
"origin": "string",
|
|
2038
2089
|
"pages": {},
|
|
2090
|
+
"global_blocks": {},
|
|
2039
2091
|
"id": 12345,
|
|
2040
2092
|
"organization_id": 12345,
|
|
2041
2093
|
"org_settings": {
|
|
@@ -2090,9 +2142,17 @@ const { data } = await client.getOrgPortalConfig({
|
|
|
2090
2142
|
"name": "Installer Portal",
|
|
2091
2143
|
"domain": "abc.com",
|
|
2092
2144
|
"is_epilot_domain": true,
|
|
2145
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
2146
|
+
"domain_settings": {
|
|
2147
|
+
"is_custom_domain_enabled": true,
|
|
2148
|
+
"is_epilot_domain_enabled": true,
|
|
2149
|
+
"is_redirection_enabled": true
|
|
2150
|
+
},
|
|
2093
2151
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2094
2152
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2095
2153
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2154
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2155
|
+
"self_registration_entity": "contact",
|
|
2096
2156
|
"user_account_self_management": false,
|
|
2097
2157
|
"feature_settings": {
|
|
2098
2158
|
"start_page": true,
|
|
@@ -2234,6 +2294,7 @@ const { data } = await client.getOrgPortalConfig({
|
|
|
2234
2294
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
2235
2295
|
"origin": "string",
|
|
2236
2296
|
"pages": {},
|
|
2297
|
+
"global_blocks": {},
|
|
2237
2298
|
"id": 12345,
|
|
2238
2299
|
"organization_id": 12345,
|
|
2239
2300
|
"org_settings": {
|
|
@@ -2293,9 +2354,17 @@ const { data } = await client.getPublicPortalConfigV3({
|
|
|
2293
2354
|
"name": "Installer Portal",
|
|
2294
2355
|
"domain": "abc.com",
|
|
2295
2356
|
"is_epilot_domain": true,
|
|
2357
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
2358
|
+
"domain_settings": {
|
|
2359
|
+
"is_custom_domain_enabled": true,
|
|
2360
|
+
"is_epilot_domain_enabled": true,
|
|
2361
|
+
"is_redirection_enabled": true
|
|
2362
|
+
},
|
|
2296
2363
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2297
2364
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2298
2365
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2366
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2367
|
+
"self_registration_entity": "contact",
|
|
2299
2368
|
"user_account_self_management": false,
|
|
2300
2369
|
"feature_settings": {
|
|
2301
2370
|
"start_page": true,
|
|
@@ -2437,6 +2506,7 @@ const { data } = await client.getPublicPortalConfigV3({
|
|
|
2437
2506
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
2438
2507
|
"origin": "string",
|
|
2439
2508
|
"pages": {},
|
|
2509
|
+
"global_blocks": {},
|
|
2440
2510
|
"id": 12345,
|
|
2441
2511
|
"organization_id": 12345,
|
|
2442
2512
|
"org_settings": {
|
|
@@ -2491,9 +2561,17 @@ const { data } = await client.getOrgPortalConfigV3({
|
|
|
2491
2561
|
"name": "Installer Portal",
|
|
2492
2562
|
"domain": "abc.com",
|
|
2493
2563
|
"is_epilot_domain": true,
|
|
2564
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
2565
|
+
"domain_settings": {
|
|
2566
|
+
"is_custom_domain_enabled": true,
|
|
2567
|
+
"is_epilot_domain_enabled": true,
|
|
2568
|
+
"is_redirection_enabled": true
|
|
2569
|
+
},
|
|
2494
2570
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2495
2571
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2496
2572
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2573
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2574
|
+
"self_registration_entity": "contact",
|
|
2497
2575
|
"user_account_self_management": false,
|
|
2498
2576
|
"feature_settings": {
|
|
2499
2577
|
"start_page": true,
|
|
@@ -2635,6 +2713,7 @@ const { data } = await client.getOrgPortalConfigV3({
|
|
|
2635
2713
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
2636
2714
|
"origin": "string",
|
|
2637
2715
|
"pages": {},
|
|
2716
|
+
"global_blocks": {},
|
|
2638
2717
|
"id": 12345,
|
|
2639
2718
|
"organization_id": 12345,
|
|
2640
2719
|
"org_settings": {
|
|
@@ -2693,9 +2772,13 @@ const { data } = await client.getAllPortalConfigs()
|
|
|
2693
2772
|
"name": "Installer Portal",
|
|
2694
2773
|
"domain": "abc.com",
|
|
2695
2774
|
"is_epilot_domain": true,
|
|
2775
|
+
"epilot_domain": "example-portal-12345.ecp.epilot.cloud",
|
|
2776
|
+
"domain_settings": {},
|
|
2696
2777
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
2697
2778
|
"allowed_portal_entities": ["contact", "contract"],
|
|
2698
2779
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2780
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
2781
|
+
"self_registration_entity": "contact",
|
|
2699
2782
|
"user_account_self_management": false,
|
|
2700
2783
|
"feature_settings": {},
|
|
2701
2784
|
"accessToken": "string",
|
|
@@ -2723,6 +2806,7 @@ const { data } = await client.getAllPortalConfigs()
|
|
|
2723
2806
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
2724
2807
|
"origin": "string",
|
|
2725
2808
|
"pages": {},
|
|
2809
|
+
"global_blocks": {},
|
|
2726
2810
|
"id": 12345,
|
|
2727
2811
|
"organization_id": 12345,
|
|
2728
2812
|
"org_settings": {},
|
|
@@ -3760,7 +3844,51 @@ const { data } = await client.checkContactExistsV3(
|
|
|
3760
3844
|
```json
|
|
3761
3845
|
{
|
|
3762
3846
|
"exists": true,
|
|
3763
|
-
"contactId": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
3847
|
+
"contactId": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
3848
|
+
"accountId": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
3849
|
+
}
|
|
3850
|
+
```
|
|
3851
|
+
|
|
3852
|
+
</details>
|
|
3853
|
+
|
|
3854
|
+
---
|
|
3855
|
+
|
|
3856
|
+
### `checkAccountExists`
|
|
3857
|
+
|
|
3858
|
+
True if account with given identifiers exists.
|
|
3859
|
+
Supports two identification methods:
|
|
3860
|
+
1. Using portal_id
|
|
3861
|
+
2. Using domain
|
|
3862
|
+
|
|
3863
|
+
`POST /v3/portal/public/account/exists`
|
|
3864
|
+
|
|
3865
|
+
```ts
|
|
3866
|
+
const { data } = await client.checkAccountExists(
|
|
3867
|
+
{
|
|
3868
|
+
portal_id: 'example',
|
|
3869
|
+
domain: 'example',
|
|
3870
|
+
},
|
|
3871
|
+
{
|
|
3872
|
+
org_id: 728,
|
|
3873
|
+
registration_identifiers: {
|
|
3874
|
+
account: {
|
|
3875
|
+
customer_number: 'ACC-123456'
|
|
3876
|
+
},
|
|
3877
|
+
contract: {
|
|
3878
|
+
contract_number: '123456'
|
|
3879
|
+
}
|
|
3880
|
+
}
|
|
3881
|
+
},
|
|
3882
|
+
)
|
|
3883
|
+
```
|
|
3884
|
+
|
|
3885
|
+
<details>
|
|
3886
|
+
<summary>Response</summary>
|
|
3887
|
+
|
|
3888
|
+
```json
|
|
3889
|
+
{
|
|
3890
|
+
"exists": true,
|
|
3891
|
+
"accountId": "5da0a718-c822-403d-9f5d-20d4584e0528"
|
|
3764
3892
|
}
|
|
3765
3893
|
```
|
|
3766
3894
|
|
|
@@ -5525,6 +5653,61 @@ const { data } = await client.getMeterReadings(
|
|
|
5525
5653
|
|
|
5526
5654
|
---
|
|
5527
5655
|
|
|
5656
|
+
### `getSSOProvider`
|
|
5657
|
+
|
|
5658
|
+
Returns the public configuration of a single SSO identity provider with env var
|
|
5659
|
+
placeholders (incl. secrets) already resolved against the organization's environment.
|
|
5660
|
+
|
|
5661
|
+
`GET /v2/portal/public/sso/providers/{provider_slug}`
|
|
5662
|
+
|
|
5663
|
+
```ts
|
|
5664
|
+
const { data } = await client.getSSOProvider({
|
|
5665
|
+
provider_slug: 'example',
|
|
5666
|
+
org_id: 'example',
|
|
5667
|
+
origin: 'example',
|
|
5668
|
+
portal_id: 'example',
|
|
5669
|
+
domain: 'example',
|
|
5670
|
+
})
|
|
5671
|
+
```
|
|
5672
|
+
|
|
5673
|
+
<details>
|
|
5674
|
+
<summary>Response</summary>
|
|
5675
|
+
|
|
5676
|
+
```json
|
|
5677
|
+
{
|
|
5678
|
+
"slug": "office-365-login",
|
|
5679
|
+
"display_name": "Office 365 Login",
|
|
5680
|
+
"oidc_config": {
|
|
5681
|
+
"type": "implicit",
|
|
5682
|
+
"oidc_issuer": "https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0",
|
|
5683
|
+
"redirect_uri": "https://customer-portal.com/login",
|
|
5684
|
+
"client_id": "ab81daf8-8b1f-42d6-94ca-c51621054c75",
|
|
5685
|
+
"has_client_secret": true,
|
|
5686
|
+
"scope": "openid email",
|
|
5687
|
+
"metadata": {
|
|
5688
|
+
"authorization_endpoint": "https://www.facebook.com/v12.0/dialog/oauth",
|
|
5689
|
+
"token_endpoint": "https://graph.facebook.com/v12.0/oauth/access_token",
|
|
5690
|
+
"userinfo_endpoint": "https://graph.facebook.com/me",
|
|
5691
|
+
"logout_uri": "https://login.microsoftonline.com/common/oauth2/v2.0/logout",
|
|
5692
|
+
"logout_redirect_uri": "https://customer-portal.com/login",
|
|
5693
|
+
"skip_login_as_logout": false,
|
|
5694
|
+
"mobile_redirect_uri": "msauth.io.epilot.ecp://auth",
|
|
5695
|
+
"test_auth_username": "test@epilot.io",
|
|
5696
|
+
"test_auth_password": "string"
|
|
5697
|
+
},
|
|
5698
|
+
"prompt": "login"
|
|
5699
|
+
},
|
|
5700
|
+
"mobile_oidc_config": {
|
|
5701
|
+
"client_id": 123456,
|
|
5702
|
+
"client_secret": 123456
|
|
5703
|
+
}
|
|
5704
|
+
}
|
|
5705
|
+
```
|
|
5706
|
+
|
|
5707
|
+
</details>
|
|
5708
|
+
|
|
5709
|
+
---
|
|
5710
|
+
|
|
5528
5711
|
### `ssoLogin`
|
|
5529
5712
|
|
|
5530
5713
|
Initiate login using external SSO identity.
|
|
@@ -6566,9 +6749,17 @@ const { data } = await client.createPortalConfig(
|
|
|
6566
6749
|
name: 'Installer Portal',
|
|
6567
6750
|
domain: 'abc.com',
|
|
6568
6751
|
is_epilot_domain: true,
|
|
6752
|
+
epilot_domain: 'example-portal-1.ecp.epilot.io',
|
|
6753
|
+
domain_settings: {
|
|
6754
|
+
is_custom_domain_enabled: true,
|
|
6755
|
+
is_epilot_domain_enabled: true,
|
|
6756
|
+
is_redirection_enabled: true
|
|
6757
|
+
},
|
|
6569
6758
|
design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
6570
6759
|
allowed_portal_entities: ['contact', 'contract'],
|
|
6571
6760
|
self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
6761
|
+
self_registration_account_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
6762
|
+
self_registration_entity: 'contact',
|
|
6572
6763
|
user_account_self_management: false,
|
|
6573
6764
|
feature_settings: {
|
|
6574
6765
|
start_page: true,
|
|
@@ -6710,6 +6901,7 @@ const { data } = await client.createPortalConfig(
|
|
|
6710
6901
|
portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
6711
6902
|
portal_sk_v3: 'PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
6712
6903
|
origin: 'string',
|
|
6904
|
+
global_blocks: {},
|
|
6713
6905
|
pages: [
|
|
6714
6906
|
{
|
|
6715
6907
|
slug: 'dashboard',
|
|
@@ -6763,9 +6955,17 @@ const { data } = await client.createPortalConfig(
|
|
|
6763
6955
|
"name": "Installer Portal",
|
|
6764
6956
|
"domain": "abc.com",
|
|
6765
6957
|
"is_epilot_domain": true,
|
|
6958
|
+
"epilot_domain": "example-portal-1.ecp.epilot.io",
|
|
6959
|
+
"domain_settings": {
|
|
6960
|
+
"is_custom_domain_enabled": true,
|
|
6961
|
+
"is_epilot_domain_enabled": true,
|
|
6962
|
+
"is_redirection_enabled": true
|
|
6963
|
+
},
|
|
6766
6964
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
6767
6965
|
"allowed_portal_entities": ["contact", "contract"],
|
|
6768
6966
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
6967
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
6968
|
+
"self_registration_entity": "contact",
|
|
6769
6969
|
"user_account_self_management": false,
|
|
6770
6970
|
"feature_settings": {
|
|
6771
6971
|
"start_page": true,
|
|
@@ -6906,6 +7106,7 @@ const { data } = await client.createPortalConfig(
|
|
|
6906
7106
|
"portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
6907
7107
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
6908
7108
|
"origin": "string",
|
|
7109
|
+
"global_blocks": {},
|
|
6909
7110
|
"organization_id": 12345,
|
|
6910
7111
|
"org_settings": {
|
|
6911
7112
|
"canary": {
|
|
@@ -7003,9 +7204,17 @@ const { data } = await client.getPortalConfigV3({
|
|
|
7003
7204
|
"name": "Installer Portal",
|
|
7004
7205
|
"domain": "abc.com",
|
|
7005
7206
|
"is_epilot_domain": true,
|
|
7207
|
+
"epilot_domain": "example-portal-1.ecp.epilot.io",
|
|
7208
|
+
"domain_settings": {
|
|
7209
|
+
"is_custom_domain_enabled": true,
|
|
7210
|
+
"is_epilot_domain_enabled": true,
|
|
7211
|
+
"is_redirection_enabled": true
|
|
7212
|
+
},
|
|
7006
7213
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7007
7214
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7008
7215
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7216
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7217
|
+
"self_registration_entity": "contact",
|
|
7009
7218
|
"user_account_self_management": false,
|
|
7010
7219
|
"feature_settings": {
|
|
7011
7220
|
"start_page": true,
|
|
@@ -7146,6 +7355,7 @@ const { data } = await client.getPortalConfigV3({
|
|
|
7146
7355
|
"portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7147
7356
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7148
7357
|
"origin": "string",
|
|
7358
|
+
"global_blocks": {},
|
|
7149
7359
|
"organization_id": 12345,
|
|
7150
7360
|
"org_settings": {
|
|
7151
7361
|
"canary": {
|
|
@@ -7238,9 +7448,17 @@ const { data } = await client.putPortalConfig(
|
|
|
7238
7448
|
name: 'Installer Portal',
|
|
7239
7449
|
domain: 'abc.com',
|
|
7240
7450
|
is_epilot_domain: true,
|
|
7451
|
+
epilot_domain: 'example-portal-1.ecp.epilot.io',
|
|
7452
|
+
domain_settings: {
|
|
7453
|
+
is_custom_domain_enabled: true,
|
|
7454
|
+
is_epilot_domain_enabled: true,
|
|
7455
|
+
is_redirection_enabled: true
|
|
7456
|
+
},
|
|
7241
7457
|
design_id: '5da0a718-c822-403d-9f5d-20d4584e0528',
|
|
7242
7458
|
allowed_portal_entities: ['contact', 'contract'],
|
|
7243
7459
|
self_registration_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
7460
|
+
self_registration_account_setting: 'ALLOW_WITH_CONTACT_CREATION',
|
|
7461
|
+
self_registration_entity: 'contact',
|
|
7244
7462
|
user_account_self_management: false,
|
|
7245
7463
|
feature_settings: {
|
|
7246
7464
|
start_page: true,
|
|
@@ -7382,6 +7600,7 @@ const { data } = await client.putPortalConfig(
|
|
|
7382
7600
|
portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
7383
7601
|
portal_sk_v3: 'PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c',
|
|
7384
7602
|
origin: 'string',
|
|
7603
|
+
global_blocks: {},
|
|
7385
7604
|
organization_id: 12345,
|
|
7386
7605
|
org_settings: {
|
|
7387
7606
|
canary: {
|
|
@@ -7464,9 +7683,17 @@ const { data } = await client.putPortalConfig(
|
|
|
7464
7683
|
"name": "Installer Portal",
|
|
7465
7684
|
"domain": "abc.com",
|
|
7466
7685
|
"is_epilot_domain": true,
|
|
7686
|
+
"epilot_domain": "example-portal-1.ecp.epilot.io",
|
|
7687
|
+
"domain_settings": {
|
|
7688
|
+
"is_custom_domain_enabled": true,
|
|
7689
|
+
"is_epilot_domain_enabled": true,
|
|
7690
|
+
"is_redirection_enabled": true
|
|
7691
|
+
},
|
|
7467
7692
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7468
7693
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7469
7694
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7695
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7696
|
+
"self_registration_entity": "contact",
|
|
7470
7697
|
"user_account_self_management": false,
|
|
7471
7698
|
"feature_settings": {
|
|
7472
7699
|
"start_page": true,
|
|
@@ -7607,6 +7834,7 @@ const { data } = await client.putPortalConfig(
|
|
|
7607
7834
|
"portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7608
7835
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7609
7836
|
"origin": "string",
|
|
7837
|
+
"global_blocks": {},
|
|
7610
7838
|
"organization_id": 12345,
|
|
7611
7839
|
"org_settings": {
|
|
7612
7840
|
"canary": {
|
|
@@ -7702,9 +7930,13 @@ const { data } = await client.listAllPortalConfigs()
|
|
|
7702
7930
|
"name": "Installer Portal",
|
|
7703
7931
|
"domain": "abc.com",
|
|
7704
7932
|
"is_epilot_domain": true,
|
|
7933
|
+
"epilot_domain": "example-portal-1.ecp.epilot.io",
|
|
7934
|
+
"domain_settings": {},
|
|
7705
7935
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7706
7936
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7707
7937
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7938
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
7939
|
+
"self_registration_entity": "contact",
|
|
7708
7940
|
"user_account_self_management": false,
|
|
7709
7941
|
"feature_settings": {},
|
|
7710
7942
|
"accessToken": "string",
|
|
@@ -7731,6 +7963,7 @@ const { data } = await client.listAllPortalConfigs()
|
|
|
7731
7963
|
"portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7732
7964
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7733
7965
|
"origin": "string",
|
|
7966
|
+
"global_blocks": {},
|
|
7734
7967
|
"organization_id": 12345,
|
|
7735
7968
|
"org_settings": {},
|
|
7736
7969
|
"feature_flags": {},
|
|
@@ -7821,9 +8054,17 @@ const { data } = await client.clonePortalConfig(
|
|
|
7821
8054
|
"name": "Installer Portal",
|
|
7822
8055
|
"domain": "abc.com",
|
|
7823
8056
|
"is_epilot_domain": true,
|
|
8057
|
+
"epilot_domain": "example-portal-1.ecp.epilot.io",
|
|
8058
|
+
"domain_settings": {
|
|
8059
|
+
"is_custom_domain_enabled": true,
|
|
8060
|
+
"is_epilot_domain_enabled": true,
|
|
8061
|
+
"is_redirection_enabled": true
|
|
8062
|
+
},
|
|
7824
8063
|
"design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
7825
8064
|
"allowed_portal_entities": ["contact", "contract"],
|
|
7826
8065
|
"self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
8066
|
+
"self_registration_account_setting": "ALLOW_WITH_CONTACT_CREATION",
|
|
8067
|
+
"self_registration_entity": "contact",
|
|
7827
8068
|
"user_account_self_management": false,
|
|
7828
8069
|
"feature_settings": {
|
|
7829
8070
|
"start_page": true,
|
|
@@ -7964,6 +8205,7 @@ const { data } = await client.clonePortalConfig(
|
|
|
7964
8205
|
"portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7965
8206
|
"portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
|
|
7966
8207
|
"origin": "string",
|
|
8208
|
+
"global_blocks": {},
|
|
7967
8209
|
"organization_id": 12345,
|
|
7968
8210
|
"org_settings": {
|
|
7969
8211
|
"canary": {
|
|
@@ -8185,6 +8427,64 @@ const { data } = await client.enablePartner({
|
|
|
8185
8427
|
|
|
8186
8428
|
---
|
|
8187
8429
|
|
|
8430
|
+
### `verifyDns`
|
|
8431
|
+
|
|
8432
|
+
Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
|
|
8433
|
+
|
|
8434
|
+
`POST /v3/portal/verify-dns`
|
|
8435
|
+
|
|
8436
|
+
```ts
|
|
8437
|
+
const { data } = await client.verifyDns({
|
|
8438
|
+
portal_id: 'example',
|
|
8439
|
+
})
|
|
8440
|
+
```
|
|
8441
|
+
|
|
8442
|
+
<details>
|
|
8443
|
+
<summary>Response</summary>
|
|
8444
|
+
|
|
8445
|
+
```json
|
|
8446
|
+
{
|
|
8447
|
+
"domain_status": "PENDING",
|
|
8448
|
+
"message": "string"
|
|
8449
|
+
}
|
|
8450
|
+
```
|
|
8451
|
+
|
|
8452
|
+
</details>
|
|
8453
|
+
|
|
8454
|
+
---
|
|
8455
|
+
|
|
8456
|
+
### `portalProxyExecute`
|
|
8457
|
+
|
|
8458
|
+
Execute an Integration Hub managed-call use case on behalf of a portal user.
|
|
8459
|
+
Bridges PortalAuth to the Integration API by generating an internal token.
|
|
8460
|
+
|
|
8461
|
+
`POST /v2/portal/proxy/execute`
|
|
8462
|
+
|
|
8463
|
+
```ts
|
|
8464
|
+
const { data } = await client.portalProxyExecute(
|
|
8465
|
+
null,
|
|
8466
|
+
{
|
|
8467
|
+
integration_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
|
|
8468
|
+
use_case_slug: 'string',
|
|
8469
|
+
payload: {}
|
|
8470
|
+
},
|
|
8471
|
+
)
|
|
8472
|
+
```
|
|
8473
|
+
|
|
8474
|
+
<details>
|
|
8475
|
+
<summary>Response</summary>
|
|
8476
|
+
|
|
8477
|
+
```json
|
|
8478
|
+
{
|
|
8479
|
+
"success": true,
|
|
8480
|
+
"data": {}
|
|
8481
|
+
}
|
|
8482
|
+
```
|
|
8483
|
+
|
|
8484
|
+
</details>
|
|
8485
|
+
|
|
8486
|
+
---
|
|
8487
|
+
|
|
8188
8488
|
## Schemas
|
|
8189
8489
|
|
|
8190
8490
|
### `ContextEntity`
|
|
@@ -8375,9 +8675,17 @@ type CommonConfigAttributes = {
|
|
|
8375
8675
|
name?: string
|
|
8376
8676
|
domain: string
|
|
8377
8677
|
is_epilot_domain?: boolean
|
|
8678
|
+
epilot_domain?: string
|
|
8679
|
+
domain_settings?: {
|
|
8680
|
+
is_custom_domain_enabled?: boolean
|
|
8681
|
+
is_epilot_domain_enabled?: boolean
|
|
8682
|
+
is_redirection_enabled?: boolean
|
|
8683
|
+
}
|
|
8378
8684
|
design_id?: string // uuid
|
|
8379
8685
|
allowed_portal_entities?: string[]
|
|
8380
8686
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
8687
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
|
|
8688
|
+
self_registration_entity?: "contact" | "account"
|
|
8381
8689
|
user_account_self_management?: boolean
|
|
8382
8690
|
feature_settings?: {
|
|
8383
8691
|
start_page?: boolean
|
|
@@ -8462,14 +8770,6 @@ type CommonConfigAttributes = {
|
|
|
8462
8770
|
registration_identifiers?: Array<{
|
|
8463
8771
|
name?: string
|
|
8464
8772
|
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
8773
|
// ...
|
|
8474
8774
|
}
|
|
8475
8775
|
```
|
|
@@ -8511,9 +8811,17 @@ type UpsertPortalConfig = {
|
|
|
8511
8811
|
name?: string
|
|
8512
8812
|
domain: string
|
|
8513
8813
|
is_epilot_domain?: boolean
|
|
8814
|
+
epilot_domain?: string
|
|
8815
|
+
domain_settings?: {
|
|
8816
|
+
is_custom_domain_enabled?: boolean
|
|
8817
|
+
is_epilot_domain_enabled?: boolean
|
|
8818
|
+
is_redirection_enabled?: boolean
|
|
8819
|
+
}
|
|
8514
8820
|
design_id?: string // uuid
|
|
8515
8821
|
allowed_portal_entities?: string[]
|
|
8516
8822
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
8823
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
|
|
8824
|
+
self_registration_entity?: "contact" | "account"
|
|
8517
8825
|
user_account_self_management?: boolean
|
|
8518
8826
|
feature_settings?: {
|
|
8519
8827
|
start_page?: boolean
|
|
@@ -8569,14 +8877,6 @@ type UpsertPortalConfig = {
|
|
|
8569
8877
|
forgotPassword?: string // uuid
|
|
8570
8878
|
invitation?: string // uuid
|
|
8571
8879
|
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
8880
|
// ...
|
|
8581
8881
|
}
|
|
8582
8882
|
```
|
|
@@ -8589,9 +8889,17 @@ type PortalConfig = {
|
|
|
8589
8889
|
name?: string
|
|
8590
8890
|
domain: string
|
|
8591
8891
|
is_epilot_domain?: boolean
|
|
8892
|
+
epilot_domain?: string
|
|
8893
|
+
domain_settings?: {
|
|
8894
|
+
is_custom_domain_enabled?: boolean
|
|
8895
|
+
is_epilot_domain_enabled?: boolean
|
|
8896
|
+
is_redirection_enabled?: boolean
|
|
8897
|
+
}
|
|
8592
8898
|
design_id?: string // uuid
|
|
8593
8899
|
allowed_portal_entities?: string[]
|
|
8594
8900
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
8901
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
|
|
8902
|
+
self_registration_entity?: "contact" | "account"
|
|
8595
8903
|
user_account_self_management?: boolean
|
|
8596
8904
|
feature_settings?: {
|
|
8597
8905
|
start_page?: boolean
|
|
@@ -8676,14 +8984,6 @@ type PortalConfig = {
|
|
|
8676
8984
|
registration_identifiers?: Array<{
|
|
8677
8985
|
name?: string
|
|
8678
8986
|
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
8987
|
// ...
|
|
8688
8988
|
}
|
|
8689
8989
|
```
|
|
@@ -8795,6 +9095,18 @@ type UpsertPortalWidget = {
|
|
|
8795
9095
|
}
|
|
8796
9096
|
```
|
|
8797
9097
|
|
|
9098
|
+
### `DomainSettings`
|
|
9099
|
+
|
|
9100
|
+
Domain settings for the portal
|
|
9101
|
+
|
|
9102
|
+
```ts
|
|
9103
|
+
type DomainSettings = {
|
|
9104
|
+
is_custom_domain_enabled?: boolean
|
|
9105
|
+
is_epilot_domain_enabled?: boolean
|
|
9106
|
+
is_redirection_enabled?: boolean
|
|
9107
|
+
}
|
|
9108
|
+
```
|
|
9109
|
+
|
|
8798
9110
|
### `WidgetBase`
|
|
8799
9111
|
|
|
8800
9112
|
```ts
|
|
@@ -9143,6 +9455,15 @@ type ContactExistsRequest = {
|
|
|
9143
9455
|
}
|
|
9144
9456
|
```
|
|
9145
9457
|
|
|
9458
|
+
### `AccountExistsRequest`
|
|
9459
|
+
|
|
9460
|
+
```ts
|
|
9461
|
+
type AccountExistsRequest = {
|
|
9462
|
+
org_id: string
|
|
9463
|
+
registration_identifiers: Record<string, Record<string, string>>
|
|
9464
|
+
}
|
|
9465
|
+
```
|
|
9466
|
+
|
|
9146
9467
|
### `UserRequest`
|
|
9147
9468
|
|
|
9148
9469
|
```ts
|
|
@@ -10861,6 +11182,13 @@ type ProviderDisplayName = string
|
|
|
10861
11182
|
|
|
10862
11183
|
### `ProviderConfig`
|
|
10863
11184
|
|
|
11185
|
+
SSO identity provider configuration.
|
|
11186
|
+
|
|
11187
|
+
Env var interpolation: only string fields under `oidc_config` and
|
|
11188
|
+
`mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
11189
|
+
Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
11190
|
+
get resolved at runtime against the organization's
|
|
11191
|
+
|
|
10864
11192
|
```ts
|
|
10865
11193
|
type ProviderConfig = {
|
|
10866
11194
|
slug?: string
|
|
@@ -10937,7 +11265,6 @@ type ProviderPublicConfig = {
|
|
|
10937
11265
|
oidc_issuer: string
|
|
10938
11266
|
redirect_uri?: string
|
|
10939
11267
|
client_id: string
|
|
10940
|
-
client_secret?: string
|
|
10941
11268
|
has_client_secret?: boolean
|
|
10942
11269
|
scope: string
|
|
10943
11270
|
metadata?: {
|
|
@@ -11008,6 +11335,10 @@ type EntityMatchingConfig = {
|
|
|
11008
11335
|
|
|
11009
11336
|
### `OIDCProviderConfig`
|
|
11010
11337
|
|
|
11338
|
+
OIDC provider configuration. All string fields support env var interpolation
|
|
11339
|
+
(incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
|
|
11340
|
+
|
|
11341
|
+
|
|
11011
11342
|
```ts
|
|
11012
11343
|
type OIDCProviderConfig = {
|
|
11013
11344
|
type?: "authorization_code" | "implicit"
|
|
@@ -11032,8 +11363,42 @@ type OIDCProviderConfig = {
|
|
|
11032
11363
|
}
|
|
11033
11364
|
```
|
|
11034
11365
|
|
|
11366
|
+
### `OIDCProviderPublicConfig`
|
|
11367
|
+
|
|
11368
|
+
Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
|
|
11369
|
+
the `client_secret` field — it is kept server-side and only used to exchange the
|
|
11370
|
+
authorization code at the SSO callback. String fields are returned with env var
|
|
11371
|
+
placeholders already resolved when fetched via `GET /v2/p
|
|
11372
|
+
|
|
11373
|
+
```ts
|
|
11374
|
+
type OIDCProviderPublicConfig = {
|
|
11375
|
+
type?: "authorization_code" | "implicit"
|
|
11376
|
+
oidc_issuer: string
|
|
11377
|
+
redirect_uri?: string
|
|
11378
|
+
client_id: string
|
|
11379
|
+
has_client_secret?: boolean
|
|
11380
|
+
scope: string
|
|
11381
|
+
metadata?: {
|
|
11382
|
+
authorization_endpoint?: string
|
|
11383
|
+
token_endpoint?: string
|
|
11384
|
+
userinfo_endpoint?: string
|
|
11385
|
+
logout_uri?: string
|
|
11386
|
+
logout_redirect_uri?: string
|
|
11387
|
+
skip_login_as_logout?: boolean
|
|
11388
|
+
mobile_redirect_uri?: string
|
|
11389
|
+
test_auth_username?: string
|
|
11390
|
+
test_auth_password?: string
|
|
11391
|
+
}
|
|
11392
|
+
prompt?: "login" | "select_account" | "consent"
|
|
11393
|
+
}
|
|
11394
|
+
```
|
|
11395
|
+
|
|
11035
11396
|
### `MoblieOIDCConfig`
|
|
11036
11397
|
|
|
11398
|
+
Mobile OIDC configuration. All string fields support env var interpolation
|
|
11399
|
+
(incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
11400
|
+
|
|
11401
|
+
|
|
11037
11402
|
```ts
|
|
11038
11403
|
type MoblieOIDCConfig = {
|
|
11039
11404
|
client_id?: string
|
|
@@ -11276,9 +11641,17 @@ type CommonConfigAttributesV3 = {
|
|
|
11276
11641
|
name?: string
|
|
11277
11642
|
domain?: string
|
|
11278
11643
|
is_epilot_domain?: boolean
|
|
11644
|
+
epilot_domain?: string
|
|
11645
|
+
domain_settings?: {
|
|
11646
|
+
is_custom_domain_enabled?: boolean
|
|
11647
|
+
is_epilot_domain_enabled?: boolean
|
|
11648
|
+
is_redirection_enabled?: boolean
|
|
11649
|
+
}
|
|
11279
11650
|
design_id?: string // uuid
|
|
11280
11651
|
allowed_portal_entities?: string[]
|
|
11281
11652
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
11653
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
|
|
11654
|
+
self_registration_entity?: "contact" | "account"
|
|
11282
11655
|
user_account_self_management?: boolean
|
|
11283
11656
|
feature_settings?: {
|
|
11284
11657
|
start_page?: boolean
|
|
@@ -11363,14 +11736,6 @@ type CommonConfigAttributesV3 = {
|
|
|
11363
11736
|
registration_identifiers?: Array<{
|
|
11364
11737
|
name?: string
|
|
11365
11738
|
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
11739
|
// ...
|
|
11375
11740
|
}
|
|
11376
11741
|
```
|
|
@@ -11420,9 +11785,17 @@ type UpsertPortalConfigV3 = {
|
|
|
11420
11785
|
name?: string
|
|
11421
11786
|
domain?: string
|
|
11422
11787
|
is_epilot_domain?: boolean
|
|
11788
|
+
epilot_domain?: string
|
|
11789
|
+
domain_settings?: {
|
|
11790
|
+
is_custom_domain_enabled?: boolean
|
|
11791
|
+
is_epilot_domain_enabled?: boolean
|
|
11792
|
+
is_redirection_enabled?: boolean
|
|
11793
|
+
}
|
|
11423
11794
|
design_id?: string // uuid
|
|
11424
11795
|
allowed_portal_entities?: string[]
|
|
11425
11796
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
11797
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
|
|
11798
|
+
self_registration_entity?: "contact" | "account"
|
|
11426
11799
|
user_account_self_management?: boolean
|
|
11427
11800
|
feature_settings?: {
|
|
11428
11801
|
start_page?: boolean
|
|
@@ -11478,14 +11851,6 @@ type UpsertPortalConfigV3 = {
|
|
|
11478
11851
|
forgotPassword?: string // uuid
|
|
11479
11852
|
invitation?: string // uuid
|
|
11480
11853
|
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
11854
|
// ...
|
|
11490
11855
|
}
|
|
11491
11856
|
```
|
|
@@ -11527,9 +11892,17 @@ type PortalConfigV3 = {
|
|
|
11527
11892
|
name?: string
|
|
11528
11893
|
domain?: string
|
|
11529
11894
|
is_epilot_domain?: boolean
|
|
11895
|
+
epilot_domain?: string
|
|
11896
|
+
domain_settings?: {
|
|
11897
|
+
is_custom_domain_enabled?: boolean
|
|
11898
|
+
is_epilot_domain_enabled?: boolean
|
|
11899
|
+
is_redirection_enabled?: boolean
|
|
11900
|
+
}
|
|
11530
11901
|
design_id?: string // uuid
|
|
11531
11902
|
allowed_portal_entities?: string[]
|
|
11532
11903
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS"
|
|
11904
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY"
|
|
11905
|
+
self_registration_entity?: "contact" | "account"
|
|
11533
11906
|
user_account_self_management?: boolean
|
|
11534
11907
|
feature_settings?: {
|
|
11535
11908
|
start_page?: boolean
|
|
@@ -11585,14 +11958,6 @@ type PortalConfigV3 = {
|
|
|
11585
11958
|
forgotPassword?: string // uuid
|
|
11586
11959
|
invitation?: string // uuid
|
|
11587
11960
|
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
11961
|
// ...
|
|
11597
11962
|
}
|
|
11598
11963
|
```
|
|
@@ -11603,6 +11968,7 @@ type PortalConfigV3 = {
|
|
|
11603
11968
|
type JuiceSettings = {
|
|
11604
11969
|
is_dummy?: boolean
|
|
11605
11970
|
is_canary?: boolean
|
|
11971
|
+
redirect_to?: string
|
|
11606
11972
|
}
|
|
11607
11973
|
```
|
|
11608
11974
|
|