@epilot/sdk 2.10.0 → 2.10.2
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/ai-agents-runtime.json +1 -1
- package/definitions/ai-agents.json +971 -98
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +1238 -124
- package/definitions/file-runtime.json +1 -1
- package/definitions/file.json +291 -15
- package/definitions/targeting-runtime.json +1 -1
- package/definitions/targeting.json +7 -2
- package/definitions/workflow-runtime.json +1 -1
- package/definitions/workflow.json +445 -60
- package/dist/ai-agents-D6C5TXLD.cjs +7 -0
- package/dist/ai-agents-Y6PH53PH.js +7 -0
- package/dist/{ai-agents-runtime-25YRUJHI.js → ai-agents-runtime-EA23HCCP.js} +1 -1
- package/dist/{ai-agents-runtime-TILIO3UM.cjs → ai-agents-runtime-WZ3EI3NH.cjs} +2 -2
- package/dist/{ai-agents.d-CC5IjXrs.d.cts → ai-agents.d-D-7bTH-9.d.cts} +506 -5
- package/dist/{ai-agents.d-CC5IjXrs.d.ts → ai-agents.d-D-7bTH-9.d.ts} +506 -5
- 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 +8 -8
- package/dist/apis/ai-agents.d.cts +2 -2
- package/dist/apis/ai-agents.d.ts +2 -2
- package/dist/apis/ai-agents.js +2 -2
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +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/snapshot.cjs +6 -6
- package/dist/apis/snapshot.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 +8 -8
- package/dist/apis/targeting.d.cts +2 -2
- package/dist/apis/targeting.d.ts +2 -2
- package/dist/apis/targeting.js +2 -2
- 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 +8 -8
- package/dist/apis/workflow.d.cts +2 -2
- package/dist/apis/workflow.d.ts +2 -2
- package/dist/apis/workflow.js +2 -2
- package/dist/{chunk-KQKBSWGI.js → chunk-522LYPPW.js} +1 -1
- package/dist/{chunk-MCK2QUSD.cjs → chunk-7ILTRJDQ.cjs} +1 -1
- package/dist/chunk-BRWY3QHG.js +14 -0
- package/dist/chunk-G5KVG3RU.js +14 -0
- package/dist/{chunk-LSPXLT3A.js → chunk-H3NMCCSA.js} +1 -1
- package/dist/chunk-JBPITLKN.cjs +14 -0
- package/dist/chunk-LNLUCLPL.cjs +14 -0
- package/dist/chunk-LSMVZMBY.js +14 -0
- package/dist/{chunk-XH5F3S6Y.js → chunk-O6DUKVXV.js} +10 -10
- package/dist/{chunk-QNZPOA54.cjs → chunk-PM25LLET.cjs} +1 -1
- package/dist/{chunk-OJGUX5TG.cjs → chunk-WK3YGGRO.cjs} +10 -10
- package/dist/chunk-YEBEA6XU.cjs +14 -0
- package/dist/customer-portal-MY3GZVUL.cjs +7 -0
- package/dist/customer-portal-YSODD3RC.js +7 -0
- package/dist/{customer-portal-runtime-TDHV2YVY.js → customer-portal-runtime-C6ZIKX2V.js} +1 -1
- package/dist/{customer-portal-runtime-HA6CPWB4.cjs → customer-portal-runtime-M7O3RDJ5.cjs} +2 -2
- package/dist/{customer-portal.d-BRwiQehb.d.cts → customer-portal.d-Bx5_n5UL.d.cts} +827 -8
- package/dist/{customer-portal.d-BRwiQehb.d.ts → customer-portal.d-Bx5_n5UL.d.ts} +827 -8
- package/dist/file-7CQXDQ3I.cjs +7 -0
- package/dist/file-O6ZD3HOU.js +7 -0
- package/dist/file-runtime-HYLQTQBX.cjs +5 -0
- package/dist/{file-runtime-DKGFS44O.js → file-runtime-VY6DJAQ3.js} +1 -1
- package/dist/{file.d-BjlMgTwj.d.cts → file.d-BN417xok.d.cts} +416 -23
- package/dist/{file.d-BjlMgTwj.d.ts → file.d-BN417xok.d.ts} +416 -23
- package/dist/index.cjs +18 -18
- package/dist/index.d.cts +5 -5
- package/dist/index.d.ts +5 -5
- package/dist/index.js +6 -6
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/dist/{targeting-WC62BBZN.cjs → targeting-4YMBBPDW.cjs} +1 -1
- package/dist/{targeting-X4Y2ODBT.js → targeting-VCENULF6.js} +1 -1
- package/dist/{targeting-runtime-D5YUPZQM.js → targeting-runtime-QI7322HB.js} +1 -1
- package/dist/{targeting-runtime-MLMOM7CK.cjs → targeting-runtime-X3DQ527N.cjs} +2 -2
- package/dist/{targeting.d-0rNF7ErD.d.cts → targeting.d-Bq3onSes.d.cts} +1 -1
- package/dist/{targeting.d-0rNF7ErD.d.ts → targeting.d-Bq3onSes.d.ts} +1 -1
- package/dist/workflow-7OU2YEEI.cjs +7 -0
- package/dist/workflow-IVKCWS44.js +7 -0
- package/dist/{workflow-runtime-DNTQDYPQ.js → workflow-runtime-L5HMFISV.js} +1 -1
- package/dist/{workflow-runtime-VKFESVFX.cjs → workflow-runtime-LMGACZP4.cjs} +2 -2
- package/dist/{workflow.d-CMSKt8oN.d.cts → workflow.d-eFv0ecBi.d.cts} +745 -81
- package/dist/{workflow.d-CMSKt8oN.d.ts → workflow.d-eFv0ecBi.d.ts} +745 -81
- package/docs/ai-agents.md +641 -23
- package/docs/customer-portal.md +700 -31
- package/docs/file.md +165 -25
- package/docs/targeting.md +1 -1
- package/docs/workflow.md +247 -47
- package/package.json +11 -12
- package/definitions/focus-pocus-runtime.json +0 -1
- package/definitions/focus-pocus.json +0 -757
- package/dist/ai-agents-IZWFEUSH.js +0 -7
- package/dist/ai-agents-PWHKNRCX.cjs +0 -7
- package/dist/chunk-4M5V6BIT.cjs +0 -14
- package/dist/chunk-5ZXGKLB6.cjs +0 -14
- package/dist/chunk-774ASAAH.js +0 -14
- package/dist/chunk-FARDEGPH.cjs +0 -14
- package/dist/chunk-JENQHXFI.js +0 -14
- package/dist/chunk-RDVFQOCQ.js +0 -14
- package/dist/customer-portal-4DXHY42V.js +0 -7
- package/dist/customer-portal-5OSGSYGF.cjs +0 -7
- package/dist/file-2MSILSPP.cjs +0 -7
- package/dist/file-JVFTT5RZ.js +0 -7
- package/dist/file-runtime-7AWKNQU6.cjs +0 -5
- package/dist/workflow-3WBD74WR.js +0 -7
- package/dist/workflow-WIUZ5TOX.cjs +0 -7
|
@@ -1049,6 +1049,11 @@ declare namespace Components {
|
|
|
1049
1049
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
1050
1050
|
*/
|
|
1051
1051
|
auto_redirect_to_sso?: boolean;
|
|
1052
|
+
/**
|
|
1053
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
1054
|
+
*
|
|
1055
|
+
*/
|
|
1056
|
+
prevent_user_enumeration?: boolean;
|
|
1052
1057
|
};
|
|
1053
1058
|
/**
|
|
1054
1059
|
* AWS Cognito Pool details for the portal
|
|
@@ -1561,6 +1566,11 @@ declare namespace Components {
|
|
|
1561
1566
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
1562
1567
|
*/
|
|
1563
1568
|
auto_redirect_to_sso?: boolean;
|
|
1569
|
+
/**
|
|
1570
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
1571
|
+
*
|
|
1572
|
+
*/
|
|
1573
|
+
prevent_user_enumeration?: boolean;
|
|
1564
1574
|
};
|
|
1565
1575
|
/**
|
|
1566
1576
|
* AWS Cognito Pool details for the portal
|
|
@@ -3463,7 +3473,32 @@ declare namespace Components {
|
|
|
3463
3473
|
* Hook that returns runtime metadata describing how a visualization should be rendered for a given portal context. Invoked by the portal before fetching data, with the same context the data hook receives.
|
|
3464
3474
|
*
|
|
3465
3475
|
*/
|
|
3466
|
-
ExtensionHookVisualizationMetadata
|
|
3476
|
+
ExtensionHookVisualizationMetadata | /**
|
|
3477
|
+
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not change the user's login email itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change (most likely by sending the user instructions to confirm the new email address).
|
|
3478
|
+
* The expected response http status code to the call is:
|
|
3479
|
+
* - 2xx if the request was accepted
|
|
3480
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3481
|
+
*
|
|
3482
|
+
*/
|
|
3483
|
+
ExtensionHookChangeEmail | /**
|
|
3484
|
+
* Hook that replaces the built-in change password functionality for portal users. When configured, the portal does not change the user's password itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the password change (most likely by sending the user instructions to complete the process).
|
|
3485
|
+
* The expected response http status code to the call is:
|
|
3486
|
+
* - 2xx if the request was accepted
|
|
3487
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3488
|
+
*
|
|
3489
|
+
*/
|
|
3490
|
+
ExtensionHookChangePassword | /**
|
|
3491
|
+
* Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.
|
|
3492
|
+
* The `deletion_mode` controls what the portal does after the call:
|
|
3493
|
+
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.
|
|
3494
|
+
* - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).
|
|
3495
|
+
*
|
|
3496
|
+
* The expected response http status code to the call is:
|
|
3497
|
+
* - 2xx if the request was accepted
|
|
3498
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3499
|
+
*
|
|
3500
|
+
*/
|
|
3501
|
+
ExtensionHookDeleteAccount))[];
|
|
3467
3502
|
}
|
|
3468
3503
|
export interface ExtensionAuthBlock {
|
|
3469
3504
|
/**
|
|
@@ -3529,6 +3564,140 @@ declare namespace Components {
|
|
|
3529
3564
|
*/
|
|
3530
3565
|
id?: string;
|
|
3531
3566
|
}
|
|
3567
|
+
/**
|
|
3568
|
+
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not change the user's login email itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change (most likely by sending the user instructions to confirm the new email address).
|
|
3569
|
+
* The expected response http status code to the call is:
|
|
3570
|
+
* - 2xx if the request was accepted
|
|
3571
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3572
|
+
*
|
|
3573
|
+
*/
|
|
3574
|
+
export interface ExtensionHookChangeEmail {
|
|
3575
|
+
type: "changeEmail";
|
|
3576
|
+
/**
|
|
3577
|
+
* Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook.
|
|
3578
|
+
*
|
|
3579
|
+
*/
|
|
3580
|
+
require_password_confirmation?: boolean;
|
|
3581
|
+
/**
|
|
3582
|
+
* Optional explanation shown to the user in the change email confirmation dialog.
|
|
3583
|
+
*/
|
|
3584
|
+
explanation?: {
|
|
3585
|
+
[name: string]: string;
|
|
3586
|
+
/**
|
|
3587
|
+
* Explanation of the functionality shown to the end user.
|
|
3588
|
+
* example:
|
|
3589
|
+
* You will receive an email with instructions to confirm your new email address.
|
|
3590
|
+
*/
|
|
3591
|
+
en: string;
|
|
3592
|
+
};
|
|
3593
|
+
auth?: ExtensionAuthBlock;
|
|
3594
|
+
call: {
|
|
3595
|
+
/**
|
|
3596
|
+
* HTTP method to use for the call
|
|
3597
|
+
*/
|
|
3598
|
+
method?: string;
|
|
3599
|
+
/**
|
|
3600
|
+
* URL to call. Supports variable interpolation.
|
|
3601
|
+
*/
|
|
3602
|
+
url: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
3605
|
+
*/
|
|
3606
|
+
params?: {
|
|
3607
|
+
[name: string]: string;
|
|
3608
|
+
};
|
|
3609
|
+
/**
|
|
3610
|
+
* Headers to use. Supports variable interpolation.
|
|
3611
|
+
*/
|
|
3612
|
+
headers: {
|
|
3613
|
+
[name: string]: string;
|
|
3614
|
+
};
|
|
3615
|
+
/**
|
|
3616
|
+
* Optional JSON body to use for the call. Defaults to an object with the requested new email and portal user context. The requested new email is available as `{{Input.new_email}}` and the current account email as `{{Input.old_email}}`. Supports variable interpolation.
|
|
3617
|
+
*/
|
|
3618
|
+
body?: {
|
|
3619
|
+
[key: string]: any;
|
|
3620
|
+
};
|
|
3621
|
+
};
|
|
3622
|
+
resolved?: {
|
|
3623
|
+
/**
|
|
3624
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3625
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3626
|
+
*
|
|
3627
|
+
* example:
|
|
3628
|
+
* error.message
|
|
3629
|
+
*/
|
|
3630
|
+
error_message_path?: string;
|
|
3631
|
+
};
|
|
3632
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3633
|
+
}
|
|
3634
|
+
/**
|
|
3635
|
+
* Hook that replaces the built-in change password functionality for portal users. When configured, the portal does not change the user's password itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the password change (most likely by sending the user instructions to complete the process).
|
|
3636
|
+
* The expected response http status code to the call is:
|
|
3637
|
+
* - 2xx if the request was accepted
|
|
3638
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3639
|
+
*
|
|
3640
|
+
*/
|
|
3641
|
+
export interface ExtensionHookChangePassword {
|
|
3642
|
+
type: "changePassword";
|
|
3643
|
+
/**
|
|
3644
|
+
* Whether the portal user must provide a new password. When false, the portal only asks the user to confirm (showing the configured explanation) and no new password is collected; the third-party system is expected to handle the password change. When true, the portal collects a new password and passes it to the third-party system as `{{Input.new_password}}`.
|
|
3645
|
+
*
|
|
3646
|
+
*/
|
|
3647
|
+
require_new_password?: boolean;
|
|
3648
|
+
/**
|
|
3649
|
+
* Optional explanation shown to the user in the change password confirmation dialog.
|
|
3650
|
+
*/
|
|
3651
|
+
explanation?: {
|
|
3652
|
+
[name: string]: string;
|
|
3653
|
+
/**
|
|
3654
|
+
* Explanation of the functionality shown to the end user.
|
|
3655
|
+
* example:
|
|
3656
|
+
* You will receive an email with instructions to reset your password.
|
|
3657
|
+
*/
|
|
3658
|
+
en: string;
|
|
3659
|
+
};
|
|
3660
|
+
auth?: ExtensionAuthBlock;
|
|
3661
|
+
call: {
|
|
3662
|
+
/**
|
|
3663
|
+
* HTTP method to use for the call
|
|
3664
|
+
*/
|
|
3665
|
+
method?: string;
|
|
3666
|
+
/**
|
|
3667
|
+
* URL to call. Supports variable interpolation.
|
|
3668
|
+
*/
|
|
3669
|
+
url: string;
|
|
3670
|
+
/**
|
|
3671
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
3672
|
+
*/
|
|
3673
|
+
params?: {
|
|
3674
|
+
[name: string]: string;
|
|
3675
|
+
};
|
|
3676
|
+
/**
|
|
3677
|
+
* Headers to use. Supports variable interpolation.
|
|
3678
|
+
*/
|
|
3679
|
+
headers: {
|
|
3680
|
+
[name: string]: string;
|
|
3681
|
+
};
|
|
3682
|
+
/**
|
|
3683
|
+
* Optional JSON body to use for the call. Defaults to an object with portal user context (and the new password as `{{Input.new_password}}` when `require_new_password` is true). Supports variable interpolation.
|
|
3684
|
+
*/
|
|
3685
|
+
body?: {
|
|
3686
|
+
[key: string]: any;
|
|
3687
|
+
};
|
|
3688
|
+
};
|
|
3689
|
+
resolved?: {
|
|
3690
|
+
/**
|
|
3691
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3692
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3693
|
+
*
|
|
3694
|
+
* example:
|
|
3695
|
+
* error.message
|
|
3696
|
+
*/
|
|
3697
|
+
error_message_path?: string;
|
|
3698
|
+
};
|
|
3699
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3700
|
+
}
|
|
3532
3701
|
/**
|
|
3533
3702
|
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
3534
3703
|
* - 200 with the time series data
|
|
@@ -3808,6 +3977,77 @@ declare namespace Components {
|
|
|
3808
3977
|
use_static_ips?: boolean;
|
|
3809
3978
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3810
3979
|
}
|
|
3980
|
+
/**
|
|
3981
|
+
* Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.
|
|
3982
|
+
* The `deletion_mode` controls what the portal does after the call:
|
|
3983
|
+
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.
|
|
3984
|
+
* - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).
|
|
3985
|
+
*
|
|
3986
|
+
* The expected response http status code to the call is:
|
|
3987
|
+
* - 2xx if the request was accepted
|
|
3988
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3989
|
+
*
|
|
3990
|
+
*/
|
|
3991
|
+
export interface ExtensionHookDeleteAccount {
|
|
3992
|
+
type: "deleteAccount";
|
|
3993
|
+
/**
|
|
3994
|
+
* Controls how the account deletion is handled. `synchronous` waits for the third-party system to respond and then also deletes the epilot user. `asynchronous` hands the deletion over entirely to the third-party system and the portal does not delete anything immediately.
|
|
3995
|
+
*
|
|
3996
|
+
*/
|
|
3997
|
+
deletion_mode?: "synchronous" | "asynchronous";
|
|
3998
|
+
/**
|
|
3999
|
+
* Optional explanation shown to the user in the delete account confirmation dialog.
|
|
4000
|
+
*/
|
|
4001
|
+
explanation?: {
|
|
4002
|
+
[name: string]: string;
|
|
4003
|
+
/**
|
|
4004
|
+
* Explanation of the functionality shown to the end user.
|
|
4005
|
+
* example:
|
|
4006
|
+
* Your account deletion will be processed by our system. This may take a few days.
|
|
4007
|
+
*/
|
|
4008
|
+
en: string;
|
|
4009
|
+
};
|
|
4010
|
+
auth?: ExtensionAuthBlock;
|
|
4011
|
+
call: {
|
|
4012
|
+
/**
|
|
4013
|
+
* HTTP method to use for the call
|
|
4014
|
+
*/
|
|
4015
|
+
method?: string;
|
|
4016
|
+
/**
|
|
4017
|
+
* URL to call. Supports variable interpolation.
|
|
4018
|
+
*/
|
|
4019
|
+
url: string;
|
|
4020
|
+
/**
|
|
4021
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
4022
|
+
*/
|
|
4023
|
+
params?: {
|
|
4024
|
+
[name: string]: string;
|
|
4025
|
+
};
|
|
4026
|
+
/**
|
|
4027
|
+
* Headers to use. Supports variable interpolation.
|
|
4028
|
+
*/
|
|
4029
|
+
headers: {
|
|
4030
|
+
[name: string]: string;
|
|
4031
|
+
};
|
|
4032
|
+
/**
|
|
4033
|
+
* Optional JSON body to use for the call. Defaults to an object with portal user context, e.g. `{"portal_user_id": "...", "email": "..."}`. Supports variable interpolation.
|
|
4034
|
+
*/
|
|
4035
|
+
body?: {
|
|
4036
|
+
[key: string]: any;
|
|
4037
|
+
};
|
|
4038
|
+
};
|
|
4039
|
+
resolved?: {
|
|
4040
|
+
/**
|
|
4041
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
4042
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
4043
|
+
*
|
|
4044
|
+
* example:
|
|
4045
|
+
* error.message
|
|
4046
|
+
*/
|
|
4047
|
+
error_message_path?: string;
|
|
4048
|
+
};
|
|
4049
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
4050
|
+
}
|
|
3811
4051
|
/**
|
|
3812
4052
|
* Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
|
|
3813
4053
|
* - 200:
|
|
@@ -4844,6 +5084,109 @@ declare namespace Components {
|
|
|
4844
5084
|
};
|
|
4845
5085
|
schema?: string;
|
|
4846
5086
|
}
|
|
5087
|
+
export interface MobileBranding {
|
|
5088
|
+
[name: string]: any;
|
|
5089
|
+
app_icon?: string;
|
|
5090
|
+
splash?: string;
|
|
5091
|
+
splash_dark?: string;
|
|
5092
|
+
icon_background_color?: string;
|
|
5093
|
+
splash_background_color?: string;
|
|
5094
|
+
splash_background_color_dark?: string;
|
|
5095
|
+
}
|
|
5096
|
+
/**
|
|
5097
|
+
* Latest build/upload status for a platform (system-written).
|
|
5098
|
+
*/
|
|
5099
|
+
export interface MobileBuildStatus {
|
|
5100
|
+
[name: string]: any;
|
|
5101
|
+
version?: string;
|
|
5102
|
+
build_number?: number;
|
|
5103
|
+
/**
|
|
5104
|
+
* e.g. testflight | internal | beta
|
|
5105
|
+
*/
|
|
5106
|
+
track?: string;
|
|
5107
|
+
status?: "building" | "uploaded" | "failed";
|
|
5108
|
+
updated_at?: string; // date-time
|
|
5109
|
+
error?: string;
|
|
5110
|
+
}
|
|
5111
|
+
/**
|
|
5112
|
+
* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here.
|
|
5113
|
+
*/
|
|
5114
|
+
export interface MobileConfig {
|
|
5115
|
+
[name: string]: any;
|
|
5116
|
+
/**
|
|
5117
|
+
* Portal id (response-only; ignored on write).
|
|
5118
|
+
*/
|
|
5119
|
+
portal_id?: string;
|
|
5120
|
+
enabled?: boolean;
|
|
5121
|
+
/**
|
|
5122
|
+
* App display name compiled into the binary.
|
|
5123
|
+
*/
|
|
5124
|
+
display_name?: string;
|
|
5125
|
+
/**
|
|
5126
|
+
* Host the mobile shell loads (defaults to the portal domain).
|
|
5127
|
+
*/
|
|
5128
|
+
app_host?: string;
|
|
5129
|
+
environment?: "prod" | "staging" | "dev";
|
|
5130
|
+
branding?: MobileBranding;
|
|
5131
|
+
ios?: {
|
|
5132
|
+
[name: string]: any;
|
|
5133
|
+
/**
|
|
5134
|
+
* iOS bundle id (matches the App Store Connect app).
|
|
5135
|
+
*/
|
|
5136
|
+
bundle_id?: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* Apple Developer Team ID.
|
|
5139
|
+
*/
|
|
5140
|
+
team_id?: string;
|
|
5141
|
+
credentials_status?: "not_configured" | "configured";
|
|
5142
|
+
/**
|
|
5143
|
+
* Numeric App Store id (system-written after first upload).
|
|
5144
|
+
*/
|
|
5145
|
+
app_store_id?: string;
|
|
5146
|
+
/**
|
|
5147
|
+
* System-written App Store URL.
|
|
5148
|
+
*/
|
|
5149
|
+
store_url?: string;
|
|
5150
|
+
last_build?: /* Latest build/upload status for a platform (system-written). */ MobileBuildStatus;
|
|
5151
|
+
};
|
|
5152
|
+
android?: {
|
|
5153
|
+
[name: string]: any;
|
|
5154
|
+
/**
|
|
5155
|
+
* Android package name (matches the Play Console app).
|
|
5156
|
+
*/
|
|
5157
|
+
package_name?: string;
|
|
5158
|
+
credentials_status?: "not_configured" | "configured";
|
|
5159
|
+
/**
|
|
5160
|
+
* Play App Signing upload-key state.
|
|
5161
|
+
*/
|
|
5162
|
+
upload_key_status?: "not_configured" | "generated" | "enrolled";
|
|
5163
|
+
/**
|
|
5164
|
+
* System-written Play Store URL.
|
|
5165
|
+
*/
|
|
5166
|
+
store_url?: string;
|
|
5167
|
+
last_build?: /* Latest build/upload status for a platform (system-written). */ MobileBuildStatus;
|
|
5168
|
+
};
|
|
5169
|
+
}
|
|
5170
|
+
/**
|
|
5171
|
+
* Editable mobile fields for PUT. Only mobile-relevant settings + app branding can be changed. Portal-derived values (display_name, app_host), the portal logo, and system-written fields (credentials_status, app_store_id, last_build, …) are ignored if sent.
|
|
5172
|
+
*/
|
|
5173
|
+
export interface MobileConfigUpdate {
|
|
5174
|
+
[name: string]: any;
|
|
5175
|
+
enabled?: boolean;
|
|
5176
|
+
ios?: {
|
|
5177
|
+
[name: string]: any;
|
|
5178
|
+
bundle_id?: string;
|
|
5179
|
+
team_id?: string;
|
|
5180
|
+
store_url?: string;
|
|
5181
|
+
app_store_id?: string;
|
|
5182
|
+
};
|
|
5183
|
+
android?: {
|
|
5184
|
+
[name: string]: any;
|
|
5185
|
+
package_name?: string;
|
|
5186
|
+
store_url?: string;
|
|
5187
|
+
};
|
|
5188
|
+
branding?: MobileBranding;
|
|
5189
|
+
}
|
|
4847
5190
|
/**
|
|
4848
5191
|
* Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
|
|
4849
5192
|
* fields below may reference org env vars via mustache-like templates, e.g.
|
|
@@ -5645,6 +5988,11 @@ declare namespace Components {
|
|
|
5645
5988
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
5646
5989
|
*/
|
|
5647
5990
|
auto_redirect_to_sso?: boolean;
|
|
5991
|
+
/**
|
|
5992
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
5993
|
+
*
|
|
5994
|
+
*/
|
|
5995
|
+
prevent_user_enumeration?: boolean;
|
|
5648
5996
|
};
|
|
5649
5997
|
/**
|
|
5650
5998
|
* AWS Cognito Pool details for the portal
|
|
@@ -6252,6 +6600,11 @@ declare namespace Components {
|
|
|
6252
6600
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
6253
6601
|
*/
|
|
6254
6602
|
auto_redirect_to_sso?: boolean;
|
|
6603
|
+
/**
|
|
6604
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
6605
|
+
*
|
|
6606
|
+
*/
|
|
6607
|
+
prevent_user_enumeration?: boolean;
|
|
6255
6608
|
};
|
|
6256
6609
|
/**
|
|
6257
6610
|
* AWS Cognito Pool details for the portal
|
|
@@ -6893,6 +7246,18 @@ declare namespace Components {
|
|
|
6893
7246
|
*
|
|
6894
7247
|
*/
|
|
6895
7248
|
MoblieOIDCConfig;
|
|
7249
|
+
/**
|
|
7250
|
+
* Allow the resolved `client_secret` to be returned through the
|
|
7251
|
+
* public single-provider endpoint at SSO initiation. Only set this
|
|
7252
|
+
* for OIDC flows that require a public client secret in the
|
|
7253
|
+
* browser (e.g. some PKCE-less authorization-code variants). When
|
|
7254
|
+
* unset (default), the secret is kept server-side and only used at
|
|
7255
|
+
* the token exchange.
|
|
7256
|
+
*
|
|
7257
|
+
* example:
|
|
7258
|
+
* false
|
|
7259
|
+
*/
|
|
7260
|
+
expose_client_secret?: boolean;
|
|
6896
7261
|
}
|
|
6897
7262
|
/**
|
|
6898
7263
|
* Human-readable display name for identity provider shown in login
|
|
@@ -6950,6 +7315,28 @@ declare namespace Components {
|
|
|
6950
7315
|
en: string;
|
|
6951
7316
|
};
|
|
6952
7317
|
}
|
|
7318
|
+
export interface PublicChangeEmailDetails {
|
|
7319
|
+
/**
|
|
7320
|
+
* Identifier of the hook.
|
|
7321
|
+
*/
|
|
7322
|
+
id?: string;
|
|
7323
|
+
/**
|
|
7324
|
+
* Whether the portal user must confirm their current password before the email change is handed over to the third-party system.
|
|
7325
|
+
*/
|
|
7326
|
+
require_password_confirmation?: boolean;
|
|
7327
|
+
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
7328
|
+
}
|
|
7329
|
+
export interface PublicChangePasswordDetails {
|
|
7330
|
+
/**
|
|
7331
|
+
* Identifier of the hook.
|
|
7332
|
+
*/
|
|
7333
|
+
id?: string;
|
|
7334
|
+
/**
|
|
7335
|
+
* Whether the portal user must provide a new password that is passed to the third-party system.
|
|
7336
|
+
*/
|
|
7337
|
+
require_new_password?: boolean;
|
|
7338
|
+
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
7339
|
+
}
|
|
6953
7340
|
export interface PublicContractIdentificationDetails {
|
|
6954
7341
|
/**
|
|
6955
7342
|
* Explanation of the hook.
|
|
@@ -6988,6 +7375,13 @@ declare namespace Components {
|
|
|
6988
7375
|
*/
|
|
6989
7376
|
block_types?: string[];
|
|
6990
7377
|
}
|
|
7378
|
+
export interface PublicDeleteAccountDetails {
|
|
7379
|
+
/**
|
|
7380
|
+
* Identifier of the hook.
|
|
7381
|
+
*/
|
|
7382
|
+
id?: string;
|
|
7383
|
+
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
7384
|
+
}
|
|
6991
7385
|
export interface PublicExtensionCapabilities {
|
|
6992
7386
|
consumptionDataRetrieval?: DataRetrievalItem[];
|
|
6993
7387
|
dataExport?: DataRetrievalItem[];
|
|
@@ -7002,6 +7396,21 @@ declare namespace Components {
|
|
|
7002
7396
|
extension?: PublicExtensionDetails;
|
|
7003
7397
|
hook?: PublicMeterReadingPlausibilityCheckDetails;
|
|
7004
7398
|
};
|
|
7399
|
+
changeEmail?: {
|
|
7400
|
+
app?: PublicAppDetails;
|
|
7401
|
+
extension?: PublicExtensionDetails;
|
|
7402
|
+
hook?: PublicChangeEmailDetails;
|
|
7403
|
+
};
|
|
7404
|
+
changePassword?: {
|
|
7405
|
+
app?: PublicAppDetails;
|
|
7406
|
+
extension?: PublicExtensionDetails;
|
|
7407
|
+
hook?: PublicChangePasswordDetails;
|
|
7408
|
+
};
|
|
7409
|
+
deleteAccount?: {
|
|
7410
|
+
app?: PublicAppDetails;
|
|
7411
|
+
extension?: PublicExtensionDetails;
|
|
7412
|
+
hook?: PublicDeleteAccountDetails;
|
|
7413
|
+
};
|
|
7005
7414
|
}
|
|
7006
7415
|
export interface PublicExtensionDetails {
|
|
7007
7416
|
/**
|
|
@@ -7025,6 +7434,16 @@ declare namespace Components {
|
|
|
7025
7434
|
*/
|
|
7026
7435
|
plausibility_mode?: "check" | "range";
|
|
7027
7436
|
}
|
|
7437
|
+
/**
|
|
7438
|
+
* Explanation of the hook.
|
|
7439
|
+
*/
|
|
7440
|
+
export interface PublicSelfManagementExplanation {
|
|
7441
|
+
[name: string]: string;
|
|
7442
|
+
/**
|
|
7443
|
+
* Explanation of the functionality shown to the end user.
|
|
7444
|
+
*/
|
|
7445
|
+
en: string;
|
|
7446
|
+
}
|
|
7028
7447
|
/**
|
|
7029
7448
|
* The person who recorded the reading
|
|
7030
7449
|
* example:
|
|
@@ -7679,6 +8098,11 @@ declare namespace Components {
|
|
|
7679
8098
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
7680
8099
|
*/
|
|
7681
8100
|
auto_redirect_to_sso?: boolean;
|
|
8101
|
+
/**
|
|
8102
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
8103
|
+
*
|
|
8104
|
+
*/
|
|
8105
|
+
prevent_user_enumeration?: boolean;
|
|
7682
8106
|
};
|
|
7683
8107
|
/**
|
|
7684
8108
|
* AWS Cognito Pool details for the portal
|
|
@@ -8254,6 +8678,11 @@ declare namespace Components {
|
|
|
8254
8678
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
8255
8679
|
*/
|
|
8256
8680
|
auto_redirect_to_sso?: boolean;
|
|
8681
|
+
/**
|
|
8682
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
8683
|
+
*
|
|
8684
|
+
*/
|
|
8685
|
+
prevent_user_enumeration?: boolean;
|
|
8257
8686
|
};
|
|
8258
8687
|
/**
|
|
8259
8688
|
* AWS Cognito Pool details for the portal
|
|
@@ -8929,6 +9358,26 @@ declare namespace Paths {
|
|
|
8929
9358
|
}
|
|
8930
9359
|
}
|
|
8931
9360
|
}
|
|
9361
|
+
namespace ChangePortalUserPassword {
|
|
9362
|
+
export interface RequestBody {
|
|
9363
|
+
/**
|
|
9364
|
+
* New password chosen by the portal user.
|
|
9365
|
+
* Required when the configured `changePassword` hook has `require_new_password` enabled, ignored otherwise.
|
|
9366
|
+
*
|
|
9367
|
+
*/
|
|
9368
|
+
new_password?: string;
|
|
9369
|
+
}
|
|
9370
|
+
namespace Responses {
|
|
9371
|
+
export interface $200 {
|
|
9372
|
+
message?: string;
|
|
9373
|
+
}
|
|
9374
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
9375
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
9376
|
+
export interface $404 {
|
|
9377
|
+
}
|
|
9378
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
9379
|
+
}
|
|
9380
|
+
}
|
|
8932
9381
|
namespace CheckAccountExists {
|
|
8933
9382
|
namespace Parameters {
|
|
8934
9383
|
export type Domain = string;
|
|
@@ -9264,6 +9713,30 @@ declare namespace Paths {
|
|
|
9264
9713
|
export type $500 = Components.Responses.InternalServerError;
|
|
9265
9714
|
}
|
|
9266
9715
|
}
|
|
9716
|
+
namespace CreatePortalUserEntity {
|
|
9717
|
+
namespace Parameters {
|
|
9718
|
+
/**
|
|
9719
|
+
* example:
|
|
9720
|
+
* asset
|
|
9721
|
+
*/
|
|
9722
|
+
export type Slug = "asset";
|
|
9723
|
+
}
|
|
9724
|
+
export interface PathParameters {
|
|
9725
|
+
slug: /**
|
|
9726
|
+
* example:
|
|
9727
|
+
* asset
|
|
9728
|
+
*/
|
|
9729
|
+
Parameters.Slug;
|
|
9730
|
+
}
|
|
9731
|
+
export type RequestBody = Components.Schemas.Entity;
|
|
9732
|
+
namespace Responses {
|
|
9733
|
+
export type $201 = /* Response for entity get request */ Components.Schemas.EntityResponse;
|
|
9734
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
9735
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
9736
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9737
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
9738
|
+
}
|
|
9739
|
+
}
|
|
9267
9740
|
namespace CreateUser {
|
|
9268
9741
|
namespace Parameters {
|
|
9269
9742
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -9399,7 +9872,14 @@ declare namespace Paths {
|
|
|
9399
9872
|
namespace DeletePortalUser {
|
|
9400
9873
|
namespace Responses {
|
|
9401
9874
|
export interface $200 {
|
|
9402
|
-
|
|
9875
|
+
/**
|
|
9876
|
+
* `User Succesfully Deleted` when the user was deleted, or `Account deletion requested`
|
|
9877
|
+
* when an asynchronous deleteAccount portal extension hook handed the deletion over to a third party.
|
|
9878
|
+
*
|
|
9879
|
+
* example:
|
|
9880
|
+
* User Succesfully Deleted
|
|
9881
|
+
*/
|
|
9882
|
+
message?: string;
|
|
9403
9883
|
data?: /**
|
|
9404
9884
|
* Entity ID
|
|
9405
9885
|
* example:
|
|
@@ -10869,6 +11349,23 @@ declare namespace Paths {
|
|
|
10869
11349
|
export type $500 = Components.Responses.InternalServerError;
|
|
10870
11350
|
}
|
|
10871
11351
|
}
|
|
11352
|
+
namespace GetMobileConfig {
|
|
11353
|
+
namespace Parameters {
|
|
11354
|
+
export type PortalId = string;
|
|
11355
|
+
export type Raw = boolean;
|
|
11356
|
+
}
|
|
11357
|
+
export interface QueryParameters {
|
|
11358
|
+
portal_id: Parameters.PortalId;
|
|
11359
|
+
raw?: Parameters.Raw;
|
|
11360
|
+
}
|
|
11361
|
+
namespace Responses {
|
|
11362
|
+
export type $200 = /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ Components.Schemas.MobileConfig;
|
|
11363
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11364
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11365
|
+
export type $404 = Components.Responses.NotFound;
|
|
11366
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11367
|
+
}
|
|
11368
|
+
}
|
|
10872
11369
|
namespace GetOpportunity {
|
|
10873
11370
|
namespace Parameters {
|
|
10874
11371
|
export type Id = /**
|
|
@@ -11177,6 +11674,11 @@ declare namespace Paths {
|
|
|
11177
11674
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
11178
11675
|
*/
|
|
11179
11676
|
auto_redirect_to_sso?: boolean;
|
|
11677
|
+
/**
|
|
11678
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
11679
|
+
*
|
|
11680
|
+
*/
|
|
11681
|
+
prevent_user_enumeration?: boolean;
|
|
11180
11682
|
};
|
|
11181
11683
|
/**
|
|
11182
11684
|
* AWS Cognito Pool details for the portal
|
|
@@ -11783,6 +12285,11 @@ declare namespace Paths {
|
|
|
11783
12285
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
11784
12286
|
*/
|
|
11785
12287
|
auto_redirect_to_sso?: boolean;
|
|
12288
|
+
/**
|
|
12289
|
+
* Opt-in. When true, suppresses responses that reveal whether a user exists for public, pre-authentication actions (the login entry-point check and self-registration), at the expense of some UX. Already-authenticated actions are unaffected. Default false.
|
|
12290
|
+
*
|
|
12291
|
+
*/
|
|
12292
|
+
prevent_user_enumeration?: boolean;
|
|
11786
12293
|
};
|
|
11787
12294
|
/**
|
|
11788
12295
|
* AWS Cognito Pool details for the portal
|
|
@@ -13509,6 +14016,28 @@ declare namespace Paths {
|
|
|
13509
14016
|
export type $500 = Components.Responses.InternalServerError;
|
|
13510
14017
|
}
|
|
13511
14018
|
}
|
|
14019
|
+
namespace ListEmailTemplateReferences {
|
|
14020
|
+
export interface RequestBody {
|
|
14021
|
+
/**
|
|
14022
|
+
* Email template id to find portal references for
|
|
14023
|
+
*/
|
|
14024
|
+
template_id: string;
|
|
14025
|
+
}
|
|
14026
|
+
namespace Responses {
|
|
14027
|
+
export interface $200 {
|
|
14028
|
+
portals: {
|
|
14029
|
+
id: string;
|
|
14030
|
+
/**
|
|
14031
|
+
* Portal display name (or domain); falls back to id when unavailable
|
|
14032
|
+
*/
|
|
14033
|
+
name?: string | null;
|
|
14034
|
+
}[];
|
|
14035
|
+
}
|
|
14036
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14037
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14038
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14039
|
+
}
|
|
14040
|
+
}
|
|
13512
14041
|
namespace LoginToPortalAsUser {
|
|
13513
14042
|
export interface RequestBody {
|
|
13514
14043
|
/**
|
|
@@ -13536,6 +14065,32 @@ declare namespace Paths {
|
|
|
13536
14065
|
}
|
|
13537
14066
|
}
|
|
13538
14067
|
}
|
|
14068
|
+
namespace MigrateEmailTemplateReferences {
|
|
14069
|
+
export interface RequestBody {
|
|
14070
|
+
/**
|
|
14071
|
+
* Template id currently referenced on portal rows
|
|
14072
|
+
*/
|
|
14073
|
+
source_template_id: string;
|
|
14074
|
+
/**
|
|
14075
|
+
* Template id to write in place of the source
|
|
14076
|
+
*/
|
|
14077
|
+
destination_template_id: string;
|
|
14078
|
+
}
|
|
14079
|
+
namespace Responses {
|
|
14080
|
+
export interface $200 {
|
|
14081
|
+
/**
|
|
14082
|
+
* example:
|
|
14083
|
+
* 2
|
|
14084
|
+
*/
|
|
14085
|
+
migrated_portal_count: number;
|
|
14086
|
+
migrated_portal_ids: string[];
|
|
14087
|
+
failed_portal_ids: string[];
|
|
14088
|
+
}
|
|
14089
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14090
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14091
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14092
|
+
}
|
|
14093
|
+
}
|
|
13539
14094
|
namespace NotifyMLoginInterestChange {
|
|
13540
14095
|
namespace Parameters {
|
|
13541
14096
|
export type ClientId = string;
|
|
@@ -13590,6 +14145,38 @@ declare namespace Paths {
|
|
|
13590
14145
|
export type $500 = Components.Responses.InternalServerError;
|
|
13591
14146
|
}
|
|
13592
14147
|
}
|
|
14148
|
+
namespace PatchPortalUserEntity {
|
|
14149
|
+
namespace Parameters {
|
|
14150
|
+
export type Id = /**
|
|
14151
|
+
* Entity ID
|
|
14152
|
+
* example:
|
|
14153
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
14154
|
+
*/
|
|
14155
|
+
Components.Schemas.EntityId /* uuid */;
|
|
14156
|
+
/**
|
|
14157
|
+
* example:
|
|
14158
|
+
* asset
|
|
14159
|
+
*/
|
|
14160
|
+
export type Slug = "asset";
|
|
14161
|
+
}
|
|
14162
|
+
export interface PathParameters {
|
|
14163
|
+
slug: /**
|
|
14164
|
+
* example:
|
|
14165
|
+
* asset
|
|
14166
|
+
*/
|
|
14167
|
+
Parameters.Slug;
|
|
14168
|
+
id: Parameters.Id;
|
|
14169
|
+
}
|
|
14170
|
+
export type RequestBody = Components.Schemas.Entity;
|
|
14171
|
+
namespace Responses {
|
|
14172
|
+
export type $200 = /* Response for entity get request */ Components.Schemas.EntityResponse;
|
|
14173
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
14174
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14175
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14176
|
+
export type $404 = Components.Responses.NotFound;
|
|
14177
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14178
|
+
}
|
|
14179
|
+
}
|
|
13593
14180
|
namespace PortalProxyExecute {
|
|
13594
14181
|
export interface RequestBody {
|
|
13595
14182
|
/**
|
|
@@ -13711,8 +14298,26 @@ declare namespace Paths {
|
|
|
13711
14298
|
export type $500 = Components.Responses.InternalServerError;
|
|
13712
14299
|
}
|
|
13713
14300
|
}
|
|
14301
|
+
namespace PutMobileConfig {
|
|
14302
|
+
namespace Parameters {
|
|
14303
|
+
export type PortalId = string;
|
|
14304
|
+
}
|
|
14305
|
+
export interface QueryParameters {
|
|
14306
|
+
portal_id: Parameters.PortalId;
|
|
14307
|
+
}
|
|
14308
|
+
export type RequestBody = /* Editable mobile fields for PUT. Only mobile-relevant settings + app branding can be changed. Portal-derived values (display_name, app_host), the portal logo, and system-written fields (credentials_status, app_store_id, last_build, …) are ignored if sent. */ Components.Schemas.MobileConfigUpdate;
|
|
14309
|
+
namespace Responses {
|
|
14310
|
+
export type $200 = /* Mobile app configuration for the portal. Stored inside the portal's config object. Identifiers/branding are non-secret; signing credentials live in a secure store, never here. */ Components.Schemas.MobileConfig;
|
|
14311
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
14312
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14313
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14314
|
+
export type $404 = Components.Responses.NotFound;
|
|
14315
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14316
|
+
}
|
|
14317
|
+
}
|
|
13714
14318
|
namespace PutPortalConfig {
|
|
13715
14319
|
namespace Parameters {
|
|
14320
|
+
export type PageUpsertMode = "id" | "slug";
|
|
13716
14321
|
/**
|
|
13717
14322
|
* example:
|
|
13718
14323
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
@@ -13726,6 +14331,9 @@ declare namespace Paths {
|
|
|
13726
14331
|
*/
|
|
13727
14332
|
Parameters.PortalId /* uuid */;
|
|
13728
14333
|
}
|
|
14334
|
+
export interface QueryParameters {
|
|
14335
|
+
page_upsert_mode?: Parameters.PageUpsertMode;
|
|
14336
|
+
}
|
|
13729
14337
|
export type RequestBody = Components.Schemas.PortalConfigV3;
|
|
13730
14338
|
namespace Responses {
|
|
13731
14339
|
export type $200 = Components.Schemas.PortalConfigV3;
|
|
@@ -14524,13 +15132,23 @@ declare namespace Paths {
|
|
|
14524
15132
|
*/
|
|
14525
15133
|
email: string;
|
|
14526
15134
|
/**
|
|
14527
|
-
* Password of the portal user for confirmation
|
|
15135
|
+
* Password of the portal user for confirmation.
|
|
15136
|
+
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal.
|
|
15137
|
+
*
|
|
14528
15138
|
*/
|
|
14529
|
-
password
|
|
15139
|
+
password?: string;
|
|
14530
15140
|
}
|
|
14531
15141
|
namespace Responses {
|
|
14532
15142
|
export interface $200 {
|
|
14533
|
-
|
|
15143
|
+
/**
|
|
15144
|
+
* `You will receive a confirmation mail soon on your updated email address.` for the built-in flow,
|
|
15145
|
+
* or `Your email change request has been received.` when a changeEmail portal extension hook handed
|
|
15146
|
+
* the change over to a third party.
|
|
15147
|
+
*
|
|
15148
|
+
* example:
|
|
15149
|
+
* You will receive a confirmation mail soon on your updated email address.
|
|
15150
|
+
*/
|
|
15151
|
+
message?: string;
|
|
14534
15152
|
}
|
|
14535
15153
|
export type $400 = Components.Responses.InvalidRequest;
|
|
14536
15154
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -15324,6 +15942,38 @@ interface OperationMethods {
|
|
|
15324
15942
|
data?: Paths.UpsertEmailTemplates.RequestBody,
|
|
15325
15943
|
config?: AxiosRequestConfig
|
|
15326
15944
|
): OperationResponse<Paths.UpsertEmailTemplates.Responses.$200>
|
|
15945
|
+
/**
|
|
15946
|
+
* migrateEmailTemplateReferences - migrateEmailTemplateReferences
|
|
15947
|
+
*
|
|
15948
|
+
* Walk every email-template config row in the caller's org and re-point any
|
|
15949
|
+
* field on `email_templates` that currently references `source_template_id`
|
|
15950
|
+
* at `destination_template_id`. Intended to be called from the email-template
|
|
15951
|
+
* migration flow when a duplicated template is refined.
|
|
15952
|
+
*
|
|
15953
|
+
* Only v3-shaped rows are migrated (those carrying `portal_sk_v3`). Returns
|
|
15954
|
+
* the portal IDs that were rewritten and any whose update failed.
|
|
15955
|
+
*
|
|
15956
|
+
*/
|
|
15957
|
+
'migrateEmailTemplateReferences'(
|
|
15958
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15959
|
+
data?: Paths.MigrateEmailTemplateReferences.RequestBody,
|
|
15960
|
+
config?: AxiosRequestConfig
|
|
15961
|
+
): OperationResponse<Paths.MigrateEmailTemplateReferences.Responses.$200>
|
|
15962
|
+
/**
|
|
15963
|
+
* listEmailTemplateReferences - listEmailTemplateReferences
|
|
15964
|
+
*
|
|
15965
|
+
* Read-only sibling of migrateEmailTemplateReferences. Lists every portal in
|
|
15966
|
+
* the caller's org whose `email_templates` config references `template_id`,
|
|
15967
|
+
* without rewriting anything. Used by the email-template MFE to show which
|
|
15968
|
+
* portals a template affects (in template settings and as a pre-migrate
|
|
15969
|
+
* preview). Uses the same discovery as the migrate path.
|
|
15970
|
+
*
|
|
15971
|
+
*/
|
|
15972
|
+
'listEmailTemplateReferences'(
|
|
15973
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15974
|
+
data?: Paths.ListEmailTemplateReferences.RequestBody,
|
|
15975
|
+
config?: AxiosRequestConfig
|
|
15976
|
+
): OperationResponse<Paths.ListEmailTemplateReferences.Responses.$200>
|
|
15327
15977
|
/**
|
|
15328
15978
|
* getEmailTemplatesByPortalId - getEmailTemplatesByPortalId
|
|
15329
15979
|
*
|
|
@@ -15630,6 +16280,18 @@ interface OperationMethods {
|
|
|
15630
16280
|
data?: Paths.UpdatePortalUserEmail.RequestBody,
|
|
15631
16281
|
config?: AxiosRequestConfig
|
|
15632
16282
|
): OperationResponse<Paths.UpdatePortalUserEmail.Responses.$200>
|
|
16283
|
+
/**
|
|
16284
|
+
* changePortalUserPassword - changePortalUserPassword
|
|
16285
|
+
*
|
|
16286
|
+
* Hand over a password change to the third-party system configured via the `changePassword` portal extension hook.
|
|
16287
|
+
* Only available when such a hook is configured for the portal; the built-in password change flow does not use this endpoint.
|
|
16288
|
+
*
|
|
16289
|
+
*/
|
|
16290
|
+
'changePortalUserPassword'(
|
|
16291
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16292
|
+
data?: Paths.ChangePortalUserPassword.RequestBody,
|
|
16293
|
+
config?: AxiosRequestConfig
|
|
16294
|
+
): OperationResponse<Paths.ChangePortalUserPassword.Responses.$200>
|
|
15633
16295
|
/**
|
|
15634
16296
|
* resendConfirmationEmail - resendConfirmationEmail
|
|
15635
16297
|
*
|
|
@@ -16089,6 +16751,28 @@ interface OperationMethods {
|
|
|
16089
16751
|
data?: Paths.SearchPortalUserEntities.RequestBody,
|
|
16090
16752
|
config?: AxiosRequestConfig
|
|
16091
16753
|
): OperationResponse<Paths.SearchPortalUserEntities.Responses.$200>
|
|
16754
|
+
/**
|
|
16755
|
+
* createPortalUserEntity - createPortalUserEntity
|
|
16756
|
+
*
|
|
16757
|
+
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
|
|
16758
|
+
* Create a single entity on behalf of a portal user. The schema slug is passed in the path and must be one of the supported (experimental) schemas; field-level permissions are enforced by the caller's role grants. The request body is the entity to create (its attributes); the created entity is automatically related to the caller's contact.
|
|
16759
|
+
*/
|
|
16760
|
+
'createPortalUserEntity'(
|
|
16761
|
+
parameters?: Parameters<Paths.CreatePortalUserEntity.PathParameters> | null,
|
|
16762
|
+
data?: Paths.CreatePortalUserEntity.RequestBody,
|
|
16763
|
+
config?: AxiosRequestConfig
|
|
16764
|
+
): OperationResponse<Paths.CreatePortalUserEntity.Responses.$201>
|
|
16765
|
+
/**
|
|
16766
|
+
* patchPortalUserEntity - patchPortalUserEntity
|
|
16767
|
+
*
|
|
16768
|
+
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
|
|
16769
|
+
* Partially update a single entity on behalf of a portal user. The schema slug and entity id are passed in the path; the schema must be one of the supported (experimental) schemas. Field-level permissions are enforced by the caller's role grants (use null to clear a field, e.g. external_id). The target entity must already be owned by the caller's contact.
|
|
16770
|
+
*/
|
|
16771
|
+
'patchPortalUserEntity'(
|
|
16772
|
+
parameters?: Parameters<Paths.PatchPortalUserEntity.PathParameters> | null,
|
|
16773
|
+
data?: Paths.PatchPortalUserEntity.RequestBody,
|
|
16774
|
+
config?: AxiosRequestConfig
|
|
16775
|
+
): OperationResponse<Paths.PatchPortalUserEntity.Responses.$200>
|
|
16092
16776
|
/**
|
|
16093
16777
|
* canTriggerPortalFlow - canTriggerPortalFlow
|
|
16094
16778
|
*
|
|
@@ -16473,7 +17157,7 @@ interface OperationMethods {
|
|
|
16473
17157
|
* Updates a specific portal configuration by ID.
|
|
16474
17158
|
*/
|
|
16475
17159
|
'putPortalConfig'(
|
|
16476
|
-
parameters?: Parameters<Paths.PutPortalConfig.PathParameters> | null,
|
|
17160
|
+
parameters?: Parameters<Paths.PutPortalConfig.QueryParameters & Paths.PutPortalConfig.PathParameters> | null,
|
|
16477
17161
|
data?: Paths.PutPortalConfig.RequestBody,
|
|
16478
17162
|
config?: AxiosRequestConfig
|
|
16479
17163
|
): OperationResponse<Paths.PutPortalConfig.Responses.$200>
|
|
@@ -16599,6 +17283,29 @@ interface OperationMethods {
|
|
|
16599
17283
|
data?: Paths.PortalProxyExecute.RequestBody,
|
|
16600
17284
|
config?: AxiosRequestConfig
|
|
16601
17285
|
): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
|
|
17286
|
+
/**
|
|
17287
|
+
* getMobileConfig - getMobileConfig
|
|
17288
|
+
*
|
|
17289
|
+
* Returns the portal's mobile app configuration. By default the response is build-ready (resolved): base info (display_name from the portal name, app_host from the domain, environment) and branding (logo from the portal images, colors from the design palette) are filled in. Pass raw=true to get only the stored mobile_config without resolution.
|
|
17290
|
+
*/
|
|
17291
|
+
'getMobileConfig'(
|
|
17292
|
+
parameters?: Parameters<Paths.GetMobileConfig.QueryParameters> | null,
|
|
17293
|
+
data?: any,
|
|
17294
|
+
config?: AxiosRequestConfig
|
|
17295
|
+
): OperationResponse<Paths.GetMobileConfig.Responses.$200>
|
|
17296
|
+
/**
|
|
17297
|
+
* putMobileConfig - putMobileConfig
|
|
17298
|
+
*
|
|
17299
|
+
* Merges the provided fields into the portal's mobile app configuration
|
|
17300
|
+
* (deep merge). Only mobile_config is modified; all other portal settings
|
|
17301
|
+
* are left untouched.
|
|
17302
|
+
*
|
|
17303
|
+
*/
|
|
17304
|
+
'putMobileConfig'(
|
|
17305
|
+
parameters?: Parameters<Paths.PutMobileConfig.QueryParameters> | null,
|
|
17306
|
+
data?: Paths.PutMobileConfig.RequestBody,
|
|
17307
|
+
config?: AxiosRequestConfig
|
|
17308
|
+
): OperationResponse<Paths.PutMobileConfig.Responses.$200>
|
|
16602
17309
|
}
|
|
16603
17310
|
|
|
16604
17311
|
interface PathsDictionary {
|
|
@@ -16956,6 +17663,42 @@ interface PathsDictionary {
|
|
|
16956
17663
|
config?: AxiosRequestConfig
|
|
16957
17664
|
): OperationResponse<Paths.GetEmailTemplates.Responses.$200>
|
|
16958
17665
|
}
|
|
17666
|
+
['/v3/portal/email-templates:migrate-references']: {
|
|
17667
|
+
/**
|
|
17668
|
+
* migrateEmailTemplateReferences - migrateEmailTemplateReferences
|
|
17669
|
+
*
|
|
17670
|
+
* Walk every email-template config row in the caller's org and re-point any
|
|
17671
|
+
* field on `email_templates` that currently references `source_template_id`
|
|
17672
|
+
* at `destination_template_id`. Intended to be called from the email-template
|
|
17673
|
+
* migration flow when a duplicated template is refined.
|
|
17674
|
+
*
|
|
17675
|
+
* Only v3-shaped rows are migrated (those carrying `portal_sk_v3`). Returns
|
|
17676
|
+
* the portal IDs that were rewritten and any whose update failed.
|
|
17677
|
+
*
|
|
17678
|
+
*/
|
|
17679
|
+
'post'(
|
|
17680
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
17681
|
+
data?: Paths.MigrateEmailTemplateReferences.RequestBody,
|
|
17682
|
+
config?: AxiosRequestConfig
|
|
17683
|
+
): OperationResponse<Paths.MigrateEmailTemplateReferences.Responses.$200>
|
|
17684
|
+
}
|
|
17685
|
+
['/v3/portal/email-templates:list-references']: {
|
|
17686
|
+
/**
|
|
17687
|
+
* listEmailTemplateReferences - listEmailTemplateReferences
|
|
17688
|
+
*
|
|
17689
|
+
* Read-only sibling of migrateEmailTemplateReferences. Lists every portal in
|
|
17690
|
+
* the caller's org whose `email_templates` config references `template_id`,
|
|
17691
|
+
* without rewriting anything. Used by the email-template MFE to show which
|
|
17692
|
+
* portals a template affects (in template settings and as a pre-migrate
|
|
17693
|
+
* preview). Uses the same discovery as the migrate path.
|
|
17694
|
+
*
|
|
17695
|
+
*/
|
|
17696
|
+
'post'(
|
|
17697
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
17698
|
+
data?: Paths.ListEmailTemplateReferences.RequestBody,
|
|
17699
|
+
config?: AxiosRequestConfig
|
|
17700
|
+
): OperationResponse<Paths.ListEmailTemplateReferences.Responses.$200>
|
|
17701
|
+
}
|
|
16959
17702
|
['/v3/portal/email-templates/{portal_id}']: {
|
|
16960
17703
|
/**
|
|
16961
17704
|
* upsertEmailTemplatesByPortalId - upsertEmailTemplatesByPortalId
|
|
@@ -17308,6 +18051,20 @@ interface PathsDictionary {
|
|
|
17308
18051
|
config?: AxiosRequestConfig
|
|
17309
18052
|
): OperationResponse<Paths.UpdatePortalUserEmail.Responses.$200>
|
|
17310
18053
|
}
|
|
18054
|
+
['/v2/portal/user/change/password']: {
|
|
18055
|
+
/**
|
|
18056
|
+
* changePortalUserPassword - changePortalUserPassword
|
|
18057
|
+
*
|
|
18058
|
+
* Hand over a password change to the third-party system configured via the `changePassword` portal extension hook.
|
|
18059
|
+
* Only available when such a hook is configured for the portal; the built-in password change flow does not use this endpoint.
|
|
18060
|
+
*
|
|
18061
|
+
*/
|
|
18062
|
+
'put'(
|
|
18063
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
18064
|
+
data?: Paths.ChangePortalUserPassword.RequestBody,
|
|
18065
|
+
config?: AxiosRequestConfig
|
|
18066
|
+
): OperationResponse<Paths.ChangePortalUserPassword.Responses.$200>
|
|
18067
|
+
}
|
|
17311
18068
|
['/v2/portal/user/resend/confirmation-email/{id}']: {
|
|
17312
18069
|
/**
|
|
17313
18070
|
* resendConfirmationEmail - resendConfirmationEmail
|
|
@@ -17847,6 +18604,32 @@ interface PathsDictionary {
|
|
|
17847
18604
|
config?: AxiosRequestConfig
|
|
17848
18605
|
): OperationResponse<Paths.SearchPortalUserEntities.Responses.$200>
|
|
17849
18606
|
}
|
|
18607
|
+
['/v2/portal/entity/{slug}']: {
|
|
18608
|
+
/**
|
|
18609
|
+
* createPortalUserEntity - createPortalUserEntity
|
|
18610
|
+
*
|
|
18611
|
+
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
|
|
18612
|
+
* Create a single entity on behalf of a portal user. The schema slug is passed in the path and must be one of the supported (experimental) schemas; field-level permissions are enforced by the caller's role grants. The request body is the entity to create (its attributes); the created entity is automatically related to the caller's contact.
|
|
18613
|
+
*/
|
|
18614
|
+
'post'(
|
|
18615
|
+
parameters?: Parameters<Paths.CreatePortalUserEntity.PathParameters> | null,
|
|
18616
|
+
data?: Paths.CreatePortalUserEntity.RequestBody,
|
|
18617
|
+
config?: AxiosRequestConfig
|
|
18618
|
+
): OperationResponse<Paths.CreatePortalUserEntity.Responses.$201>
|
|
18619
|
+
}
|
|
18620
|
+
['/v2/portal/entity/{slug}/{id}']: {
|
|
18621
|
+
/**
|
|
18622
|
+
* patchPortalUserEntity - patchPortalUserEntity
|
|
18623
|
+
*
|
|
18624
|
+
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
|
|
18625
|
+
* Partially update a single entity on behalf of a portal user. The schema slug and entity id are passed in the path; the schema must be one of the supported (experimental) schemas. Field-level permissions are enforced by the caller's role grants (use null to clear a field, e.g. external_id). The target entity must already be owned by the caller's contact.
|
|
18626
|
+
*/
|
|
18627
|
+
'patch'(
|
|
18628
|
+
parameters?: Parameters<Paths.PatchPortalUserEntity.PathParameters> | null,
|
|
18629
|
+
data?: Paths.PatchPortalUserEntity.RequestBody,
|
|
18630
|
+
config?: AxiosRequestConfig
|
|
18631
|
+
): OperationResponse<Paths.PatchPortalUserEntity.Responses.$200>
|
|
18632
|
+
}
|
|
17850
18633
|
['/v2/portal/can-trigger-portal-flow']: {
|
|
17851
18634
|
/**
|
|
17852
18635
|
* canTriggerPortalFlow - canTriggerPortalFlow
|
|
@@ -18286,7 +19069,7 @@ interface PathsDictionary {
|
|
|
18286
19069
|
* Updates a specific portal configuration by ID.
|
|
18287
19070
|
*/
|
|
18288
19071
|
'put'(
|
|
18289
|
-
parameters?: Parameters<Paths.PutPortalConfig.PathParameters> | null,
|
|
19072
|
+
parameters?: Parameters<Paths.PutPortalConfig.QueryParameters & Paths.PutPortalConfig.PathParameters> | null,
|
|
18290
19073
|
data?: Paths.PutPortalConfig.RequestBody,
|
|
18291
19074
|
config?: AxiosRequestConfig
|
|
18292
19075
|
): OperationResponse<Paths.PutPortalConfig.Responses.$200>
|
|
@@ -18435,6 +19218,31 @@ interface PathsDictionary {
|
|
|
18435
19218
|
config?: AxiosRequestConfig
|
|
18436
19219
|
): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
|
|
18437
19220
|
}
|
|
19221
|
+
['/v1/portal/mobile-config']: {
|
|
19222
|
+
/**
|
|
19223
|
+
* getMobileConfig - getMobileConfig
|
|
19224
|
+
*
|
|
19225
|
+
* Returns the portal's mobile app configuration. By default the response is build-ready (resolved): base info (display_name from the portal name, app_host from the domain, environment) and branding (logo from the portal images, colors from the design palette) are filled in. Pass raw=true to get only the stored mobile_config without resolution.
|
|
19226
|
+
*/
|
|
19227
|
+
'get'(
|
|
19228
|
+
parameters?: Parameters<Paths.GetMobileConfig.QueryParameters> | null,
|
|
19229
|
+
data?: any,
|
|
19230
|
+
config?: AxiosRequestConfig
|
|
19231
|
+
): OperationResponse<Paths.GetMobileConfig.Responses.$200>
|
|
19232
|
+
/**
|
|
19233
|
+
* putMobileConfig - putMobileConfig
|
|
19234
|
+
*
|
|
19235
|
+
* Merges the provided fields into the portal's mobile app configuration
|
|
19236
|
+
* (deep merge). Only mobile_config is modified; all other portal settings
|
|
19237
|
+
* are left untouched.
|
|
19238
|
+
*
|
|
19239
|
+
*/
|
|
19240
|
+
'put'(
|
|
19241
|
+
parameters?: Parameters<Paths.PutMobileConfig.QueryParameters> | null,
|
|
19242
|
+
data?: Paths.PutMobileConfig.RequestBody,
|
|
19243
|
+
config?: AxiosRequestConfig
|
|
19244
|
+
): OperationResponse<Paths.PutMobileConfig.Responses.$200>
|
|
19245
|
+
}
|
|
18438
19246
|
}
|
|
18439
19247
|
|
|
18440
19248
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -18504,10 +19312,13 @@ type Extension = Components.Schemas.Extension;
|
|
|
18504
19312
|
type ExtensionAuthBlock = Components.Schemas.ExtensionAuthBlock;
|
|
18505
19313
|
type ExtensionConfig = Components.Schemas.ExtensionConfig;
|
|
18506
19314
|
type ExtensionHook = Components.Schemas.ExtensionHook;
|
|
19315
|
+
type ExtensionHookChangeEmail = Components.Schemas.ExtensionHookChangeEmail;
|
|
19316
|
+
type ExtensionHookChangePassword = Components.Schemas.ExtensionHookChangePassword;
|
|
18507
19317
|
type ExtensionHookConsumptionDataRetrieval = Components.Schemas.ExtensionHookConsumptionDataRetrieval;
|
|
18508
19318
|
type ExtensionHookContractIdentification = Components.Schemas.ExtensionHookContractIdentification;
|
|
18509
19319
|
type ExtensionHookCostDataRetrieval = Components.Schemas.ExtensionHookCostDataRetrieval;
|
|
18510
19320
|
type ExtensionHookDataExport = Components.Schemas.ExtensionHookDataExport;
|
|
19321
|
+
type ExtensionHookDeleteAccount = Components.Schemas.ExtensionHookDeleteAccount;
|
|
18511
19322
|
type ExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.ExtensionHookMeterReadingPlausibilityCheck;
|
|
18512
19323
|
type ExtensionHookPriceDataRetrieval = Components.Schemas.ExtensionHookPriceDataRetrieval;
|
|
18513
19324
|
type ExtensionHookRegistrationIdentifiersCheck = Components.Schemas.ExtensionHookRegistrationIdentifiersCheck;
|
|
@@ -18530,6 +19341,10 @@ type MeterReading = Components.Schemas.MeterReading;
|
|
|
18530
19341
|
type MeterReadingPhoto = Components.Schemas.MeterReadingPhoto;
|
|
18531
19342
|
type MeterReadingPhotoData = Components.Schemas.MeterReadingPhotoData;
|
|
18532
19343
|
type MeterReadingWidget = Components.Schemas.MeterReadingWidget;
|
|
19344
|
+
type MobileBranding = Components.Schemas.MobileBranding;
|
|
19345
|
+
type MobileBuildStatus = Components.Schemas.MobileBuildStatus;
|
|
19346
|
+
type MobileConfig = Components.Schemas.MobileConfig;
|
|
19347
|
+
type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
|
|
18533
19348
|
type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
18534
19349
|
type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
18535
19350
|
type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
@@ -18553,11 +19368,15 @@ type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
|
18553
19368
|
type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
18554
19369
|
type ProviderSlug = Components.Schemas.ProviderSlug;
|
|
18555
19370
|
type PublicAppDetails = Components.Schemas.PublicAppDetails;
|
|
19371
|
+
type PublicChangeEmailDetails = Components.Schemas.PublicChangeEmailDetails;
|
|
19372
|
+
type PublicChangePasswordDetails = Components.Schemas.PublicChangePasswordDetails;
|
|
18556
19373
|
type PublicContractIdentificationDetails = Components.Schemas.PublicContractIdentificationDetails;
|
|
18557
19374
|
type PublicDataRetrievalHookDetails = Components.Schemas.PublicDataRetrievalHookDetails;
|
|
19375
|
+
type PublicDeleteAccountDetails = Components.Schemas.PublicDeleteAccountDetails;
|
|
18558
19376
|
type PublicExtensionCapabilities = Components.Schemas.PublicExtensionCapabilities;
|
|
18559
19377
|
type PublicExtensionDetails = Components.Schemas.PublicExtensionDetails;
|
|
18560
19378
|
type PublicMeterReadingPlausibilityCheckDetails = Components.Schemas.PublicMeterReadingPlausibilityCheckDetails;
|
|
19379
|
+
type PublicSelfManagementExplanation = Components.Schemas.PublicSelfManagementExplanation;
|
|
18561
19380
|
type ReadBy = Components.Schemas.ReadBy;
|
|
18562
19381
|
type ReadingStatus = Components.Schemas.ReadingStatus;
|
|
18563
19382
|
type Reason = Components.Schemas.Reason;
|
|
@@ -18592,4 +19411,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
|
|
18592
19411
|
type WorkflowExecution = Components.Schemas.WorkflowExecution;
|
|
18593
19412
|
type WorkflowStep = Components.Schemas.WorkflowStep;
|
|
18594
19413
|
|
|
18595
|
-
export { type EntityItem as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributesV3 as D, type Contact as E, type ContactCountRequest as F, type ContactExistsRequest as G, type ContentWidget as H, type ContextEntities as I, type ContextEntity as J, type Contract as K, type ContractIdentifier as L, type CreateUserRequest as M, type Currency as N, type OperationMethods as O, Paths as P, type DataRetrievalItem as Q, DeleteEntityFile as R, type Direction as S, type DocumentWidget as T, type DomainSettings as U, type EmailTemplates as V, type Entity as W, type EntityEditRule as X, type EntityFileCount as Y, type EntityGetParams as Z, type EntityId as _, Components as a, type
|
|
19414
|
+
export { type EntityItem as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributesV3 as D, type Contact as E, type ContactCountRequest as F, type ContactExistsRequest as G, type ContentWidget as H, type ContextEntities as I, type ContextEntity as J, type Contract as K, type ContractIdentifier as L, type CreateUserRequest as M, type Currency as N, type OperationMethods as O, Paths as P, type DataRetrievalItem as Q, DeleteEntityFile as R, type Direction as S, type DocumentWidget as T, type DomainSettings as U, type EmailTemplates as V, type Entity as W, type EntityEditRule as X, type EntityFileCount as Y, type EntityGetParams as Z, type EntityId as _, Components as a, type PortalWidget as a$, type EntityMatchingConfig as a0, type EntityResponse as a1, type EntityResponseGroupedWithHits as a2, type EntityResponseWithHits as a3, type EntitySearchParams as a4, type EntitySlug as a5, type EntitySlugConfig as a6, type EntityTemplates as a7, type EntityWidget as a8, type ErrorResp as a9, type JourneyActions as aA, type JuiceSettings as aB, type Meter as aC, type MeterChartWidget as aD, type MeterReading as aE, type MeterReadingPhoto as aF, type MeterReadingPhotoData as aG, type MeterReadingWidget as aH, type MobileBranding as aI, type MobileBuildStatus as aJ, type MobileConfig as aK, type MobileConfigUpdate as aL, type MoblieOIDCConfig as aM, type OIDCProviderConfig as aN, type OIDCProviderMetadata as aO, type Opportunity as aP, type Order as aQ, type OrganizationSettings as aR, type Origin as aS, type Page as aT, type PageRequest as aU, type PaymentWidget as aV, type PortalConfig as aW, type PortalConfigV3 as aX, type PortalId as aY, type PortalUser as aZ, type PortalUserRegistrationStatus as a_, type Exists as aa, type Extension as ab, type ExtensionAuthBlock as ac, type ExtensionConfig as ad, type ExtensionHook as ae, type ExtensionHookChangeEmail as af, type ExtensionHookChangePassword as ag, type ExtensionHookConsumptionDataRetrieval as ah, type ExtensionHookContractIdentification as ai, type ExtensionHookCostDataRetrieval as aj, type ExtensionHookDataExport as ak, type ExtensionHookDeleteAccount as al, type ExtensionHookMeterReadingPlausibilityCheck as am, type ExtensionHookPriceDataRetrieval as an, type ExtensionHookRegistrationIdentifiersCheck as ao, type ExtensionHookSelection as ap, type ExtensionHookVisualizationMetadata as aq, type ExtensionSeamlessLink as ar, type ExternalLink as as, type ExtraSchemaAttributes as at, type FailedRuleErrorResp as au, type File as av, type FileItem as aw, type Grant as ax, type IdentifierAttribute as ay, type InstallmentEvent as az, type PathsDictionary as b, type Product as b0, type ProductRecommendationsWidget as b1, type ProviderConfig as b2, type ProviderDisplayName as b3, type ProviderPublicConfig as b4, type ProviderSlug as b5, type PublicAppDetails as b6, type PublicChangeEmailDetails as b7, type PublicChangePasswordDetails as b8, type PublicContractIdentificationDetails as b9, type UpdateOnlyPortalConfigAttributes as bA, type UpsertPortalConfig as bB, type UpsertPortalConfigV3 as bC, UpsertPortalWidget as bD, type UserRequest as bE, type VisualizationDataRange as bF, type VisualizationMetadata as bG, type VisualizationTypeOption as bH, type WidgetAction as bI, type WidgetBase as bJ, type WorfklowIdentifier as bK, type WorkflowExecution as bL, type WorkflowStep as bM, type PublicDataRetrievalHookDetails as ba, type PublicDeleteAccountDetails as bb, type PublicExtensionCapabilities as bc, type PublicExtensionDetails as bd, type PublicMeterReadingPlausibilityCheckDetails as be, type PublicSelfManagementExplanation as bf, type ReadBy as bg, type ReadingStatus as bh, type Reason as bi, type RegistrationIdentifier as bj, type ReimbursementEvent as bk, type Rule as bl, type SAMLProviderConfig as bm, type SSOCallbackRequest as bn, type SSOCallbackResponse as bo, type SSOLoginToken as bp, SaveEntityFile as bq, type SavePortalFile as br, type Schema as bs, type SearchIncludes as bt, type SecureProxyConfig as bu, type Source as bv, type SwappableConfig as bw, type TariffType as bx, type TeaserWidget as by, type TriggerPortalFlow as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdditionalContactAttribute as j, type AdminUser as k, type AllowedFileExtensions as l, type AttributeMappingConfig as m, type AuthConfig as n, type BaseBillingEvent as o, type BaseEntity as p, type BillingAccount as q, type BillingEvent as r, type Block as s, type BlockId as t, type BlockProps as u, type BlockRequest as v, type BlockType as w, type BusinessPartnerItem as x, type CampaignWidget as y, type CommonConfigAttributes as z };
|