@epilot/sdk 2.15.4 → 2.15.6
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 +280 -3
- package/definitions/pricing.json +14 -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.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- 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-7LWNOS5V.js → chunk-6DBGRVEF.js} +3 -3
- package/dist/{chunk-L4XLUNUO.js → chunk-EPDH37RS.js} +1 -1
- package/dist/{chunk-IZ52TBS7.cjs → chunk-LKV3RKOP.cjs} +1 -1
- package/dist/{chunk-E7FFVRBQ.cjs → chunk-VBTUFDXY.cjs} +3 -3
- package/dist/customer-portal-JDIXJD6C.cjs +7 -0
- package/dist/customer-portal-WIRQ7UCN.js +7 -0
- package/dist/{customer-portal-runtime-SOZ4QOVZ.cjs → customer-portal-runtime-7WW3YRWJ.cjs} +2 -2
- package/dist/{customer-portal-runtime-QM3MLBPV.js → customer-portal-runtime-FZQLCEJQ.js} +1 -1
- package/dist/{customer-portal.d-DsB3qJro.d.cts → customer-portal.d-JVkJjm_e.d.cts} +225 -5
- package/dist/{customer-portal.d-DsB3qJro.d.ts → customer-portal.d-JVkJjm_e.d.ts} +225 -5
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/pricing-CXWAKLA6.js +7 -0
- package/dist/pricing-L7VUML4H.cjs +7 -0
- package/dist/{pricing.d-gPt5L7wp.d.cts → pricing.d-BgjfwicJ.d.cts} +22 -1
- package/dist/{pricing.d-gPt5L7wp.d.ts → pricing.d-BgjfwicJ.d.ts} +22 -1
- package/docs/customer-portal.md +216 -0
- package/docs/pricing.md +11 -0
- package/package.json +1 -1
- package/dist/customer-portal-7ZNROWXS.js +0 -7
- package/dist/customer-portal-ZW4I52KG.cjs +0 -7
- package/dist/pricing-5Y7TZHMR.js +0 -7
- package/dist/pricing-BJUABPHU.cjs +0 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkLKV3RKOPcjs = require('./chunk-LKV3RKOP.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkLKV3RKOPcjs.require_customer_portal_runtime.call(void 0, );
|
|
@@ -3618,7 +3618,7 @@ declare namespace Components {
|
|
|
3618
3618
|
*/
|
|
3619
3619
|
change_mode?: "synchronous" | "asynchronous";
|
|
3620
3620
|
/**
|
|
3621
|
-
* 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.
|
|
3621
|
+
* 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. Skipped for portal users whose identity is managed by an identity provider: an SSO login has no password to confirm. When no password is confirmed and `change_mode` is `synchronous`, the re-created login gets a random password and the portal user signs in through their identity provider, or sets a new password via the email code flow.
|
|
3622
3622
|
*
|
|
3623
3623
|
*/
|
|
3624
3624
|
require_password_confirmation?: boolean;
|
|
@@ -7204,6 +7204,20 @@ declare namespace Components {
|
|
|
7204
7204
|
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7205
7205
|
*/
|
|
7206
7206
|
export type PortalId = string;
|
|
7207
|
+
/**
|
|
7208
|
+
* Portal-specific (ECP / installer) display config of a workflow task
|
|
7209
|
+
*/
|
|
7210
|
+
export interface PortalTaskConfig {
|
|
7211
|
+
enabled?: boolean;
|
|
7212
|
+
label?: string;
|
|
7213
|
+
description?: string;
|
|
7214
|
+
journey?: {
|
|
7215
|
+
id?: string;
|
|
7216
|
+
journeyId?: string;
|
|
7217
|
+
name?: string;
|
|
7218
|
+
complete_task_automatically?: boolean;
|
|
7219
|
+
};
|
|
7220
|
+
}
|
|
7207
7221
|
/**
|
|
7208
7222
|
* The portal user entity
|
|
7209
7223
|
*/
|
|
@@ -7273,6 +7287,122 @@ declare namespace Components {
|
|
|
7273
7287
|
}
|
|
7274
7288
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
7275
7289
|
export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
|
|
7290
|
+
/**
|
|
7291
|
+
* A portal-facing projection of a workflow execution (V1 or V2), with the execution
|
|
7292
|
+
* graph already linearized by the Workflows API into a flat, ordered list of
|
|
7293
|
+
* portal-visible tasks.
|
|
7294
|
+
*
|
|
7295
|
+
*/
|
|
7296
|
+
export interface PortalWorkflow {
|
|
7297
|
+
/**
|
|
7298
|
+
* Id of the workflow / flow execution
|
|
7299
|
+
*/
|
|
7300
|
+
id: string;
|
|
7301
|
+
/**
|
|
7302
|
+
* Id of the workflow definition / flow template this execution was created from
|
|
7303
|
+
*/
|
|
7304
|
+
definition_id?: string;
|
|
7305
|
+
name: string;
|
|
7306
|
+
status: "STARTED" | "DONE" | "CLOSED";
|
|
7307
|
+
/**
|
|
7308
|
+
* 2 = legacy V1 workflow execution (linear model), 3 = V2 flow execution (graph model)
|
|
7309
|
+
*/
|
|
7310
|
+
version: 2 | 3;
|
|
7311
|
+
/**
|
|
7312
|
+
* Creation timestamp, doubles as started time
|
|
7313
|
+
*/
|
|
7314
|
+
created_at?: string;
|
|
7315
|
+
/**
|
|
7316
|
+
* Last update timestamp
|
|
7317
|
+
*/
|
|
7318
|
+
updated_at?: string;
|
|
7319
|
+
/**
|
|
7320
|
+
* Timestamp when the execution was completed, if it is
|
|
7321
|
+
*/
|
|
7322
|
+
completed_at?: string;
|
|
7323
|
+
due_date?: string;
|
|
7324
|
+
assigned_to?: string[];
|
|
7325
|
+
contexts?: {
|
|
7326
|
+
entity_id?: string;
|
|
7327
|
+
entity_schema?: string;
|
|
7328
|
+
is_primary?: boolean;
|
|
7329
|
+
}[];
|
|
7330
|
+
/**
|
|
7331
|
+
* True when the linearized path reached the end of the execution graph. False when an
|
|
7332
|
+
* unevaluated decision task was encountered, meaning additional tasks may appear once
|
|
7333
|
+
* the decision is resolved (the returned tasks are still the guaranteed active path).
|
|
7334
|
+
* Always true for V1 executions.
|
|
7335
|
+
*
|
|
7336
|
+
*/
|
|
7337
|
+
is_path_complete: boolean;
|
|
7338
|
+
/**
|
|
7339
|
+
* Portal-visible tasks in linear (timeline) order
|
|
7340
|
+
*/
|
|
7341
|
+
tasks: /* A single portal-visible task of a linearized workflow execution */ PortalWorkflowTask[];
|
|
7342
|
+
}
|
|
7343
|
+
/**
|
|
7344
|
+
* A single portal-visible task of a linearized workflow execution
|
|
7345
|
+
*/
|
|
7346
|
+
export interface PortalWorkflowTask {
|
|
7347
|
+
/**
|
|
7348
|
+
* Id of the underlying task (V2) or step (V1)
|
|
7349
|
+
*/
|
|
7350
|
+
id: string;
|
|
7351
|
+
/**
|
|
7352
|
+
* Internal task/step name (fallback label when the portal config has none)
|
|
7353
|
+
*/
|
|
7354
|
+
name: string;
|
|
7355
|
+
/**
|
|
7356
|
+
* Zero-based position of the task in the linearized timeline
|
|
7357
|
+
*/
|
|
7358
|
+
order: number;
|
|
7359
|
+
/**
|
|
7360
|
+
* Normalized task status:
|
|
7361
|
+
* - COMPLETED / SKIPPED: the task is done (skipped tasks count as done for progress)
|
|
7362
|
+
* - IN_PROGRESS: the task has been reached and work has started
|
|
7363
|
+
* - PENDING: the task has not been completed yet
|
|
7364
|
+
*
|
|
7365
|
+
*/
|
|
7366
|
+
status: "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "PENDING";
|
|
7367
|
+
/**
|
|
7368
|
+
* True when the task has been reached in the execution — all predecessor tasks on its
|
|
7369
|
+
* path are completed/skipped — so the portal user can act on it (e.g. start its journey).
|
|
7370
|
+
* Tasks that are only part of the projected future path are returned with is_active false.
|
|
7371
|
+
*
|
|
7372
|
+
*/
|
|
7373
|
+
is_active: boolean;
|
|
7374
|
+
ecp?: /* Portal-specific (ECP / installer) display config of a workflow task */ PortalTaskConfig;
|
|
7375
|
+
installer?: /* Portal-specific (ECP / installer) display config of a workflow task */ PortalTaskConfig;
|
|
7376
|
+
/**
|
|
7377
|
+
* Journey linked to the task, if any
|
|
7378
|
+
*/
|
|
7379
|
+
journey?: {
|
|
7380
|
+
id?: string;
|
|
7381
|
+
journeyId?: string;
|
|
7382
|
+
name?: string;
|
|
7383
|
+
/**
|
|
7384
|
+
* If true, the task is auto completed when the journey is completed
|
|
7385
|
+
*/
|
|
7386
|
+
complete_task_automatically?: boolean;
|
|
7387
|
+
};
|
|
7388
|
+
assigned_to?: string[];
|
|
7389
|
+
/**
|
|
7390
|
+
* Id of the phase the underlying task belongs to, if any (V2 only)
|
|
7391
|
+
*/
|
|
7392
|
+
phase_id?: string;
|
|
7393
|
+
/**
|
|
7394
|
+
* Name of the phase the underlying task belongs to, if any (V2 only)
|
|
7395
|
+
*/
|
|
7396
|
+
phase_name?: string;
|
|
7397
|
+
/**
|
|
7398
|
+
* Timestamp when the task was completed or skipped
|
|
7399
|
+
*/
|
|
7400
|
+
completed_at?: string;
|
|
7401
|
+
/**
|
|
7402
|
+
* Last update timestamp of the underlying task/step
|
|
7403
|
+
*/
|
|
7404
|
+
updated_at?: string;
|
|
7405
|
+
}
|
|
7276
7406
|
/**
|
|
7277
7407
|
* The product entity
|
|
7278
7408
|
*/
|
|
@@ -7497,7 +7627,7 @@ declare namespace Components {
|
|
|
7497
7627
|
change_mode?: "synchronous" | "asynchronous";
|
|
7498
7628
|
/**
|
|
7499
7629
|
* Whether the portal user must confirm their current password before the email change is handed over to the third-party system.
|
|
7500
|
-
*
|
|
7630
|
+
* Not required for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.
|
|
7501
7631
|
*
|
|
7502
7632
|
*/
|
|
7503
7633
|
require_password_confirmation?: boolean;
|
|
@@ -11565,6 +11695,51 @@ declare namespace Paths {
|
|
|
11565
11695
|
export type $500 = Components.Responses.InternalServerError;
|
|
11566
11696
|
}
|
|
11567
11697
|
}
|
|
11698
|
+
namespace GetEntityPortalWorkflows {
|
|
11699
|
+
namespace Parameters {
|
|
11700
|
+
/**
|
|
11701
|
+
* ID of the entity
|
|
11702
|
+
* example:
|
|
11703
|
+
* abc123
|
|
11704
|
+
*/
|
|
11705
|
+
export type Id = string;
|
|
11706
|
+
/**
|
|
11707
|
+
* Schema slug of the entity
|
|
11708
|
+
* example:
|
|
11709
|
+
* opportunity
|
|
11710
|
+
*/
|
|
11711
|
+
export type Slug = string;
|
|
11712
|
+
}
|
|
11713
|
+
export interface PathParameters {
|
|
11714
|
+
slug: /**
|
|
11715
|
+
* Schema slug of the entity
|
|
11716
|
+
* example:
|
|
11717
|
+
* opportunity
|
|
11718
|
+
*/
|
|
11719
|
+
Parameters.Slug;
|
|
11720
|
+
id: /**
|
|
11721
|
+
* ID of the entity
|
|
11722
|
+
* example:
|
|
11723
|
+
* abc123
|
|
11724
|
+
*/
|
|
11725
|
+
Parameters.Id;
|
|
11726
|
+
}
|
|
11727
|
+
namespace Responses {
|
|
11728
|
+
export interface $200 {
|
|
11729
|
+
portal_workflows?: /**
|
|
11730
|
+
* A portal-facing projection of a workflow execution (V1 or V2), with the execution
|
|
11731
|
+
* graph already linearized by the Workflows API into a flat, ordered list of
|
|
11732
|
+
* portal-visible tasks.
|
|
11733
|
+
*
|
|
11734
|
+
*/
|
|
11735
|
+
Components.Schemas.PortalWorkflow[];
|
|
11736
|
+
}
|
|
11737
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11738
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11739
|
+
export type $404 = Components.Responses.NotFound;
|
|
11740
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11741
|
+
}
|
|
11742
|
+
}
|
|
11568
11743
|
namespace GetEntityWorkflows {
|
|
11569
11744
|
namespace Parameters {
|
|
11570
11745
|
/**
|
|
@@ -15594,8 +15769,8 @@ declare namespace Paths {
|
|
|
15594
15769
|
email: string;
|
|
15595
15770
|
/**
|
|
15596
15771
|
* Password of the portal user for confirmation.
|
|
15597
|
-
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal
|
|
15598
|
-
*
|
|
15772
|
+
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal,
|
|
15773
|
+
* or the portal user's identity is managed by an identity provider - an SSO login has no password to confirm.
|
|
15599
15774
|
*
|
|
15600
15775
|
*/
|
|
15601
15776
|
password?: string;
|
|
@@ -17308,6 +17483,26 @@ interface OperationMethods {
|
|
|
17308
17483
|
data?: any,
|
|
17309
17484
|
config?: AxiosRequestConfig
|
|
17310
17485
|
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
17486
|
+
/**
|
|
17487
|
+
* getEntityPortalWorkflows - Get linearized workflows for an entity
|
|
17488
|
+
*
|
|
17489
|
+
* Get all portal-relevant workflows associated with an entity (requires access to the entity),
|
|
17490
|
+
* linearized by the Workflows API into a flat, ordered list of portal-visible tasks.
|
|
17491
|
+
*
|
|
17492
|
+
* Unlike `getEntityWorkflows`, this endpoint returns a single uniform shape for both legacy
|
|
17493
|
+
* (V1) workflow executions and graph-based (V2) flow executions — the execution graph is
|
|
17494
|
+
* already resolved server-side (active path, task reachability, chronological ordering), so
|
|
17495
|
+
* clients can render a timeline without any graph traversal logic.
|
|
17496
|
+
*
|
|
17497
|
+
* Tasks carry the config of both portal audiences (`ecp` and `installer`); clients filter
|
|
17498
|
+
* per their configured audience, so one response serves every block on a page.
|
|
17499
|
+
*
|
|
17500
|
+
*/
|
|
17501
|
+
'getEntityPortalWorkflows'(
|
|
17502
|
+
parameters?: Parameters<Paths.GetEntityPortalWorkflows.PathParameters> | null,
|
|
17503
|
+
data?: any,
|
|
17504
|
+
config?: AxiosRequestConfig
|
|
17505
|
+
): OperationResponse<Paths.GetEntityPortalWorkflows.Responses.$200>
|
|
17311
17506
|
/**
|
|
17312
17507
|
* uploadMeterReadingPhoto - Upload Meter Reading Photo
|
|
17313
17508
|
*
|
|
@@ -19210,6 +19405,28 @@ interface PathsDictionary {
|
|
|
19210
19405
|
config?: AxiosRequestConfig
|
|
19211
19406
|
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
19212
19407
|
}
|
|
19408
|
+
['/v2/portal/entity/{slug}/{id}/workflows/linearized']: {
|
|
19409
|
+
/**
|
|
19410
|
+
* getEntityPortalWorkflows - Get linearized workflows for an entity
|
|
19411
|
+
*
|
|
19412
|
+
* Get all portal-relevant workflows associated with an entity (requires access to the entity),
|
|
19413
|
+
* linearized by the Workflows API into a flat, ordered list of portal-visible tasks.
|
|
19414
|
+
*
|
|
19415
|
+
* Unlike `getEntityWorkflows`, this endpoint returns a single uniform shape for both legacy
|
|
19416
|
+
* (V1) workflow executions and graph-based (V2) flow executions — the execution graph is
|
|
19417
|
+
* already resolved server-side (active path, task reachability, chronological ordering), so
|
|
19418
|
+
* clients can render a timeline without any graph traversal logic.
|
|
19419
|
+
*
|
|
19420
|
+
* Tasks carry the config of both portal audiences (`ecp` and `installer`); clients filter
|
|
19421
|
+
* per their configured audience, so one response serves every block on a page.
|
|
19422
|
+
*
|
|
19423
|
+
*/
|
|
19424
|
+
'get'(
|
|
19425
|
+
parameters?: Parameters<Paths.GetEntityPortalWorkflows.PathParameters> | null,
|
|
19426
|
+
data?: any,
|
|
19427
|
+
config?: AxiosRequestConfig
|
|
19428
|
+
): OperationResponse<Paths.GetEntityPortalWorkflows.Responses.$200>
|
|
19429
|
+
}
|
|
19213
19430
|
['/v2/portal/metering/reading/photo']: {
|
|
19214
19431
|
/**
|
|
19215
19432
|
* uploadMeterReadingPhoto - Upload Meter Reading Photo
|
|
@@ -19893,9 +20110,12 @@ type PortalConfig = Components.Schemas.PortalConfig;
|
|
|
19893
20110
|
type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
19894
20111
|
type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
19895
20112
|
type PortalId = Components.Schemas.PortalId;
|
|
20113
|
+
type PortalTaskConfig = Components.Schemas.PortalTaskConfig;
|
|
19896
20114
|
type PortalUser = Components.Schemas.PortalUser;
|
|
19897
20115
|
type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
|
19898
20116
|
type PortalWidget = Components.Schemas.PortalWidget;
|
|
20117
|
+
type PortalWorkflow = Components.Schemas.PortalWorkflow;
|
|
20118
|
+
type PortalWorkflowTask = Components.Schemas.PortalWorkflowTask;
|
|
19899
20119
|
type Product = Components.Schemas.Product;
|
|
19900
20120
|
type ProductRecommendationsWidget = Components.Schemas.ProductRecommendationsWidget;
|
|
19901
20121
|
type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
@@ -19946,4 +20166,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
|
|
19946
20166
|
type WorkflowExecution = Components.Schemas.WorkflowExecution;
|
|
19947
20167
|
type WorkflowStep = Components.Schemas.WorkflowStep;
|
|
19948
20168
|
|
|
19949
|
-
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 PortalId 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 MobileOtaConfig as aM, type MoblieOIDCConfig as aN, type OIDCProviderConfig as aO, type OIDCProviderMetadata as aP, type Opportunity as aQ, type Order as aR, type OrganizationSettings as aS, type Origin as aT, type OtaPortal as aU, type Page as aV, type PageRequest as aW, type PaymentWidget as aX, type PortalConfig as aY, type PortalConfigV3 as aZ, type PortalDataExportColumn 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
|
|
20169
|
+
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 PortalId 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 MobileOtaConfig as aM, type MoblieOIDCConfig as aN, type OIDCProviderConfig as aO, type OIDCProviderMetadata as aP, type Opportunity as aQ, type Order as aR, type OrganizationSettings as aS, type Origin as aT, type OtaPortal as aU, type Page as aV, type PageRequest as aW, type PaymentWidget as aX, type PortalConfig as aY, type PortalConfigV3 as aZ, type PortalDataExportColumn 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 PortalTaskConfig as b0, type PortalUser as b1, type PortalUserRegistrationStatus as b2, type PortalWidget as b3, type PortalWorkflow as b4, type PortalWorkflowTask as b5, type Product as b6, type ProductRecommendationsWidget as b7, type ProviderConfig as b8, type ProviderDisplayName as b9, type SecureProxyConfig as bA, type Source as bB, type SwappableConfig as bC, type TariffType as bD, type TeaserWidget as bE, type TriggerPortalFlow as bF, type UpdateOnlyPortalConfigAttributes as bG, type UpsertPortalConfig as bH, type UpsertPortalConfigV3 as bI, UpsertPortalWidget as bJ, type UserRequest as bK, type VisualizationDataRange as bL, type VisualizationMetadata as bM, type VisualizationTypeOption as bN, type WidgetAction as bO, type WidgetBase as bP, type WorfklowIdentifier as bQ, type WorkflowExecution as bR, type WorkflowStep as bS, type ProviderPublicConfig as ba, type ProviderSlug as bb, type PublicAppDetails as bc, type PublicChangeEmailDetails as bd, type PublicChangePasswordDetails as be, type PublicContractIdentificationDetails as bf, type PublicDataRetrievalHookDetails as bg, type PublicDeleteAccountDetails as bh, type PublicExtensionCapabilities as bi, type PublicExtensionDetails as bj, type PublicMeterReadingPlausibilityCheckDetails as bk, type PublicSelfManagementExplanation as bl, type ReadBy as bm, type ReadingStatus as bn, type Reason as bo, type RegistrationIdentifier as bp, type ReimbursementEvent as bq, type Rule as br, type SAMLProviderConfig as bs, type SSOCallbackRequest as bt, type SSOCallbackResponse as bu, type SSOLoginToken as bv, SaveEntityFile as bw, type SavePortalFile as bx, type Schema as by, type SearchIncludes 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 };
|
|
@@ -3618,7 +3618,7 @@ declare namespace Components {
|
|
|
3618
3618
|
*/
|
|
3619
3619
|
change_mode?: "synchronous" | "asynchronous";
|
|
3620
3620
|
/**
|
|
3621
|
-
* 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.
|
|
3621
|
+
* 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. Skipped for portal users whose identity is managed by an identity provider: an SSO login has no password to confirm. When no password is confirmed and `change_mode` is `synchronous`, the re-created login gets a random password and the portal user signs in through their identity provider, or sets a new password via the email code flow.
|
|
3622
3622
|
*
|
|
3623
3623
|
*/
|
|
3624
3624
|
require_password_confirmation?: boolean;
|
|
@@ -7204,6 +7204,20 @@ declare namespace Components {
|
|
|
7204
7204
|
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7205
7205
|
*/
|
|
7206
7206
|
export type PortalId = string;
|
|
7207
|
+
/**
|
|
7208
|
+
* Portal-specific (ECP / installer) display config of a workflow task
|
|
7209
|
+
*/
|
|
7210
|
+
export interface PortalTaskConfig {
|
|
7211
|
+
enabled?: boolean;
|
|
7212
|
+
label?: string;
|
|
7213
|
+
description?: string;
|
|
7214
|
+
journey?: {
|
|
7215
|
+
id?: string;
|
|
7216
|
+
journeyId?: string;
|
|
7217
|
+
name?: string;
|
|
7218
|
+
complete_task_automatically?: boolean;
|
|
7219
|
+
};
|
|
7220
|
+
}
|
|
7207
7221
|
/**
|
|
7208
7222
|
* The portal user entity
|
|
7209
7223
|
*/
|
|
@@ -7273,6 +7287,122 @@ declare namespace Components {
|
|
|
7273
7287
|
}
|
|
7274
7288
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
7275
7289
|
export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget | MeterReadingWidget | MeterChartWidget | CampaignWidget | ProductRecommendationsWidget;
|
|
7290
|
+
/**
|
|
7291
|
+
* A portal-facing projection of a workflow execution (V1 or V2), with the execution
|
|
7292
|
+
* graph already linearized by the Workflows API into a flat, ordered list of
|
|
7293
|
+
* portal-visible tasks.
|
|
7294
|
+
*
|
|
7295
|
+
*/
|
|
7296
|
+
export interface PortalWorkflow {
|
|
7297
|
+
/**
|
|
7298
|
+
* Id of the workflow / flow execution
|
|
7299
|
+
*/
|
|
7300
|
+
id: string;
|
|
7301
|
+
/**
|
|
7302
|
+
* Id of the workflow definition / flow template this execution was created from
|
|
7303
|
+
*/
|
|
7304
|
+
definition_id?: string;
|
|
7305
|
+
name: string;
|
|
7306
|
+
status: "STARTED" | "DONE" | "CLOSED";
|
|
7307
|
+
/**
|
|
7308
|
+
* 2 = legacy V1 workflow execution (linear model), 3 = V2 flow execution (graph model)
|
|
7309
|
+
*/
|
|
7310
|
+
version: 2 | 3;
|
|
7311
|
+
/**
|
|
7312
|
+
* Creation timestamp, doubles as started time
|
|
7313
|
+
*/
|
|
7314
|
+
created_at?: string;
|
|
7315
|
+
/**
|
|
7316
|
+
* Last update timestamp
|
|
7317
|
+
*/
|
|
7318
|
+
updated_at?: string;
|
|
7319
|
+
/**
|
|
7320
|
+
* Timestamp when the execution was completed, if it is
|
|
7321
|
+
*/
|
|
7322
|
+
completed_at?: string;
|
|
7323
|
+
due_date?: string;
|
|
7324
|
+
assigned_to?: string[];
|
|
7325
|
+
contexts?: {
|
|
7326
|
+
entity_id?: string;
|
|
7327
|
+
entity_schema?: string;
|
|
7328
|
+
is_primary?: boolean;
|
|
7329
|
+
}[];
|
|
7330
|
+
/**
|
|
7331
|
+
* True when the linearized path reached the end of the execution graph. False when an
|
|
7332
|
+
* unevaluated decision task was encountered, meaning additional tasks may appear once
|
|
7333
|
+
* the decision is resolved (the returned tasks are still the guaranteed active path).
|
|
7334
|
+
* Always true for V1 executions.
|
|
7335
|
+
*
|
|
7336
|
+
*/
|
|
7337
|
+
is_path_complete: boolean;
|
|
7338
|
+
/**
|
|
7339
|
+
* Portal-visible tasks in linear (timeline) order
|
|
7340
|
+
*/
|
|
7341
|
+
tasks: /* A single portal-visible task of a linearized workflow execution */ PortalWorkflowTask[];
|
|
7342
|
+
}
|
|
7343
|
+
/**
|
|
7344
|
+
* A single portal-visible task of a linearized workflow execution
|
|
7345
|
+
*/
|
|
7346
|
+
export interface PortalWorkflowTask {
|
|
7347
|
+
/**
|
|
7348
|
+
* Id of the underlying task (V2) or step (V1)
|
|
7349
|
+
*/
|
|
7350
|
+
id: string;
|
|
7351
|
+
/**
|
|
7352
|
+
* Internal task/step name (fallback label when the portal config has none)
|
|
7353
|
+
*/
|
|
7354
|
+
name: string;
|
|
7355
|
+
/**
|
|
7356
|
+
* Zero-based position of the task in the linearized timeline
|
|
7357
|
+
*/
|
|
7358
|
+
order: number;
|
|
7359
|
+
/**
|
|
7360
|
+
* Normalized task status:
|
|
7361
|
+
* - COMPLETED / SKIPPED: the task is done (skipped tasks count as done for progress)
|
|
7362
|
+
* - IN_PROGRESS: the task has been reached and work has started
|
|
7363
|
+
* - PENDING: the task has not been completed yet
|
|
7364
|
+
*
|
|
7365
|
+
*/
|
|
7366
|
+
status: "COMPLETED" | "SKIPPED" | "IN_PROGRESS" | "PENDING";
|
|
7367
|
+
/**
|
|
7368
|
+
* True when the task has been reached in the execution — all predecessor tasks on its
|
|
7369
|
+
* path are completed/skipped — so the portal user can act on it (e.g. start its journey).
|
|
7370
|
+
* Tasks that are only part of the projected future path are returned with is_active false.
|
|
7371
|
+
*
|
|
7372
|
+
*/
|
|
7373
|
+
is_active: boolean;
|
|
7374
|
+
ecp?: /* Portal-specific (ECP / installer) display config of a workflow task */ PortalTaskConfig;
|
|
7375
|
+
installer?: /* Portal-specific (ECP / installer) display config of a workflow task */ PortalTaskConfig;
|
|
7376
|
+
/**
|
|
7377
|
+
* Journey linked to the task, if any
|
|
7378
|
+
*/
|
|
7379
|
+
journey?: {
|
|
7380
|
+
id?: string;
|
|
7381
|
+
journeyId?: string;
|
|
7382
|
+
name?: string;
|
|
7383
|
+
/**
|
|
7384
|
+
* If true, the task is auto completed when the journey is completed
|
|
7385
|
+
*/
|
|
7386
|
+
complete_task_automatically?: boolean;
|
|
7387
|
+
};
|
|
7388
|
+
assigned_to?: string[];
|
|
7389
|
+
/**
|
|
7390
|
+
* Id of the phase the underlying task belongs to, if any (V2 only)
|
|
7391
|
+
*/
|
|
7392
|
+
phase_id?: string;
|
|
7393
|
+
/**
|
|
7394
|
+
* Name of the phase the underlying task belongs to, if any (V2 only)
|
|
7395
|
+
*/
|
|
7396
|
+
phase_name?: string;
|
|
7397
|
+
/**
|
|
7398
|
+
* Timestamp when the task was completed or skipped
|
|
7399
|
+
*/
|
|
7400
|
+
completed_at?: string;
|
|
7401
|
+
/**
|
|
7402
|
+
* Last update timestamp of the underlying task/step
|
|
7403
|
+
*/
|
|
7404
|
+
updated_at?: string;
|
|
7405
|
+
}
|
|
7276
7406
|
/**
|
|
7277
7407
|
* The product entity
|
|
7278
7408
|
*/
|
|
@@ -7497,7 +7627,7 @@ declare namespace Components {
|
|
|
7497
7627
|
change_mode?: "synchronous" | "asynchronous";
|
|
7498
7628
|
/**
|
|
7499
7629
|
* Whether the portal user must confirm their current password before the email change is handed over to the third-party system.
|
|
7500
|
-
*
|
|
7630
|
+
* Not required for portal users whose identity is managed by an identity provider - an SSO login has no password to confirm.
|
|
7501
7631
|
*
|
|
7502
7632
|
*/
|
|
7503
7633
|
require_password_confirmation?: boolean;
|
|
@@ -11565,6 +11695,51 @@ declare namespace Paths {
|
|
|
11565
11695
|
export type $500 = Components.Responses.InternalServerError;
|
|
11566
11696
|
}
|
|
11567
11697
|
}
|
|
11698
|
+
namespace GetEntityPortalWorkflows {
|
|
11699
|
+
namespace Parameters {
|
|
11700
|
+
/**
|
|
11701
|
+
* ID of the entity
|
|
11702
|
+
* example:
|
|
11703
|
+
* abc123
|
|
11704
|
+
*/
|
|
11705
|
+
export type Id = string;
|
|
11706
|
+
/**
|
|
11707
|
+
* Schema slug of the entity
|
|
11708
|
+
* example:
|
|
11709
|
+
* opportunity
|
|
11710
|
+
*/
|
|
11711
|
+
export type Slug = string;
|
|
11712
|
+
}
|
|
11713
|
+
export interface PathParameters {
|
|
11714
|
+
slug: /**
|
|
11715
|
+
* Schema slug of the entity
|
|
11716
|
+
* example:
|
|
11717
|
+
* opportunity
|
|
11718
|
+
*/
|
|
11719
|
+
Parameters.Slug;
|
|
11720
|
+
id: /**
|
|
11721
|
+
* ID of the entity
|
|
11722
|
+
* example:
|
|
11723
|
+
* abc123
|
|
11724
|
+
*/
|
|
11725
|
+
Parameters.Id;
|
|
11726
|
+
}
|
|
11727
|
+
namespace Responses {
|
|
11728
|
+
export interface $200 {
|
|
11729
|
+
portal_workflows?: /**
|
|
11730
|
+
* A portal-facing projection of a workflow execution (V1 or V2), with the execution
|
|
11731
|
+
* graph already linearized by the Workflows API into a flat, ordered list of
|
|
11732
|
+
* portal-visible tasks.
|
|
11733
|
+
*
|
|
11734
|
+
*/
|
|
11735
|
+
Components.Schemas.PortalWorkflow[];
|
|
11736
|
+
}
|
|
11737
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11738
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11739
|
+
export type $404 = Components.Responses.NotFound;
|
|
11740
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11741
|
+
}
|
|
11742
|
+
}
|
|
11568
11743
|
namespace GetEntityWorkflows {
|
|
11569
11744
|
namespace Parameters {
|
|
11570
11745
|
/**
|
|
@@ -15594,8 +15769,8 @@ declare namespace Paths {
|
|
|
15594
15769
|
email: string;
|
|
15595
15770
|
/**
|
|
15596
15771
|
* Password of the portal user for confirmation.
|
|
15597
|
-
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal
|
|
15598
|
-
*
|
|
15772
|
+
* Required unless a `changeEmail` portal extension hook with `require_password_confirmation` disabled is configured for the portal,
|
|
15773
|
+
* or the portal user's identity is managed by an identity provider - an SSO login has no password to confirm.
|
|
15599
15774
|
*
|
|
15600
15775
|
*/
|
|
15601
15776
|
password?: string;
|
|
@@ -17308,6 +17483,26 @@ interface OperationMethods {
|
|
|
17308
17483
|
data?: any,
|
|
17309
17484
|
config?: AxiosRequestConfig
|
|
17310
17485
|
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
17486
|
+
/**
|
|
17487
|
+
* getEntityPortalWorkflows - Get linearized workflows for an entity
|
|
17488
|
+
*
|
|
17489
|
+
* Get all portal-relevant workflows associated with an entity (requires access to the entity),
|
|
17490
|
+
* linearized by the Workflows API into a flat, ordered list of portal-visible tasks.
|
|
17491
|
+
*
|
|
17492
|
+
* Unlike `getEntityWorkflows`, this endpoint returns a single uniform shape for both legacy
|
|
17493
|
+
* (V1) workflow executions and graph-based (V2) flow executions — the execution graph is
|
|
17494
|
+
* already resolved server-side (active path, task reachability, chronological ordering), so
|
|
17495
|
+
* clients can render a timeline without any graph traversal logic.
|
|
17496
|
+
*
|
|
17497
|
+
* Tasks carry the config of both portal audiences (`ecp` and `installer`); clients filter
|
|
17498
|
+
* per their configured audience, so one response serves every block on a page.
|
|
17499
|
+
*
|
|
17500
|
+
*/
|
|
17501
|
+
'getEntityPortalWorkflows'(
|
|
17502
|
+
parameters?: Parameters<Paths.GetEntityPortalWorkflows.PathParameters> | null,
|
|
17503
|
+
data?: any,
|
|
17504
|
+
config?: AxiosRequestConfig
|
|
17505
|
+
): OperationResponse<Paths.GetEntityPortalWorkflows.Responses.$200>
|
|
17311
17506
|
/**
|
|
17312
17507
|
* uploadMeterReadingPhoto - Upload Meter Reading Photo
|
|
17313
17508
|
*
|
|
@@ -19210,6 +19405,28 @@ interface PathsDictionary {
|
|
|
19210
19405
|
config?: AxiosRequestConfig
|
|
19211
19406
|
): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
|
|
19212
19407
|
}
|
|
19408
|
+
['/v2/portal/entity/{slug}/{id}/workflows/linearized']: {
|
|
19409
|
+
/**
|
|
19410
|
+
* getEntityPortalWorkflows - Get linearized workflows for an entity
|
|
19411
|
+
*
|
|
19412
|
+
* Get all portal-relevant workflows associated with an entity (requires access to the entity),
|
|
19413
|
+
* linearized by the Workflows API into a flat, ordered list of portal-visible tasks.
|
|
19414
|
+
*
|
|
19415
|
+
* Unlike `getEntityWorkflows`, this endpoint returns a single uniform shape for both legacy
|
|
19416
|
+
* (V1) workflow executions and graph-based (V2) flow executions — the execution graph is
|
|
19417
|
+
* already resolved server-side (active path, task reachability, chronological ordering), so
|
|
19418
|
+
* clients can render a timeline without any graph traversal logic.
|
|
19419
|
+
*
|
|
19420
|
+
* Tasks carry the config of both portal audiences (`ecp` and `installer`); clients filter
|
|
19421
|
+
* per their configured audience, so one response serves every block on a page.
|
|
19422
|
+
*
|
|
19423
|
+
*/
|
|
19424
|
+
'get'(
|
|
19425
|
+
parameters?: Parameters<Paths.GetEntityPortalWorkflows.PathParameters> | null,
|
|
19426
|
+
data?: any,
|
|
19427
|
+
config?: AxiosRequestConfig
|
|
19428
|
+
): OperationResponse<Paths.GetEntityPortalWorkflows.Responses.$200>
|
|
19429
|
+
}
|
|
19213
19430
|
['/v2/portal/metering/reading/photo']: {
|
|
19214
19431
|
/**
|
|
19215
19432
|
* uploadMeterReadingPhoto - Upload Meter Reading Photo
|
|
@@ -19893,9 +20110,12 @@ type PortalConfig = Components.Schemas.PortalConfig;
|
|
|
19893
20110
|
type PortalConfigV3 = Components.Schemas.PortalConfigV3;
|
|
19894
20111
|
type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
|
|
19895
20112
|
type PortalId = Components.Schemas.PortalId;
|
|
20113
|
+
type PortalTaskConfig = Components.Schemas.PortalTaskConfig;
|
|
19896
20114
|
type PortalUser = Components.Schemas.PortalUser;
|
|
19897
20115
|
type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
|
|
19898
20116
|
type PortalWidget = Components.Schemas.PortalWidget;
|
|
20117
|
+
type PortalWorkflow = Components.Schemas.PortalWorkflow;
|
|
20118
|
+
type PortalWorkflowTask = Components.Schemas.PortalWorkflowTask;
|
|
19899
20119
|
type Product = Components.Schemas.Product;
|
|
19900
20120
|
type ProductRecommendationsWidget = Components.Schemas.ProductRecommendationsWidget;
|
|
19901
20121
|
type ProviderConfig = Components.Schemas.ProviderConfig;
|
|
@@ -19946,4 +20166,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
|
|
19946
20166
|
type WorkflowExecution = Components.Schemas.WorkflowExecution;
|
|
19947
20167
|
type WorkflowStep = Components.Schemas.WorkflowStep;
|
|
19948
20168
|
|
|
19949
|
-
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 PortalId 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 MobileOtaConfig as aM, type MoblieOIDCConfig as aN, type OIDCProviderConfig as aO, type OIDCProviderMetadata as aP, type Opportunity as aQ, type Order as aR, type OrganizationSettings as aS, type Origin as aT, type OtaPortal as aU, type Page as aV, type PageRequest as aW, type PaymentWidget as aX, type PortalConfig as aY, type PortalConfigV3 as aZ, type PortalDataExportColumn 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
|
|
20169
|
+
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 PortalId 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 MobileOtaConfig as aM, type MoblieOIDCConfig as aN, type OIDCProviderConfig as aO, type OIDCProviderMetadata as aP, type Opportunity as aQ, type Order as aR, type OrganizationSettings as aS, type Origin as aT, type OtaPortal as aU, type Page as aV, type PageRequest as aW, type PaymentWidget as aX, type PortalConfig as aY, type PortalConfigV3 as aZ, type PortalDataExportColumn 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 PortalTaskConfig as b0, type PortalUser as b1, type PortalUserRegistrationStatus as b2, type PortalWidget as b3, type PortalWorkflow as b4, type PortalWorkflowTask as b5, type Product as b6, type ProductRecommendationsWidget as b7, type ProviderConfig as b8, type ProviderDisplayName as b9, type SecureProxyConfig as bA, type Source as bB, type SwappableConfig as bC, type TariffType as bD, type TeaserWidget as bE, type TriggerPortalFlow as bF, type UpdateOnlyPortalConfigAttributes as bG, type UpsertPortalConfig as bH, type UpsertPortalConfigV3 as bI, UpsertPortalWidget as bJ, type UserRequest as bK, type VisualizationDataRange as bL, type VisualizationMetadata as bM, type VisualizationTypeOption as bN, type WidgetAction as bO, type WidgetBase as bP, type WorfklowIdentifier as bQ, type WorkflowExecution as bR, type WorkflowStep as bS, type ProviderPublicConfig as ba, type ProviderSlug as bb, type PublicAppDetails as bc, type PublicChangeEmailDetails as bd, type PublicChangePasswordDetails as be, type PublicContractIdentificationDetails as bf, type PublicDataRetrievalHookDetails as bg, type PublicDeleteAccountDetails as bh, type PublicExtensionCapabilities as bi, type PublicExtensionDetails as bj, type PublicMeterReadingPlausibilityCheckDetails as bk, type PublicSelfManagementExplanation as bl, type ReadBy as bm, type ReadingStatus as bn, type Reason as bo, type RegistrationIdentifier as bp, type ReimbursementEvent as bq, type Rule as br, type SAMLProviderConfig as bs, type SSOCallbackRequest as bt, type SSOCallbackResponse as bu, type SSOLoginToken as bv, SaveEntityFile as bw, type SavePortalFile as bx, type Schema as by, type SearchIncludes 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 };
|