@epilot/app-client 0.13.8 → 0.15.0
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/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +35 -0
- package/dist/openapi.d.ts +365 -49
- package/dist/openapi.json +331 -22
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -8,6 +8,12 @@ import type {
|
|
|
8
8
|
|
|
9
9
|
declare namespace Components {
|
|
10
10
|
namespace RequestBodies {
|
|
11
|
+
export interface CloneVersionRequest {
|
|
12
|
+
/**
|
|
13
|
+
* Short description of what the new version will change
|
|
14
|
+
*/
|
|
15
|
+
changelog?: string;
|
|
16
|
+
}
|
|
11
17
|
export interface CreateBundlePresignedRequest {
|
|
12
18
|
/**
|
|
13
19
|
* Version of the app
|
|
@@ -105,6 +111,25 @@ declare namespace Components {
|
|
|
105
111
|
*/
|
|
106
112
|
role_id?: string | null;
|
|
107
113
|
grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Schemas.Grants;
|
|
114
|
+
/**
|
|
115
|
+
* Replaces the full set of server-side functions for this version
|
|
116
|
+
*/
|
|
117
|
+
functions?: /**
|
|
118
|
+
* A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
Schemas.FunctionDefinition[];
|
|
122
|
+
/**
|
|
123
|
+
* Replaces the full set of app-level option declarations for this version.
|
|
124
|
+
* Option keys must be unique app-wide; `secret`-touching options are always
|
|
125
|
+
* sensitive and must not declare `sensitive: false`.
|
|
126
|
+
*
|
|
127
|
+
*/
|
|
128
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Schemas.Options[];
|
|
129
|
+
/**
|
|
130
|
+
* Short description of what changed in this version
|
|
131
|
+
*/
|
|
132
|
+
changelog?: string;
|
|
108
133
|
}
|
|
109
134
|
export type UpsertComponentRequest = Schemas.BaseComponent;
|
|
110
135
|
}
|
|
@@ -155,9 +180,9 @@ declare namespace Components {
|
|
|
155
180
|
*/
|
|
156
181
|
target: string; // ^https://
|
|
157
182
|
/**
|
|
158
|
-
* Authentication strategy
|
|
183
|
+
* Authentication strategy. 'basic' sends an HTTP Basic Authorization header built server-side from the 'username' and 'password' component options.
|
|
159
184
|
*/
|
|
160
|
-
auth_type: "header" | "bearer" | "oauth2" | "none";
|
|
185
|
+
auth_type: "header" | "bearer" | "basic" | "oauth2" | "none";
|
|
161
186
|
/**
|
|
162
187
|
* Header name for 'header' auth type
|
|
163
188
|
*/
|
|
@@ -276,7 +301,16 @@ declare namespace Components {
|
|
|
276
301
|
/**
|
|
277
302
|
* List of options for the app component
|
|
278
303
|
*/
|
|
279
|
-
options?: /*
|
|
304
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
|
|
305
|
+
/**
|
|
306
|
+
* Keys of app-level options this component uses. Narrows which options are
|
|
307
|
+
* folded back into `options` for legacy consumers (e.g. which values a journey
|
|
308
|
+
* block receives in its public args) — a scoping hint, never a security
|
|
309
|
+
* boundary. Stamped automatically by the component-options migration; may also
|
|
310
|
+
* be declared by the app developer.
|
|
311
|
+
*
|
|
312
|
+
*/
|
|
313
|
+
uses_options?: string[];
|
|
280
314
|
surfaces?: {
|
|
281
315
|
[key: string]: any;
|
|
282
316
|
};
|
|
@@ -315,7 +349,16 @@ declare namespace Components {
|
|
|
315
349
|
/**
|
|
316
350
|
* List of options for the app component
|
|
317
351
|
*/
|
|
318
|
-
options?: /*
|
|
352
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
|
|
353
|
+
/**
|
|
354
|
+
* Keys of app-level options this component uses. Narrows which options are
|
|
355
|
+
* folded back into `options` for legacy consumers (e.g. which values a journey
|
|
356
|
+
* block receives in its public args) — a scoping hint, never a security
|
|
357
|
+
* boundary. Stamped automatically by the component-options migration; may also
|
|
358
|
+
* be declared by the app developer.
|
|
359
|
+
*
|
|
360
|
+
*/
|
|
361
|
+
uses_options?: string[];
|
|
319
362
|
surfaces?: {
|
|
320
363
|
[key: string]: any;
|
|
321
364
|
};
|
|
@@ -504,7 +547,7 @@ declare namespace Components {
|
|
|
504
547
|
/**
|
|
505
548
|
* Type of app component
|
|
506
549
|
*/
|
|
507
|
-
export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY";
|
|
550
|
+
export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "APP_FUNCTION";
|
|
508
551
|
/**
|
|
509
552
|
* Configuration of the published app
|
|
510
553
|
*/
|
|
@@ -612,6 +655,18 @@ declare namespace Components {
|
|
|
612
655
|
updated_by?: string;
|
|
613
656
|
};
|
|
614
657
|
components: BaseComponent[];
|
|
658
|
+
/**
|
|
659
|
+
* Server-side functions of the app, including scheduled functions
|
|
660
|
+
*/
|
|
661
|
+
functions?: /**
|
|
662
|
+
* A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
|
|
663
|
+
*
|
|
664
|
+
*/
|
|
665
|
+
FunctionDefinition[];
|
|
666
|
+
/**
|
|
667
|
+
* App-level option declarations (with sensitivity) of this version
|
|
668
|
+
*/
|
|
669
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
|
|
615
670
|
/**
|
|
616
671
|
* Visibility of the app version
|
|
617
672
|
*/
|
|
@@ -790,6 +845,18 @@ declare namespace Components {
|
|
|
790
845
|
*/
|
|
791
846
|
owner_org_id: string;
|
|
792
847
|
components: BaseComponent[];
|
|
848
|
+
/**
|
|
849
|
+
* Server-side functions of the app, including scheduled functions
|
|
850
|
+
*/
|
|
851
|
+
functions?: /**
|
|
852
|
+
* A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
|
|
853
|
+
*
|
|
854
|
+
*/
|
|
855
|
+
FunctionDefinition[];
|
|
856
|
+
/**
|
|
857
|
+
* App-level option declarations (with sensitivity) of this version
|
|
858
|
+
*/
|
|
859
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
|
|
793
860
|
/**
|
|
794
861
|
* Visibility of the app version
|
|
795
862
|
*/
|
|
@@ -869,12 +936,24 @@ declare namespace Components {
|
|
|
869
936
|
}
|
|
870
937
|
export interface CustomFlowActionComponent {
|
|
871
938
|
component_type: "CUSTOM_FLOW_ACTION";
|
|
872
|
-
configuration:
|
|
939
|
+
configuration: /**
|
|
940
|
+
* Configuration of a flow action component. `external_integration` calls an external HTTP endpoint; `function` runs a workflow-type app function in the epilot sandbox.
|
|
941
|
+
*
|
|
942
|
+
*/
|
|
943
|
+
CustomFlowConfig;
|
|
873
944
|
surfaces?: {
|
|
874
945
|
flow_action_config?: AppBridgeSurfaceConfig;
|
|
875
946
|
};
|
|
876
947
|
}
|
|
877
|
-
|
|
948
|
+
/**
|
|
949
|
+
* Configuration of a flow action component. `external_integration` calls an external HTTP endpoint; `function` runs a workflow-type app function in the epilot sandbox.
|
|
950
|
+
*
|
|
951
|
+
*/
|
|
952
|
+
export type CustomFlowConfig = /**
|
|
953
|
+
* Configuration of a flow action component. `external_integration` calls an external HTTP endpoint; `function` runs a workflow-type app function in the epilot sandbox.
|
|
954
|
+
*
|
|
955
|
+
*/
|
|
956
|
+
ExternalIntegrationCustomActionConfig | FunctionRefCustomActionConfig;
|
|
878
957
|
export interface CustomPageComponent {
|
|
879
958
|
component_type: "CUSTOM_PAGE";
|
|
880
959
|
configuration: CustomPageConfig;
|
|
@@ -997,6 +1076,10 @@ declare namespace Components {
|
|
|
997
1076
|
* Filter by correlation ID for tracing
|
|
998
1077
|
*/
|
|
999
1078
|
correlation_id?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Case-insensitive substring match over event details and component id
|
|
1081
|
+
*/
|
|
1082
|
+
search?: string;
|
|
1000
1083
|
};
|
|
1001
1084
|
aggregation?: {
|
|
1002
1085
|
/**
|
|
@@ -1011,6 +1094,11 @@ declare namespace Components {
|
|
|
1011
1094
|
pagination?: {
|
|
1012
1095
|
page?: number;
|
|
1013
1096
|
page_size?: number;
|
|
1097
|
+
/**
|
|
1098
|
+
* Cursor: only return events strictly older than this timestamp. Use the timestamp of the last received event to fetch the next page; more efficient than increasing page/page_size.
|
|
1099
|
+
*
|
|
1100
|
+
*/
|
|
1101
|
+
before?: string; // date-time
|
|
1014
1102
|
};
|
|
1015
1103
|
sort?: {
|
|
1016
1104
|
field?: "timestamp" | "event_type" | "component_id";
|
|
@@ -1176,6 +1264,93 @@ declare namespace Components {
|
|
|
1176
1264
|
};
|
|
1177
1265
|
};
|
|
1178
1266
|
}
|
|
1267
|
+
/**
|
|
1268
|
+
* A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
|
|
1269
|
+
*
|
|
1270
|
+
*/
|
|
1271
|
+
export interface FunctionDefinition {
|
|
1272
|
+
/**
|
|
1273
|
+
* Unique function name within the app
|
|
1274
|
+
*/
|
|
1275
|
+
name: string; // ^[a-z0-9][a-z0-9-]{0,63}$
|
|
1276
|
+
/**
|
|
1277
|
+
* Where the function can be used. `workflow` functions are referenced by CUSTOM_FLOW_ACTION components (type `function`) and run with entity context. `scheduled` functions run automatically per installation on their cron schedule.
|
|
1278
|
+
*
|
|
1279
|
+
*/
|
|
1280
|
+
type: "workflow" | "scheduled";
|
|
1281
|
+
/**
|
|
1282
|
+
* Human-readable display name of the function, shown to installing organizations (e.g. in the scheduled-functions summary)
|
|
1283
|
+
*
|
|
1284
|
+
*/
|
|
1285
|
+
label?: {
|
|
1286
|
+
/**
|
|
1287
|
+
* English translation
|
|
1288
|
+
*/
|
|
1289
|
+
en?: string | null;
|
|
1290
|
+
/**
|
|
1291
|
+
* German translation
|
|
1292
|
+
*/
|
|
1293
|
+
de: string;
|
|
1294
|
+
};
|
|
1295
|
+
/**
|
|
1296
|
+
* Description of the function
|
|
1297
|
+
*/
|
|
1298
|
+
description?: {
|
|
1299
|
+
/**
|
|
1300
|
+
* English translation
|
|
1301
|
+
*/
|
|
1302
|
+
en?: string | null;
|
|
1303
|
+
/**
|
|
1304
|
+
* German translation
|
|
1305
|
+
*/
|
|
1306
|
+
de: string;
|
|
1307
|
+
};
|
|
1308
|
+
/**
|
|
1309
|
+
* JavaScript code to execute. Must declare a top-level `async function handler(input, context)`. Maximum size: 300KB (hard limit). Security restrictions: eval() and Function() constructor are not allowed.
|
|
1310
|
+
*
|
|
1311
|
+
*/
|
|
1312
|
+
code: string;
|
|
1313
|
+
/**
|
|
1314
|
+
* Cron trigger for the function, executed once per installation. Standard 5-field cron expression (e.g. "0 3 * * *") or rate expression (e.g. "rate(30 minutes)"). Minimum interval: 15 minutes. Scheduled runs are limited to 60 seconds.
|
|
1315
|
+
*
|
|
1316
|
+
* example:
|
|
1317
|
+
* rate(30 minutes)
|
|
1318
|
+
*/
|
|
1319
|
+
schedule?: string;
|
|
1320
|
+
/**
|
|
1321
|
+
* IANA timezone the cron expression is evaluated in
|
|
1322
|
+
*/
|
|
1323
|
+
schedule_timezone?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Behavior when the previous scheduled run is still active
|
|
1326
|
+
*/
|
|
1327
|
+
schedule_overlap?: "skip";
|
|
1328
|
+
/**
|
|
1329
|
+
* DEPRECATED and ignored — functions receive the app's full effective option keyspace (sensitive values included) via input.app_options. Kept for manifest compatibility.
|
|
1330
|
+
*
|
|
1331
|
+
*/
|
|
1332
|
+
secrets?: string[];
|
|
1333
|
+
}
|
|
1334
|
+
export interface FunctionRefCustomActionConfig {
|
|
1335
|
+
/**
|
|
1336
|
+
* Name of the custom action
|
|
1337
|
+
*/
|
|
1338
|
+
name?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Description of the custom action
|
|
1341
|
+
*/
|
|
1342
|
+
description?: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Wait for callback_url to be called before completing the action
|
|
1345
|
+
*/
|
|
1346
|
+
wait_for_callback?: boolean;
|
|
1347
|
+
type: "function";
|
|
1348
|
+
/**
|
|
1349
|
+
* Name of a `workflow`-type function of the same app version. The component provides the org-facing contract (name, options, config surface); the referenced function provides the code.
|
|
1350
|
+
*
|
|
1351
|
+
*/
|
|
1352
|
+
function_name: string;
|
|
1353
|
+
}
|
|
1179
1354
|
/**
|
|
1180
1355
|
* Required grants for the app in order to call APIs for the installing tenant
|
|
1181
1356
|
*/
|
|
@@ -1225,6 +1400,22 @@ declare namespace Components {
|
|
|
1225
1400
|
* List of component configurations for the installed version
|
|
1226
1401
|
*/
|
|
1227
1402
|
components: BaseComponent[];
|
|
1403
|
+
/**
|
|
1404
|
+
* Server-side functions of the installed version, including scheduled functions
|
|
1405
|
+
*/
|
|
1406
|
+
functions?: /**
|
|
1407
|
+
* A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
|
|
1408
|
+
*
|
|
1409
|
+
*/
|
|
1410
|
+
FunctionDefinition[];
|
|
1411
|
+
/**
|
|
1412
|
+
* Effective app-level options of the installation: declared top-level options plus
|
|
1413
|
+
* component-level options lifted to the app keyspace, each with its configured
|
|
1414
|
+
* `value`. Values of sensitive options (secrets) are never included — they carry
|
|
1415
|
+
* `configured` and `value_updated_at` instead.
|
|
1416
|
+
*
|
|
1417
|
+
*/
|
|
1418
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
|
|
1228
1419
|
/**
|
|
1229
1420
|
* Version of the app that is installed
|
|
1230
1421
|
*/
|
|
@@ -1260,6 +1451,55 @@ declare namespace Components {
|
|
|
1260
1451
|
*/
|
|
1261
1452
|
_manifest?: string /* uuid */[];
|
|
1262
1453
|
}
|
|
1454
|
+
/**
|
|
1455
|
+
* Review entry including app ownership info, used by internal admin endpoints
|
|
1456
|
+
*/
|
|
1457
|
+
export interface InternalReview {
|
|
1458
|
+
/**
|
|
1459
|
+
* Version of the app that is under review
|
|
1460
|
+
*/
|
|
1461
|
+
version?: string;
|
|
1462
|
+
/**
|
|
1463
|
+
* Status of the review
|
|
1464
|
+
*/
|
|
1465
|
+
review_status?: "approved" | "rejected" | "pending";
|
|
1466
|
+
/**
|
|
1467
|
+
* Timestamp of the review
|
|
1468
|
+
*/
|
|
1469
|
+
requested_at?: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* User ID of the reviewer
|
|
1472
|
+
*/
|
|
1473
|
+
requested_by?: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Email of the technical contact
|
|
1476
|
+
*/
|
|
1477
|
+
technical_contact?: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* Email of the marketing contact
|
|
1480
|
+
*/
|
|
1481
|
+
marketing_contact?: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* URL of the demo
|
|
1484
|
+
*/
|
|
1485
|
+
demo_url?: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* ID of the app configuration
|
|
1488
|
+
*/
|
|
1489
|
+
app_id?: string;
|
|
1490
|
+
/**
|
|
1491
|
+
* Organization ID of the app owner
|
|
1492
|
+
*/
|
|
1493
|
+
org_id?: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Identity of the internal reviewer who approved the review
|
|
1496
|
+
*/
|
|
1497
|
+
reviewed_by?: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* Timestamp of the approval
|
|
1500
|
+
*/
|
|
1501
|
+
reviewed_at?: string;
|
|
1502
|
+
}
|
|
1263
1503
|
export interface JourneyBlockComponent {
|
|
1264
1504
|
component_type: "CUSTOM_JOURNEY_BLOCK";
|
|
1265
1505
|
configuration: JourneyBlockConfig;
|
|
@@ -1388,7 +1628,7 @@ declare namespace Components {
|
|
|
1388
1628
|
value: any;
|
|
1389
1629
|
}
|
|
1390
1630
|
/**
|
|
1391
|
-
*
|
|
1631
|
+
* An option declaration — a setting the installing org fills in. Declared at app level.
|
|
1392
1632
|
*/
|
|
1393
1633
|
export interface Options {
|
|
1394
1634
|
/**
|
|
@@ -1443,10 +1683,42 @@ declare namespace Components {
|
|
|
1443
1683
|
*
|
|
1444
1684
|
*/
|
|
1445
1685
|
type: "text" | "number" | "boolean" | "secret" | "object";
|
|
1686
|
+
/**
|
|
1687
|
+
* Write-only, server-side only value — like a sensitive environment variable
|
|
1688
|
+
* (app-level options only). Sensitive values are never serialized in any response;
|
|
1689
|
+
* they are resolvable only via server-side channels (API proxy injection, function
|
|
1690
|
+
* runs, the internal options/resolve endpoint). Non-sensitive values
|
|
1691
|
+
* are readable wherever the app runs, including the end-customer browser (journey and
|
|
1692
|
+
* portal runtime). Forced to true for `secret`-touching options. Default: false.
|
|
1693
|
+
*
|
|
1694
|
+
*/
|
|
1695
|
+
sensitive?: boolean;
|
|
1696
|
+
/**
|
|
1697
|
+
* Serialized instead of `value` for sensitive options (secrets): true when a
|
|
1698
|
+
* value is stored.
|
|
1699
|
+
*
|
|
1700
|
+
*/
|
|
1701
|
+
configured?: boolean;
|
|
1702
|
+
/**
|
|
1703
|
+
* Compatibility marker: this option is declared at app level and folded back
|
|
1704
|
+
* into the component's options so existing consumers (journey runtime, portal
|
|
1705
|
+
* blocks, older services) keep working unchanged. New consumers should read
|
|
1706
|
+
* app-level options from the installation's `options` array instead.
|
|
1707
|
+
*
|
|
1708
|
+
*/
|
|
1709
|
+
lifted?: boolean;
|
|
1710
|
+
/**
|
|
1711
|
+
* Timestamp of the last value change. Only returned for sensitive options
|
|
1712
|
+
* (alongside `configured`) so installers can see when a secret was last rotated.
|
|
1713
|
+
*
|
|
1714
|
+
*/
|
|
1715
|
+
value_updated_at?: string;
|
|
1446
1716
|
}
|
|
1447
1717
|
export interface OptionsRef {
|
|
1448
1718
|
/**
|
|
1449
|
-
* ID of the component these values are for
|
|
1719
|
+
* ID of the component these values are for. Use the sentinel `$app` for
|
|
1720
|
+
* app-level option values (options declared at the manifest top level).
|
|
1721
|
+
*
|
|
1450
1722
|
*/
|
|
1451
1723
|
component_id: string;
|
|
1452
1724
|
options: Option[];
|
|
@@ -1593,7 +1865,7 @@ declare namespace Components {
|
|
|
1593
1865
|
* { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh", "color": "primary", "precision": 2 },
|
|
1594
1866
|
* ...
|
|
1595
1867
|
* ],
|
|
1596
|
-
* "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
|
|
1868
|
+
* "intervals": ["PT15M", "PT1H", "P1D", "P1M", "P1Y"],
|
|
1597
1869
|
* "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
|
|
1598
1870
|
* }
|
|
1599
1871
|
* Each type option carries its own `statistical_method`, which describes the method already applied to that type's data and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. A single visualization can therefore mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.
|
|
@@ -1836,7 +2108,7 @@ declare namespace Components {
|
|
|
1836
2108
|
* Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
|
|
1837
2109
|
*
|
|
1838
2110
|
*/
|
|
1839
|
-
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
2111
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
|
|
1840
2112
|
auth?: PortalExtensionAuthBlock;
|
|
1841
2113
|
call: {
|
|
1842
2114
|
/**
|
|
@@ -2007,7 +2279,7 @@ declare namespace Components {
|
|
|
2007
2279
|
* Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
|
|
2008
2280
|
*
|
|
2009
2281
|
*/
|
|
2010
|
-
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
2282
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
|
|
2011
2283
|
auth?: PortalExtensionAuthBlock;
|
|
2012
2284
|
call: {
|
|
2013
2285
|
/**
|
|
@@ -2338,7 +2610,7 @@ declare namespace Components {
|
|
|
2338
2610
|
* Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
|
|
2339
2611
|
*
|
|
2340
2612
|
*/
|
|
2341
|
-
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
|
|
2613
|
+
intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M" | "P1Y")[];
|
|
2342
2614
|
auth?: PortalExtensionAuthBlock;
|
|
2343
2615
|
call: {
|
|
2344
2616
|
/**
|
|
@@ -2470,7 +2742,7 @@ declare namespace Components {
|
|
|
2470
2742
|
* { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh", "color": "primary", "precision": 2 },
|
|
2471
2743
|
* ...
|
|
2472
2744
|
* ],
|
|
2473
|
-
* "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
|
|
2745
|
+
* "intervals": ["PT15M", "PT1H", "P1D", "P1M", "P1Y"],
|
|
2474
2746
|
* "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
|
|
2475
2747
|
* }
|
|
2476
2748
|
* Each type option carries its own `statistical_method`, which describes the method already applied to that type's data and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. A single visualization can therefore mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.
|
|
@@ -2647,6 +2919,18 @@ declare namespace Components {
|
|
|
2647
2919
|
billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
|
|
2648
2920
|
};
|
|
2649
2921
|
components: BaseComponent[];
|
|
2922
|
+
/**
|
|
2923
|
+
* Server-side functions of the app, including scheduled functions
|
|
2924
|
+
*/
|
|
2925
|
+
functions?: /**
|
|
2926
|
+
* A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
|
|
2927
|
+
*
|
|
2928
|
+
*/
|
|
2929
|
+
FunctionDefinition[];
|
|
2930
|
+
/**
|
|
2931
|
+
* App-level option declarations (with sensitivity) of this version
|
|
2932
|
+
*/
|
|
2933
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
|
|
2650
2934
|
/**
|
|
2651
2935
|
* Flag to indicate if the app is in beta.
|
|
2652
2936
|
*/
|
|
@@ -2729,28 +3013,6 @@ declare namespace Components {
|
|
|
2729
3013
|
*/
|
|
2730
3014
|
key: string;
|
|
2731
3015
|
}
|
|
2732
|
-
export interface SandboxCustomActionConfig {
|
|
2733
|
-
/**
|
|
2734
|
-
* Name of the custom action
|
|
2735
|
-
*/
|
|
2736
|
-
name?: string;
|
|
2737
|
-
/**
|
|
2738
|
-
* Description of the custom action
|
|
2739
|
-
*/
|
|
2740
|
-
description?: string;
|
|
2741
|
-
/**
|
|
2742
|
-
* Wait for callback_url to be called before completing the action
|
|
2743
|
-
*/
|
|
2744
|
-
wait_for_callback?: boolean;
|
|
2745
|
-
type: "sandbox";
|
|
2746
|
-
sandbox_settings?: {
|
|
2747
|
-
/**
|
|
2748
|
-
* JavaScript code to execute for the sandbox action. Maximum size: 300KB (hard limit). Code is stored as raw JavaScript and will be syntax-validated on save. Security restrictions: eval() and Function() constructor are not allowed.
|
|
2749
|
-
*
|
|
2750
|
-
*/
|
|
2751
|
-
code?: string;
|
|
2752
|
-
};
|
|
2753
|
-
}
|
|
2754
3016
|
export interface TextArg {
|
|
2755
3017
|
type?: "text";
|
|
2756
3018
|
}
|
|
@@ -2778,6 +3040,7 @@ declare namespace Paths {
|
|
|
2778
3040
|
sourceVersion: Parameters.SourceVersion;
|
|
2779
3041
|
targetVersion: Parameters.TargetVersion;
|
|
2780
3042
|
}
|
|
3043
|
+
export type RequestBody = Components.RequestBodies.CloneVersionRequest;
|
|
2781
3044
|
namespace Responses {
|
|
2782
3045
|
export interface $201 {
|
|
2783
3046
|
app_id?: string;
|
|
@@ -3346,6 +3609,29 @@ declare namespace Paths {
|
|
|
3346
3609
|
}
|
|
3347
3610
|
}
|
|
3348
3611
|
}
|
|
3612
|
+
namespace ResolveOptions {
|
|
3613
|
+
namespace Parameters {
|
|
3614
|
+
export type AppId = string;
|
|
3615
|
+
}
|
|
3616
|
+
export interface PathParameters {
|
|
3617
|
+
appId: Parameters.AppId;
|
|
3618
|
+
}
|
|
3619
|
+
export interface RequestBody {
|
|
3620
|
+
/**
|
|
3621
|
+
* Narrow the response to these option keys
|
|
3622
|
+
*/
|
|
3623
|
+
keys?: string[];
|
|
3624
|
+
}
|
|
3625
|
+
namespace Responses {
|
|
3626
|
+
export interface $200 {
|
|
3627
|
+
options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Components.Schemas.Options[];
|
|
3628
|
+
}
|
|
3629
|
+
export interface $403 {
|
|
3630
|
+
}
|
|
3631
|
+
export interface $404 {
|
|
3632
|
+
}
|
|
3633
|
+
}
|
|
3634
|
+
}
|
|
3349
3635
|
namespace Uninstall {
|
|
3350
3636
|
namespace Parameters {
|
|
3351
3637
|
export type AppId = string;
|
|
@@ -3399,12 +3685,18 @@ declare namespace Paths {
|
|
|
3399
3685
|
export type AppId = string;
|
|
3400
3686
|
export type Path = string;
|
|
3401
3687
|
export type ProxyName = string;
|
|
3688
|
+
export interface Query {
|
|
3689
|
+
[name: string]: any;
|
|
3690
|
+
}
|
|
3402
3691
|
}
|
|
3403
3692
|
export interface PathParameters {
|
|
3404
3693
|
appId: Parameters.AppId;
|
|
3405
3694
|
proxyName: Parameters.ProxyName;
|
|
3406
3695
|
path: Parameters.Path;
|
|
3407
3696
|
}
|
|
3697
|
+
export interface QueryParameters {
|
|
3698
|
+
query?: Parameters.Query;
|
|
3699
|
+
}
|
|
3408
3700
|
}
|
|
3409
3701
|
}
|
|
3410
3702
|
|
|
@@ -3638,7 +3930,7 @@ export interface OperationMethods {
|
|
|
3638
3930
|
*/
|
|
3639
3931
|
'cloneVersion'(
|
|
3640
3932
|
parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
|
|
3641
|
-
data?:
|
|
3933
|
+
data?: Paths.CloneVersion.RequestBody,
|
|
3642
3934
|
config?: AxiosRequestConfig
|
|
3643
3935
|
): OperationResponse<Paths.CloneVersion.Responses.$201>
|
|
3644
3936
|
/**
|
|
@@ -3701,6 +3993,16 @@ export interface OperationMethods {
|
|
|
3701
3993
|
data?: any,
|
|
3702
3994
|
config?: AxiosRequestConfig
|
|
3703
3995
|
): OperationResponse<Paths.PromoteVersion.Responses.$200>
|
|
3996
|
+
/**
|
|
3997
|
+
* resolveOptions - resolveOptions
|
|
3998
|
+
*
|
|
3999
|
+
* Resolve the effective app-level options of an installation, including decrypted sensitive values (secrets). This endpoint accepts epilot internal-auth tokens exclusively (internal service calls, e.g. automation-workers or the customer portal API) — no user token, API key, or app token can call it, regardless of roles. Every call is audit-logged with the caller identity.
|
|
4000
|
+
*/
|
|
4001
|
+
'resolveOptions'(
|
|
4002
|
+
parameters?: Parameters<Paths.ResolveOptions.PathParameters> | null,
|
|
4003
|
+
data?: Paths.ResolveOptions.RequestBody,
|
|
4004
|
+
config?: AxiosRequestConfig
|
|
4005
|
+
): OperationResponse<Paths.ResolveOptions.Responses.$200>
|
|
3704
4006
|
/**
|
|
3705
4007
|
* ingestEvent - ingestEvent
|
|
3706
4008
|
*
|
|
@@ -3717,7 +4019,7 @@ export interface OperationMethods {
|
|
|
3717
4019
|
* Forward a GET request to a registered proxy target from a public-facing component (e.g. journey blocks)
|
|
3718
4020
|
*/
|
|
3719
4021
|
'publicProxyGet'(
|
|
3720
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4022
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3721
4023
|
data?: any,
|
|
3722
4024
|
config?: AxiosRequestConfig
|
|
3723
4025
|
): OperationResponse<Paths.PublicProxyGet.Responses.$200>
|
|
@@ -3727,7 +4029,7 @@ export interface OperationMethods {
|
|
|
3727
4029
|
* Forward a PUT request to a registered proxy target from a public-facing component
|
|
3728
4030
|
*/
|
|
3729
4031
|
'publicProxyPut'(
|
|
3730
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4032
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3731
4033
|
data?: Paths.PublicProxyPut.RequestBody,
|
|
3732
4034
|
config?: AxiosRequestConfig
|
|
3733
4035
|
): OperationResponse<Paths.PublicProxyPut.Responses.$200>
|
|
@@ -3737,7 +4039,7 @@ export interface OperationMethods {
|
|
|
3737
4039
|
* Forward a POST request to a registered proxy target from a public-facing component (e.g. journey blocks)
|
|
3738
4040
|
*/
|
|
3739
4041
|
'publicProxyPost'(
|
|
3740
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4042
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3741
4043
|
data?: Paths.PublicProxyPost.RequestBody,
|
|
3742
4044
|
config?: AxiosRequestConfig
|
|
3743
4045
|
): OperationResponse<Paths.PublicProxyPost.Responses.$200>
|
|
@@ -3747,7 +4049,7 @@ export interface OperationMethods {
|
|
|
3747
4049
|
* Forward a PATCH request to a registered proxy target from a public-facing component
|
|
3748
4050
|
*/
|
|
3749
4051
|
'publicProxyPatch'(
|
|
3750
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4052
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3751
4053
|
data?: Paths.PublicProxyPatch.RequestBody,
|
|
3752
4054
|
config?: AxiosRequestConfig
|
|
3753
4055
|
): OperationResponse<Paths.PublicProxyPatch.Responses.$200>
|
|
@@ -3757,7 +4059,7 @@ export interface OperationMethods {
|
|
|
3757
4059
|
* Forward a DELETE request to a registered proxy target from a public-facing component
|
|
3758
4060
|
*/
|
|
3759
4061
|
'publicProxyDelete'(
|
|
3760
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4062
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3761
4063
|
data?: any,
|
|
3762
4064
|
config?: AxiosRequestConfig
|
|
3763
4065
|
): OperationResponse<Paths.PublicProxyDelete.Responses.$200>
|
|
@@ -4021,7 +4323,7 @@ export interface PathsDictionary {
|
|
|
4021
4323
|
*/
|
|
4022
4324
|
'post'(
|
|
4023
4325
|
parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
|
|
4024
|
-
data?:
|
|
4326
|
+
data?: Paths.CloneVersion.RequestBody,
|
|
4025
4327
|
config?: AxiosRequestConfig
|
|
4026
4328
|
): OperationResponse<Paths.CloneVersion.Responses.$201>
|
|
4027
4329
|
}
|
|
@@ -4091,6 +4393,18 @@ export interface PathsDictionary {
|
|
|
4091
4393
|
config?: AxiosRequestConfig
|
|
4092
4394
|
): OperationResponse<Paths.PromoteVersion.Responses.$200>
|
|
4093
4395
|
}
|
|
4396
|
+
['/v1/app/{appId}/options/resolve']: {
|
|
4397
|
+
/**
|
|
4398
|
+
* resolveOptions - resolveOptions
|
|
4399
|
+
*
|
|
4400
|
+
* Resolve the effective app-level options of an installation, including decrypted sensitive values (secrets). This endpoint accepts epilot internal-auth tokens exclusively (internal service calls, e.g. automation-workers or the customer portal API) — no user token, API key, or app token can call it, regardless of roles. Every call is audit-logged with the caller identity.
|
|
4401
|
+
*/
|
|
4402
|
+
'post'(
|
|
4403
|
+
parameters?: Parameters<Paths.ResolveOptions.PathParameters> | null,
|
|
4404
|
+
data?: Paths.ResolveOptions.RequestBody,
|
|
4405
|
+
config?: AxiosRequestConfig
|
|
4406
|
+
): OperationResponse<Paths.ResolveOptions.Responses.$200>
|
|
4407
|
+
}
|
|
4094
4408
|
['/v1/app-events']: {
|
|
4095
4409
|
/**
|
|
4096
4410
|
* ingestEvent - ingestEvent
|
|
@@ -4110,7 +4424,7 @@ export interface PathsDictionary {
|
|
|
4110
4424
|
* Forward a GET request to a registered proxy target from a public-facing component (e.g. journey blocks)
|
|
4111
4425
|
*/
|
|
4112
4426
|
'get'(
|
|
4113
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4427
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4114
4428
|
data?: any,
|
|
4115
4429
|
config?: AxiosRequestConfig
|
|
4116
4430
|
): OperationResponse<Paths.PublicProxyGet.Responses.$200>
|
|
@@ -4120,7 +4434,7 @@ export interface PathsDictionary {
|
|
|
4120
4434
|
* Forward a POST request to a registered proxy target from a public-facing component (e.g. journey blocks)
|
|
4121
4435
|
*/
|
|
4122
4436
|
'post'(
|
|
4123
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4437
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4124
4438
|
data?: Paths.PublicProxyPost.RequestBody,
|
|
4125
4439
|
config?: AxiosRequestConfig
|
|
4126
4440
|
): OperationResponse<Paths.PublicProxyPost.Responses.$200>
|
|
@@ -4130,7 +4444,7 @@ export interface PathsDictionary {
|
|
|
4130
4444
|
* Forward a PUT request to a registered proxy target from a public-facing component
|
|
4131
4445
|
*/
|
|
4132
4446
|
'put'(
|
|
4133
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4447
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4134
4448
|
data?: Paths.PublicProxyPut.RequestBody,
|
|
4135
4449
|
config?: AxiosRequestConfig
|
|
4136
4450
|
): OperationResponse<Paths.PublicProxyPut.Responses.$200>
|
|
@@ -4140,7 +4454,7 @@ export interface PathsDictionary {
|
|
|
4140
4454
|
* Forward a PATCH request to a registered proxy target from a public-facing component
|
|
4141
4455
|
*/
|
|
4142
4456
|
'patch'(
|
|
4143
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4457
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4144
4458
|
data?: Paths.PublicProxyPatch.RequestBody,
|
|
4145
4459
|
config?: AxiosRequestConfig
|
|
4146
4460
|
): OperationResponse<Paths.PublicProxyPatch.Responses.$200>
|
|
@@ -4150,7 +4464,7 @@ export interface PathsDictionary {
|
|
|
4150
4464
|
* Forward a DELETE request to a registered proxy target from a public-facing component
|
|
4151
4465
|
*/
|
|
4152
4466
|
'delete'(
|
|
4153
|
-
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4467
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.QueryParameters & Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4154
4468
|
data?: any,
|
|
4155
4469
|
config?: AxiosRequestConfig
|
|
4156
4470
|
): OperationResponse<Paths.PublicProxyDelete.Responses.$200>
|
|
@@ -4196,8 +4510,11 @@ export type ExternalProductCatalogComponent = Components.Schemas.ExternalProduct
|
|
|
4196
4510
|
export type ExternalProductCatalogConfig = Components.Schemas.ExternalProductCatalogConfig;
|
|
4197
4511
|
export type ExternalProductCatalogHookProductRecommendations = Components.Schemas.ExternalProductCatalogHookProductRecommendations;
|
|
4198
4512
|
export type ExternalProductCatalogHookProducts = Components.Schemas.ExternalProductCatalogHookProducts;
|
|
4513
|
+
export type FunctionDefinition = Components.Schemas.FunctionDefinition;
|
|
4514
|
+
export type FunctionRefCustomActionConfig = Components.Schemas.FunctionRefCustomActionConfig;
|
|
4199
4515
|
export type Grants = Components.Schemas.Grants;
|
|
4200
4516
|
export type Installation = Components.Schemas.Installation;
|
|
4517
|
+
export type InternalReview = Components.Schemas.InternalReview;
|
|
4201
4518
|
export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
|
|
4202
4519
|
export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
|
|
4203
4520
|
export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
|
|
@@ -4233,6 +4550,5 @@ export type RawEvents = Components.Schemas.RawEvents;
|
|
|
4233
4550
|
export type Review = Components.Schemas.Review;
|
|
4234
4551
|
export type Role = Components.Schemas.Role;
|
|
4235
4552
|
export type S3Reference = Components.Schemas.S3Reference;
|
|
4236
|
-
export type SandboxCustomActionConfig = Components.Schemas.SandboxCustomActionConfig;
|
|
4237
4553
|
export type TextArg = Components.Schemas.TextArg;
|
|
4238
4554
|
export type TranslatedString = Components.Schemas.TranslatedString;
|