@epilot/app-client 0.13.1 → 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.
- package/dist/openapi.d.ts +56 -8
- package/dist/openapi.json +70 -13
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -1676,6 +1676,10 @@ declare namespace Components {
|
|
|
1676
1676
|
/**
|
|
1677
1677
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1678
1678
|
*/
|
|
1679
|
+
data_path?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* Deprecated. Use `data_path` instead.
|
|
1682
|
+
*/
|
|
1679
1683
|
dataPath?: string;
|
|
1680
1684
|
/**
|
|
1681
1685
|
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
@@ -1684,7 +1688,7 @@ declare namespace Components {
|
|
|
1684
1688
|
* example:
|
|
1685
1689
|
* error.message
|
|
1686
1690
|
*/
|
|
1687
|
-
|
|
1691
|
+
error_message_path?: string;
|
|
1688
1692
|
};
|
|
1689
1693
|
/**
|
|
1690
1694
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -1744,10 +1748,24 @@ declare namespace Components {
|
|
|
1744
1748
|
[key: string]: any;
|
|
1745
1749
|
};
|
|
1746
1750
|
/**
|
|
1747
|
-
* 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.
|
|
1751
|
+
* 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.
|
|
1748
1752
|
*/
|
|
1749
1753
|
result?: string;
|
|
1750
1754
|
};
|
|
1755
|
+
resolved?: {
|
|
1756
|
+
/**
|
|
1757
|
+
* 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`.
|
|
1758
|
+
*/
|
|
1759
|
+
result?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1762
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1763
|
+
*
|
|
1764
|
+
* example:
|
|
1765
|
+
* error.message
|
|
1766
|
+
*/
|
|
1767
|
+
error_message_path?: string;
|
|
1768
|
+
};
|
|
1751
1769
|
/**
|
|
1752
1770
|
* Mode of contract assignment. See hook description for mode details.
|
|
1753
1771
|
*/
|
|
@@ -1829,6 +1847,10 @@ declare namespace Components {
|
|
|
1829
1847
|
/**
|
|
1830
1848
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
1831
1849
|
*/
|
|
1850
|
+
data_path?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* Deprecated. Use `data_path` instead.
|
|
1853
|
+
*/
|
|
1832
1854
|
dataPath?: string;
|
|
1833
1855
|
/**
|
|
1834
1856
|
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
@@ -1837,7 +1859,7 @@ declare namespace Components {
|
|
|
1837
1859
|
* example:
|
|
1838
1860
|
* error.message
|
|
1839
1861
|
*/
|
|
1840
|
-
|
|
1862
|
+
error_message_path?: string;
|
|
1841
1863
|
};
|
|
1842
1864
|
/**
|
|
1843
1865
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -1904,7 +1926,7 @@ declare namespace Components {
|
|
|
1904
1926
|
* example:
|
|
1905
1927
|
* error.message
|
|
1906
1928
|
*/
|
|
1907
|
-
|
|
1929
|
+
error_message_path?: string;
|
|
1908
1930
|
};
|
|
1909
1931
|
/**
|
|
1910
1932
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -1968,6 +1990,10 @@ declare namespace Components {
|
|
|
1968
1990
|
* example:
|
|
1969
1991
|
* data.results
|
|
1970
1992
|
*/
|
|
1993
|
+
data_path?: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* Deprecated. Use `data_path` instead.
|
|
1996
|
+
*/
|
|
1971
1997
|
dataPath?: string;
|
|
1972
1998
|
/**
|
|
1973
1999
|
* Counter identifier(s) used to match against the meter's counters.
|
|
@@ -2008,7 +2034,7 @@ declare namespace Components {
|
|
|
2008
2034
|
* example:
|
|
2009
2035
|
* error.message
|
|
2010
2036
|
*/
|
|
2011
|
-
|
|
2037
|
+
error_message_path?: string;
|
|
2012
2038
|
};
|
|
2013
2039
|
/**
|
|
2014
2040
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -2069,6 +2095,10 @@ declare namespace Components {
|
|
|
2069
2095
|
/**
|
|
2070
2096
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
2071
2097
|
*/
|
|
2098
|
+
data_path?: string;
|
|
2099
|
+
/**
|
|
2100
|
+
* Deprecated. Use `data_path` instead.
|
|
2101
|
+
*/
|
|
2072
2102
|
dataPath?: string;
|
|
2073
2103
|
/**
|
|
2074
2104
|
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
@@ -2077,7 +2107,7 @@ declare namespace Components {
|
|
|
2077
2107
|
* example:
|
|
2078
2108
|
* error.message
|
|
2079
2109
|
*/
|
|
2080
|
-
|
|
2110
|
+
error_message_path?: string;
|
|
2081
2111
|
};
|
|
2082
2112
|
/**
|
|
2083
2113
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -2129,10 +2159,24 @@ declare namespace Components {
|
|
|
2129
2159
|
[key: string]: any;
|
|
2130
2160
|
};
|
|
2131
2161
|
/**
|
|
2132
|
-
* 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.
|
|
2162
|
+
* 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.
|
|
2133
2163
|
*/
|
|
2134
2164
|
result: string;
|
|
2135
2165
|
};
|
|
2166
|
+
resolved?: {
|
|
2167
|
+
/**
|
|
2168
|
+
* 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`.
|
|
2169
|
+
*/
|
|
2170
|
+
result?: string;
|
|
2171
|
+
/**
|
|
2172
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
2173
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
2174
|
+
*
|
|
2175
|
+
* example:
|
|
2176
|
+
* error.message
|
|
2177
|
+
*/
|
|
2178
|
+
error_message_path?: string;
|
|
2179
|
+
};
|
|
2136
2180
|
/**
|
|
2137
2181
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
2138
2182
|
* 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.
|
|
@@ -2201,6 +2245,10 @@ declare namespace Components {
|
|
|
2201
2245
|
/**
|
|
2202
2246
|
* Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
|
|
2203
2247
|
*/
|
|
2248
|
+
data_path?: string;
|
|
2249
|
+
/**
|
|
2250
|
+
* Deprecated. Use `data_path` instead.
|
|
2251
|
+
*/
|
|
2204
2252
|
dataPath?: string;
|
|
2205
2253
|
/**
|
|
2206
2254
|
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
@@ -2209,7 +2257,7 @@ declare namespace Components {
|
|
|
2209
2257
|
* example:
|
|
2210
2258
|
* error.message
|
|
2211
2259
|
*/
|
|
2212
|
-
|
|
2260
|
+
error_message_path?: string;
|
|
2213
2261
|
};
|
|
2214
2262
|
/**
|
|
2215
2263
|
* Deprecated. Prefer `secure_proxy` instead.
|
package/dist/openapi.json
CHANGED
|
@@ -2750,7 +2750,8 @@
|
|
|
2750
2750
|
},
|
|
2751
2751
|
"result": {
|
|
2752
2752
|
"type": "string",
|
|
2753
|
-
"
|
|
2753
|
+
"deprecated": true,
|
|
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."
|
|
2754
2755
|
}
|
|
2755
2756
|
},
|
|
2756
2757
|
"required": [
|
|
@@ -2760,6 +2761,21 @@
|
|
|
2760
2761
|
],
|
|
2761
2762
|
"additionalProperties": false
|
|
2762
2763
|
},
|
|
2764
|
+
"resolved": {
|
|
2765
|
+
"type": "object",
|
|
2766
|
+
"properties": {
|
|
2767
|
+
"result": {
|
|
2768
|
+
"type": "string",
|
|
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`."
|
|
2770
|
+
},
|
|
2771
|
+
"error_message_path": {
|
|
2772
|
+
"type": "string",
|
|
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",
|
|
2774
|
+
"example": "error.message"
|
|
2775
|
+
}
|
|
2776
|
+
},
|
|
2777
|
+
"additionalProperties": false
|
|
2778
|
+
},
|
|
2763
2779
|
"use_static_ips": {
|
|
2764
2780
|
"type": "boolean",
|
|
2765
2781
|
"deprecated": true,
|
|
@@ -2832,7 +2848,8 @@
|
|
|
2832
2848
|
},
|
|
2833
2849
|
"result": {
|
|
2834
2850
|
"type": "string",
|
|
2835
|
-
"
|
|
2851
|
+
"deprecated": true,
|
|
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."
|
|
2836
2853
|
}
|
|
2837
2854
|
},
|
|
2838
2855
|
"required": [
|
|
@@ -2841,6 +2858,21 @@
|
|
|
2841
2858
|
],
|
|
2842
2859
|
"additionalProperties": false
|
|
2843
2860
|
},
|
|
2861
|
+
"resolved": {
|
|
2862
|
+
"type": "object",
|
|
2863
|
+
"properties": {
|
|
2864
|
+
"result": {
|
|
2865
|
+
"type": "string",
|
|
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`."
|
|
2867
|
+
},
|
|
2868
|
+
"error_message_path": {
|
|
2869
|
+
"type": "string",
|
|
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",
|
|
2871
|
+
"example": "error.message"
|
|
2872
|
+
}
|
|
2873
|
+
},
|
|
2874
|
+
"additionalProperties": false
|
|
2875
|
+
},
|
|
2844
2876
|
"assignment_mode": {
|
|
2845
2877
|
"type": "string",
|
|
2846
2878
|
"enum": [
|
|
@@ -2953,11 +2985,16 @@
|
|
|
2953
2985
|
"type": "object",
|
|
2954
2986
|
"description": "Response to the call",
|
|
2955
2987
|
"properties": {
|
|
2956
|
-
"
|
|
2988
|
+
"data_path": {
|
|
2957
2989
|
"type": "string",
|
|
2958
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",
|
|
2959
2991
|
"example": "data.results"
|
|
2960
2992
|
},
|
|
2993
|
+
"dataPath": {
|
|
2994
|
+
"type": "string",
|
|
2995
|
+
"deprecated": true,
|
|
2996
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
2997
|
+
},
|
|
2961
2998
|
"counter_identifiers": {
|
|
2962
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",
|
|
2963
3000
|
"type": "object",
|
|
@@ -2983,7 +3020,7 @@
|
|
|
2983
3020
|
"description": "Lower allowed limit of the meter reading",
|
|
2984
3021
|
"example": "{{CallResponse.data.lower_limit}}"
|
|
2985
3022
|
},
|
|
2986
|
-
"
|
|
3023
|
+
"error_message_path": {
|
|
2987
3024
|
"type": "string",
|
|
2988
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",
|
|
2989
3026
|
"example": "error.message"
|
|
@@ -3086,11 +3123,16 @@
|
|
|
3086
3123
|
"resolved": {
|
|
3087
3124
|
"type": "object",
|
|
3088
3125
|
"properties": {
|
|
3089
|
-
"
|
|
3126
|
+
"data_path": {
|
|
3090
3127
|
"type": "string",
|
|
3091
3128
|
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
3092
3129
|
},
|
|
3093
|
-
"
|
|
3130
|
+
"dataPath": {
|
|
3131
|
+
"type": "string",
|
|
3132
|
+
"deprecated": true,
|
|
3133
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
3134
|
+
},
|
|
3135
|
+
"error_message_path": {
|
|
3094
3136
|
"type": "string",
|
|
3095
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",
|
|
3096
3138
|
"example": "error.message"
|
|
@@ -3192,11 +3234,16 @@
|
|
|
3192
3234
|
"resolved": {
|
|
3193
3235
|
"type": "object",
|
|
3194
3236
|
"properties": {
|
|
3195
|
-
"
|
|
3237
|
+
"data_path": {
|
|
3196
3238
|
"type": "string",
|
|
3197
3239
|
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
3198
3240
|
},
|
|
3199
|
-
"
|
|
3241
|
+
"dataPath": {
|
|
3242
|
+
"type": "string",
|
|
3243
|
+
"deprecated": true,
|
|
3244
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
3245
|
+
},
|
|
3246
|
+
"error_message_path": {
|
|
3200
3247
|
"type": "string",
|
|
3201
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",
|
|
3202
3249
|
"example": "error.message"
|
|
@@ -3291,7 +3338,7 @@
|
|
|
3291
3338
|
"resolved": {
|
|
3292
3339
|
"type": "object",
|
|
3293
3340
|
"properties": {
|
|
3294
|
-
"
|
|
3341
|
+
"error_message_path": {
|
|
3295
3342
|
"type": "string",
|
|
3296
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",
|
|
3297
3344
|
"example": "error.message"
|
|
@@ -3379,11 +3426,16 @@
|
|
|
3379
3426
|
"resolved": {
|
|
3380
3427
|
"type": "object",
|
|
3381
3428
|
"properties": {
|
|
3382
|
-
"
|
|
3429
|
+
"data_path": {
|
|
3383
3430
|
"type": "string",
|
|
3384
3431
|
"description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
|
|
3385
3432
|
},
|
|
3386
|
-
"
|
|
3433
|
+
"dataPath": {
|
|
3434
|
+
"type": "string",
|
|
3435
|
+
"deprecated": true,
|
|
3436
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
3437
|
+
},
|
|
3438
|
+
"error_message_path": {
|
|
3387
3439
|
"type": "string",
|
|
3388
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",
|
|
3389
3441
|
"example": "error.message"
|
|
@@ -3485,11 +3537,16 @@
|
|
|
3485
3537
|
"resolved": {
|
|
3486
3538
|
"type": "object",
|
|
3487
3539
|
"properties": {
|
|
3488
|
-
"
|
|
3540
|
+
"data_path": {
|
|
3489
3541
|
"type": "string",
|
|
3490
3542
|
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
3491
3543
|
},
|
|
3492
|
-
"
|
|
3544
|
+
"dataPath": {
|
|
3545
|
+
"type": "string",
|
|
3546
|
+
"deprecated": true,
|
|
3547
|
+
"description": "Deprecated. Use `data_path` instead."
|
|
3548
|
+
},
|
|
3549
|
+
"error_message_path": {
|
|
3493
3550
|
"type": "string",
|
|
3494
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",
|
|
3495
3552
|
"example": "error.message"
|