@coveo/platform-client 71.0.0 → 72.1.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/cjs/handlers/response/ResponseHandlers.js +4 -0
- package/dist/cjs/handlers/response/ResponseHandlers.js.map +1 -1
- package/dist/esm/handlers/response/ResponseHandlers.js +4 -0
- package/dist/esm/handlers/response/ResponseHandlers.js.map +1 -1
- package/dist/types/handlers/response/ResponseHandlerInterfaces.d.ts +38 -0
- package/dist/types/handlers/response/ResponseHandlers.d.ts +26 -2
- package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.d.ts +17 -9
- package/package.json +1 -1
|
@@ -51,6 +51,7 @@ const error = {
|
|
|
51
51
|
platformError.title = responseJson.title ?? getErrorTypeFromAliases(responseJson) ?? 'unknown';
|
|
52
52
|
platformError.detail = responseJson.detail ?? getErrorDetailFromAliases(responseJson) ?? 'unknown';
|
|
53
53
|
platformError.status = response.status;
|
|
54
|
+
platformError.url = response.url;
|
|
54
55
|
throw platformError;
|
|
55
56
|
},
|
|
56
57
|
};
|
|
@@ -62,6 +63,7 @@ const blockedByWAF = {
|
|
|
62
63
|
platformError.title = 'Request blocked for security reasons';
|
|
63
64
|
platformError.detail = 'The web application firewall has identified the request to be potentially malicious.';
|
|
64
65
|
platformError.status = response.status;
|
|
66
|
+
platformError.url = response.url;
|
|
65
67
|
throw platformError;
|
|
66
68
|
},
|
|
67
69
|
};
|
|
@@ -74,6 +76,7 @@ const badGateway = {
|
|
|
74
76
|
platformError.detail =
|
|
75
77
|
'The service is currently unable to reach the necessary endpoint, likely due to a bad gateway. Please try your request again later.';
|
|
76
78
|
platformError.status = response.status;
|
|
79
|
+
platformError.url = response.url;
|
|
77
80
|
throw platformError;
|
|
78
81
|
},
|
|
79
82
|
};
|
|
@@ -86,6 +89,7 @@ const htmlError = {
|
|
|
86
89
|
'Unable to process the request. An issue has occurred with the endpoint, and the system is unable to parse the error.';
|
|
87
90
|
platformError.detail = await response.text();
|
|
88
91
|
platformError.status = response.status;
|
|
92
|
+
platformError.url = response.url;
|
|
89
93
|
throw platformError;
|
|
90
94
|
},
|
|
91
95
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ResponseHandlers.js","sourceRoot":"","sources":["../../../../src/handlers/response/ResponseHandlers.ts"],"names":[],"mappings":";;;AAAA,+FAA+F;AAC/F,wCAAsC;
|
|
1
|
+
{"version":3,"file":"ResponseHandlers.js","sourceRoot":"","sources":["../../../../src/handlers/response/ResponseHandlers.ts"],"names":[],"mappings":";;;AAAA,+FAA+F;AAC/F,wCAAsC;AAStC;;;GAGG;AACI,MAAM,WAAW,GAAwB,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AAAzE,QAAA,WAAW,eAA8D;AAEtF;;;GAGG;AACI,MAAM,aAAa,GAAwB,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;AAA/D,QAAA,aAAa,iBAAkD;AAE5E,MAAM,SAAS,GAAoB;IAC/B,UAAU,EAAE,mBAAW;IACvB,OAAO,EAAE,GAAkB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAO,CAAC;CACzD,CAAC;AAEF,MAAM,OAAO,GAAoB;IAC7B,UAAU,EAAE,qBAAa;IACzB,OAAO,EAAE,KAAK,EAAK,QAAkB,EAAE,qBAAyC,MAAM,EAAc,EAAE;QAClG,IAAI,kBAAkB,KAAK,MAAM,EAAE,CAAC;YAChC,OAAO,QAAQ,CAAC,kBAAkB,CAAC,EAAO,CAAC;QAC/C,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtC,OACI,IAAI,CAAC,KAIR,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxE,OAAO,OAAO,CAAC,MAAM,CAAC;YAC1B,CAAC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAoB;IACjC,UAAU,EAAE,qBAAa;IACzB,OAAO,EAAE,KAAK,EAAK,QAAkB,EAAc,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM;CACrF,CAAC;AAEF,MAAM,KAAK,GAAoB;IAC3B,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;IACtB,OAAO,EAAE,KAAK,EAAE,QAAkB,EAAE,EAAE;QAClC,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;QACxE,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAC3C,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK,GAAI,YAAY,CAAC,KAAgB,IAAI,uBAAuB,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;QAC3G,aAAa,CAAC,MAAM,GAAI,YAAY,CAAC,MAAiB,IAAI,yBAAyB,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;QAC/G,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,YAAY,GAAoB;IAClC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,OAAO;IAChF,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK,GAAG,sCAAsC,CAAC;QAC7D,aAAa,CAAC,MAAM,GAAG,sFAAsF,CAAC;QAC9G,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,UAAU,GAAoB;IAChC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;IACjD,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK,GAAG,sBAAsB,CAAC;QAC7C,aAAa,CAAC,MAAM;YAChB,oIAAoI,CAAC;QACzI,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,SAAS,GAAoB;IAC/B,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,WAAW;IAC9E,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;QACxB,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK;YACf,sHAAsH,CAAC;QAC3H,aAAa,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC7C,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;AACvD,MAAM,uBAAuB,GAAG,CAAC,YAAoB,EAAE,EAAE,CAAC,wBAAwB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;AACnH,MAAM,kBAAkB,GAAG,CAAC,SAAS,CAAC,CAAC;AACvC,MAAM,yBAAyB,GAAG,CAAC,YAAoB,EAAE,EAAE,CAAC,wBAAwB,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;AAEvH,MAAM,wBAAwB,GAAG,CAAC,YAAoB,EAAE,SAAmB,EAAiB,EAAE;IAC1F,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC5B,IAAI,KAAK,IAAI,YAAY,IAAI,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;AAEnG,QAAA,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C,SAAS;IACT,OAAO;IACP,WAAW;IACX,YAAY;IACZ,UAAU;IACV,SAAS;IACT,KAAK;CACR,CAAC,CAAC;AAEH,kBAAe,KAAK,EAChB,QAAkB,EAClB,cAAkD,EAClD,kBAAuC,EAC7B,EAAE;IACZ,MAAM,QAAQ,GAAG,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,uBAAuB,CAAC;IACnF,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CACzB,CAAC,SAAS,EAAE,EAAE,CACV,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QAC7D,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;QAC1D,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CACrC,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,OAAO,CAAC,OAAO,CAAI,QAAQ,EAAE,kBAAkB,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,KAAK;IAC/C;;;OAGG;IACH,UAAU,CAAS;IACnB;;;OAGG;IACH,KAAK,CAAS;IACd;;OAEG;IACH,MAAM,CAAS;IACf;;OAEG;IACH,MAAM,CAAS;CAyBlB;AA3CD,4DA2CC"}
|
|
@@ -46,6 +46,7 @@ const error = {
|
|
|
46
46
|
platformError.title = responseJson.title ?? getErrorTypeFromAliases(responseJson) ?? 'unknown';
|
|
47
47
|
platformError.detail = responseJson.detail ?? getErrorDetailFromAliases(responseJson) ?? 'unknown';
|
|
48
48
|
platformError.status = response.status;
|
|
49
|
+
platformError.url = response.url;
|
|
49
50
|
throw platformError;
|
|
50
51
|
},
|
|
51
52
|
};
|
|
@@ -57,6 +58,7 @@ const blockedByWAF = {
|
|
|
57
58
|
platformError.title = 'Request blocked for security reasons';
|
|
58
59
|
platformError.detail = 'The web application firewall has identified the request to be potentially malicious.';
|
|
59
60
|
platformError.status = response.status;
|
|
61
|
+
platformError.url = response.url;
|
|
60
62
|
throw platformError;
|
|
61
63
|
},
|
|
62
64
|
};
|
|
@@ -69,6 +71,7 @@ const badGateway = {
|
|
|
69
71
|
platformError.detail =
|
|
70
72
|
'The service is currently unable to reach the necessary endpoint, likely due to a bad gateway. Please try your request again later.';
|
|
71
73
|
platformError.status = response.status;
|
|
74
|
+
platformError.url = response.url;
|
|
72
75
|
throw platformError;
|
|
73
76
|
},
|
|
74
77
|
};
|
|
@@ -81,6 +84,7 @@ const htmlError = {
|
|
|
81
84
|
'Unable to process the request. An issue has occurred with the endpoint, and the system is unable to parse the error.';
|
|
82
85
|
platformError.detail = await response.text();
|
|
83
86
|
platformError.status = response.status;
|
|
87
|
+
platformError.url = response.url;
|
|
84
88
|
throw platformError;
|
|
85
89
|
},
|
|
86
90
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ResponseHandlers.js","sourceRoot":"","sources":["../../../../src/handlers/response/ResponseHandlers.ts"],"names":[],"mappings":"AAAA,+FAA+F;AAC/F,OAAO,8BAA8B,CAAC;
|
|
1
|
+
{"version":3,"file":"ResponseHandlers.js","sourceRoot":"","sources":["../../../../src/handlers/response/ResponseHandlers.ts"],"names":[],"mappings":"AAAA,+FAA+F;AAC/F,OAAO,8BAA8B,CAAC;AAStC;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAwB,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AAEtF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAwB,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;AAE5E,MAAM,SAAS,GAAoB;IAC/B,UAAU,EAAE,WAAW;IACvB,OAAO,EAAE,GAAkB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAO,CAAC;CACzD,CAAC;AAEF,MAAM,OAAO,GAAoB;IAC7B,UAAU,EAAE,aAAa;IACzB,OAAO,EAAE,KAAK,EAAK,QAAkB,EAAE,qBAAyC,MAAM,EAAc,EAAE;QAClG,IAAI,kBAAkB,KAAK,MAAM,EAAE,CAAC;YAChC,OAAO,QAAQ,CAAC,kBAAkB,CAAC,EAAO,CAAC;QAC/C,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtC,OACI,IAAI,CAAC,KAIR,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxE,OAAO,OAAO,CAAC,MAAM,CAAC;YAC1B,CAAC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAoB;IACjC,UAAU,EAAE,aAAa;IACzB,OAAO,EAAE,KAAK,EAAK,QAAkB,EAAc,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM;CACrF,CAAC;AAEF,MAAM,KAAK,GAAoB;IAC3B,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;IACtB,OAAO,EAAE,KAAK,EAAE,QAAkB,EAAE,EAAE;QAClC,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;QACxE,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAC3C,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK,GAAI,YAAY,CAAC,KAAgB,IAAI,uBAAuB,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;QAC3G,aAAa,CAAC,MAAM,GAAI,YAAY,CAAC,MAAiB,IAAI,yBAAyB,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;QAC/G,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,YAAY,GAAoB;IAClC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,OAAO;IAChF,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK,GAAG,sCAAsC,CAAC;QAC7D,aAAa,CAAC,MAAM,GAAG,sFAAsF,CAAC;QAC9G,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,UAAU,GAAoB;IAChC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;IACjD,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK,GAAG,sBAAsB,CAAC;QAC7C,aAAa,CAAC,MAAM;YAChB,oIAAoI,CAAC;QACzI,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,SAAS,GAAoB;IAC/B,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,WAAW;IAC9E,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;QACxB,MAAM,aAAa,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACrD,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QAC7E,aAAa,CAAC,KAAK;YACf,sHAAsH,CAAC;QAC3H,aAAa,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC7C,aAAa,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,aAAa,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,aAAa,CAAC;IACxB,CAAC;CACJ,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;AACvD,MAAM,uBAAuB,GAAG,CAAC,YAAoB,EAAE,EAAE,CAAC,wBAAwB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;AACnH,MAAM,kBAAkB,GAAG,CAAC,SAAS,CAAC,CAAC;AACvC,MAAM,yBAAyB,GAAG,CAAC,YAAoB,EAAE,EAAE,CAAC,wBAAwB,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;AAEvH,MAAM,wBAAwB,GAAG,CAAC,YAAoB,EAAE,SAAmB,EAAiB,EAAE;IAC1F,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC5B,IAAI,KAAK,IAAI,YAAY,IAAI,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;AAEhH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C,SAAS;IACT,OAAO;IACP,WAAW;IACX,YAAY;IACZ,UAAU;IACV,SAAS;IACT,KAAK;CACR,CAAC,CAAC;AAEH,eAAe,KAAK,EAChB,QAAkB,EAClB,cAAkD,EAClD,kBAAuC,EAC7B,EAAE;IACZ,MAAM,QAAQ,GAAG,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,uBAAuB,CAAC;IACnF,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CACzB,CAAC,SAAS,EAAE,EAAE,CACV,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QAC7D,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;QAC1D,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CACrC,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,OAAO,CAAC,OAAO,CAAI,QAAQ,EAAE,kBAAkB,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAC/C;;;OAGG;IACH,UAAU,CAAS;IACnB;;;OAGG;IACH,KAAK,CAAS;IACd;;OAEG;IACH,MAAM,CAAS;IACf;;OAEG;IACH,MAAM,CAAS;CAyBlB"}
|
|
@@ -15,3 +15,41 @@ export interface ResponseHandler {
|
|
|
15
15
|
*/
|
|
16
16
|
process<T>(response: Response, responseBodyFormat?: ResponseBodyFormat): Promise<T>;
|
|
17
17
|
}
|
|
18
|
+
/**
|
|
19
|
+
* A single error entry returned in the `details` array of a Coveo Platform API error response.
|
|
20
|
+
*/
|
|
21
|
+
export interface PlatformErrorDetail {
|
|
22
|
+
/**
|
|
23
|
+
* A code identifying the type of this error entry, for example `INVALID_PARAMETER`.
|
|
24
|
+
*/
|
|
25
|
+
errorCode: string;
|
|
26
|
+
/**
|
|
27
|
+
* A human-readable explanation of this error entry.
|
|
28
|
+
*/
|
|
29
|
+
message: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The JSON body returned by the Coveo Platform API when a request fails.
|
|
33
|
+
*/
|
|
34
|
+
export interface PlatformErrorResponse {
|
|
35
|
+
/**
|
|
36
|
+
* A human-readable explanation of the error.
|
|
37
|
+
*/
|
|
38
|
+
message: string;
|
|
39
|
+
/**
|
|
40
|
+
* A code identifying the type of error, for example `ORGANIZATION_ALREADY_EXISTS`.
|
|
41
|
+
*/
|
|
42
|
+
errorCode: string;
|
|
43
|
+
/**
|
|
44
|
+
* The unique identifier of the request that failed, useful when contacting Coveo support.
|
|
45
|
+
*/
|
|
46
|
+
requestID: string;
|
|
47
|
+
/**
|
|
48
|
+
* Error messages grouped by key, for example by resource type.
|
|
49
|
+
*/
|
|
50
|
+
errorMessages?: Record<string, string[]>;
|
|
51
|
+
/**
|
|
52
|
+
* Additional errors that caused the request to fail, for example one per invalid parameter.
|
|
53
|
+
*/
|
|
54
|
+
details?: PlatformErrorDetail[];
|
|
55
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import 'core-js/actual/json/parse.js';
|
|
2
2
|
import { Predicate } from '../../utils/types.js';
|
|
3
|
-
import { ResponseBodyFormat, ResponseHandler } from './ResponseHandlerInterfaces.js';
|
|
3
|
+
import { PlatformErrorDetail, PlatformErrorResponse, ResponseBodyFormat, ResponseHandler } from './ResponseHandlerInterfaces.js';
|
|
4
4
|
/**
|
|
5
5
|
* Check whether the response status is `204 No Content`.
|
|
6
6
|
* @param response
|
|
@@ -26,7 +26,7 @@ export default _default;
|
|
|
26
26
|
* Represent errors coming from Coveo's API.
|
|
27
27
|
* Follow loosely [RFC-7807](https://www.ietf.org/rfc/rfc7807.html)
|
|
28
28
|
*/
|
|
29
|
-
export declare class CoveoPlatformClientError extends Error {
|
|
29
|
+
export declare class CoveoPlatformClientError extends Error implements Partial<PlatformErrorResponse> {
|
|
30
30
|
/**
|
|
31
31
|
* The HTTP X-Request-ID request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again.
|
|
32
32
|
* It allows the client and server to correlate each HTTP request.
|
|
@@ -45,4 +45,28 @@ export declare class CoveoPlatformClientError extends Error {
|
|
|
45
45
|
* A human-readable explanation specific to this occurrence of the problem.
|
|
46
46
|
*/
|
|
47
47
|
detail: string;
|
|
48
|
+
/**
|
|
49
|
+
* The URL of the request that failed.
|
|
50
|
+
*/
|
|
51
|
+
url?: string;
|
|
52
|
+
/**
|
|
53
|
+
* A code identifying the type of error, as returned by the Coveo Platform API.
|
|
54
|
+
* Only set when the error response body is JSON.
|
|
55
|
+
*/
|
|
56
|
+
errorCode?: string;
|
|
57
|
+
/**
|
|
58
|
+
* The unique identifier of the request that failed, as returned by the Coveo Platform API.
|
|
59
|
+
* Only set when the error response body is JSON.
|
|
60
|
+
*/
|
|
61
|
+
requestID?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Error messages grouped by key, as returned by the Coveo Platform API.
|
|
64
|
+
* Only set when the error response body is JSON and contains them.
|
|
65
|
+
*/
|
|
66
|
+
errorMessages?: Record<string, string[]>;
|
|
67
|
+
/**
|
|
68
|
+
* Additional errors that caused the request to fail, as returned by the Coveo Platform API.
|
|
69
|
+
* Only set when the error response body is JSON and contains them.
|
|
70
|
+
*/
|
|
71
|
+
details?: PlatformErrorDetail[];
|
|
48
72
|
}
|
|
@@ -174,21 +174,25 @@ export interface DataHealthGetOverviewResponse {
|
|
|
174
174
|
}
|
|
175
175
|
export interface DataHealthGetGroupListingParams extends OrganizationParamParts, TimeRangeParamParts, Paginated {
|
|
176
176
|
/**
|
|
177
|
-
* The
|
|
177
|
+
* The categories of rules for which data health should be displayed.
|
|
178
178
|
*/
|
|
179
|
-
category
|
|
179
|
+
category?: string[];
|
|
180
180
|
/**
|
|
181
|
-
* The
|
|
181
|
+
* The feature for which data health should be computed.
|
|
182
182
|
*/
|
|
183
|
-
|
|
183
|
+
feature?: string[];
|
|
184
184
|
/**
|
|
185
|
-
*
|
|
185
|
+
* The tracking id to filter by when getting groups listing.
|
|
186
186
|
*/
|
|
187
|
-
|
|
187
|
+
trackingId?: string[];
|
|
188
188
|
/**
|
|
189
189
|
* Whether to show groups with only beta rules.
|
|
190
190
|
*/
|
|
191
191
|
showBetaRules?: boolean;
|
|
192
|
+
/**
|
|
193
|
+
* Whether to show groups with no validated entity or not.
|
|
194
|
+
*/
|
|
195
|
+
showEmptyGroups?: boolean;
|
|
192
196
|
}
|
|
193
197
|
export interface DataHealthGetGroupListingResponse extends PaginatedResponse {
|
|
194
198
|
/**
|
|
@@ -218,11 +222,15 @@ export interface DataHealthGroupListingEntry {
|
|
|
218
222
|
*/
|
|
219
223
|
failedValidations: number;
|
|
220
224
|
}
|
|
221
|
-
export interface DataHealthGetGroupDetailParams extends OrganizationParamParts, TimeRangeParamParts
|
|
225
|
+
export interface DataHealthGetGroupDetailParams extends OrganizationParamParts, TimeRangeParamParts {
|
|
222
226
|
/**
|
|
223
|
-
* The
|
|
227
|
+
* The categories of rules for which data health should be displayed.
|
|
224
228
|
*/
|
|
225
|
-
category
|
|
229
|
+
category?: string[];
|
|
230
|
+
/**
|
|
231
|
+
* The feature for which data health should be computed.
|
|
232
|
+
*/
|
|
233
|
+
feature?: string[];
|
|
226
234
|
/**
|
|
227
235
|
* The tracking id to filter by when getting groups listing.
|
|
228
236
|
*/
|