@epilot/app-client 0.13.0 → 0.13.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +84 -4
- package/dist/openapi.json +222 -566
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={330(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var p=n(t(466));r.default=p.default},466
|
|
1
|
+
(()=>{"use strict";var e={330:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var p=n(t(466));r.default=p.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/public/app/{appId}/components/{componentId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"},{"name":"componentId","in":"path","required":true,"description":"ID of the component to retrieve"}],"get":{"operationId":"getPublicFacingComponent","responses":{}}},"/v1/app-configurations":{"get":{"operationId":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public":{"get":{"operationId":"listPublicConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}},"delete":{"operationId":"deleteConfiguration","responses":{}}},"/v1/app-configurations/{appId}/events":{"post":{"operationId":"queryEvents","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"responses":{}}},"/v1/app-configurations/{appId}/zip":{"post":{"operationId":"createZipUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/PatchVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/review":{"get":{"operationId":"getReview","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"post":{"operationId":"createReview","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateReviewRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}},"/v1/app-events":{"post":{"operationId":"ingestEvent","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/app/{appId}/proxy/{proxyName}/{path}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the installed app"},{"name":"proxyName","in":"path","required":true,"description":"Name of the proxy target as defined in the app manifest"},{"name":"path","in":"path","required":true,"description":"Path to forward to the proxy target"}],"get":{"operationId":"publicProxyGet","responses":{}},"post":{"operationId":"publicProxyPost","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"requestBodies":{"CreateReviewRequest":{"required":true,"content":{"application/json":{}}},"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"PatchVersionRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var p=r[n];if(void 0!==p)return p.exports;var o=r[n]={exports:{}};return e[n].call(o.exports,o,o.exports,t),o.exports}(330),n=exports;for(var p in t)n[p]=t[p];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1580,13 +1580,14 @@ declare namespace Components {
|
|
|
1580
1580
|
* - 200 with a JSON body of shape:
|
|
1581
1581
|
* {
|
|
1582
1582
|
* "type_options": [
|
|
1583
|
-
* { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh" },
|
|
1583
|
+
* { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh", "color": "primary", "precision": 2 },
|
|
1584
1584
|
* ...
|
|
1585
1585
|
* ],
|
|
1586
1586
|
* "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
|
|
1587
1587
|
* "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
|
|
1588
1588
|
* }
|
|
1589
1589
|
* 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.
|
|
1590
|
+
* Each type option may also customize its rendering: `color` picks a Spark palette color (`primary`, `slate`, `mauve`, `orange`, `red`, `tomato`, `amber`, `green`, `blue`) used to draw the type's series; `precision` sets the number of decimal places to show for that type's values (axis labels, tooltips, summaries). Both are optional — the consumer falls back to its own defaults when they are omitted.
|
|
1590
1591
|
* `aggregation_group` controls how types within a group are visually combined (depends on the per-type `statistical_method`):
|
|
1591
1592
|
* - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.
|
|
1592
1593
|
* - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.
|
|
@@ -1676,6 +1677,14 @@ declare namespace Components {
|
|
|
1676
1677
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1677
1678
|
*/
|
|
1678
1679
|
dataPath?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1682
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1683
|
+
*
|
|
1684
|
+
* example:
|
|
1685
|
+
* error.message
|
|
1686
|
+
*/
|
|
1687
|
+
errorMessagePath?: string;
|
|
1679
1688
|
};
|
|
1680
1689
|
/**
|
|
1681
1690
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -1735,10 +1744,24 @@ declare namespace Components {
|
|
|
1735
1744
|
[key: string]: any;
|
|
1736
1745
|
};
|
|
1737
1746
|
/**
|
|
1738
|
-
* 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.
|
|
1747
|
+
* 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.
|
|
1739
1748
|
*/
|
|
1740
1749
|
result?: string;
|
|
1741
1750
|
};
|
|
1751
|
+
resolved?: {
|
|
1752
|
+
/**
|
|
1753
|
+
* 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`.
|
|
1754
|
+
*/
|
|
1755
|
+
result?: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1758
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1759
|
+
*
|
|
1760
|
+
* example:
|
|
1761
|
+
* error.message
|
|
1762
|
+
*/
|
|
1763
|
+
errorMessagePath?: string;
|
|
1764
|
+
};
|
|
1742
1765
|
/**
|
|
1743
1766
|
* Mode of contract assignment. See hook description for mode details.
|
|
1744
1767
|
*/
|
|
@@ -1821,6 +1844,14 @@ declare namespace Components {
|
|
|
1821
1844
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1822
1845
|
*/
|
|
1823
1846
|
dataPath?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1849
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1850
|
+
*
|
|
1851
|
+
* example:
|
|
1852
|
+
* error.message
|
|
1853
|
+
*/
|
|
1854
|
+
errorMessagePath?: string;
|
|
1824
1855
|
};
|
|
1825
1856
|
/**
|
|
1826
1857
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -1879,6 +1910,16 @@ declare namespace Components {
|
|
|
1879
1910
|
[name: string]: any;
|
|
1880
1911
|
};
|
|
1881
1912
|
};
|
|
1913
|
+
resolved?: {
|
|
1914
|
+
/**
|
|
1915
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1916
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1917
|
+
*
|
|
1918
|
+
* example:
|
|
1919
|
+
* error.message
|
|
1920
|
+
*/
|
|
1921
|
+
errorMessagePath?: string;
|
|
1922
|
+
};
|
|
1882
1923
|
/**
|
|
1883
1924
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
1884
1925
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
@@ -1974,6 +2015,14 @@ declare namespace Components {
|
|
|
1974
2015
|
* {{CallResponse.data.lower_limit}}
|
|
1975
2016
|
*/
|
|
1976
2017
|
lower_limit?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
2020
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
2021
|
+
*
|
|
2022
|
+
* example:
|
|
2023
|
+
* error.message
|
|
2024
|
+
*/
|
|
2025
|
+
errorMessagePath?: string;
|
|
1977
2026
|
};
|
|
1978
2027
|
/**
|
|
1979
2028
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -2035,6 +2084,14 @@ declare namespace Components {
|
|
|
2035
2084
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
2036
2085
|
*/
|
|
2037
2086
|
dataPath?: string;
|
|
2087
|
+
/**
|
|
2088
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
2089
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
2090
|
+
*
|
|
2091
|
+
* example:
|
|
2092
|
+
* error.message
|
|
2093
|
+
*/
|
|
2094
|
+
errorMessagePath?: string;
|
|
2038
2095
|
};
|
|
2039
2096
|
/**
|
|
2040
2097
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -2086,10 +2143,24 @@ declare namespace Components {
|
|
|
2086
2143
|
[key: string]: any;
|
|
2087
2144
|
};
|
|
2088
2145
|
/**
|
|
2089
|
-
* 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.
|
|
2146
|
+
* 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.
|
|
2090
2147
|
*/
|
|
2091
2148
|
result: string;
|
|
2092
2149
|
};
|
|
2150
|
+
resolved?: {
|
|
2151
|
+
/**
|
|
2152
|
+
* 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`.
|
|
2153
|
+
*/
|
|
2154
|
+
result?: string;
|
|
2155
|
+
/**
|
|
2156
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
2157
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
2158
|
+
*
|
|
2159
|
+
* example:
|
|
2160
|
+
* error.message
|
|
2161
|
+
*/
|
|
2162
|
+
errorMessagePath?: string;
|
|
2163
|
+
};
|
|
2093
2164
|
/**
|
|
2094
2165
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
2095
2166
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
@@ -2103,13 +2174,14 @@ declare namespace Components {
|
|
|
2103
2174
|
* - 200 with a JSON body of shape:
|
|
2104
2175
|
* {
|
|
2105
2176
|
* "type_options": [
|
|
2106
|
-
* { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh" },
|
|
2177
|
+
* { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh", "color": "primary", "precision": 2 },
|
|
2107
2178
|
* ...
|
|
2108
2179
|
* ],
|
|
2109
2180
|
* "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
|
|
2110
2181
|
* "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
|
|
2111
2182
|
* }
|
|
2112
2183
|
* 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.
|
|
2184
|
+
* Each type option may also customize its rendering: `color` picks a Spark palette color (`primary`, `slate`, `mauve`, `orange`, `red`, `tomato`, `amber`, `green`, `blue`) used to draw the type's series; `precision` sets the number of decimal places to show for that type's values (axis labels, tooltips, summaries). Both are optional — the consumer falls back to its own defaults when they are omitted.
|
|
2113
2185
|
* `aggregation_group` controls how types within a group are visually combined (depends on the per-type `statistical_method`):
|
|
2114
2186
|
* - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.
|
|
2115
2187
|
* - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.
|
|
@@ -2158,6 +2230,14 @@ declare namespace Components {
|
|
|
2158
2230
|
* Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
|
|
2159
2231
|
*/
|
|
2160
2232
|
dataPath?: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
2235
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
2236
|
+
*
|
|
2237
|
+
* example:
|
|
2238
|
+
* error.message
|
|
2239
|
+
*/
|
|
2240
|
+
errorMessagePath?: string;
|
|
2161
2241
|
};
|
|
2162
2242
|
/**
|
|
2163
2243
|
* Deprecated. Prefer `secure_proxy` instead.
|