@epilot/sdk 2.10.1 → 2.10.3
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 +1180 -45
- package/definitions/focus-pocus-runtime.json +1 -0
- package/definitions/focus-pocus.json +757 -0
- 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 +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 +6 -6
- package/dist/apis/file.js +1 -1
- 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 +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/{chunk-HB6KHEKG.cjs → chunk-ESCPKTPT.cjs} +2 -2
- package/dist/chunk-JBPITLKN.cjs +14 -0
- package/dist/{chunk-H3ZV5T3V.js → chunk-K732EC6B.js} +2 -2
- package/dist/chunk-LSMVZMBY.js +14 -0
- package/dist/customer-portal-EJBJ4BNI.cjs +7 -0
- package/dist/customer-portal-ZVST2CTU.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-JUlTCfGt.d.cts} +852 -8
- package/dist/{customer-portal.d-BRwiQehb.d.ts → customer-portal.d-JUlTCfGt.d.ts} +852 -8
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/docs/customer-portal.md +709 -35
- package/package.json +12 -11
- package/dist/chunk-5ZXGKLB6.cjs +0 -14
- package/dist/chunk-774ASAAH.js +0 -14
- package/dist/customer-portal-4DXHY42V.js +0 -7
- package/dist/customer-portal-5OSGSYGF.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
|
|
@@ -2050,6 +2060,15 @@ declare namespace Components {
|
|
|
2050
2060
|
[name: string]: string;
|
|
2051
2061
|
};
|
|
2052
2062
|
};
|
|
2063
|
+
/**
|
|
2064
|
+
* Whether to (re)trigger the registration identifiers check hook, which issues a request
|
|
2065
|
+
* to the connected ERP to (re)sync the contact, in addition to waiting for the entity to
|
|
2066
|
+
* arrive. Defaults to true to preserve existing behaviour. Set to false on retry attempts
|
|
2067
|
+
* to only poll for an already-triggered sync to land, without issuing another upstream
|
|
2068
|
+
* request to the ERP.
|
|
2069
|
+
*
|
|
2070
|
+
*/
|
|
2071
|
+
trigger_identifiers_check?: boolean;
|
|
2053
2072
|
}
|
|
2054
2073
|
export interface ContentWidget {
|
|
2055
2074
|
id: string;
|
|
@@ -3463,7 +3482,32 @@ declare namespace Components {
|
|
|
3463
3482
|
* 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
3483
|
*
|
|
3465
3484
|
*/
|
|
3466
|
-
ExtensionHookVisualizationMetadata
|
|
3485
|
+
ExtensionHookVisualizationMetadata | /**
|
|
3486
|
+
* 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).
|
|
3487
|
+
* The expected response http status code to the call is:
|
|
3488
|
+
* - 2xx if the request was accepted
|
|
3489
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3490
|
+
*
|
|
3491
|
+
*/
|
|
3492
|
+
ExtensionHookChangeEmail | /**
|
|
3493
|
+
* 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).
|
|
3494
|
+
* The expected response http status code to the call is:
|
|
3495
|
+
* - 2xx if the request was accepted
|
|
3496
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3497
|
+
*
|
|
3498
|
+
*/
|
|
3499
|
+
ExtensionHookChangePassword | /**
|
|
3500
|
+
* 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.
|
|
3501
|
+
* The `deletion_mode` controls what the portal does after the call:
|
|
3502
|
+
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.
|
|
3503
|
+
* - `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).
|
|
3504
|
+
*
|
|
3505
|
+
* The expected response http status code to the call is:
|
|
3506
|
+
* - 2xx if the request was accepted
|
|
3507
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3508
|
+
*
|
|
3509
|
+
*/
|
|
3510
|
+
ExtensionHookDeleteAccount))[];
|
|
3467
3511
|
}
|
|
3468
3512
|
export interface ExtensionAuthBlock {
|
|
3469
3513
|
/**
|
|
@@ -3529,6 +3573,140 @@ declare namespace Components {
|
|
|
3529
3573
|
*/
|
|
3530
3574
|
id?: string;
|
|
3531
3575
|
}
|
|
3576
|
+
/**
|
|
3577
|
+
* 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).
|
|
3578
|
+
* The expected response http status code to the call is:
|
|
3579
|
+
* - 2xx if the request was accepted
|
|
3580
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3581
|
+
*
|
|
3582
|
+
*/
|
|
3583
|
+
export interface ExtensionHookChangeEmail {
|
|
3584
|
+
type: "changeEmail";
|
|
3585
|
+
/**
|
|
3586
|
+
* 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.
|
|
3587
|
+
*
|
|
3588
|
+
*/
|
|
3589
|
+
require_password_confirmation?: boolean;
|
|
3590
|
+
/**
|
|
3591
|
+
* Optional explanation shown to the user in the change email confirmation dialog.
|
|
3592
|
+
*/
|
|
3593
|
+
explanation?: {
|
|
3594
|
+
[name: string]: string;
|
|
3595
|
+
/**
|
|
3596
|
+
* Explanation of the functionality shown to the end user.
|
|
3597
|
+
* example:
|
|
3598
|
+
* You will receive an email with instructions to confirm your new email address.
|
|
3599
|
+
*/
|
|
3600
|
+
en: string;
|
|
3601
|
+
};
|
|
3602
|
+
auth?: ExtensionAuthBlock;
|
|
3603
|
+
call: {
|
|
3604
|
+
/**
|
|
3605
|
+
* HTTP method to use for the call
|
|
3606
|
+
*/
|
|
3607
|
+
method?: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* URL to call. Supports variable interpolation.
|
|
3610
|
+
*/
|
|
3611
|
+
url: string;
|
|
3612
|
+
/**
|
|
3613
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
3614
|
+
*/
|
|
3615
|
+
params?: {
|
|
3616
|
+
[name: string]: string;
|
|
3617
|
+
};
|
|
3618
|
+
/**
|
|
3619
|
+
* Headers to use. Supports variable interpolation.
|
|
3620
|
+
*/
|
|
3621
|
+
headers: {
|
|
3622
|
+
[name: string]: string;
|
|
3623
|
+
};
|
|
3624
|
+
/**
|
|
3625
|
+
* 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.
|
|
3626
|
+
*/
|
|
3627
|
+
body?: {
|
|
3628
|
+
[key: string]: any;
|
|
3629
|
+
};
|
|
3630
|
+
};
|
|
3631
|
+
resolved?: {
|
|
3632
|
+
/**
|
|
3633
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3634
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3635
|
+
*
|
|
3636
|
+
* example:
|
|
3637
|
+
* error.message
|
|
3638
|
+
*/
|
|
3639
|
+
error_message_path?: string;
|
|
3640
|
+
};
|
|
3641
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3642
|
+
}
|
|
3643
|
+
/**
|
|
3644
|
+
* 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).
|
|
3645
|
+
* The expected response http status code to the call is:
|
|
3646
|
+
* - 2xx if the request was accepted
|
|
3647
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3648
|
+
*
|
|
3649
|
+
*/
|
|
3650
|
+
export interface ExtensionHookChangePassword {
|
|
3651
|
+
type: "changePassword";
|
|
3652
|
+
/**
|
|
3653
|
+
* 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}}`.
|
|
3654
|
+
*
|
|
3655
|
+
*/
|
|
3656
|
+
require_new_password?: boolean;
|
|
3657
|
+
/**
|
|
3658
|
+
* Optional explanation shown to the user in the change password confirmation dialog.
|
|
3659
|
+
*/
|
|
3660
|
+
explanation?: {
|
|
3661
|
+
[name: string]: string;
|
|
3662
|
+
/**
|
|
3663
|
+
* Explanation of the functionality shown to the end user.
|
|
3664
|
+
* example:
|
|
3665
|
+
* You will receive an email with instructions to reset your password.
|
|
3666
|
+
*/
|
|
3667
|
+
en: string;
|
|
3668
|
+
};
|
|
3669
|
+
auth?: ExtensionAuthBlock;
|
|
3670
|
+
call: {
|
|
3671
|
+
/**
|
|
3672
|
+
* HTTP method to use for the call
|
|
3673
|
+
*/
|
|
3674
|
+
method?: string;
|
|
3675
|
+
/**
|
|
3676
|
+
* URL to call. Supports variable interpolation.
|
|
3677
|
+
*/
|
|
3678
|
+
url: string;
|
|
3679
|
+
/**
|
|
3680
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
3681
|
+
*/
|
|
3682
|
+
params?: {
|
|
3683
|
+
[name: string]: string;
|
|
3684
|
+
};
|
|
3685
|
+
/**
|
|
3686
|
+
* Headers to use. Supports variable interpolation.
|
|
3687
|
+
*/
|
|
3688
|
+
headers: {
|
|
3689
|
+
[name: string]: string;
|
|
3690
|
+
};
|
|
3691
|
+
/**
|
|
3692
|
+
* 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.
|
|
3693
|
+
*/
|
|
3694
|
+
body?: {
|
|
3695
|
+
[key: string]: any;
|
|
3696
|
+
};
|
|
3697
|
+
};
|
|
3698
|
+
resolved?: {
|
|
3699
|
+
/**
|
|
3700
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3701
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3702
|
+
*
|
|
3703
|
+
* example:
|
|
3704
|
+
* error.message
|
|
3705
|
+
*/
|
|
3706
|
+
error_message_path?: string;
|
|
3707
|
+
};
|
|
3708
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3709
|
+
}
|
|
3532
3710
|
/**
|
|
3533
3711
|
* 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
3712
|
* - 200 with the time series data
|
|
@@ -3808,6 +3986,77 @@ declare namespace Components {
|
|
|
3808
3986
|
use_static_ips?: boolean;
|
|
3809
3987
|
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
3810
3988
|
}
|
|
3989
|
+
/**
|
|
3990
|
+
* 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.
|
|
3991
|
+
* The `deletion_mode` controls what the portal does after the call:
|
|
3992
|
+
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the epilot user.
|
|
3993
|
+
* - `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).
|
|
3994
|
+
*
|
|
3995
|
+
* The expected response http status code to the call is:
|
|
3996
|
+
* - 2xx if the request was accepted
|
|
3997
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
3998
|
+
*
|
|
3999
|
+
*/
|
|
4000
|
+
export interface ExtensionHookDeleteAccount {
|
|
4001
|
+
type: "deleteAccount";
|
|
4002
|
+
/**
|
|
4003
|
+
* 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.
|
|
4004
|
+
*
|
|
4005
|
+
*/
|
|
4006
|
+
deletion_mode?: "synchronous" | "asynchronous";
|
|
4007
|
+
/**
|
|
4008
|
+
* Optional explanation shown to the user in the delete account confirmation dialog.
|
|
4009
|
+
*/
|
|
4010
|
+
explanation?: {
|
|
4011
|
+
[name: string]: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* Explanation of the functionality shown to the end user.
|
|
4014
|
+
* example:
|
|
4015
|
+
* Your account deletion will be processed by our system. This may take a few days.
|
|
4016
|
+
*/
|
|
4017
|
+
en: string;
|
|
4018
|
+
};
|
|
4019
|
+
auth?: ExtensionAuthBlock;
|
|
4020
|
+
call: {
|
|
4021
|
+
/**
|
|
4022
|
+
* HTTP method to use for the call
|
|
4023
|
+
*/
|
|
4024
|
+
method?: string;
|
|
4025
|
+
/**
|
|
4026
|
+
* URL to call. Supports variable interpolation.
|
|
4027
|
+
*/
|
|
4028
|
+
url: string;
|
|
4029
|
+
/**
|
|
4030
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
4031
|
+
*/
|
|
4032
|
+
params?: {
|
|
4033
|
+
[name: string]: string;
|
|
4034
|
+
};
|
|
4035
|
+
/**
|
|
4036
|
+
* Headers to use. Supports variable interpolation.
|
|
4037
|
+
*/
|
|
4038
|
+
headers: {
|
|
4039
|
+
[name: string]: string;
|
|
4040
|
+
};
|
|
4041
|
+
/**
|
|
4042
|
+
* 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.
|
|
4043
|
+
*/
|
|
4044
|
+
body?: {
|
|
4045
|
+
[key: string]: any;
|
|
4046
|
+
};
|
|
4047
|
+
};
|
|
4048
|
+
resolved?: {
|
|
4049
|
+
/**
|
|
4050
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
4051
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
4052
|
+
*
|
|
4053
|
+
* example:
|
|
4054
|
+
* error.message
|
|
4055
|
+
*/
|
|
4056
|
+
error_message_path?: string;
|
|
4057
|
+
};
|
|
4058
|
+
secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
|
|
4059
|
+
}
|
|
3811
4060
|
/**
|
|
3812
4061
|
* 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
4062
|
* - 200:
|
|
@@ -4844,6 +5093,109 @@ declare namespace Components {
|
|
|
4844
5093
|
};
|
|
4845
5094
|
schema?: string;
|
|
4846
5095
|
}
|
|
5096
|
+
export interface MobileBranding {
|
|
5097
|
+
[name: string]: any;
|
|
5098
|
+
app_icon?: string;
|
|
5099
|
+
splash?: string;
|
|
5100
|
+
splash_dark?: string;
|
|
5101
|
+
icon_background_color?: string;
|
|
5102
|
+
splash_background_color?: string;
|
|
5103
|
+
splash_background_color_dark?: string;
|
|
5104
|
+
}
|
|
5105
|
+
/**
|
|
5106
|
+
* Latest build/upload status for a platform (system-written).
|
|
5107
|
+
*/
|
|
5108
|
+
export interface MobileBuildStatus {
|
|
5109
|
+
[name: string]: any;
|
|
5110
|
+
version?: string;
|
|
5111
|
+
build_number?: number;
|
|
5112
|
+
/**
|
|
5113
|
+
* e.g. testflight | internal | beta
|
|
5114
|
+
*/
|
|
5115
|
+
track?: string;
|
|
5116
|
+
status?: "building" | "uploaded" | "failed";
|
|
5117
|
+
updated_at?: string; // date-time
|
|
5118
|
+
error?: string;
|
|
5119
|
+
}
|
|
5120
|
+
/**
|
|
5121
|
+
* 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.
|
|
5122
|
+
*/
|
|
5123
|
+
export interface MobileConfig {
|
|
5124
|
+
[name: string]: any;
|
|
5125
|
+
/**
|
|
5126
|
+
* Portal id (response-only; ignored on write).
|
|
5127
|
+
*/
|
|
5128
|
+
portal_id?: string;
|
|
5129
|
+
enabled?: boolean;
|
|
5130
|
+
/**
|
|
5131
|
+
* App display name compiled into the binary.
|
|
5132
|
+
*/
|
|
5133
|
+
display_name?: string;
|
|
5134
|
+
/**
|
|
5135
|
+
* Host the mobile shell loads (defaults to the portal domain).
|
|
5136
|
+
*/
|
|
5137
|
+
app_host?: string;
|
|
5138
|
+
environment?: "prod" | "staging" | "dev";
|
|
5139
|
+
branding?: MobileBranding;
|
|
5140
|
+
ios?: {
|
|
5141
|
+
[name: string]: any;
|
|
5142
|
+
/**
|
|
5143
|
+
* iOS bundle id (matches the App Store Connect app).
|
|
5144
|
+
*/
|
|
5145
|
+
bundle_id?: string;
|
|
5146
|
+
/**
|
|
5147
|
+
* Apple Developer Team ID.
|
|
5148
|
+
*/
|
|
5149
|
+
team_id?: string;
|
|
5150
|
+
credentials_status?: "not_configured" | "configured";
|
|
5151
|
+
/**
|
|
5152
|
+
* Numeric App Store id (system-written after first upload).
|
|
5153
|
+
*/
|
|
5154
|
+
app_store_id?: string;
|
|
5155
|
+
/**
|
|
5156
|
+
* System-written App Store URL.
|
|
5157
|
+
*/
|
|
5158
|
+
store_url?: string;
|
|
5159
|
+
last_build?: /* Latest build/upload status for a platform (system-written). */ MobileBuildStatus;
|
|
5160
|
+
};
|
|
5161
|
+
android?: {
|
|
5162
|
+
[name: string]: any;
|
|
5163
|
+
/**
|
|
5164
|
+
* Android package name (matches the Play Console app).
|
|
5165
|
+
*/
|
|
5166
|
+
package_name?: string;
|
|
5167
|
+
credentials_status?: "not_configured" | "configured";
|
|
5168
|
+
/**
|
|
5169
|
+
* Play App Signing upload-key state.
|
|
5170
|
+
*/
|
|
5171
|
+
upload_key_status?: "not_configured" | "generated" | "enrolled";
|
|
5172
|
+
/**
|
|
5173
|
+
* System-written Play Store URL.
|
|
5174
|
+
*/
|
|
5175
|
+
store_url?: string;
|
|
5176
|
+
last_build?: /* Latest build/upload status for a platform (system-written). */ MobileBuildStatus;
|
|
5177
|
+
};
|
|
5178
|
+
}
|
|
5179
|
+
/**
|
|
5180
|
+
* 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.
|
|
5181
|
+
*/
|
|
5182
|
+
export interface MobileConfigUpdate {
|
|
5183
|
+
[name: string]: any;
|
|
5184
|
+
enabled?: boolean;
|
|
5185
|
+
ios?: {
|
|
5186
|
+
[name: string]: any;
|
|
5187
|
+
bundle_id?: string;
|
|
5188
|
+
team_id?: string;
|
|
5189
|
+
store_url?: string;
|
|
5190
|
+
app_store_id?: string;
|
|
5191
|
+
};
|
|
5192
|
+
android?: {
|
|
5193
|
+
[name: string]: any;
|
|
5194
|
+
package_name?: string;
|
|
5195
|
+
store_url?: string;
|
|
5196
|
+
};
|
|
5197
|
+
branding?: MobileBranding;
|
|
5198
|
+
}
|
|
4847
5199
|
/**
|
|
4848
5200
|
* Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
|
|
4849
5201
|
* fields below may reference org env vars via mustache-like templates, e.g.
|
|
@@ -5645,6 +5997,11 @@ declare namespace Components {
|
|
|
5645
5997
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
5646
5998
|
*/
|
|
5647
5999
|
auto_redirect_to_sso?: boolean;
|
|
6000
|
+
/**
|
|
6001
|
+
* 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.
|
|
6002
|
+
*
|
|
6003
|
+
*/
|
|
6004
|
+
prevent_user_enumeration?: boolean;
|
|
5648
6005
|
};
|
|
5649
6006
|
/**
|
|
5650
6007
|
* AWS Cognito Pool details for the portal
|
|
@@ -6252,6 +6609,11 @@ declare namespace Components {
|
|
|
6252
6609
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
6253
6610
|
*/
|
|
6254
6611
|
auto_redirect_to_sso?: boolean;
|
|
6612
|
+
/**
|
|
6613
|
+
* 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.
|
|
6614
|
+
*
|
|
6615
|
+
*/
|
|
6616
|
+
prevent_user_enumeration?: boolean;
|
|
6255
6617
|
};
|
|
6256
6618
|
/**
|
|
6257
6619
|
* AWS Cognito Pool details for the portal
|
|
@@ -6893,6 +7255,18 @@ declare namespace Components {
|
|
|
6893
7255
|
*
|
|
6894
7256
|
*/
|
|
6895
7257
|
MoblieOIDCConfig;
|
|
7258
|
+
/**
|
|
7259
|
+
* Allow the resolved `client_secret` to be returned through the
|
|
7260
|
+
* public single-provider endpoint at SSO initiation. Only set this
|
|
7261
|
+
* for OIDC flows that require a public client secret in the
|
|
7262
|
+
* browser (e.g. some PKCE-less authorization-code variants). When
|
|
7263
|
+
* unset (default), the secret is kept server-side and only used at
|
|
7264
|
+
* the token exchange.
|
|
7265
|
+
*
|
|
7266
|
+
* example:
|
|
7267
|
+
* false
|
|
7268
|
+
*/
|
|
7269
|
+
expose_client_secret?: boolean;
|
|
6896
7270
|
}
|
|
6897
7271
|
/**
|
|
6898
7272
|
* Human-readable display name for identity provider shown in login
|
|
@@ -6950,6 +7324,28 @@ declare namespace Components {
|
|
|
6950
7324
|
en: string;
|
|
6951
7325
|
};
|
|
6952
7326
|
}
|
|
7327
|
+
export interface PublicChangeEmailDetails {
|
|
7328
|
+
/**
|
|
7329
|
+
* Identifier of the hook.
|
|
7330
|
+
*/
|
|
7331
|
+
id?: string;
|
|
7332
|
+
/**
|
|
7333
|
+
* Whether the portal user must confirm their current password before the email change is handed over to the third-party system.
|
|
7334
|
+
*/
|
|
7335
|
+
require_password_confirmation?: boolean;
|
|
7336
|
+
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
7337
|
+
}
|
|
7338
|
+
export interface PublicChangePasswordDetails {
|
|
7339
|
+
/**
|
|
7340
|
+
* Identifier of the hook.
|
|
7341
|
+
*/
|
|
7342
|
+
id?: string;
|
|
7343
|
+
/**
|
|
7344
|
+
* Whether the portal user must provide a new password that is passed to the third-party system.
|
|
7345
|
+
*/
|
|
7346
|
+
require_new_password?: boolean;
|
|
7347
|
+
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
7348
|
+
}
|
|
6953
7349
|
export interface PublicContractIdentificationDetails {
|
|
6954
7350
|
/**
|
|
6955
7351
|
* Explanation of the hook.
|
|
@@ -6988,6 +7384,13 @@ declare namespace Components {
|
|
|
6988
7384
|
*/
|
|
6989
7385
|
block_types?: string[];
|
|
6990
7386
|
}
|
|
7387
|
+
export interface PublicDeleteAccountDetails {
|
|
7388
|
+
/**
|
|
7389
|
+
* Identifier of the hook.
|
|
7390
|
+
*/
|
|
7391
|
+
id?: string;
|
|
7392
|
+
explanation?: /* Explanation of the hook. */ PublicSelfManagementExplanation;
|
|
7393
|
+
}
|
|
6991
7394
|
export interface PublicExtensionCapabilities {
|
|
6992
7395
|
consumptionDataRetrieval?: DataRetrievalItem[];
|
|
6993
7396
|
dataExport?: DataRetrievalItem[];
|
|
@@ -7002,6 +7405,21 @@ declare namespace Components {
|
|
|
7002
7405
|
extension?: PublicExtensionDetails;
|
|
7003
7406
|
hook?: PublicMeterReadingPlausibilityCheckDetails;
|
|
7004
7407
|
};
|
|
7408
|
+
changeEmail?: {
|
|
7409
|
+
app?: PublicAppDetails;
|
|
7410
|
+
extension?: PublicExtensionDetails;
|
|
7411
|
+
hook?: PublicChangeEmailDetails;
|
|
7412
|
+
};
|
|
7413
|
+
changePassword?: {
|
|
7414
|
+
app?: PublicAppDetails;
|
|
7415
|
+
extension?: PublicExtensionDetails;
|
|
7416
|
+
hook?: PublicChangePasswordDetails;
|
|
7417
|
+
};
|
|
7418
|
+
deleteAccount?: {
|
|
7419
|
+
app?: PublicAppDetails;
|
|
7420
|
+
extension?: PublicExtensionDetails;
|
|
7421
|
+
hook?: PublicDeleteAccountDetails;
|
|
7422
|
+
};
|
|
7005
7423
|
}
|
|
7006
7424
|
export interface PublicExtensionDetails {
|
|
7007
7425
|
/**
|
|
@@ -7025,6 +7443,16 @@ declare namespace Components {
|
|
|
7025
7443
|
*/
|
|
7026
7444
|
plausibility_mode?: "check" | "range";
|
|
7027
7445
|
}
|
|
7446
|
+
/**
|
|
7447
|
+
* Explanation of the hook.
|
|
7448
|
+
*/
|
|
7449
|
+
export interface PublicSelfManagementExplanation {
|
|
7450
|
+
[name: string]: string;
|
|
7451
|
+
/**
|
|
7452
|
+
* Explanation of the functionality shown to the end user.
|
|
7453
|
+
*/
|
|
7454
|
+
en: string;
|
|
7455
|
+
}
|
|
7028
7456
|
/**
|
|
7029
7457
|
* The person who recorded the reading
|
|
7030
7458
|
* example:
|
|
@@ -7679,6 +8107,11 @@ declare namespace Components {
|
|
|
7679
8107
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
7680
8108
|
*/
|
|
7681
8109
|
auto_redirect_to_sso?: boolean;
|
|
8110
|
+
/**
|
|
8111
|
+
* 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.
|
|
8112
|
+
*
|
|
8113
|
+
*/
|
|
8114
|
+
prevent_user_enumeration?: boolean;
|
|
7682
8115
|
};
|
|
7683
8116
|
/**
|
|
7684
8117
|
* AWS Cognito Pool details for the portal
|
|
@@ -8254,6 +8687,11 @@ declare namespace Components {
|
|
|
8254
8687
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
8255
8688
|
*/
|
|
8256
8689
|
auto_redirect_to_sso?: boolean;
|
|
8690
|
+
/**
|
|
8691
|
+
* 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.
|
|
8692
|
+
*
|
|
8693
|
+
*/
|
|
8694
|
+
prevent_user_enumeration?: boolean;
|
|
8257
8695
|
};
|
|
8258
8696
|
/**
|
|
8259
8697
|
* AWS Cognito Pool details for the portal
|
|
@@ -8929,6 +9367,26 @@ declare namespace Paths {
|
|
|
8929
9367
|
}
|
|
8930
9368
|
}
|
|
8931
9369
|
}
|
|
9370
|
+
namespace ChangePortalUserPassword {
|
|
9371
|
+
export interface RequestBody {
|
|
9372
|
+
/**
|
|
9373
|
+
* New password chosen by the portal user.
|
|
9374
|
+
* Required when the configured `changePassword` hook has `require_new_password` enabled, ignored otherwise.
|
|
9375
|
+
*
|
|
9376
|
+
*/
|
|
9377
|
+
new_password?: string;
|
|
9378
|
+
}
|
|
9379
|
+
namespace Responses {
|
|
9380
|
+
export interface $200 {
|
|
9381
|
+
message?: string;
|
|
9382
|
+
}
|
|
9383
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
9384
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
9385
|
+
export interface $404 {
|
|
9386
|
+
}
|
|
9387
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
9388
|
+
}
|
|
9389
|
+
}
|
|
8932
9390
|
namespace CheckAccountExists {
|
|
8933
9391
|
namespace Parameters {
|
|
8934
9392
|
export type Domain = string;
|
|
@@ -8992,6 +9450,14 @@ declare namespace Paths {
|
|
|
8992
9450
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8993
9451
|
*/
|
|
8994
9452
|
Components.Schemas.EntityId /* uuid */;
|
|
9453
|
+
/**
|
|
9454
|
+
* Present only when exists is false. NOT_FOUND means the given identifiers did
|
|
9455
|
+
* not match any contact (definitive - the client should not retry). TIMEOUT
|
|
9456
|
+
* means the contact was not found within the processing window but may still be
|
|
9457
|
+
* ingesting; the client may retry (ideally with trigger_identifiers_check=false).
|
|
9458
|
+
*
|
|
9459
|
+
*/
|
|
9460
|
+
reason?: "TIMEOUT" | "NOT_FOUND";
|
|
8995
9461
|
}
|
|
8996
9462
|
export type $400 = Components.Responses.InvalidRequest;
|
|
8997
9463
|
export type $404 = Components.Responses.NotFound;
|
|
@@ -9039,6 +9505,14 @@ declare namespace Paths {
|
|
|
9039
9505
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
9040
9506
|
*/
|
|
9041
9507
|
Components.Schemas.EntityId /* uuid */;
|
|
9508
|
+
/**
|
|
9509
|
+
* Present only when exists is false. NOT_FOUND means the given identifiers did
|
|
9510
|
+
* not match any contact (definitive - the client should not retry). TIMEOUT
|
|
9511
|
+
* means the contact was not found within the processing window but may still be
|
|
9512
|
+
* ingesting; the client may retry (ideally with trigger_identifiers_check=false).
|
|
9513
|
+
*
|
|
9514
|
+
*/
|
|
9515
|
+
reason?: "TIMEOUT" | "NOT_FOUND";
|
|
9042
9516
|
}
|
|
9043
9517
|
export type $400 = Components.Responses.InvalidRequest;
|
|
9044
9518
|
export type $404 = Components.Responses.NotFound;
|
|
@@ -9264,6 +9738,30 @@ declare namespace Paths {
|
|
|
9264
9738
|
export type $500 = Components.Responses.InternalServerError;
|
|
9265
9739
|
}
|
|
9266
9740
|
}
|
|
9741
|
+
namespace CreatePortalUserEntity {
|
|
9742
|
+
namespace Parameters {
|
|
9743
|
+
/**
|
|
9744
|
+
* example:
|
|
9745
|
+
* asset
|
|
9746
|
+
*/
|
|
9747
|
+
export type Slug = "asset";
|
|
9748
|
+
}
|
|
9749
|
+
export interface PathParameters {
|
|
9750
|
+
slug: /**
|
|
9751
|
+
* example:
|
|
9752
|
+
* asset
|
|
9753
|
+
*/
|
|
9754
|
+
Parameters.Slug;
|
|
9755
|
+
}
|
|
9756
|
+
export type RequestBody = Components.Schemas.Entity;
|
|
9757
|
+
namespace Responses {
|
|
9758
|
+
export type $201 = /* Response for entity get request */ Components.Schemas.EntityResponse;
|
|
9759
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
9760
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
9761
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9762
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
9763
|
+
}
|
|
9764
|
+
}
|
|
9267
9765
|
namespace CreateUser {
|
|
9268
9766
|
namespace Parameters {
|
|
9269
9767
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -9399,7 +9897,14 @@ declare namespace Paths {
|
|
|
9399
9897
|
namespace DeletePortalUser {
|
|
9400
9898
|
namespace Responses {
|
|
9401
9899
|
export interface $200 {
|
|
9402
|
-
|
|
9900
|
+
/**
|
|
9901
|
+
* `User Succesfully Deleted` when the user was deleted, or `Account deletion requested`
|
|
9902
|
+
* when an asynchronous deleteAccount portal extension hook handed the deletion over to a third party.
|
|
9903
|
+
*
|
|
9904
|
+
* example:
|
|
9905
|
+
* User Succesfully Deleted
|
|
9906
|
+
*/
|
|
9907
|
+
message?: string;
|
|
9403
9908
|
data?: /**
|
|
9404
9909
|
* Entity ID
|
|
9405
9910
|
* example:
|
|
@@ -10869,6 +11374,23 @@ declare namespace Paths {
|
|
|
10869
11374
|
export type $500 = Components.Responses.InternalServerError;
|
|
10870
11375
|
}
|
|
10871
11376
|
}
|
|
11377
|
+
namespace GetMobileConfig {
|
|
11378
|
+
namespace Parameters {
|
|
11379
|
+
export type PortalId = string;
|
|
11380
|
+
export type Raw = boolean;
|
|
11381
|
+
}
|
|
11382
|
+
export interface QueryParameters {
|
|
11383
|
+
portal_id: Parameters.PortalId;
|
|
11384
|
+
raw?: Parameters.Raw;
|
|
11385
|
+
}
|
|
11386
|
+
namespace Responses {
|
|
11387
|
+
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;
|
|
11388
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11389
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11390
|
+
export type $404 = Components.Responses.NotFound;
|
|
11391
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11392
|
+
}
|
|
11393
|
+
}
|
|
10872
11394
|
namespace GetOpportunity {
|
|
10873
11395
|
namespace Parameters {
|
|
10874
11396
|
export type Id = /**
|
|
@@ -11177,6 +11699,11 @@ declare namespace Paths {
|
|
|
11177
11699
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
11178
11700
|
*/
|
|
11179
11701
|
auto_redirect_to_sso?: boolean;
|
|
11702
|
+
/**
|
|
11703
|
+
* 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.
|
|
11704
|
+
*
|
|
11705
|
+
*/
|
|
11706
|
+
prevent_user_enumeration?: boolean;
|
|
11180
11707
|
};
|
|
11181
11708
|
/**
|
|
11182
11709
|
* AWS Cognito Pool details for the portal
|
|
@@ -11783,6 +12310,11 @@ declare namespace Paths {
|
|
|
11783
12310
|
* Decide whether to automatically redirect to the provider page during login, which would completely bypass showing the portal authentication page.
|
|
11784
12311
|
*/
|
|
11785
12312
|
auto_redirect_to_sso?: boolean;
|
|
12313
|
+
/**
|
|
12314
|
+
* 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.
|
|
12315
|
+
*
|
|
12316
|
+
*/
|
|
12317
|
+
prevent_user_enumeration?: boolean;
|
|
11786
12318
|
};
|
|
11787
12319
|
/**
|
|
11788
12320
|
* AWS Cognito Pool details for the portal
|
|
@@ -13509,6 +14041,28 @@ declare namespace Paths {
|
|
|
13509
14041
|
export type $500 = Components.Responses.InternalServerError;
|
|
13510
14042
|
}
|
|
13511
14043
|
}
|
|
14044
|
+
namespace ListEmailTemplateReferences {
|
|
14045
|
+
export interface RequestBody {
|
|
14046
|
+
/**
|
|
14047
|
+
* Email template id to find portal references for
|
|
14048
|
+
*/
|
|
14049
|
+
template_id: string;
|
|
14050
|
+
}
|
|
14051
|
+
namespace Responses {
|
|
14052
|
+
export interface $200 {
|
|
14053
|
+
portals: {
|
|
14054
|
+
id: string;
|
|
14055
|
+
/**
|
|
14056
|
+
* Portal display name (or domain); falls back to id when unavailable
|
|
14057
|
+
*/
|
|
14058
|
+
name?: string | null;
|
|
14059
|
+
}[];
|
|
14060
|
+
}
|
|
14061
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14062
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14063
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14064
|
+
}
|
|
14065
|
+
}
|
|
13512
14066
|
namespace LoginToPortalAsUser {
|
|
13513
14067
|
export interface RequestBody {
|
|
13514
14068
|
/**
|
|
@@ -13536,6 +14090,32 @@ declare namespace Paths {
|
|
|
13536
14090
|
}
|
|
13537
14091
|
}
|
|
13538
14092
|
}
|
|
14093
|
+
namespace MigrateEmailTemplateReferences {
|
|
14094
|
+
export interface RequestBody {
|
|
14095
|
+
/**
|
|
14096
|
+
* Template id currently referenced on portal rows
|
|
14097
|
+
*/
|
|
14098
|
+
source_template_id: string;
|
|
14099
|
+
/**
|
|
14100
|
+
* Template id to write in place of the source
|
|
14101
|
+
*/
|
|
14102
|
+
destination_template_id: string;
|
|
14103
|
+
}
|
|
14104
|
+
namespace Responses {
|
|
14105
|
+
export interface $200 {
|
|
14106
|
+
/**
|
|
14107
|
+
* example:
|
|
14108
|
+
* 2
|
|
14109
|
+
*/
|
|
14110
|
+
migrated_portal_count: number;
|
|
14111
|
+
migrated_portal_ids: string[];
|
|
14112
|
+
failed_portal_ids: string[];
|
|
14113
|
+
}
|
|
14114
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14115
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14116
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14117
|
+
}
|
|
14118
|
+
}
|
|
13539
14119
|
namespace NotifyMLoginInterestChange {
|
|
13540
14120
|
namespace Parameters {
|
|
13541
14121
|
export type ClientId = string;
|
|
@@ -13590,6 +14170,38 @@ declare namespace Paths {
|
|
|
13590
14170
|
export type $500 = Components.Responses.InternalServerError;
|
|
13591
14171
|
}
|
|
13592
14172
|
}
|
|
14173
|
+
namespace PatchPortalUserEntity {
|
|
14174
|
+
namespace Parameters {
|
|
14175
|
+
export type Id = /**
|
|
14176
|
+
* Entity ID
|
|
14177
|
+
* example:
|
|
14178
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
14179
|
+
*/
|
|
14180
|
+
Components.Schemas.EntityId /* uuid */;
|
|
14181
|
+
/**
|
|
14182
|
+
* example:
|
|
14183
|
+
* asset
|
|
14184
|
+
*/
|
|
14185
|
+
export type Slug = "asset";
|
|
14186
|
+
}
|
|
14187
|
+
export interface PathParameters {
|
|
14188
|
+
slug: /**
|
|
14189
|
+
* example:
|
|
14190
|
+
* asset
|
|
14191
|
+
*/
|
|
14192
|
+
Parameters.Slug;
|
|
14193
|
+
id: Parameters.Id;
|
|
14194
|
+
}
|
|
14195
|
+
export type RequestBody = Components.Schemas.Entity;
|
|
14196
|
+
namespace Responses {
|
|
14197
|
+
export type $200 = /* Response for entity get request */ Components.Schemas.EntityResponse;
|
|
14198
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
14199
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14200
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14201
|
+
export type $404 = Components.Responses.NotFound;
|
|
14202
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14203
|
+
}
|
|
14204
|
+
}
|
|
13593
14205
|
namespace PortalProxyExecute {
|
|
13594
14206
|
export interface RequestBody {
|
|
13595
14207
|
/**
|
|
@@ -13711,8 +14323,26 @@ declare namespace Paths {
|
|
|
13711
14323
|
export type $500 = Components.Responses.InternalServerError;
|
|
13712
14324
|
}
|
|
13713
14325
|
}
|
|
14326
|
+
namespace PutMobileConfig {
|
|
14327
|
+
namespace Parameters {
|
|
14328
|
+
export type PortalId = string;
|
|
14329
|
+
}
|
|
14330
|
+
export interface QueryParameters {
|
|
14331
|
+
portal_id: Parameters.PortalId;
|
|
14332
|
+
}
|
|
14333
|
+
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;
|
|
14334
|
+
namespace Responses {
|
|
14335
|
+
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;
|
|
14336
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
14337
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14338
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14339
|
+
export type $404 = Components.Responses.NotFound;
|
|
14340
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14341
|
+
}
|
|
14342
|
+
}
|
|
13714
14343
|
namespace PutPortalConfig {
|
|
13715
14344
|
namespace Parameters {
|
|
14345
|
+
export type PageUpsertMode = "id" | "slug";
|
|
13716
14346
|
/**
|
|
13717
14347
|
* example:
|
|
13718
14348
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
@@ -13726,6 +14356,9 @@ declare namespace Paths {
|
|
|
13726
14356
|
*/
|
|
13727
14357
|
Parameters.PortalId /* uuid */;
|
|
13728
14358
|
}
|
|
14359
|
+
export interface QueryParameters {
|
|
14360
|
+
page_upsert_mode?: Parameters.PageUpsertMode;
|
|
14361
|
+
}
|
|
13729
14362
|
export type RequestBody = Components.Schemas.PortalConfigV3;
|
|
13730
14363
|
namespace Responses {
|
|
13731
14364
|
export type $200 = Components.Schemas.PortalConfigV3;
|
|
@@ -14524,13 +15157,23 @@ declare namespace Paths {
|
|
|
14524
15157
|
*/
|
|
14525
15158
|
email: string;
|
|
14526
15159
|
/**
|
|
14527
|
-
* Password of the portal user for confirmation
|
|
15160
|
+
* Password of the portal user for confirmation.
|
|
15161
|
+
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal.
|
|
15162
|
+
*
|
|
14528
15163
|
*/
|
|
14529
|
-
password
|
|
15164
|
+
password?: string;
|
|
14530
15165
|
}
|
|
14531
15166
|
namespace Responses {
|
|
14532
15167
|
export interface $200 {
|
|
14533
|
-
|
|
15168
|
+
/**
|
|
15169
|
+
* `You will receive a confirmation mail soon on your updated email address.` for the built-in flow,
|
|
15170
|
+
* or `Your email change request has been received.` when a changeEmail portal extension hook handed
|
|
15171
|
+
* the change over to a third party.
|
|
15172
|
+
*
|
|
15173
|
+
* example:
|
|
15174
|
+
* You will receive a confirmation mail soon on your updated email address.
|
|
15175
|
+
*/
|
|
15176
|
+
message?: string;
|
|
14534
15177
|
}
|
|
14535
15178
|
export type $400 = Components.Responses.InvalidRequest;
|
|
14536
15179
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -15324,6 +15967,38 @@ interface OperationMethods {
|
|
|
15324
15967
|
data?: Paths.UpsertEmailTemplates.RequestBody,
|
|
15325
15968
|
config?: AxiosRequestConfig
|
|
15326
15969
|
): OperationResponse<Paths.UpsertEmailTemplates.Responses.$200>
|
|
15970
|
+
/**
|
|
15971
|
+
* migrateEmailTemplateReferences - migrateEmailTemplateReferences
|
|
15972
|
+
*
|
|
15973
|
+
* Walk every email-template config row in the caller's org and re-point any
|
|
15974
|
+
* field on `email_templates` that currently references `source_template_id`
|
|
15975
|
+
* at `destination_template_id`. Intended to be called from the email-template
|
|
15976
|
+
* migration flow when a duplicated template is refined.
|
|
15977
|
+
*
|
|
15978
|
+
* Only v3-shaped rows are migrated (those carrying `portal_sk_v3`). Returns
|
|
15979
|
+
* the portal IDs that were rewritten and any whose update failed.
|
|
15980
|
+
*
|
|
15981
|
+
*/
|
|
15982
|
+
'migrateEmailTemplateReferences'(
|
|
15983
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15984
|
+
data?: Paths.MigrateEmailTemplateReferences.RequestBody,
|
|
15985
|
+
config?: AxiosRequestConfig
|
|
15986
|
+
): OperationResponse<Paths.MigrateEmailTemplateReferences.Responses.$200>
|
|
15987
|
+
/**
|
|
15988
|
+
* listEmailTemplateReferences - listEmailTemplateReferences
|
|
15989
|
+
*
|
|
15990
|
+
* Read-only sibling of migrateEmailTemplateReferences. Lists every portal in
|
|
15991
|
+
* the caller's org whose `email_templates` config references `template_id`,
|
|
15992
|
+
* without rewriting anything. Used by the email-template MFE to show which
|
|
15993
|
+
* portals a template affects (in template settings and as a pre-migrate
|
|
15994
|
+
* preview). Uses the same discovery as the migrate path.
|
|
15995
|
+
*
|
|
15996
|
+
*/
|
|
15997
|
+
'listEmailTemplateReferences'(
|
|
15998
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15999
|
+
data?: Paths.ListEmailTemplateReferences.RequestBody,
|
|
16000
|
+
config?: AxiosRequestConfig
|
|
16001
|
+
): OperationResponse<Paths.ListEmailTemplateReferences.Responses.$200>
|
|
15327
16002
|
/**
|
|
15328
16003
|
* getEmailTemplatesByPortalId - getEmailTemplatesByPortalId
|
|
15329
16004
|
*
|
|
@@ -15630,6 +16305,18 @@ interface OperationMethods {
|
|
|
15630
16305
|
data?: Paths.UpdatePortalUserEmail.RequestBody,
|
|
15631
16306
|
config?: AxiosRequestConfig
|
|
15632
16307
|
): OperationResponse<Paths.UpdatePortalUserEmail.Responses.$200>
|
|
16308
|
+
/**
|
|
16309
|
+
* changePortalUserPassword - changePortalUserPassword
|
|
16310
|
+
*
|
|
16311
|
+
* Hand over a password change to the third-party system configured via the `changePassword` portal extension hook.
|
|
16312
|
+
* Only available when such a hook is configured for the portal; the built-in password change flow does not use this endpoint.
|
|
16313
|
+
*
|
|
16314
|
+
*/
|
|
16315
|
+
'changePortalUserPassword'(
|
|
16316
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16317
|
+
data?: Paths.ChangePortalUserPassword.RequestBody,
|
|
16318
|
+
config?: AxiosRequestConfig
|
|
16319
|
+
): OperationResponse<Paths.ChangePortalUserPassword.Responses.$200>
|
|
15633
16320
|
/**
|
|
15634
16321
|
* resendConfirmationEmail - resendConfirmationEmail
|
|
15635
16322
|
*
|
|
@@ -16089,6 +16776,28 @@ interface OperationMethods {
|
|
|
16089
16776
|
data?: Paths.SearchPortalUserEntities.RequestBody,
|
|
16090
16777
|
config?: AxiosRequestConfig
|
|
16091
16778
|
): OperationResponse<Paths.SearchPortalUserEntities.Responses.$200>
|
|
16779
|
+
/**
|
|
16780
|
+
* createPortalUserEntity - createPortalUserEntity
|
|
16781
|
+
*
|
|
16782
|
+
* **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.
|
|
16783
|
+
* 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.
|
|
16784
|
+
*/
|
|
16785
|
+
'createPortalUserEntity'(
|
|
16786
|
+
parameters?: Parameters<Paths.CreatePortalUserEntity.PathParameters> | null,
|
|
16787
|
+
data?: Paths.CreatePortalUserEntity.RequestBody,
|
|
16788
|
+
config?: AxiosRequestConfig
|
|
16789
|
+
): OperationResponse<Paths.CreatePortalUserEntity.Responses.$201>
|
|
16790
|
+
/**
|
|
16791
|
+
* patchPortalUserEntity - patchPortalUserEntity
|
|
16792
|
+
*
|
|
16793
|
+
* **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.
|
|
16794
|
+
* 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.
|
|
16795
|
+
*/
|
|
16796
|
+
'patchPortalUserEntity'(
|
|
16797
|
+
parameters?: Parameters<Paths.PatchPortalUserEntity.PathParameters> | null,
|
|
16798
|
+
data?: Paths.PatchPortalUserEntity.RequestBody,
|
|
16799
|
+
config?: AxiosRequestConfig
|
|
16800
|
+
): OperationResponse<Paths.PatchPortalUserEntity.Responses.$200>
|
|
16092
16801
|
/**
|
|
16093
16802
|
* canTriggerPortalFlow - canTriggerPortalFlow
|
|
16094
16803
|
*
|
|
@@ -16473,7 +17182,7 @@ interface OperationMethods {
|
|
|
16473
17182
|
* Updates a specific portal configuration by ID.
|
|
16474
17183
|
*/
|
|
16475
17184
|
'putPortalConfig'(
|
|
16476
|
-
parameters?: Parameters<Paths.PutPortalConfig.PathParameters> | null,
|
|
17185
|
+
parameters?: Parameters<Paths.PutPortalConfig.QueryParameters & Paths.PutPortalConfig.PathParameters> | null,
|
|
16477
17186
|
data?: Paths.PutPortalConfig.RequestBody,
|
|
16478
17187
|
config?: AxiosRequestConfig
|
|
16479
17188
|
): OperationResponse<Paths.PutPortalConfig.Responses.$200>
|
|
@@ -16599,6 +17308,29 @@ interface OperationMethods {
|
|
|
16599
17308
|
data?: Paths.PortalProxyExecute.RequestBody,
|
|
16600
17309
|
config?: AxiosRequestConfig
|
|
16601
17310
|
): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
|
|
17311
|
+
/**
|
|
17312
|
+
* getMobileConfig - getMobileConfig
|
|
17313
|
+
*
|
|
17314
|
+
* 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.
|
|
17315
|
+
*/
|
|
17316
|
+
'getMobileConfig'(
|
|
17317
|
+
parameters?: Parameters<Paths.GetMobileConfig.QueryParameters> | null,
|
|
17318
|
+
data?: any,
|
|
17319
|
+
config?: AxiosRequestConfig
|
|
17320
|
+
): OperationResponse<Paths.GetMobileConfig.Responses.$200>
|
|
17321
|
+
/**
|
|
17322
|
+
* putMobileConfig - putMobileConfig
|
|
17323
|
+
*
|
|
17324
|
+
* Merges the provided fields into the portal's mobile app configuration
|
|
17325
|
+
* (deep merge). Only mobile_config is modified; all other portal settings
|
|
17326
|
+
* are left untouched.
|
|
17327
|
+
*
|
|
17328
|
+
*/
|
|
17329
|
+
'putMobileConfig'(
|
|
17330
|
+
parameters?: Parameters<Paths.PutMobileConfig.QueryParameters> | null,
|
|
17331
|
+
data?: Paths.PutMobileConfig.RequestBody,
|
|
17332
|
+
config?: AxiosRequestConfig
|
|
17333
|
+
): OperationResponse<Paths.PutMobileConfig.Responses.$200>
|
|
16602
17334
|
}
|
|
16603
17335
|
|
|
16604
17336
|
interface PathsDictionary {
|
|
@@ -16956,6 +17688,42 @@ interface PathsDictionary {
|
|
|
16956
17688
|
config?: AxiosRequestConfig
|
|
16957
17689
|
): OperationResponse<Paths.GetEmailTemplates.Responses.$200>
|
|
16958
17690
|
}
|
|
17691
|
+
['/v3/portal/email-templates:migrate-references']: {
|
|
17692
|
+
/**
|
|
17693
|
+
* migrateEmailTemplateReferences - migrateEmailTemplateReferences
|
|
17694
|
+
*
|
|
17695
|
+
* Walk every email-template config row in the caller's org and re-point any
|
|
17696
|
+
* field on `email_templates` that currently references `source_template_id`
|
|
17697
|
+
* at `destination_template_id`. Intended to be called from the email-template
|
|
17698
|
+
* migration flow when a duplicated template is refined.
|
|
17699
|
+
*
|
|
17700
|
+
* Only v3-shaped rows are migrated (those carrying `portal_sk_v3`). Returns
|
|
17701
|
+
* the portal IDs that were rewritten and any whose update failed.
|
|
17702
|
+
*
|
|
17703
|
+
*/
|
|
17704
|
+
'post'(
|
|
17705
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
17706
|
+
data?: Paths.MigrateEmailTemplateReferences.RequestBody,
|
|
17707
|
+
config?: AxiosRequestConfig
|
|
17708
|
+
): OperationResponse<Paths.MigrateEmailTemplateReferences.Responses.$200>
|
|
17709
|
+
}
|
|
17710
|
+
['/v3/portal/email-templates:list-references']: {
|
|
17711
|
+
/**
|
|
17712
|
+
* listEmailTemplateReferences - listEmailTemplateReferences
|
|
17713
|
+
*
|
|
17714
|
+
* Read-only sibling of migrateEmailTemplateReferences. Lists every portal in
|
|
17715
|
+
* the caller's org whose `email_templates` config references `template_id`,
|
|
17716
|
+
* without rewriting anything. Used by the email-template MFE to show which
|
|
17717
|
+
* portals a template affects (in template settings and as a pre-migrate
|
|
17718
|
+
* preview). Uses the same discovery as the migrate path.
|
|
17719
|
+
*
|
|
17720
|
+
*/
|
|
17721
|
+
'post'(
|
|
17722
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
17723
|
+
data?: Paths.ListEmailTemplateReferences.RequestBody,
|
|
17724
|
+
config?: AxiosRequestConfig
|
|
17725
|
+
): OperationResponse<Paths.ListEmailTemplateReferences.Responses.$200>
|
|
17726
|
+
}
|
|
16959
17727
|
['/v3/portal/email-templates/{portal_id}']: {
|
|
16960
17728
|
/**
|
|
16961
17729
|
* upsertEmailTemplatesByPortalId - upsertEmailTemplatesByPortalId
|
|
@@ -17308,6 +18076,20 @@ interface PathsDictionary {
|
|
|
17308
18076
|
config?: AxiosRequestConfig
|
|
17309
18077
|
): OperationResponse<Paths.UpdatePortalUserEmail.Responses.$200>
|
|
17310
18078
|
}
|
|
18079
|
+
['/v2/portal/user/change/password']: {
|
|
18080
|
+
/**
|
|
18081
|
+
* changePortalUserPassword - changePortalUserPassword
|
|
18082
|
+
*
|
|
18083
|
+
* Hand over a password change to the third-party system configured via the `changePassword` portal extension hook.
|
|
18084
|
+
* Only available when such a hook is configured for the portal; the built-in password change flow does not use this endpoint.
|
|
18085
|
+
*
|
|
18086
|
+
*/
|
|
18087
|
+
'put'(
|
|
18088
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
18089
|
+
data?: Paths.ChangePortalUserPassword.RequestBody,
|
|
18090
|
+
config?: AxiosRequestConfig
|
|
18091
|
+
): OperationResponse<Paths.ChangePortalUserPassword.Responses.$200>
|
|
18092
|
+
}
|
|
17311
18093
|
['/v2/portal/user/resend/confirmation-email/{id}']: {
|
|
17312
18094
|
/**
|
|
17313
18095
|
* resendConfirmationEmail - resendConfirmationEmail
|
|
@@ -17847,6 +18629,32 @@ interface PathsDictionary {
|
|
|
17847
18629
|
config?: AxiosRequestConfig
|
|
17848
18630
|
): OperationResponse<Paths.SearchPortalUserEntities.Responses.$200>
|
|
17849
18631
|
}
|
|
18632
|
+
['/v2/portal/entity/{slug}']: {
|
|
18633
|
+
/**
|
|
18634
|
+
* createPortalUserEntity - createPortalUserEntity
|
|
18635
|
+
*
|
|
18636
|
+
* **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.
|
|
18637
|
+
* 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.
|
|
18638
|
+
*/
|
|
18639
|
+
'post'(
|
|
18640
|
+
parameters?: Parameters<Paths.CreatePortalUserEntity.PathParameters> | null,
|
|
18641
|
+
data?: Paths.CreatePortalUserEntity.RequestBody,
|
|
18642
|
+
config?: AxiosRequestConfig
|
|
18643
|
+
): OperationResponse<Paths.CreatePortalUserEntity.Responses.$201>
|
|
18644
|
+
}
|
|
18645
|
+
['/v2/portal/entity/{slug}/{id}']: {
|
|
18646
|
+
/**
|
|
18647
|
+
* patchPortalUserEntity - patchPortalUserEntity
|
|
18648
|
+
*
|
|
18649
|
+
* **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.
|
|
18650
|
+
* 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.
|
|
18651
|
+
*/
|
|
18652
|
+
'patch'(
|
|
18653
|
+
parameters?: Parameters<Paths.PatchPortalUserEntity.PathParameters> | null,
|
|
18654
|
+
data?: Paths.PatchPortalUserEntity.RequestBody,
|
|
18655
|
+
config?: AxiosRequestConfig
|
|
18656
|
+
): OperationResponse<Paths.PatchPortalUserEntity.Responses.$200>
|
|
18657
|
+
}
|
|
17850
18658
|
['/v2/portal/can-trigger-portal-flow']: {
|
|
17851
18659
|
/**
|
|
17852
18660
|
* canTriggerPortalFlow - canTriggerPortalFlow
|
|
@@ -18286,7 +19094,7 @@ interface PathsDictionary {
|
|
|
18286
19094
|
* Updates a specific portal configuration by ID.
|
|
18287
19095
|
*/
|
|
18288
19096
|
'put'(
|
|
18289
|
-
parameters?: Parameters<Paths.PutPortalConfig.PathParameters> | null,
|
|
19097
|
+
parameters?: Parameters<Paths.PutPortalConfig.QueryParameters & Paths.PutPortalConfig.PathParameters> | null,
|
|
18290
19098
|
data?: Paths.PutPortalConfig.RequestBody,
|
|
18291
19099
|
config?: AxiosRequestConfig
|
|
18292
19100
|
): OperationResponse<Paths.PutPortalConfig.Responses.$200>
|
|
@@ -18435,6 +19243,31 @@ interface PathsDictionary {
|
|
|
18435
19243
|
config?: AxiosRequestConfig
|
|
18436
19244
|
): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
|
|
18437
19245
|
}
|
|
19246
|
+
['/v1/portal/mobile-config']: {
|
|
19247
|
+
/**
|
|
19248
|
+
* getMobileConfig - getMobileConfig
|
|
19249
|
+
*
|
|
19250
|
+
* 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.
|
|
19251
|
+
*/
|
|
19252
|
+
'get'(
|
|
19253
|
+
parameters?: Parameters<Paths.GetMobileConfig.QueryParameters> | null,
|
|
19254
|
+
data?: any,
|
|
19255
|
+
config?: AxiosRequestConfig
|
|
19256
|
+
): OperationResponse<Paths.GetMobileConfig.Responses.$200>
|
|
19257
|
+
/**
|
|
19258
|
+
* putMobileConfig - putMobileConfig
|
|
19259
|
+
*
|
|
19260
|
+
* Merges the provided fields into the portal's mobile app configuration
|
|
19261
|
+
* (deep merge). Only mobile_config is modified; all other portal settings
|
|
19262
|
+
* are left untouched.
|
|
19263
|
+
*
|
|
19264
|
+
*/
|
|
19265
|
+
'put'(
|
|
19266
|
+
parameters?: Parameters<Paths.PutMobileConfig.QueryParameters> | null,
|
|
19267
|
+
data?: Paths.PutMobileConfig.RequestBody,
|
|
19268
|
+
config?: AxiosRequestConfig
|
|
19269
|
+
): OperationResponse<Paths.PutMobileConfig.Responses.$200>
|
|
19270
|
+
}
|
|
18438
19271
|
}
|
|
18439
19272
|
|
|
18440
19273
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -18504,10 +19337,13 @@ type Extension = Components.Schemas.Extension;
|
|
|
18504
19337
|
type ExtensionAuthBlock = Components.Schemas.ExtensionAuthBlock;
|
|
18505
19338
|
type ExtensionConfig = Components.Schemas.ExtensionConfig;
|
|
18506
19339
|
type ExtensionHook = Components.Schemas.ExtensionHook;
|
|
19340
|
+
type ExtensionHookChangeEmail = Components.Schemas.ExtensionHookChangeEmail;
|
|
19341
|
+
type ExtensionHookChangePassword = Components.Schemas.ExtensionHookChangePassword;
|
|
18507
19342
|
type ExtensionHookConsumptionDataRetrieval = Components.Schemas.ExtensionHookConsumptionDataRetrieval;
|
|
18508
19343
|
type ExtensionHookContractIdentification = Components.Schemas.ExtensionHookContractIdentification;
|
|
18509
19344
|
type ExtensionHookCostDataRetrieval = Components.Schemas.ExtensionHookCostDataRetrieval;
|
|
18510
19345
|
type ExtensionHookDataExport = Components.Schemas.ExtensionHookDataExport;
|
|
19346
|
+
type ExtensionHookDeleteAccount = Components.Schemas.ExtensionHookDeleteAccount;
|
|
18511
19347
|
type ExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.ExtensionHookMeterReadingPlausibilityCheck;
|
|
18512
19348
|
type ExtensionHookPriceDataRetrieval = Components.Schemas.ExtensionHookPriceDataRetrieval;
|
|
18513
19349
|
type ExtensionHookRegistrationIdentifiersCheck = Components.Schemas.ExtensionHookRegistrationIdentifiersCheck;
|
|
@@ -18530,6 +19366,10 @@ type MeterReading = Components.Schemas.MeterReading;
|
|
|
18530
19366
|
type MeterReadingPhoto = Components.Schemas.MeterReadingPhoto;
|
|
18531
19367
|
type MeterReadingPhotoData = Components.Schemas.MeterReadingPhotoData;
|
|
18532
19368
|
type MeterReadingWidget = Components.Schemas.MeterReadingWidget;
|
|
19369
|
+
type MobileBranding = Components.Schemas.MobileBranding;
|
|
19370
|
+
type MobileBuildStatus = Components.Schemas.MobileBuildStatus;
|
|
19371
|
+
type MobileConfig = Components.Schemas.MobileConfig;
|
|
19372
|
+
type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
|
|
18533
19373
|
type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
18534
19374
|
type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
18535
19375
|
type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
@@ -18553,11 +19393,15 @@ type ProviderDisplayName = Components.Schemas.ProviderDisplayName;
|
|
|
18553
19393
|
type ProviderPublicConfig = Components.Schemas.ProviderPublicConfig;
|
|
18554
19394
|
type ProviderSlug = Components.Schemas.ProviderSlug;
|
|
18555
19395
|
type PublicAppDetails = Components.Schemas.PublicAppDetails;
|
|
19396
|
+
type PublicChangeEmailDetails = Components.Schemas.PublicChangeEmailDetails;
|
|
19397
|
+
type PublicChangePasswordDetails = Components.Schemas.PublicChangePasswordDetails;
|
|
18556
19398
|
type PublicContractIdentificationDetails = Components.Schemas.PublicContractIdentificationDetails;
|
|
18557
19399
|
type PublicDataRetrievalHookDetails = Components.Schemas.PublicDataRetrievalHookDetails;
|
|
19400
|
+
type PublicDeleteAccountDetails = Components.Schemas.PublicDeleteAccountDetails;
|
|
18558
19401
|
type PublicExtensionCapabilities = Components.Schemas.PublicExtensionCapabilities;
|
|
18559
19402
|
type PublicExtensionDetails = Components.Schemas.PublicExtensionDetails;
|
|
18560
19403
|
type PublicMeterReadingPlausibilityCheckDetails = Components.Schemas.PublicMeterReadingPlausibilityCheckDetails;
|
|
19404
|
+
type PublicSelfManagementExplanation = Components.Schemas.PublicSelfManagementExplanation;
|
|
18561
19405
|
type ReadBy = Components.Schemas.ReadBy;
|
|
18562
19406
|
type ReadingStatus = Components.Schemas.ReadingStatus;
|
|
18563
19407
|
type Reason = Components.Schemas.Reason;
|
|
@@ -18592,4 +19436,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
|
|
18592
19436
|
type WorkflowExecution = Components.Schemas.WorkflowExecution;
|
|
18593
19437
|
type WorkflowStep = Components.Schemas.WorkflowStep;
|
|
18594
19438
|
|
|
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
|
|
19439
|
+
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 };
|