@epilot/app-client 0.13.2 → 0.13.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.
Files changed (3) hide show
  1. package/dist/openapi.d.ts +28 -8
  2. package/dist/openapi.json +601 -164
  3. package/package.json +1 -1
package/dist/openapi.json CHANGED
@@ -67,7 +67,9 @@
67
67
  "summary": "getPublicFacingComponent",
68
68
  "description": "Retrieve public facing components for an installed app",
69
69
  "operationId": "getPublicFacingComponent",
70
- "tags": ["App Installation"],
70
+ "tags": [
71
+ "App Installation"
72
+ ],
71
73
  "responses": {
72
74
  "200": {
73
75
  "description": "Successful response with public app component details",
@@ -95,7 +97,9 @@
95
97
  "summary": "listConfigurations",
96
98
  "description": "List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.",
97
99
  "operationId": "listConfigurations",
98
- "tags": ["App Configuration"],
100
+ "tags": [
101
+ "App Configuration"
102
+ ],
99
103
  "parameters": [
100
104
  {
101
105
  "name": "page",
@@ -155,7 +159,9 @@
155
159
  "summary": "createConfiguration",
156
160
  "description": "Create a new private app configuration. To make it public a verification process needs to be triggered",
157
161
  "operationId": "createConfiguration",
158
- "tags": ["App Configuration"],
162
+ "tags": [
163
+ "App Configuration"
164
+ ],
159
165
  "requestBody": {
160
166
  "$ref": "#/components/requestBodies/CreateConfigRequest"
161
167
  },
@@ -166,7 +172,9 @@
166
172
  "application/json": {
167
173
  "schema": {
168
174
  "type": "object",
169
- "required": ["app_id"],
175
+ "required": [
176
+ "app_id"
177
+ ],
170
178
  "properties": {
171
179
  "app_id": {
172
180
  "type": "string"
@@ -184,7 +192,9 @@
184
192
  "summary": "listPublicConfigurations",
185
193
  "description": "List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.",
186
194
  "operationId": "listPublicConfigurations",
187
- "tags": ["App Configuration"],
195
+ "tags": [
196
+ "App Configuration"
197
+ ],
188
198
  "parameters": [
189
199
  {
190
200
  "name": "page",
@@ -257,7 +267,9 @@
257
267
  "summary": "getPublicConfiguration",
258
268
  "description": "Retrieve the public configuration of an app to install in your tenant",
259
269
  "operationId": "getPublicConfiguration",
260
- "tags": ["App Configuration"],
270
+ "tags": [
271
+ "App Configuration"
272
+ ],
261
273
  "parameters": [
262
274
  {
263
275
  "name": "version",
@@ -301,7 +313,9 @@
301
313
  "summary": "getConfiguration",
302
314
  "description": "Retrieve a specific app configuration",
303
315
  "operationId": "getConfiguration",
304
- "tags": ["App Configuration"],
316
+ "tags": [
317
+ "App Configuration"
318
+ ],
305
319
  "parameters": [
306
320
  {
307
321
  "name": "version",
@@ -332,7 +346,9 @@
332
346
  "summary": "patchMetadata",
333
347
  "description": "Patch non-versioned configuration metadata of a given app configuration.",
334
348
  "operationId": "patchMetadata",
335
- "tags": ["App Configuration"],
349
+ "tags": [
350
+ "App Configuration"
351
+ ],
336
352
  "requestBody": {
337
353
  "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
338
354
  },
@@ -349,7 +365,9 @@
349
365
  "summary": "Delete app configuration",
350
366
  "description": "Delete an app configuration and all its versions and components.",
351
367
  "operationId": "deleteConfiguration",
352
- "tags": ["App Configuration"],
368
+ "tags": [
369
+ "App Configuration"
370
+ ],
353
371
  "responses": {
354
372
  "204": {
355
373
  "description": "App configuration deleted successfully"
@@ -365,7 +383,9 @@
365
383
  "summary": "queryEvents",
366
384
  "description": "Query analytics events for a specific app with flexible filtering",
367
385
  "operationId": "queryEvents",
368
- "tags": ["App Analytics"],
386
+ "tags": [
387
+ "App Analytics"
388
+ ],
369
389
  "parameters": [
370
390
  {
371
391
  "name": "appId",
@@ -412,7 +432,9 @@
412
432
  "summary": "createBundleUploadUrl",
413
433
  "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path",
414
434
  "operationId": "createBundleUploadUrl",
415
- "tags": ["App Configuration"],
435
+ "tags": [
436
+ "App Configuration"
437
+ ],
416
438
  "parameters": [
417
439
  {
418
440
  "name": "appId",
@@ -434,7 +456,9 @@
434
456
  "application/json": {
435
457
  "schema": {
436
458
  "type": "object",
437
- "required": ["upload_url"],
459
+ "required": [
460
+ "upload_url"
461
+ ],
438
462
  "properties": {
439
463
  "component_id": {
440
464
  "type": "string",
@@ -472,7 +496,9 @@
472
496
  "summary": "createZipUploadUrl",
473
497
  "operationId": "createZipUploadUrl",
474
498
  "description": "Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path\n",
475
- "tags": ["App Configuration"],
499
+ "tags": [
500
+ "App Configuration"
501
+ ],
476
502
  "parameters": [
477
503
  {
478
504
  "name": "appId",
@@ -516,7 +542,10 @@
516
542
  "application/json": {
517
543
  "schema": {
518
544
  "type": "object",
519
- "required": ["upload_url", "artifact_url"],
545
+ "required": [
546
+ "upload_url",
547
+ "artifact_url"
548
+ ],
520
549
  "properties": {
521
550
  "component_id": {
522
551
  "type": "string",
@@ -565,7 +594,9 @@
565
594
  "summary": "createLogoUploadUrl",
566
595
  "description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
567
596
  "operationId": "createLogoUploadUrl",
568
- "tags": ["App Configuration"],
597
+ "tags": [
598
+ "App Configuration"
599
+ ],
569
600
  "requestBody": {
570
601
  "$ref": "#/components/requestBodies/CreateLogoPresignedRequest"
571
602
  },
@@ -576,7 +607,9 @@
576
607
  "application/json": {
577
608
  "schema": {
578
609
  "type": "object",
579
- "required": ["upload_url"],
610
+ "required": [
611
+ "upload_url"
612
+ ],
580
613
  "properties": {
581
614
  "upload_url": {
582
615
  "type": "string",
@@ -604,7 +637,9 @@
604
637
  "summary": "deleteLogo",
605
638
  "description": "Delete the app logo from /<app-id>/logo.png path",
606
639
  "operationId": "deleteLogo",
607
- "tags": ["App Configuration"],
640
+ "tags": [
641
+ "App Configuration"
642
+ ],
608
643
  "responses": {
609
644
  "204": {
610
645
  "description": "Logo deleted successfully"
@@ -620,7 +655,9 @@
620
655
  "summary": "listVersions",
621
656
  "description": "Retrieve a list of versions for an app configuration",
622
657
  "operationId": "listVersions",
623
- "tags": ["App Configuration"],
658
+ "tags": [
659
+ "App Configuration"
660
+ ],
624
661
  "parameters": [
625
662
  {
626
663
  "name": "appId",
@@ -694,7 +731,9 @@
694
731
  "summary": "getVersion",
695
732
  "description": "Retrieve a specific version of an app configuration",
696
733
  "operationId": "getVersion",
697
- "tags": ["App Configuration"],
734
+ "tags": [
735
+ "App Configuration"
736
+ ],
698
737
  "parameters": [
699
738
  {
700
739
  "name": "appId",
@@ -735,7 +774,9 @@
735
774
  "summary": "deleteVersion",
736
775
  "description": "Delete a specific version of an app configuration",
737
776
  "operationId": "deleteVersion",
738
- "tags": ["App Configuration"],
777
+ "tags": [
778
+ "App Configuration"
779
+ ],
739
780
  "parameters": [
740
781
  {
741
782
  "name": "appId",
@@ -775,7 +816,9 @@
775
816
  "summary": "patchVersion",
776
817
  "description": "Patch an existing app version",
777
818
  "operationId": "patchVersion",
778
- "tags": ["App Configuration"],
819
+ "tags": [
820
+ "App Configuration"
821
+ ],
779
822
  "parameters": [
780
823
  {
781
824
  "name": "appId",
@@ -817,7 +860,9 @@
817
860
  "summary": "getReview",
818
861
  "description": "Retrieve the review status of a specific app version",
819
862
  "operationId": "getReview",
820
- "tags": ["App Configuration"],
863
+ "tags": [
864
+ "App Configuration"
865
+ ],
821
866
  "parameters": [
822
867
  {
823
868
  "name": "appId",
@@ -863,7 +908,9 @@
863
908
  "summary": "createReview",
864
909
  "description": "Submit an app version for review to make it public",
865
910
  "operationId": "createReview",
866
- "tags": ["App Configuration"],
911
+ "tags": [
912
+ "App Configuration"
913
+ ],
867
914
  "parameters": [
868
915
  {
869
916
  "name": "appId",
@@ -917,7 +964,9 @@
917
964
  "summary": "createComponent",
918
965
  "description": "Patch an existing app version to create/add a component",
919
966
  "operationId": "createComponent",
920
- "tags": ["App Configuration"],
967
+ "tags": [
968
+ "App Configuration"
969
+ ],
921
970
  "parameters": [
922
971
  {
923
972
  "name": "appId",
@@ -971,7 +1020,9 @@
971
1020
  "summary": "patchComponent",
972
1021
  "description": "Patch an existing app version to update its components",
973
1022
  "operationId": "patchComponent",
974
- "tags": ["App Configuration"],
1023
+ "tags": [
1024
+ "App Configuration"
1025
+ ],
975
1026
  "parameters": [
976
1027
  {
977
1028
  "name": "appId",
@@ -1020,7 +1071,9 @@
1020
1071
  "summary": "deleteComponent",
1021
1072
  "description": "Delete a specific component from an app version",
1022
1073
  "operationId": "deleteComponent",
1023
- "tags": ["App Configuration"],
1074
+ "tags": [
1075
+ "App Configuration"
1076
+ ],
1024
1077
  "parameters": [
1025
1078
  {
1026
1079
  "name": "appId",
@@ -1065,7 +1118,9 @@
1065
1118
  "summary": "cloneVersion",
1066
1119
  "description": "Clone an existing app version to create a new version",
1067
1120
  "operationId": "cloneVersion",
1068
- "tags": ["App Configuration"],
1121
+ "tags": [
1122
+ "App Configuration"
1123
+ ],
1069
1124
  "parameters": [
1070
1125
  {
1071
1126
  "name": "appId",
@@ -1111,7 +1166,10 @@
1111
1166
  },
1112
1167
  "status": {
1113
1168
  "type": "string",
1114
- "enum": ["pending", "published"]
1169
+ "enum": [
1170
+ "pending",
1171
+ "published"
1172
+ ]
1115
1173
  }
1116
1174
  }
1117
1175
  }
@@ -1132,7 +1190,9 @@
1132
1190
  "summary": "listInstallations",
1133
1191
  "description": "Retrieve a list of installed apps for the organization.",
1134
1192
  "operationId": "listInstallations",
1135
- "tags": ["App Installation"],
1193
+ "tags": [
1194
+ "App Installation"
1195
+ ],
1136
1196
  "parameters": [
1137
1197
  {
1138
1198
  "name": "componentType",
@@ -1211,7 +1271,9 @@
1211
1271
  "summary": "getInstallation",
1212
1272
  "description": "Retrieve details of an installed app by its ID.",
1213
1273
  "operationId": "getInstallation",
1214
- "tags": ["App Installation"],
1274
+ "tags": [
1275
+ "App Installation"
1276
+ ],
1215
1277
  "parameters": [
1216
1278
  {
1217
1279
  "name": "appId",
@@ -1242,7 +1304,9 @@
1242
1304
  "summary": "install",
1243
1305
  "description": "Upsert app installation by its ID.",
1244
1306
  "operationId": "install",
1245
- "tags": ["App Installation"],
1307
+ "tags": [
1308
+ "App Installation"
1309
+ ],
1246
1310
  "parameters": [
1247
1311
  {
1248
1312
  "name": "appId",
@@ -1276,7 +1340,9 @@
1276
1340
  "summary": "patchInstallation",
1277
1341
  "description": "Patch an installed app by its ID.",
1278
1342
  "operationId": "patchInstallation",
1279
- "tags": ["App Installation"],
1343
+ "tags": [
1344
+ "App Installation"
1345
+ ],
1280
1346
  "parameters": [
1281
1347
  {
1282
1348
  "name": "appId",
@@ -1303,7 +1369,9 @@
1303
1369
  "summary": "uninstall",
1304
1370
  "description": "Uninstall an app by its ID.",
1305
1371
  "operationId": "uninstall",
1306
- "tags": ["App Installation"],
1372
+ "tags": [
1373
+ "App Installation"
1374
+ ],
1307
1375
  "parameters": [
1308
1376
  {
1309
1377
  "name": "appId",
@@ -1329,7 +1397,9 @@
1329
1397
  "summary": "promoteVersion",
1330
1398
  "description": "Update an installed app to a new version",
1331
1399
  "operationId": "promoteVersion",
1332
- "tags": ["App Installation"],
1400
+ "tags": [
1401
+ "App Installation"
1402
+ ],
1333
1403
  "parameters": [
1334
1404
  {
1335
1405
  "name": "appId",
@@ -1373,7 +1443,9 @@
1373
1443
  "summary": "ingestEvent",
1374
1444
  "operationId": "ingestEvent",
1375
1445
  "description": "Internal endpoint for services to submit app events for analytic purposes",
1376
- "tags": ["App Analytics"],
1446
+ "tags": [
1447
+ "App Analytics"
1448
+ ],
1377
1449
  "requestBody": {
1378
1450
  "required": true,
1379
1451
  "content": {
@@ -1435,7 +1507,9 @@
1435
1507
  "summary": "publicProxyGet",
1436
1508
  "operationId": "publicProxyGet",
1437
1509
  "description": "Forward a GET request to a registered proxy target from a public-facing component (e.g. journey blocks)",
1438
- "tags": ["App Proxy"],
1510
+ "tags": [
1511
+ "App Proxy"
1512
+ ],
1439
1513
  "security": [
1440
1514
  {
1441
1515
  "EpilotAuth": []
@@ -1460,7 +1534,9 @@
1460
1534
  "summary": "publicProxyPost",
1461
1535
  "operationId": "publicProxyPost",
1462
1536
  "description": "Forward a POST request to a registered proxy target from a public-facing component (e.g. journey blocks)",
1463
- "tags": ["App Proxy"],
1537
+ "tags": [
1538
+ "App Proxy"
1539
+ ],
1464
1540
  "security": [
1465
1541
  {
1466
1542
  "EpilotAuth": []
@@ -1500,7 +1576,10 @@
1500
1576
  "application/json": {
1501
1577
  "schema": {
1502
1578
  "type": "object",
1503
- "required": ["technical_contact", "marketing_contact"],
1579
+ "required": [
1580
+ "technical_contact",
1581
+ "marketing_contact"
1582
+ ],
1504
1583
  "properties": {
1505
1584
  "technical_contact": {
1506
1585
  "type": "string",
@@ -1525,7 +1604,10 @@
1525
1604
  "application/json": {
1526
1605
  "schema": {
1527
1606
  "type": "object",
1528
- "required": ["filename", "mime_type"],
1607
+ "required": [
1608
+ "filename",
1609
+ "mime_type"
1610
+ ],
1529
1611
  "properties": {
1530
1612
  "filename": {
1531
1613
  "type": "string",
@@ -1535,7 +1617,11 @@
1535
1617
  "mime_type": {
1536
1618
  "type": "string",
1537
1619
  "description": "MIME type of the logo file",
1538
- "enum": ["image/png", "image/jpeg", "image/jpg"],
1620
+ "enum": [
1621
+ "image/png",
1622
+ "image/jpeg",
1623
+ "image/jpg"
1624
+ ],
1539
1625
  "example": "image/png"
1540
1626
  }
1541
1627
  }
@@ -1549,7 +1635,9 @@
1549
1635
  "application/json": {
1550
1636
  "schema": {
1551
1637
  "type": "object",
1552
- "required": ["version"],
1638
+ "required": [
1639
+ "version"
1640
+ ],
1553
1641
  "properties": {
1554
1642
  "version": {
1555
1643
  "type": "string",
@@ -1647,7 +1735,10 @@
1647
1735
  "application/json": {
1648
1736
  "schema": {
1649
1737
  "type": "object",
1650
- "required": ["name", "description"],
1738
+ "required": [
1739
+ "name",
1740
+ "description"
1741
+ ],
1651
1742
  "properties": {
1652
1743
  "name": {
1653
1744
  "type": "string",
@@ -1730,7 +1821,10 @@
1730
1821
  "Options": {
1731
1822
  "type": "object",
1732
1823
  "description": "Options for the component configuration",
1733
- "required": ["key", "type"],
1824
+ "required": [
1825
+ "key",
1826
+ "type"
1827
+ ],
1734
1828
  "properties": {
1735
1829
  "key": {
1736
1830
  "type": "string",
@@ -1764,7 +1858,13 @@
1764
1858
  },
1765
1859
  "type": {
1766
1860
  "type": "string",
1767
- "enum": ["text", "number", "boolean", "secret", "object"],
1861
+ "enum": [
1862
+ "text",
1863
+ "number",
1864
+ "boolean",
1865
+ "secret",
1866
+ "object"
1867
+ ],
1768
1868
  "description": "The type of this option. `object` declares a structured value whose fields are listed\nunder `fields`. Combine with `repeatable: true` to express a list of these objects.\n"
1769
1869
  }
1770
1870
  }
@@ -1772,7 +1872,10 @@
1772
1872
  "ObjectField": {
1773
1873
  "type": "object",
1774
1874
  "description": "One declared field inside a `type: object` option. Fields are primitives — object nesting\nis not supported.\n",
1775
- "required": ["key", "type"],
1875
+ "required": [
1876
+ "key",
1877
+ "type"
1878
+ ],
1776
1879
  "properties": {
1777
1880
  "key": {
1778
1881
  "type": "string",
@@ -1792,14 +1895,22 @@
1792
1895
  },
1793
1896
  "type": {
1794
1897
  "type": "string",
1795
- "enum": ["text", "number", "boolean", "secret"],
1898
+ "enum": [
1899
+ "text",
1900
+ "number",
1901
+ "boolean",
1902
+ "secret"
1903
+ ],
1796
1904
  "description": "Primitive type of this field."
1797
1905
  }
1798
1906
  }
1799
1907
  },
1800
1908
  "Option": {
1801
1909
  "type": "object",
1802
- "required": ["key", "value"],
1910
+ "required": [
1911
+ "key",
1912
+ "value"
1913
+ ],
1803
1914
  "properties": {
1804
1915
  "key": {
1805
1916
  "type": "string",
@@ -1812,7 +1923,10 @@
1812
1923
  },
1813
1924
  "OptionsRef": {
1814
1925
  "type": "object",
1815
- "required": ["component_id", "options"],
1926
+ "required": [
1927
+ "component_id",
1928
+ "options"
1929
+ ],
1816
1930
  "properties": {
1817
1931
  "component_id": {
1818
1932
  "type": "string",
@@ -1840,7 +1954,10 @@
1840
1954
  "example": "manifest.json"
1841
1955
  }
1842
1956
  },
1843
- "required": ["bucket", "key"]
1957
+ "required": [
1958
+ "bucket",
1959
+ "key"
1960
+ ]
1844
1961
  },
1845
1962
  "ComponentType": {
1846
1963
  "type": "string",
@@ -1859,7 +1976,9 @@
1859
1976
  },
1860
1977
  "Author": {
1861
1978
  "type": "object",
1862
- "required": ["company"],
1979
+ "required": [
1980
+ "company"
1981
+ ],
1863
1982
  "properties": {
1864
1983
  "name": {
1865
1984
  "type": "string",
@@ -1899,11 +2018,16 @@
1899
2018
  },
1900
2019
  "NotificationEvent": {
1901
2020
  "type": "string",
1902
- "enum": ["app.installed", "app.uninstalled"]
2021
+ "enum": [
2022
+ "app.installed",
2023
+ "app.uninstalled"
2024
+ ]
1903
2025
  },
1904
2026
  "BaseComponentCommon": {
1905
2027
  "type": "object",
1906
- "required": ["id"],
2028
+ "required": [
2029
+ "id"
2030
+ ],
1907
2031
  "properties": {
1908
2032
  "id": {
1909
2033
  "type": "string",
@@ -1996,11 +2120,16 @@
1996
2120
  },
1997
2121
  "ApiProxyComponent": {
1998
2122
  "type": "object",
1999
- "required": ["component_type", "configuration"],
2123
+ "required": [
2124
+ "component_type",
2125
+ "configuration"
2126
+ ],
2000
2127
  "properties": {
2001
2128
  "component_type": {
2002
2129
  "type": "string",
2003
- "enum": ["API_PROXY"]
2130
+ "enum": [
2131
+ "API_PROXY"
2132
+ ]
2004
2133
  },
2005
2134
  "configuration": {
2006
2135
  "$ref": "#/components/schemas/ApiProxyConfig"
@@ -2009,11 +2138,16 @@
2009
2138
  },
2010
2139
  "CustomCapabilityComponent": {
2011
2140
  "type": "object",
2012
- "required": ["component_type", "configuration"],
2141
+ "required": [
2142
+ "component_type",
2143
+ "configuration"
2144
+ ],
2013
2145
  "properties": {
2014
2146
  "component_type": {
2015
2147
  "type": "string",
2016
- "enum": ["CUSTOM_CAPABILITY"]
2148
+ "enum": [
2149
+ "CUSTOM_CAPABILITY"
2150
+ ]
2017
2151
  },
2018
2152
  "configuration": {
2019
2153
  "type": "object",
@@ -2021,7 +2155,10 @@
2021
2155
  "type": {
2022
2156
  "description": "Define what type of capability this is",
2023
2157
  "type": "string",
2024
- "enum": ["tab", "group"]
2158
+ "enum": [
2159
+ "tab",
2160
+ "group"
2161
+ ]
2025
2162
  },
2026
2163
  "allowed_schemas": {
2027
2164
  "description": "Which schemas are supported by the capability. If empty, all schemas are supported.",
@@ -2046,11 +2183,16 @@
2046
2183
  },
2047
2184
  "CustomPageComponent": {
2048
2185
  "type": "object",
2049
- "required": ["component_type", "configuration"],
2186
+ "required": [
2187
+ "component_type",
2188
+ "configuration"
2189
+ ],
2050
2190
  "properties": {
2051
2191
  "component_type": {
2052
2192
  "type": "string",
2053
- "enum": ["CUSTOM_PAGE"]
2193
+ "enum": [
2194
+ "CUSTOM_PAGE"
2195
+ ]
2054
2196
  },
2055
2197
  "configuration": {
2056
2198
  "$ref": "#/components/schemas/CustomPageConfig"
@@ -2067,7 +2209,9 @@
2067
2209
  },
2068
2210
  "CustomPageConfig": {
2069
2211
  "type": "object",
2070
- "required": ["slug"],
2212
+ "required": [
2213
+ "slug"
2214
+ ],
2071
2215
  "properties": {
2072
2216
  "slug": {
2073
2217
  "type": "string",
@@ -2093,11 +2237,16 @@
2093
2237
  },
2094
2238
  "JourneyBlockComponent": {
2095
2239
  "type": "object",
2096
- "required": ["component_type", "configuration"],
2240
+ "required": [
2241
+ "component_type",
2242
+ "configuration"
2243
+ ],
2097
2244
  "properties": {
2098
2245
  "component_type": {
2099
2246
  "type": "string",
2100
- "enum": ["CUSTOM_JOURNEY_BLOCK"]
2247
+ "enum": [
2248
+ "CUSTOM_JOURNEY_BLOCK"
2249
+ ]
2101
2250
  },
2102
2251
  "configuration": {
2103
2252
  "$ref": "#/components/schemas/JourneyBlockConfig"
@@ -2106,11 +2255,16 @@
2106
2255
  },
2107
2256
  "PortalBlockComponent": {
2108
2257
  "type": "object",
2109
- "required": ["component_type", "configuration"],
2258
+ "required": [
2259
+ "component_type",
2260
+ "configuration"
2261
+ ],
2110
2262
  "properties": {
2111
2263
  "component_type": {
2112
2264
  "type": "string",
2113
- "enum": ["CUSTOM_PORTAL_BLOCK"]
2265
+ "enum": [
2266
+ "CUSTOM_PORTAL_BLOCK"
2267
+ ]
2114
2268
  },
2115
2269
  "configuration": {
2116
2270
  "$ref": "#/components/schemas/PortalBlockConfig"
@@ -2127,19 +2281,29 @@
2127
2281
  },
2128
2282
  "ErpInformToolkitComponent": {
2129
2283
  "type": "object",
2130
- "required": ["component_type", "configuration"],
2284
+ "required": [
2285
+ "component_type",
2286
+ "configuration"
2287
+ ],
2131
2288
  "properties": {
2132
2289
  "component_type": {
2133
2290
  "type": "string",
2134
- "enum": ["ERP_INFORM_TOOLKIT"]
2291
+ "enum": [
2292
+ "ERP_INFORM_TOOLKIT"
2293
+ ]
2135
2294
  },
2136
2295
  "configuration": {
2137
2296
  "type": "object",
2138
- "required": ["type"],
2297
+ "required": [
2298
+ "type"
2299
+ ],
2139
2300
  "properties": {
2140
2301
  "type": {
2141
2302
  "type": "string",
2142
- "enum": ["inbound", "outbound"]
2303
+ "enum": [
2304
+ "inbound",
2305
+ "outbound"
2306
+ ]
2143
2307
  }
2144
2308
  }
2145
2309
  }
@@ -2147,11 +2311,16 @@
2147
2311
  },
2148
2312
  "CustomFlowActionComponent": {
2149
2313
  "type": "object",
2150
- "required": ["component_type", "configuration"],
2314
+ "required": [
2315
+ "component_type",
2316
+ "configuration"
2317
+ ],
2151
2318
  "properties": {
2152
2319
  "component_type": {
2153
2320
  "type": "string",
2154
- "enum": ["CUSTOM_FLOW_ACTION"]
2321
+ "enum": [
2322
+ "CUSTOM_FLOW_ACTION"
2323
+ ]
2155
2324
  },
2156
2325
  "configuration": {
2157
2326
  "$ref": "#/components/schemas/CustomFlowConfig"
@@ -2193,7 +2362,9 @@
2193
2362
  "properties": {
2194
2363
  "type": {
2195
2364
  "type": "string",
2196
- "enum": ["external_integration"]
2365
+ "enum": [
2366
+ "external_integration"
2367
+ ]
2197
2368
  },
2198
2369
  "external_integration_settings": {
2199
2370
  "type": "object",
@@ -2209,7 +2380,9 @@
2209
2380
  }
2210
2381
  }
2211
2382
  },
2212
- "required": ["type"]
2383
+ "required": [
2384
+ "type"
2385
+ ]
2213
2386
  }
2214
2387
  ]
2215
2388
  },
@@ -2223,7 +2396,9 @@
2223
2396
  "properties": {
2224
2397
  "type": {
2225
2398
  "type": "string",
2226
- "enum": ["sandbox"]
2399
+ "enum": [
2400
+ "sandbox"
2401
+ ]
2227
2402
  },
2228
2403
  "sandbox_settings": {
2229
2404
  "type": "object",
@@ -2236,7 +2411,9 @@
2236
2411
  }
2237
2412
  }
2238
2413
  },
2239
- "required": ["type"]
2414
+ "required": [
2415
+ "type"
2416
+ ]
2240
2417
  }
2241
2418
  ]
2242
2419
  },
@@ -2260,11 +2437,16 @@
2260
2437
  },
2261
2438
  "ExternalProductCatalogComponent": {
2262
2439
  "type": "object",
2263
- "required": ["component_type", "configuration"],
2440
+ "required": [
2441
+ "component_type",
2442
+ "configuration"
2443
+ ],
2264
2444
  "properties": {
2265
2445
  "component_type": {
2266
2446
  "type": "string",
2267
- "enum": ["EXTERNAL_PRODUCT_CATALOG"]
2447
+ "enum": [
2448
+ "EXTERNAL_PRODUCT_CATALOG"
2449
+ ]
2268
2450
  },
2269
2451
  "configuration": {
2270
2452
  "$ref": "#/components/schemas/ExternalProductCatalogConfig"
@@ -2312,7 +2494,9 @@
2312
2494
  },
2313
2495
  "type": {
2314
2496
  "type": "string",
2315
- "enum": ["products"]
2497
+ "enum": [
2498
+ "products"
2499
+ ]
2316
2500
  },
2317
2501
  "auth": {
2318
2502
  "$ref": "#/components/schemas/ExternalProductCatalogAuthBlock"
@@ -2351,11 +2535,17 @@
2351
2535
  "additionalProperties": true
2352
2536
  }
2353
2537
  },
2354
- "required": ["url"],
2538
+ "required": [
2539
+ "url"
2540
+ ],
2355
2541
  "additionalProperties": false
2356
2542
  }
2357
2543
  },
2358
- "required": ["type", "call", "id"],
2544
+ "required": [
2545
+ "type",
2546
+ "call",
2547
+ "id"
2548
+ ],
2359
2549
  "additionalProperties": false
2360
2550
  },
2361
2551
  "ExternalProductCatalogHookProductRecommendations": {
@@ -2372,7 +2562,9 @@
2372
2562
  },
2373
2563
  "type": {
2374
2564
  "type": "string",
2375
- "enum": ["product-recommendations"]
2565
+ "enum": [
2566
+ "product-recommendations"
2567
+ ]
2376
2568
  },
2377
2569
  "auth": {
2378
2570
  "$ref": "#/components/schemas/ExternalProductCatalogAuthBlock"
@@ -2411,20 +2603,31 @@
2411
2603
  "additionalProperties": true
2412
2604
  }
2413
2605
  },
2414
- "required": ["url"],
2606
+ "required": [
2607
+ "url"
2608
+ ],
2415
2609
  "additionalProperties": false
2416
2610
  }
2417
2611
  },
2418
- "required": ["type", "call", "id"],
2612
+ "required": [
2613
+ "type",
2614
+ "call",
2615
+ "id"
2616
+ ],
2419
2617
  "additionalProperties": false
2420
2618
  },
2421
2619
  "PortalExtensionComponent": {
2422
2620
  "type": "object",
2423
- "required": ["component_type", "configuration"],
2621
+ "required": [
2622
+ "component_type",
2623
+ "configuration"
2624
+ ],
2424
2625
  "properties": {
2425
2626
  "component_type": {
2426
2627
  "type": "string",
2427
- "enum": ["PORTAL_EXTENSION"]
2628
+ "enum": [
2629
+ "PORTAL_EXTENSION"
2630
+ ]
2428
2631
  },
2429
2632
  "configuration": {
2430
2633
  "$ref": "#/components/schemas/PortalExtensionConfig"
@@ -2506,7 +2709,9 @@
2506
2709
  },
2507
2710
  "type": {
2508
2711
  "type": "string",
2509
- "enum": ["registrationIdentifiersCheck"]
2712
+ "enum": [
2713
+ "registrationIdentifiersCheck"
2714
+ ]
2510
2715
  },
2511
2716
  "auth": {
2512
2717
  "$ref": "#/components/schemas/PortalExtensionAuthBlock"
@@ -2549,7 +2754,11 @@
2549
2754
  "description": "Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
2550
2755
  }
2551
2756
  },
2552
- "required": ["url", "headers", "result"],
2757
+ "required": [
2758
+ "url",
2759
+ "headers",
2760
+ "result"
2761
+ ],
2553
2762
  "additionalProperties": false
2554
2763
  },
2555
2764
  "resolved": {
@@ -2559,7 +2768,7 @@
2559
2768
  "type": "string",
2560
2769
  "description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
2561
2770
  },
2562
- "errorMessagePath": {
2771
+ "error_message_path": {
2563
2772
  "type": "string",
2564
2773
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
2565
2774
  "example": "error.message"
@@ -2577,7 +2786,11 @@
2577
2786
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
2578
2787
  }
2579
2788
  },
2580
- "required": ["id", "type", "call"],
2789
+ "required": [
2790
+ "id",
2791
+ "type",
2792
+ "call"
2793
+ ],
2581
2794
  "additionalProperties": false
2582
2795
  },
2583
2796
  "PortalExtensionHookContractIdentification": {
@@ -2594,7 +2807,9 @@
2594
2807
  },
2595
2808
  "type": {
2596
2809
  "type": "string",
2597
- "enum": ["contractIdentification"]
2810
+ "enum": [
2811
+ "contractIdentification"
2812
+ ]
2598
2813
  },
2599
2814
  "auth": {
2600
2815
  "$ref": "#/components/schemas/PortalExtensionAuthBlock"
@@ -2637,7 +2852,10 @@
2637
2852
  "description": "Deprecated. Use `resolved.result` instead. Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
2638
2853
  }
2639
2854
  },
2640
- "required": ["url", "headers"],
2855
+ "required": [
2856
+ "url",
2857
+ "headers"
2858
+ ],
2641
2859
  "additionalProperties": false
2642
2860
  },
2643
2861
  "resolved": {
@@ -2647,7 +2865,7 @@
2647
2865
  "type": "string",
2648
2866
  "description": "Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
2649
2867
  },
2650
- "errorMessagePath": {
2868
+ "error_message_path": {
2651
2869
  "type": "string",
2652
2870
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
2653
2871
  "example": "error.message"
@@ -2683,7 +2901,9 @@
2683
2901
  "type": "string",
2684
2902
  "description": "Explanation of the functionality in language denoted by ISO 3166-1 alpha-2 code."
2685
2903
  },
2686
- "required": ["en"],
2904
+ "required": [
2905
+ "en"
2906
+ ],
2687
2907
  "description": "Explanation of the hook."
2688
2908
  },
2689
2909
  "use_static_ips": {
@@ -2696,7 +2916,11 @@
2696
2916
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
2697
2917
  }
2698
2918
  },
2699
- "required": ["id", "type", "call"],
2919
+ "required": [
2920
+ "id",
2921
+ "type",
2922
+ "call"
2923
+ ],
2700
2924
  "additionalProperties": false
2701
2925
  },
2702
2926
  "PortalExtensionHookMeterReadingPlausibilityCheck": {
@@ -2713,11 +2937,16 @@
2713
2937
  },
2714
2938
  "type": {
2715
2939
  "type": "string",
2716
- "enum": ["meterReadingPlausibilityCheck"]
2940
+ "enum": [
2941
+ "meterReadingPlausibilityCheck"
2942
+ ]
2717
2943
  },
2718
2944
  "plausibility_mode": {
2719
2945
  "type": "string",
2720
- "enum": ["check", "range"],
2946
+ "enum": [
2947
+ "check",
2948
+ "range"
2949
+ ],
2721
2950
  "default": "check",
2722
2951
  "description": "Mode for plausibility check:\n- \"check\": Validates meter reading and returns valid: boolean (used during submission)\n- \"range\": Returns min/max allowed values for each counter for validation before submission\n"
2723
2952
  },
@@ -2745,18 +2974,27 @@
2745
2974
  "default": {}
2746
2975
  }
2747
2976
  },
2748
- "required": ["url", "headers", "body"],
2977
+ "required": [
2978
+ "url",
2979
+ "headers",
2980
+ "body"
2981
+ ],
2749
2982
  "additionalProperties": false
2750
2983
  },
2751
2984
  "resolved": {
2752
2985
  "type": "object",
2753
2986
  "description": "Response to the call",
2754
2987
  "properties": {
2755
- "dataPath": {
2988
+ "data_path": {
2756
2989
  "type": "string",
2757
2990
  "description": "Optional path to an array in the response. If specified and the path points to an array,\nthe hook will map over each item using 'Item' variable for interpolation.\nRelevant only if plausibility_mode is \"range\".\n",
2758
2991
  "example": "data.results"
2759
2992
  },
2993
+ "dataPath": {
2994
+ "type": "string",
2995
+ "deprecated": true,
2996
+ "description": "Deprecated. Use `data_path` instead."
2997
+ },
2760
2998
  "counter_identifiers": {
2761
2999
  "description": "Counter identifier(s) used to match against the meter's counters.\nCan be a string (counter ID) or an object with counter properties.\nThe backend resolves this to meter_counter_id in the final response.\nRelevant only if plausibility_mode is \"range\".\n",
2762
3000
  "type": "object",
@@ -2782,7 +3020,7 @@
2782
3020
  "description": "Lower allowed limit of the meter reading",
2783
3021
  "example": "{{CallResponse.data.lower_limit}}"
2784
3022
  },
2785
- "errorMessagePath": {
3023
+ "error_message_path": {
2786
3024
  "type": "string",
2787
3025
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
2788
3026
  "example": "error.message"
@@ -2800,7 +3038,12 @@
2800
3038
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
2801
3039
  }
2802
3040
  },
2803
- "required": ["id", "type", "call", "resolved"],
3041
+ "required": [
3042
+ "id",
3043
+ "type",
3044
+ "call",
3045
+ "resolved"
3046
+ ],
2804
3047
  "additionalProperties": false
2805
3048
  },
2806
3049
  "PortalExtensionHookPriceDataRetrieval": {
@@ -2817,7 +3060,9 @@
2817
3060
  },
2818
3061
  "type": {
2819
3062
  "type": "string",
2820
- "enum": ["priceDataRetrieval"]
3063
+ "enum": [
3064
+ "priceDataRetrieval"
3065
+ ]
2821
3066
  },
2822
3067
  "intervals": {
2823
3068
  "type": "array",
@@ -2825,7 +3070,12 @@
2825
3070
  "description": "Deprecated. Prefer declaring a sibling `visualizationMetadata` hook on the same extension and returning `intervals` from its response — that way the supported intervals can vary per meter/contract.\nIntervals supported by the API. If omitted, it is assumed that all intervals are supported.\n",
2826
3071
  "items": {
2827
3072
  "type": "string",
2828
- "enum": ["PT15M", "PT1H", "P1D", "P1M"]
3073
+ "enum": [
3074
+ "PT15M",
3075
+ "PT1H",
3076
+ "P1D",
3077
+ "P1M"
3078
+ ]
2829
3079
  }
2830
3080
  },
2831
3081
  "auth": {
@@ -2865,17 +3115,24 @@
2865
3115
  "additionalProperties": true
2866
3116
  }
2867
3117
  },
2868
- "required": ["url"],
3118
+ "required": [
3119
+ "url"
3120
+ ],
2869
3121
  "additionalProperties": false
2870
3122
  },
2871
3123
  "resolved": {
2872
3124
  "type": "object",
2873
3125
  "properties": {
2874
- "dataPath": {
3126
+ "data_path": {
2875
3127
  "type": "string",
2876
3128
  "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
2877
3129
  },
2878
- "errorMessagePath": {
3130
+ "dataPath": {
3131
+ "type": "string",
3132
+ "deprecated": true,
3133
+ "description": "Deprecated. Use `data_path` instead."
3134
+ },
3135
+ "error_message_path": {
2879
3136
  "type": "string",
2880
3137
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
2881
3138
  "example": "error.message"
@@ -2893,7 +3150,11 @@
2893
3150
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
2894
3151
  }
2895
3152
  },
2896
- "required": ["id", "type", "call"],
3153
+ "required": [
3154
+ "id",
3155
+ "type",
3156
+ "call"
3157
+ ],
2897
3158
  "additionalProperties": false
2898
3159
  },
2899
3160
  "PortalExtensionHookConsumptionDataRetrieval": {
@@ -2910,7 +3171,9 @@
2910
3171
  },
2911
3172
  "type": {
2912
3173
  "type": "string",
2913
- "enum": ["consumptionDataRetrieval"]
3174
+ "enum": [
3175
+ "consumptionDataRetrieval"
3176
+ ]
2914
3177
  },
2915
3178
  "intervals": {
2916
3179
  "type": "array",
@@ -2918,7 +3181,12 @@
2918
3181
  "description": "Deprecated. Prefer declaring a sibling `visualizationMetadata` hook on the same extension and returning `intervals` from its response — that way the supported intervals can vary per meter/contract.\nIntervals supported by the API. If omitted, it is assumed that all intervals are supported.\n",
2919
3182
  "items": {
2920
3183
  "type": "string",
2921
- "enum": ["PT15M", "PT1H", "P1D", "P1M"]
3184
+ "enum": [
3185
+ "PT15M",
3186
+ "PT1H",
3187
+ "P1D",
3188
+ "P1M"
3189
+ ]
2922
3190
  }
2923
3191
  },
2924
3192
  "auth": {
@@ -2958,17 +3226,24 @@
2958
3226
  "additionalProperties": true
2959
3227
  }
2960
3228
  },
2961
- "required": ["url"],
3229
+ "required": [
3230
+ "url"
3231
+ ],
2962
3232
  "additionalProperties": false
2963
3233
  },
2964
3234
  "resolved": {
2965
3235
  "type": "object",
2966
3236
  "properties": {
2967
- "dataPath": {
3237
+ "data_path": {
2968
3238
  "type": "string",
2969
3239
  "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
2970
3240
  },
2971
- "errorMessagePath": {
3241
+ "dataPath": {
3242
+ "type": "string",
3243
+ "deprecated": true,
3244
+ "description": "Deprecated. Use `data_path` instead."
3245
+ },
3246
+ "error_message_path": {
2972
3247
  "type": "string",
2973
3248
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
2974
3249
  "example": "error.message"
@@ -2986,7 +3261,11 @@
2986
3261
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
2987
3262
  }
2988
3263
  },
2989
- "required": ["id", "type", "call"],
3264
+ "required": [
3265
+ "id",
3266
+ "type",
3267
+ "call"
3268
+ ],
2990
3269
  "additionalProperties": false
2991
3270
  },
2992
3271
  "PortalExtensionHookDataExport": {
@@ -3003,7 +3282,9 @@
3003
3282
  },
3004
3283
  "type": {
3005
3284
  "type": "string",
3006
- "enum": ["dataExport"]
3285
+ "enum": [
3286
+ "dataExport"
3287
+ ]
3007
3288
  },
3008
3289
  "block_types": {
3009
3290
  "type": "array",
@@ -3049,13 +3330,15 @@
3049
3330
  "additionalProperties": true
3050
3331
  }
3051
3332
  },
3052
- "required": ["url"],
3333
+ "required": [
3334
+ "url"
3335
+ ],
3053
3336
  "additionalProperties": false
3054
3337
  },
3055
3338
  "resolved": {
3056
3339
  "type": "object",
3057
3340
  "properties": {
3058
- "errorMessagePath": {
3341
+ "error_message_path": {
3059
3342
  "type": "string",
3060
3343
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
3061
3344
  "example": "error.message"
@@ -3073,7 +3356,11 @@
3073
3356
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
3074
3357
  }
3075
3358
  },
3076
- "required": ["id", "type", "call"],
3359
+ "required": [
3360
+ "id",
3361
+ "type",
3362
+ "call"
3363
+ ],
3077
3364
  "additionalProperties": false
3078
3365
  },
3079
3366
  "PortalExtensionHookVisualizationMetadata": {
@@ -3090,7 +3377,9 @@
3090
3377
  },
3091
3378
  "type": {
3092
3379
  "type": "string",
3093
- "enum": ["visualizationMetadata"]
3380
+ "enum": [
3381
+ "visualizationMetadata"
3382
+ ]
3094
3383
  },
3095
3384
  "auth": {
3096
3385
  "$ref": "#/components/schemas/PortalExtensionAuthBlock"
@@ -3129,17 +3418,24 @@
3129
3418
  "additionalProperties": true
3130
3419
  }
3131
3420
  },
3132
- "required": ["url"],
3421
+ "required": [
3422
+ "url"
3423
+ ],
3133
3424
  "additionalProperties": false
3134
3425
  },
3135
3426
  "resolved": {
3136
3427
  "type": "object",
3137
3428
  "properties": {
3138
- "dataPath": {
3429
+ "data_path": {
3139
3430
  "type": "string",
3140
3431
  "description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
3141
3432
  },
3142
- "errorMessagePath": {
3433
+ "dataPath": {
3434
+ "type": "string",
3435
+ "deprecated": true,
3436
+ "description": "Deprecated. Use `data_path` instead."
3437
+ },
3438
+ "error_message_path": {
3143
3439
  "type": "string",
3144
3440
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
3145
3441
  "example": "error.message"
@@ -3157,7 +3453,11 @@
3157
3453
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
3158
3454
  }
3159
3455
  },
3160
- "required": ["id", "type", "call"],
3456
+ "required": [
3457
+ "id",
3458
+ "type",
3459
+ "call"
3460
+ ],
3161
3461
  "additionalProperties": false
3162
3462
  },
3163
3463
  "PortalExtensionHookCostDataRetrieval": {
@@ -3174,7 +3474,9 @@
3174
3474
  },
3175
3475
  "type": {
3176
3476
  "type": "string",
3177
- "enum": ["costDataRetrieval"]
3477
+ "enum": [
3478
+ "costDataRetrieval"
3479
+ ]
3178
3480
  },
3179
3481
  "intervals": {
3180
3482
  "type": "array",
@@ -3182,7 +3484,12 @@
3182
3484
  "description": "Deprecated. Prefer declaring a sibling `visualizationMetadata` hook on the same extension and returning `intervals` from its response — that way the supported intervals can vary per meter/contract.\nIntervals supported by the API. If omitted, it is assumed that all intervals are supported.\n",
3183
3485
  "items": {
3184
3486
  "type": "string",
3185
- "enum": ["PT15M", "PT1H", "P1D", "P1M"]
3487
+ "enum": [
3488
+ "PT15M",
3489
+ "PT1H",
3490
+ "P1D",
3491
+ "P1M"
3492
+ ]
3186
3493
  }
3187
3494
  },
3188
3495
  "auth": {
@@ -3222,17 +3529,24 @@
3222
3529
  "additionalProperties": true
3223
3530
  }
3224
3531
  },
3225
- "required": ["url"],
3532
+ "required": [
3533
+ "url"
3534
+ ],
3226
3535
  "additionalProperties": false
3227
3536
  },
3228
3537
  "resolved": {
3229
3538
  "type": "object",
3230
3539
  "properties": {
3231
- "dataPath": {
3540
+ "data_path": {
3232
3541
  "type": "string",
3233
3542
  "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
3234
3543
  },
3235
- "errorMessagePath": {
3544
+ "dataPath": {
3545
+ "type": "string",
3546
+ "deprecated": true,
3547
+ "description": "Deprecated. Use `data_path` instead."
3548
+ },
3549
+ "error_message_path": {
3236
3550
  "type": "string",
3237
3551
  "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
3238
3552
  "example": "error.message"
@@ -3250,7 +3564,11 @@
3250
3564
  "$ref": "#/components/schemas/PortalExtensionSecureProxy"
3251
3565
  }
3252
3566
  },
3253
- "required": ["id", "type", "call"],
3567
+ "required": [
3568
+ "id",
3569
+ "type",
3570
+ "call"
3571
+ ],
3254
3572
  "additionalProperties": false
3255
3573
  },
3256
3574
  "PortalExtensionSeamlessLink": {
@@ -3269,7 +3587,9 @@
3269
3587
  },
3270
3588
  "type": {
3271
3589
  "type": "string",
3272
- "enum": ["seamless"]
3590
+ "enum": [
3591
+ "seamless"
3592
+ ]
3273
3593
  },
3274
3594
  "condition": {
3275
3595
  "type": "string",
@@ -3298,7 +3618,12 @@
3298
3618
  "additionalProperties": false
3299
3619
  }
3300
3620
  },
3301
- "required": ["id", "name", "type", "redirect"],
3621
+ "required": [
3622
+ "id",
3623
+ "name",
3624
+ "type",
3625
+ "redirect"
3626
+ ],
3302
3627
  "additionalProperties": false
3303
3628
  },
3304
3629
  "PortalExtensionAuthBlock": {
@@ -3348,11 +3673,16 @@
3348
3673
  "example": "{{AuthResponse.data.expires_in}}"
3349
3674
  }
3350
3675
  },
3351
- "required": ["key", "ttl"],
3676
+ "required": [
3677
+ "key",
3678
+ "ttl"
3679
+ ],
3352
3680
  "additionalProperties": false
3353
3681
  }
3354
3682
  },
3355
- "required": ["url"],
3683
+ "required": [
3684
+ "url"
3685
+ ],
3356
3686
  "additionalProperties": false
3357
3687
  },
3358
3688
  "PortalExtensionSecureProxy": {
@@ -3369,7 +3699,10 @@
3369
3699
  "description": "Use case slug for the secure proxy use case."
3370
3700
  }
3371
3701
  },
3372
- "required": ["integration_id", "use_case_slug"],
3702
+ "required": [
3703
+ "integration_id",
3704
+ "use_case_slug"
3705
+ ],
3373
3706
  "additionalProperties": false
3374
3707
  },
3375
3708
  "ExternalProductCatalogAuthBlock": {
@@ -3406,7 +3739,9 @@
3406
3739
  "additionalProperties": true
3407
3740
  }
3408
3741
  },
3409
- "required": ["url"],
3742
+ "required": [
3743
+ "url"
3744
+ ],
3410
3745
  "additionalProperties": false
3411
3746
  },
3412
3747
  "OverrideDevMode": {
@@ -3422,7 +3757,10 @@
3422
3757
  },
3423
3758
  "JourneyBlockConfig": {
3424
3759
  "type": "object",
3425
- "required": ["component_url", "component_tag"],
3760
+ "required": [
3761
+ "component_url",
3762
+ "component_tag"
3763
+ ],
3426
3764
  "properties": {
3427
3765
  "override_dev_mode": {
3428
3766
  "$ref": "#/components/schemas/OverrideDevMode"
@@ -3506,7 +3844,9 @@
3506
3844
  "footer_right_absolute"
3507
3845
  ]
3508
3846
  },
3509
- "default": ["main"]
3847
+ "default": [
3848
+ "main"
3849
+ ]
3510
3850
  }
3511
3851
  }
3512
3852
  }
@@ -3516,7 +3856,11 @@
3516
3856
  "allOf": [
3517
3857
  {
3518
3858
  "type": "object",
3519
- "required": ["key", "label", "type"],
3859
+ "required": [
3860
+ "key",
3861
+ "label",
3862
+ "type"
3863
+ ],
3520
3864
  "properties": {
3521
3865
  "key": {
3522
3866
  "type": "string",
@@ -3524,7 +3868,12 @@
3524
3868
  },
3525
3869
  "type": {
3526
3870
  "type": "string",
3527
- "enum": ["text", "boolean", "enum", "block_reference"]
3871
+ "enum": [
3872
+ "text",
3873
+ "boolean",
3874
+ "enum",
3875
+ "block_reference"
3876
+ ]
3528
3877
  },
3529
3878
  "required": {
3530
3879
  "type": "boolean",
@@ -3586,7 +3935,9 @@
3586
3935
  "properties": {
3587
3936
  "type": {
3588
3937
  "type": "string",
3589
- "enum": ["text"]
3938
+ "enum": [
3939
+ "text"
3940
+ ]
3590
3941
  }
3591
3942
  }
3592
3943
  },
@@ -3595,7 +3946,9 @@
3595
3946
  "properties": {
3596
3947
  "type": {
3597
3948
  "type": "string",
3598
- "enum": ["boolean"]
3949
+ "enum": [
3950
+ "boolean"
3951
+ ]
3599
3952
  }
3600
3953
  }
3601
3954
  },
@@ -3605,7 +3958,9 @@
3605
3958
  "properties": {
3606
3959
  "type": {
3607
3960
  "type": "string",
3608
- "enum": ["block_reference"]
3961
+ "enum": [
3962
+ "block_reference"
3963
+ ]
3609
3964
  },
3610
3965
  "allowed_types": {
3611
3966
  "type": "array",
@@ -3618,11 +3973,15 @@
3618
3973
  },
3619
3974
  "EnumArg": {
3620
3975
  "type": "object",
3621
- "required": ["options"],
3976
+ "required": [
3977
+ "options"
3978
+ ],
3622
3979
  "properties": {
3623
3980
  "type": {
3624
3981
  "type": "string",
3625
- "enum": ["enum"]
3982
+ "enum": [
3983
+ "enum"
3984
+ ]
3626
3985
  },
3627
3986
  "isMulti": {
3628
3987
  "type": "boolean",
@@ -3635,7 +3994,10 @@
3635
3994
  "minItems": 1,
3636
3995
  "items": {
3637
3996
  "type": "object",
3638
- "required": ["id", "label"],
3997
+ "required": [
3998
+ "id",
3999
+ "label"
4000
+ ],
3639
4001
  "properties": {
3640
4002
  "id": {
3641
4003
  "type": "string",
@@ -3658,7 +4020,12 @@
3658
4020
  },
3659
4021
  "BillingFrequency": {
3660
4022
  "type": "string",
3661
- "enum": ["MONTHLY", "QUARTERLY", "YEARLY", "CUSTOM"],
4023
+ "enum": [
4024
+ "MONTHLY",
4025
+ "QUARTERLY",
4026
+ "YEARLY",
4027
+ "CUSTOM"
4028
+ ],
3662
4029
  "description": "How often the subscription is billed"
3663
4030
  },
3664
4031
  "Pricing": {
@@ -3715,7 +4082,11 @@
3715
4082
  },
3716
4083
  "review_status": {
3717
4084
  "type": "string",
3718
- "enum": ["approved", "rejected", "pending"],
4085
+ "enum": [
4086
+ "approved",
4087
+ "rejected",
4088
+ "pending"
4089
+ ],
3719
4090
  "description": "Status of the review"
3720
4091
  },
3721
4092
  "requested_at": {
@@ -3889,7 +4260,10 @@
3889
4260
  },
3890
4261
  "visibility": {
3891
4262
  "type": "string",
3892
- "enum": ["public", "private"],
4263
+ "enum": [
4264
+ "public",
4265
+ "private"
4266
+ ],
3893
4267
  "description": "Visibility of the app version",
3894
4268
  "default": "private",
3895
4269
  "readOnly": true
@@ -3929,7 +4303,11 @@
3929
4303
  },
3930
4304
  "review_status": {
3931
4305
  "type": "string",
3932
- "enum": ["approved", "rejected", "pending"],
4306
+ "enum": [
4307
+ "approved",
4308
+ "rejected",
4309
+ "pending"
4310
+ ],
3933
4311
  "description": "Status of the review process"
3934
4312
  },
3935
4313
  "role": {
@@ -3966,7 +4344,11 @@
3966
4344
  "ApiProxyConfig": {
3967
4345
  "type": "object",
3968
4346
  "description": "Configuration for an API proxy component",
3969
- "required": ["name", "target", "auth_type"],
4347
+ "required": [
4348
+ "name",
4349
+ "target",
4350
+ "auth_type"
4351
+ ],
3970
4352
  "properties": {
3971
4353
  "name": {
3972
4354
  "type": "string",
@@ -3982,7 +4364,12 @@
3982
4364
  },
3983
4365
  "auth_type": {
3984
4366
  "type": "string",
3985
- "enum": ["header", "bearer", "oauth2", "none"],
4367
+ "enum": [
4368
+ "header",
4369
+ "bearer",
4370
+ "oauth2",
4371
+ "none"
4372
+ ],
3986
4373
  "description": "Authentication strategy"
3987
4374
  },
3988
4375
  "auth_header": {
@@ -4002,7 +4389,9 @@
4002
4389
  "description": "Required grants for the app in order to call APIs for the installing tenant",
4003
4390
  "items": {
4004
4391
  "type": "object",
4005
- "required": ["action"],
4392
+ "required": [
4393
+ "action"
4394
+ ],
4006
4395
  "properties": {
4007
4396
  "action": {
4008
4397
  "type": "string",
@@ -4123,7 +4512,13 @@
4123
4512
  "PublicConfiguration": {
4124
4513
  "description": "Public configuration of the published app",
4125
4514
  "type": "object",
4126
- "required": ["version", "components", "owner_org_id", "app_id", "name"],
4515
+ "required": [
4516
+ "version",
4517
+ "components",
4518
+ "owner_org_id",
4519
+ "app_id",
4520
+ "name"
4521
+ ],
4127
4522
  "properties": {
4128
4523
  "app_id": {
4129
4524
  "type": "string",
@@ -4239,7 +4634,9 @@
4239
4634
  },
4240
4635
  "TranslatedString": {
4241
4636
  "type": "object",
4242
- "required": ["de"],
4637
+ "required": [
4638
+ "de"
4639
+ ],
4243
4640
  "properties": {
4244
4641
  "en": {
4245
4642
  "type": "string",
@@ -4275,11 +4672,15 @@
4275
4672
  "example": "api_5ZugdRXasLfWBypHi93Fk"
4276
4673
  }
4277
4674
  },
4278
- "required": ["org_id"]
4675
+ "required": [
4676
+ "org_id"
4677
+ ]
4279
4678
  },
4280
4679
  "BatchEventRequest": {
4281
4680
  "type": "object",
4282
- "required": ["events"],
4681
+ "required": [
4682
+ "events"
4683
+ ],
4283
4684
  "properties": {
4284
4685
  "events": {
4285
4686
  "type": "array",
@@ -4293,7 +4694,9 @@
4293
4694
  "Actor": {
4294
4695
  "type": "object",
4295
4696
  "readOnly": true,
4296
- "required": ["type"],
4697
+ "required": [
4698
+ "type"
4699
+ ],
4297
4700
  "properties": {
4298
4701
  "org_id": {
4299
4702
  "type": "string",
@@ -4306,7 +4709,10 @@
4306
4709
  "type": {
4307
4710
  "type": "string",
4308
4711
  "description": "Type of the actor (e.g., user, system)",
4309
- "enum": ["user", "system"]
4712
+ "enum": [
4713
+ "user",
4714
+ "system"
4715
+ ]
4310
4716
  }
4311
4717
  }
4312
4718
  },
@@ -4345,7 +4751,11 @@
4345
4751
  },
4346
4752
  "event_type": {
4347
4753
  "type": "string",
4348
- "enum": ["ERROR", "WARNING", "INFO"]
4754
+ "enum": [
4755
+ "ERROR",
4756
+ "WARNING",
4757
+ "INFO"
4758
+ ]
4349
4759
  },
4350
4760
  "source": {
4351
4761
  "$ref": "#/components/schemas/ComponentType"
@@ -4378,7 +4788,13 @@
4378
4788
  },
4379
4789
  "preset": {
4380
4790
  "type": "string",
4381
- "enum": ["1h", "6h", "24h", "7d", "30d"],
4791
+ "enum": [
4792
+ "1h",
4793
+ "6h",
4794
+ "24h",
4795
+ "7d",
4796
+ "30d"
4797
+ ],
4382
4798
  "description": "Predefined time range (alternative to start/end)"
4383
4799
  }
4384
4800
  },
@@ -4405,7 +4821,11 @@
4405
4821
  "type": "array",
4406
4822
  "items": {
4407
4823
  "type": "string",
4408
- "enum": ["ERROR", "WARNING", "INFO"]
4824
+ "enum": [
4825
+ "ERROR",
4826
+ "WARNING",
4827
+ "INFO"
4828
+ ]
4409
4829
  },
4410
4830
  "description": "Filter by event types"
4411
4831
  },
@@ -4436,9 +4856,15 @@
4436
4856
  "type": "array",
4437
4857
  "items": {
4438
4858
  "type": "string",
4439
- "enum": ["count", "error_rate", "unique_users"]
4859
+ "enum": [
4860
+ "count",
4861
+ "error_rate",
4862
+ "unique_users"
4863
+ ]
4440
4864
  },
4441
- "default": ["count"],
4865
+ "default": [
4866
+ "count"
4867
+ ],
4442
4868
  "description": "Metrics to calculate"
4443
4869
  }
4444
4870
  }
@@ -4464,12 +4890,19 @@
4464
4890
  "properties": {
4465
4891
  "field": {
4466
4892
  "type": "string",
4467
- "enum": ["timestamp", "event_type", "component_id"],
4893
+ "enum": [
4894
+ "timestamp",
4895
+ "event_type",
4896
+ "component_id"
4897
+ ],
4468
4898
  "default": "timestamp"
4469
4899
  },
4470
4900
  "order": {
4471
4901
  "type": "string",
4472
- "enum": ["asc", "desc"],
4902
+ "enum": [
4903
+ "asc",
4904
+ "desc"
4905
+ ],
4473
4906
  "default": "desc"
4474
4907
  }
4475
4908
  }
@@ -4516,7 +4949,9 @@
4516
4949
  "properties": {
4517
4950
  "type": {
4518
4951
  "type": "string",
4519
- "enum": ["raw"]
4952
+ "enum": [
4953
+ "raw"
4954
+ ]
4520
4955
  },
4521
4956
  "events": {
4522
4957
  "type": "array",
@@ -4531,7 +4966,9 @@
4531
4966
  "properties": {
4532
4967
  "type": {
4533
4968
  "type": "string",
4534
- "enum": ["aggregated"]
4969
+ "enum": [
4970
+ "aggregated"
4971
+ ]
4535
4972
  },
4536
4973
  "groups": {
4537
4974
  "type": "array",