@coveo/platform-client 45.4.1 → 45.5.1

package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ReadServiceResource_js_1 = __importDefault(require("../ReadServiceResource.js"));
+class DataHealth extends ReadServiceResource_js_1.default {
+    static baseUrl = '/rest/ua/v15/datahealth';
+    /**
+     * Get health information about events.
+     */
+    listEvents(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events`, params));
+    }
+    /**
+     * Get original event payload.
+     */
+    getEventPayload(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/payload`, params));
+    }
+    /**
+     * List applicable facet values in the specified time range.
+     */
+    listFacetValues(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, params));
+    }
+    /**
+     * Get general data health information.
+     */
+    getOverview(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/overview`, params));
+    }
+    /**
+     * Get health information about groups of validation rules.
+     */
+    getGroupListing(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups`, params));
+    }
+    /**
+     * Get health information about validation rules of a specific group.
+     */
+    getGroupDetail(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups/detail`, params));
+    }
+    /**
+     * Get a list of unique tracking ids.
+     */
+    getTrackingIds(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
+    }
+    /**
+     * Build the request path, handling the optional `org` query parameter.
+     *
+     * @param route The path part of the request.
+     * @param queryParams Optional query parameters object.
+     * If this object contains an `org` property, it will override the value from the configuration.
+     * @returns The request path including formatted query parameters.
+     */
+    buildPathWithOrg(route, queryParams) {
+        return super.buildPath(route, { org: this.api.organizationId, ...queryParams });
+    }
+}
+exports.default = DataHealth;
+//# sourceMappingURL=DataHealth.js.map

package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":";;;;;AAAA,uFAA4D;AAkB5D,MAAqB,UAAW,SAAQ,gCAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC,EAAE,IAAkB;QACjE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,iBAAiB,EAAE,MAAM,CAAC,CACxE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAsC,EAAE,IAAkB;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAmC,EAAE,IAAkB;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,EAAC,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAC3F,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAiB;QACvD,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC;;AA5EL,6BA6EC"}

package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeverityConstant = void 0;
+exports.SeverityConstant = Object.freeze(['CRITICAL', 'HIGH', 'MEDIUM', 'LOW']);
+//# sourceMappingURL=DataHealthInterfaces.js.map

package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataHealthInterfaces.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.ts"],"names":[],"mappings":";;;AAIa,QAAA,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAa,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC"}

package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./DataHealth.js"), exports);
+__exportStar(require("./DataHealthInterfaces.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,4DAA0C"}

package/dist/cjs/resources/UsageAnalytics/Read/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Administration/index.js"), exports);
+__exportStar(require("./DataHealth/index.js"), exports);
 __exportStar(require("./DataShare/index.js"), exports);
 __exportStar(require("./Dimensions/index.js"), exports);
 __exportStar(require("./Exports/index.js"), exports);

package/dist/cjs/resources/UsageAnalytics/Read/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/resources/UsageAnalytics/Read/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,uDAAqC;AACrC,wDAAsC;AACtC,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,uDAAqC;AACrC,wDAAsC;AACtC,mDAAiC;AAEjC,yDAAuC;AACvC,2DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/resources/UsageAnalytics/Read/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,wDAAsC;AACtC,uDAAqC;AACrC,wDAAsC;AACtC,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,uDAAqC;AACrC,wDAAsC;AACtC,mDAAiC;AAEjC,yDAAuC;AACvC,2DAAyC"}

package/dist/cjs/resources/UsageAnalytics/UsageAnalytics.js

@@ -12,10 +12,12 @@ const Filters_js_1 = __importDefault(require("./Read/Filters/Filters.js"));
 const Reports_js_1 = __importDefault(require("./Read/Reports/Reports.js"));
 const Snowflake_js_1 = __importDefault(require("./Read/Snowflake/Snowflake.js"));
 const Statistics_js_1 = __importDefault(require("./Read/Statistics/Statistics.js"));
+const DataHealth_js_1 = __importDefault(require("./Read/DataHealth/DataHealth.js"));
 class UsageAnalytics extends Resource_js_1.default {
     api;
     serverlessApi;
     administration;
+    dataHealth;
     dataShare;
     dimensions;
     exports;
@@ -28,6 +30,7 @@ class UsageAnalytics extends Resource_js_1.default {
         this.api = api;
         this.serverlessApi = serverlessApi;
         this.administration = new Administration_js_1.default(api, serverlessApi);
+        this.dataHealth = new DataHealth_js_1.default(api, serverlessApi);
         this.dataShare = new DataShare_js_1.default(api, serverlessApi);
         this.dimensions = new Dimensions_js_1.default(api, serverlessApi);
         this.exports = new Exports_js_1.default(api, serverlessApi);

package/dist/cjs/resources/UsageAnalytics/UsageAnalytics.js.map

@@ -1 +1 @@
-{"version":3,"file":"UsageAnalytics.js","sourceRoot":"","sources":["../../../../src/resources/UsageAnalytics/UsageAnalytics.ts"],"names":[],"mappings":";;;;;AACA,iEAAsC;AACtC,gGAAqE;AACrE,iFAAsD;AACtD,oFAAyD;AACzD,2EAAgD;AAChD,2EAAgD;AAChD,2EAAgD;AAChD,iFAAsD;AACtD,oFAAyD;AAEzD,MAAqB,cAAe,SAAQ,qBAAQ;IAWlC;IACA;IAXd,cAAc,CAAiB;IAC/B,SAAS,CAAY;IACrB,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,UAAU,CAAa;IAEvB,YACc,GAAQ,EACR,aAAkB;QAE5B,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAHhB,QAAG,GAAH,GAAG,CAAK;QACR,kBAAa,GAAb,aAAa,CAAK;QAI5B,IAAI,CAAC,cAAc,GAAG,IAAI,2BAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;CACJ;AAzBD,iCAyBC"}
+{"version":3,"file":"UsageAnalytics.js","sourceRoot":"","sources":["../../../../src/resources/UsageAnalytics/UsageAnalytics.ts"],"names":[],"mappings":";;;;;AACA,iEAAsC;AACtC,gGAAqE;AACrE,iFAAsD;AACtD,oFAAyD;AACzD,2EAAgD;AAChD,2EAAgD;AAChD,2EAAgD;AAChD,iFAAsD;AACtD,oFAAyD;AACzD,oFAAyD;AAEzD,MAAqB,cAAe,SAAQ,qBAAQ;IAYlC;IACA;IAZd,cAAc,CAAiB;IAC/B,UAAU,CAAa;IACvB,SAAS,CAAY;IACrB,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,UAAU,CAAa;IAEvB,YACc,GAAQ,EACR,aAAkB;QAE5B,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAHhB,QAAG,GAAH,GAAG,CAAK;QACR,kBAAa,GAAb,aAAa,CAAK;QAI5B,IAAI,CAAC,cAAc,GAAG,IAAI,2BAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;CACJ;AA3BD,iCA2BC"}

package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js

@@ -0,0 +1,58 @@
+import ReadServiceResource from '../ReadServiceResource.js';
+export default class DataHealth extends ReadServiceResource {
+    static baseUrl = '/rest/ua/v15/datahealth';
+    /**
+     * Get health information about events.
+     */
+    listEvents(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events`, params));
+    }
+    /**
+     * Get original event payload.
+     */
+    getEventPayload(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/payload`, params));
+    }
+    /**
+     * List applicable facet values in the specified time range.
+     */
+    listFacetValues(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, params));
+    }
+    /**
+     * Get general data health information.
+     */
+    getOverview(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/overview`, params));
+    }
+    /**
+     * Get health information about groups of validation rules.
+     */
+    getGroupListing(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups`, params));
+    }
+    /**
+     * Get health information about validation rules of a specific group.
+     */
+    getGroupDetail(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/groups/detail`, params));
+    }
+    /**
+     * Get a list of unique tracking ids.
+     */
+    getTrackingIds(params, args) {
+        return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
+    }
+    /**
+     * Build the request path, handling the optional `org` query parameter.
+     *
+     * @param route The path part of the request.
+     * @param queryParams Optional query parameters object.
+     * If this object contains an `org` property, it will override the value from the configuration.
+     * @returns The request path including formatted query parameters.
+     */
+    buildPathWithOrg(route, queryParams) {
+        return super.buildPath(route, { org: this.api.organizationId, ...queryParams });
+    }
+}
+//# sourceMappingURL=DataHealth.js.map

package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAkB5D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,mBAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC,EAAE,IAAkB;QACjE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,iBAAiB,EAAE,MAAM,CAAC,CACxE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAsC,EAAE,IAAkB;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAmC,EAAE,IAAkB;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,EAAE,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAuC,EAAE,IAAkB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,MAAM,CAAC,CAChE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAsC,EAAE,IAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,SAAS,EAAE,EAAC,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAC3F,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAiB;QACvD,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC"}

package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.js

@@ -0,0 +1,2 @@
+export const SeverityConstant = Object.freeze(['CRITICAL', 'HIGH', 'MEDIUM', 'LOW']);
+//# sourceMappingURL=DataHealthInterfaces.js.map

package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataHealthInterfaces.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAa,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC"}

package/dist/esm/resources/UsageAnalytics/Read/DataHealth/index.js

@@ -0,0 +1,3 @@
+export * from './DataHealth.js';
+export * from './DataHealthInterfaces.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/resources/UsageAnalytics/Read/DataHealth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC"}

package/dist/esm/resources/UsageAnalytics/Read/index.js

@@ -1,4 +1,5 @@
 export * from './Administration/index.js';
+export * from './DataHealth/index.js';
 export * from './DataShare/index.js';
 export * from './Dimensions/index.js';
 export * from './Exports/index.js';

package/dist/esm/resources/UsageAnalytics/Read/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/resources/UsageAnalytics/Read/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/resources/UsageAnalytics/Read/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC"}

package/dist/esm/resources/UsageAnalytics/UsageAnalytics.js

@@ -7,10 +7,12 @@ import Filters from './Read/Filters/Filters.js';
 import Reports from './Read/Reports/Reports.js';
 import Snowflake from './Read/Snowflake/Snowflake.js';
 import Statistics from './Read/Statistics/Statistics.js';
+import DataHealth from './Read/DataHealth/DataHealth.js';
 export default class UsageAnalytics extends Resource {
     api;
     serverlessApi;
     administration;
+    dataHealth;
     dataShare;
     dimensions;
     exports;
@@ -23,6 +25,7 @@ export default class UsageAnalytics extends Resource {
         this.api = api;
         this.serverlessApi = serverlessApi;
         this.administration = new Administration(api, serverlessApi);
+        this.dataHealth = new DataHealth(api, serverlessApi);
         this.dataShare = new DataShare(api, serverlessApi);
         this.dimensions = new Dimensions(api, serverlessApi);
         this.exports = new Exports(api, serverlessApi);

package/dist/esm/resources/UsageAnalytics/UsageAnalytics.js.map

@@ -1 +1 @@
-{"version":3,"file":"UsageAnalytics.js","sourceRoot":"","sources":["../../../../src/resources/UsageAnalytics/UsageAnalytics.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,cAAc,MAAM,yCAAyC,CAAC;AACrE,OAAO,SAAS,MAAM,+BAA+B,CAAC;AACtD,OAAO,UAAU,MAAM,iCAAiC,CAAC;AACzD,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAChD,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAChD,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAChD,OAAO,SAAS,MAAM,+BAA+B,CAAC;AACtD,OAAO,UAAU,MAAM,iCAAiC,CAAC;AAEzD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,QAAQ;IAWlC;IACA;IAXd,cAAc,CAAiB;IAC/B,SAAS,CAAY;IACrB,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,UAAU,CAAa;IAEvB,YACc,GAAQ,EACR,aAAkB;QAE5B,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAHhB,QAAG,GAAH,GAAG,CAAK;QACR,kBAAa,GAAb,aAAa,CAAK;QAI5B,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;CACJ"}
+{"version":3,"file":"UsageAnalytics.js","sourceRoot":"","sources":["../../../../src/resources/UsageAnalytics/UsageAnalytics.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,cAAc,MAAM,yCAAyC,CAAC;AACrE,OAAO,SAAS,MAAM,+BAA+B,CAAC;AACtD,OAAO,UAAU,MAAM,iCAAiC,CAAC;AACzD,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAChD,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAChD,OAAO,OAAO,MAAM,2BAA2B,CAAC;AAChD,OAAO,SAAS,MAAM,+BAA+B,CAAC;AACtD,OAAO,UAAU,MAAM,iCAAiC,CAAC;AACzD,OAAO,UAAU,MAAM,iCAAiC,CAAC;AAEzD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,QAAQ;IAYlC;IACA;IAZd,cAAc,CAAiB;IAC/B,UAAU,CAAa;IACvB,SAAS,CAAY;IACrB,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,UAAU,CAAa;IAEvB,YACc,GAAQ,EACR,aAAkB;QAE5B,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAHhB,QAAG,GAAH,GAAG,CAAK;QACR,kBAAa,GAAb,aAAa,CAAK;QAI5B,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;CACJ"}

package/dist/types/resources/BaseInterfaces.d.ts

@@ -53,3 +53,32 @@ export type WithRequired<Type, Key extends keyof Type> = Type & {
     [Property in Key]-?: Type[Property];
 };
 export type WithOptional<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>> & Partial<Pick<T, K>>;
+/**
+ * Pagination information about which page is included in the response,
+ * and what the full range of data is.
+ */
+export interface PaginationInformationModel {
+    /**
+     * Zero-based page index of the current page.
+     */
+    page: number;
+    /**
+     * The number of items for each page.
+     * Note that the actual number of items may be lower for the last page.
+     */
+    perPage: number;
+    /**
+     * Total number of items available (across all pages).
+     */
+    totalItems: number;
+    /**
+     * The number of pages available, based on `totalItems` and `perPage`.
+     */
+    totalPages: number;
+}
+export interface PaginatedResponse {
+    /**
+     * Pagination information.
+     */
+    pagination: PaginationInformationModel;
+}

package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealth.d.ts

@@ -0,0 +1,42 @@
+import ReadServiceResource from '../ReadServiceResource.js';
+import { DataHealthEventPayloadResponse, DataHealthGetEventPayloadParams, DataHealthGetGroupDetailParams, DataHealthGetGroupDetailResponse, DataHealthGetGroupListingParams, DataHealthGetGroupListingResponse, DataHealthGetOverviewParams, DataHealthGetOverviewResponse, DataHealthGetTrackingIdsParams, DataHealthGetTrackingIdsResponse, DataHealthListEventsParameters, DataHealthListEventsResponse, DataHealthListFacetsResponse, DataHealthListFacetValueParams } from './DataHealthInterfaces.js';
+export default class DataHealth extends ReadServiceResource {
+    static baseUrl: string;
+    /**
+     * Get health information about events.
+     */
+    listEvents(params: DataHealthListEventsParameters, args?: RequestInit): Promise<DataHealthListEventsResponse>;
+    /**
+     * Get original event payload.
+     */
+    getEventPayload(params: DataHealthGetEventPayloadParams, args?: RequestInit): Promise<DataHealthEventPayloadResponse>;
+    /**
+     * List applicable facet values in the specified time range.
+     */
+    listFacetValues(params: DataHealthListFacetValueParams, args?: RequestInit): Promise<DataHealthListFacetsResponse>;
+    /**
+     * Get general data health information.
+     */
+    getOverview(params: DataHealthGetOverviewParams, args?: RequestInit): Promise<DataHealthGetOverviewResponse>;
+    /**
+     * Get health information about groups of validation rules.
+     */
+    getGroupListing(params: DataHealthGetGroupListingParams, args?: RequestInit): Promise<DataHealthGetGroupListingResponse>;
+    /**
+     * Get health information about validation rules of a specific group.
+     */
+    getGroupDetail(params: DataHealthGetGroupDetailParams, args?: RequestInit): Promise<DataHealthGetGroupDetailResponse>;
+    /**
+     * Get a list of unique tracking ids.
+     */
+    getTrackingIds(params: DataHealthGetTrackingIdsParams, args?: RequestInit): Promise<DataHealthGetTrackingIdsResponse>;
+    /**
+     * Build the request path, handling the optional `org` query parameter.
+     *
+     * @param route The path part of the request.
+     * @param queryParams Optional query parameters object.
+     * If this object contains an `org` property, it will override the value from the configuration.
+     * @returns The request path including formatted query parameters.
+     */
+    protected buildPathWithOrg(route: string, queryParams?: any): string;
+}

package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.d.ts

@@ -0,0 +1,267 @@
+import { Paginated, PaginatedResponse } from '../../../BaseInterfaces.js';
+import { OrganizationParamParts, TimeRangeParamParts } from '../CommonParamParts.js';
+export type Severity = 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW';
+export declare const SeverityConstant: readonly Severity[];
+/**
+ * Common parameters for Data Health calls that filter events.
+ */
+interface DataHealthFilterEventsParamParts {
+    /**
+     * Optional set of client ids to filter events on.
+     * Entries are OR-ed together, if other filters are specified they are combined using AND.
+     */
+    clientId?: string[] | string;
+    /**
+     * Optional set of visit ids to filter events on.
+     * Entries are OR-ed together, if other filters are specified they are combined using AND.
+     */
+    visitId?: string[] | string;
+    /**
+     * A set of event sources for which the events will be returned.
+     * If not specified, events are not filtered on event sources.
+     */
+    eventSource?: string[] | string;
+    /**
+     * A set of event types for which the events will be returned.
+     * If not specified, events are not filtered on event types.
+     */
+    eventType?: string[] | string;
+    /**
+     * A set of search hubs for which the events will be returned.
+     * If not specified, events are not filtered on search hub.
+     */
+    searchHub?: string[] | string;
+    /**
+     * A health status for which the events will be returned.
+     * If not specified, events are not filtered on event types.
+     */
+    healthStatus?: string;
+    trackingId?: string[];
+}
+export interface DataHealthListEventsParameters extends OrganizationParamParts, TimeRangeParamParts, DataHealthFilterEventsParamParts, Paginated {
+}
+export interface DataHealthGetEventPayloadParams extends OrganizationParamParts {
+    /**
+     * The ID of the event to get the payload off.
+     */
+    eventId: string;
+    /**
+     * The ISO-8601 formatted timestamp of the event.
+     */
+    timestamp: string;
+}
+export interface DataHealthEventPayloadResponse {
+    /**
+     * The ID of the event.
+     */
+    eventId: string;
+    /**
+     * The timestamp of the event.
+     */
+    timestamp: string;
+    /**
+     * The raw payload of the event.
+     */
+    eventPayload: Record<string, unknown>;
+}
+export interface DataHealthValidationErrorModel {
+    /**
+     * The error code.
+     */
+    code: string;
+    /**
+     * The path of the parameter causing the error.
+     */
+    path: string;
+    /**
+     * A description of the error.
+     */
+    message: string;
+}
+export interface DataHealthEventsListItemModel {
+    /**
+     * The source of the event.
+     */
+    source: string;
+    /**
+     * The type of the event.
+     */
+    type: string;
+    /**
+     * The searchHub of the event.
+     */
+    searchHub: string;
+    /**
+     * The ISO-8601 formatted timestamp of the event.
+     */
+    timestamp: string;
+    /**
+     * The visitId of the event.
+     */
+    visitId: string;
+    /**
+     * The clientId of the event.
+     */
+    clientId: string;
+    /**
+     * The id of the event.
+     */
+    eventId: string;
+    /**
+     * The validation errors of the event.
+     */
+    validationErrors: DataHealthValidationErrorModel[];
+}
+export interface DataHealthListEventsResponse extends PaginatedResponse {
+    /**
+     * The listing of events in the current page.
+     */
+    events: DataHealthEventsListItemModel[];
+}
+export interface DataHealthListFacetValueParams extends OrganizationParamParts, TimeRangeParamParts, DataHealthFilterEventsParamParts {
+    /**
+     * The facet for which the values should be listed.
+     */
+    facet: string;
+}
+export interface DataHealthFacetValue {
+    /**
+     * The value of the facet.
+     */
+    value: string;
+    /**
+     * The count of records that matched the facet in the current range.
+     */
+    count: number;
+}
+export interface DataHealthListFacetsResponse {
+    /**
+     * The values for this facet.
+     */
+    values: DataHealthFacetValue[];
+}
+export interface DataHealthGetOverviewParams extends OrganizationParamParts, TimeRangeParamParts {
+    /**
+     * The category to filter by when getting the overview.
+     */
+    category?: string;
+}
+export interface DataHealthGetOverviewResponse {
+    /**
+     * The overall health score for the specified category(ies)
+     */
+    score: number;
+    /**
+     * The breakdown of overall validation failures by severity.
+     */
+    severityBreakdown: Record<Severity, number>;
+    /**
+     * The total number of entity validated.
+     */
+    totalValidations: number;
+    /**
+     * The total number of entity that failed validation.
+     */
+    failedValidations: number;
+}
+export interface DataHealthGetGroupListingParams extends OrganizationParamParts, TimeRangeParamParts, Paginated {
+    /**
+     * The category to filter by when getting groups listing.
+     */
+    category: string;
+    /**
+     * The tracking id to filter by when getting groups listing.
+     */
+    trackingId?: string[];
+    /**
+     * Whether to show groups with no validated entity or not.
+     */
+    showEmptyGroups?: boolean;
+}
+export interface DataHealthGetGroupListingResponse extends PaginatedResponse {
+    /**
+     * A collection of groups.
+     */
+    groups: DataHealthGroupListingEntry[];
+}
+export interface DataHealthGroupListingEntry {
+    /**
+     * The id of the group.
+     */
+    group: string;
+    /**
+     * The health score for a group.
+     */
+    score: number;
+    /**
+     * The breakdown of validation failures by severity for a group.
+     */
+    severityBreakdown: Record<Severity, number>;
+    /**
+     * The total number of validated entity for a group.
+     */
+    totalValidations: number;
+    /**
+     * The total number of entity that failed validation for a group.
+     */
+    failedValidations: number;
+}
+export interface DataHealthGetGroupDetailParams extends OrganizationParamParts, TimeRangeParamParts, Paginated {
+    /**
+     * The category to filter by when getting details on a group.
+     */
+    category: string;
+    /**
+     * The group to filter by when getting details.
+     */
+    group: string;
+}
+export interface DataHealthGetGroupDetailResponse {
+    /**
+     * A collection of criterion or rule for a group.
+     */
+    criteria: DataHealthGroupDetailEntry[];
+}
+export interface DataHealthGroupDetailEntry {
+    /**
+     * The rule id.
+     */
+    id: string;
+    /**
+     * The category the rule is associated to.
+     */
+    category: string;
+    /**
+     * The severity for a rule.
+     */
+    severity: string;
+    /**
+     * The total number of validated entity for a rule.
+     */
+    totalValidations: number;
+    /**
+     * The number of entity that failed validation for a rule.
+     */
+    failedValidations: number;
+    /**
+     * The score for a rule.
+     */
+    score: number;
+    /**
+     * The type of entity for a rule (event or visit).
+     */
+    scope: string;
+    /**
+     * The scope type (event type or visit).
+     */
+    scopeValue: string;
+}
+export interface DataHealthGetTrackingIdsParams extends OrganizationParamParts, TimeRangeParamParts {
+}
+export interface DataHealthGetTrackingIdsResponse {
+    /**
+     * A collection of tracking ids as facet values (id and count).
+     */
+    values: DataHealthFacetValue[];
+}
+export {};

package/dist/types/resources/UsageAnalytics/Read/DataHealth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './DataHealth.js';
+export * from './DataHealthInterfaces.js';

package/dist/types/resources/UsageAnalytics/Read/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Administration/index.js';
+export * from './DataHealth/index.js';
 export * from './DataShare/index.js';
 export * from './Dimensions/index.js';
 export * from './Exports/index.js';

package/dist/types/resources/UsageAnalytics/UsageAnalytics.d.ts

@@ -8,10 +8,12 @@ import Filters from './Read/Filters/Filters.js';
 import Reports from './Read/Reports/Reports.js';
 import Snowflake from './Read/Snowflake/Snowflake.js';
 import Statistics from './Read/Statistics/Statistics.js';
+import DataHealth from './Read/DataHealth/DataHealth.js';
 export default class UsageAnalytics extends Resource {
     protected api: API;
     protected serverlessApi: API;
     administration: Administration;
+    dataHealth: DataHealth;
     dataShare: DataShare;
     dimensions: Dimensions;
     exports: Exports;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "45.4.1",
+    "version": "45.5.1",
     "description": "",
     "type": "module",
     "exports": {