@coveo/platform-client 55.12.0 → 55.13.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/resources/Enums.js +1 -1
- package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js +6 -0
- package/dist/cjs/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map +1 -1
- package/dist/esm/resources/Enums.js +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js +6 -0
- package/dist/esm/resources/UsageAnalytics/Read/DataHealth/DataHealth.js.map +1 -1
- package/dist/types/resources/ApiKeys/ApiKeysInterfaces.d.ts +8 -0
- package/dist/types/resources/Enums.d.ts +1 -1
- package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealth.d.ts +5 -1
- package/dist/types/resources/UsageAnalytics/Read/DataHealth/DataHealthInterfaces.d.ts +74 -0
- package/package.json +1 -1
|
@@ -1171,7 +1171,7 @@ var FeedbackConsumerType;
|
|
|
1171
1171
|
})(FeedbackConsumerType || (exports.FeedbackConsumerType = FeedbackConsumerType = {}));
|
|
1172
1172
|
var ApiKeyStatus;
|
|
1173
1173
|
(function (ApiKeyStatus) {
|
|
1174
|
-
ApiKeyStatus["ENABLED"] = "
|
|
1174
|
+
ApiKeyStatus["ENABLED"] = "ENABLED";
|
|
1175
1175
|
ApiKeyStatus["DISABLED"] = "DISABLED";
|
|
1176
1176
|
ApiKeyStatus["DISABLED_FOR_INACTIVITY"] = "DISABLED_FOR_INACTIVITY";
|
|
1177
1177
|
ApiKeyStatus["EXPIRED"] = "EXPIRED";
|
|
@@ -46,6 +46,12 @@ class DataHealth extends ReadServiceResource_js_1.default {
|
|
|
46
46
|
getTrackingIds(params) {
|
|
47
47
|
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
|
|
48
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Get problems about events.
|
|
51
|
+
*/
|
|
52
|
+
getEventsProblems(params) {
|
|
53
|
+
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/problems`, params));
|
|
54
|
+
}
|
|
49
55
|
/**
|
|
50
56
|
* Get failed instances for a data health criterion
|
|
51
57
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":";;;AAAA,+FAA4D;
|
|
1
|
+
{"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":";;;AAAA,+FAA4D;AAsB5D,MAAqB,UAAW,SAAQ,gCAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC;QAC7C,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;QACnD,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;QAClD,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;QAC3C,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;QACnD,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;QACjD,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;QACjD,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;;OAEG;IACH,iBAAiB,CAAC,MAAwC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,kBAAkB,EAAE,MAAM,CAAC,CACzE,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAA0C;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,2BAA2B,EAAE,MAAM,CAAC,CAClF,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;;AAhGL,6BAiGC"}
|
|
@@ -1166,7 +1166,7 @@ export var FeedbackConsumerType;
|
|
|
1166
1166
|
})(FeedbackConsumerType || (FeedbackConsumerType = {}));
|
|
1167
1167
|
export var ApiKeyStatus;
|
|
1168
1168
|
(function (ApiKeyStatus) {
|
|
1169
|
-
ApiKeyStatus["ENABLED"] = "
|
|
1169
|
+
ApiKeyStatus["ENABLED"] = "ENABLED";
|
|
1170
1170
|
ApiKeyStatus["DISABLED"] = "DISABLED";
|
|
1171
1171
|
ApiKeyStatus["DISABLED_FOR_INACTIVITY"] = "DISABLED_FOR_INACTIVITY";
|
|
1172
1172
|
ApiKeyStatus["EXPIRED"] = "EXPIRED";
|
|
@@ -43,6 +43,12 @@ export default class DataHealth extends ReadServiceResource {
|
|
|
43
43
|
getTrackingIds(params) {
|
|
44
44
|
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/facets`, { ...params, facet: 'TRACKING_ID' }));
|
|
45
45
|
}
|
|
46
|
+
/**
|
|
47
|
+
* Get problems about events.
|
|
48
|
+
*/
|
|
49
|
+
getEventsProblems(params) {
|
|
50
|
+
return this.api.get(this.buildPathWithOrg(`${DataHealth.baseUrl}/events/problems`, params));
|
|
51
|
+
}
|
|
46
52
|
/**
|
|
47
53
|
* Get failed instances for a data health criterion
|
|
48
54
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;
|
|
1
|
+
{"version":3,"file":"DataHealth.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/DataHealth/DataHealth.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAsB5D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,mBAAmB;IACvD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,MAAsC;QAC7C,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;QACnD,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;QAClD,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;QAC3C,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;QACnD,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;QACjD,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;QACjD,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;;OAEG;IACH,iBAAiB,CAAC,MAAwC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,kBAAkB,EAAE,MAAM,CAAC,CACzE,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAA0C;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,2BAA2B,EAAE,MAAM,CAAC,CAClF,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"}
|
|
@@ -95,6 +95,14 @@ export interface ApiKeyModel extends GranularResource {
|
|
|
95
95
|
* The ID of the template to which the API key is bound.
|
|
96
96
|
*/
|
|
97
97
|
apiKeyTemplateId?: string;
|
|
98
|
+
/**
|
|
99
|
+
* The date of activation of the API key.
|
|
100
|
+
*/
|
|
101
|
+
activationDate?: number;
|
|
102
|
+
/**
|
|
103
|
+
* The date the API key has been disabled.
|
|
104
|
+
*/
|
|
105
|
+
disabledDate?: number;
|
|
98
106
|
}
|
|
99
107
|
export interface CreateApiKeyOptions {
|
|
100
108
|
/**
|
|
@@ -1058,7 +1058,7 @@ export declare enum FeedbackConsumerType {
|
|
|
1058
1058
|
SOURCE_MANAGEMENT_IMPROVEMENTS = "SOURCE_MANAGEMENT_IMPROVEMENTS"
|
|
1059
1059
|
}
|
|
1060
1060
|
export declare enum ApiKeyStatus {
|
|
1061
|
-
ENABLED = "
|
|
1061
|
+
ENABLED = "ENABLED",
|
|
1062
1062
|
DISABLED = "DISABLED",
|
|
1063
1063
|
DISABLED_FOR_INACTIVITY = "DISABLED_FOR_INACTIVITY",
|
|
1064
1064
|
EXPIRED = "EXPIRED",
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import ReadServiceResource from '../ReadServiceResource.js';
|
|
2
|
-
import { DataHealthEventPayloadResponse, DataHealthGetEventPayloadParams, DataHealthGetFailedInstancesParams, DataHealthGetFailedInstancesResponse, DataHealthGetGroupDetailParams, DataHealthGetGroupDetailResponse, DataHealthGetGroupListingParams, DataHealthGetGroupListingResponse, DataHealthGetOverviewParams, DataHealthGetOverviewResponse, DataHealthGetTrackingIdsParams, DataHealthGetTrackingIdsResponse, DataHealthListEventsParameters, DataHealthListEventsResponse, DataHealthListFacetsResponse, DataHealthListFacetValueParams } from './DataHealthInterfaces.js';
|
|
2
|
+
import { DataHealthEventPayloadResponse, DataHealthGetEventPayloadParams, DataHealthGetFailedInstancesParams, DataHealthGetFailedInstancesResponse, DataHealthGetGroupDetailParams, DataHealthGetGroupDetailResponse, DataHealthGetGroupListingParams, DataHealthGetGroupListingResponse, DataHealthGetOverviewParams, DataHealthGetOverviewResponse, DataHealthGetTrackingIdsParams, DataHealthGetTrackingIdsResponse, DataHealthListEventsParameters, DataHealthListEventsResponse, DataHealthListFacetsResponse, DataHealthListFacetValueParams, EventProblemsResponse, DataHealthGetEventProblemsParams } from './DataHealthInterfaces.js';
|
|
3
3
|
export default class DataHealth extends ReadServiceResource {
|
|
4
4
|
static baseUrl: string;
|
|
5
5
|
/**
|
|
@@ -30,6 +30,10 @@ export default class DataHealth extends ReadServiceResource {
|
|
|
30
30
|
* Get a list of unique tracking ids.
|
|
31
31
|
*/
|
|
32
32
|
getTrackingIds(params: DataHealthGetTrackingIdsParams): Promise<DataHealthGetTrackingIdsResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Get problems about events.
|
|
35
|
+
*/
|
|
36
|
+
getEventsProblems(params: DataHealthGetEventProblemsParams): Promise<EventProblemsResponse>;
|
|
33
37
|
/**
|
|
34
38
|
* Get failed instances for a data health criterion
|
|
35
39
|
*
|
|
@@ -334,4 +334,78 @@ export interface DataHealthFailedInstanceEntry {
|
|
|
334
334
|
* The scope of a datahealth rule.
|
|
335
335
|
*/
|
|
336
336
|
type DataHealthRuleScope = 'EVENT' | 'VISIT';
|
|
337
|
+
export interface DataHealthGetEventProblemsParams extends OrganizationParamParts, TimeRangeParamParts, Paginated {
|
|
338
|
+
/**
|
|
339
|
+
* The event types to get event problems for.
|
|
340
|
+
* By default, all event types will be considered.
|
|
341
|
+
* See https://docs.coveo.com/en/2949/analyze-usage-data/events
|
|
342
|
+
*/
|
|
343
|
+
eventType?: string[];
|
|
344
|
+
/**
|
|
345
|
+
* The search hubs to get event problems for.
|
|
346
|
+
* By default, all search hubs will be considered.
|
|
347
|
+
*/
|
|
348
|
+
searchHub?: string[];
|
|
349
|
+
/**
|
|
350
|
+
* The tracking ID to get event problems for.
|
|
351
|
+
* By default, all tracking IDs will be considered.
|
|
352
|
+
*/
|
|
353
|
+
trackingId?: string[];
|
|
354
|
+
}
|
|
355
|
+
export interface EventProblemsResponse extends PaginatedResponse {
|
|
356
|
+
/**
|
|
357
|
+
* The event problems that match the specified filters.
|
|
358
|
+
*/
|
|
359
|
+
problems: EventProblemsResponseItem[];
|
|
360
|
+
}
|
|
361
|
+
export interface EventProblemsResponseItem {
|
|
362
|
+
/**
|
|
363
|
+
* The type of events in this response item.
|
|
364
|
+
* See https://docs.coveo.com/en/2949/analyze-usage-data/events
|
|
365
|
+
*/
|
|
366
|
+
eventType: string;
|
|
367
|
+
/**
|
|
368
|
+
* The tracking ID the events in this response item were logged with.
|
|
369
|
+
*/
|
|
370
|
+
trackingId: string;
|
|
371
|
+
/**
|
|
372
|
+
* The search hub the events in this response item were logged from.
|
|
373
|
+
*/
|
|
374
|
+
searchHub: string;
|
|
375
|
+
/**
|
|
376
|
+
* The number of failed events.
|
|
377
|
+
*/
|
|
378
|
+
failedEvents: number;
|
|
379
|
+
/**
|
|
380
|
+
* The total number of failed events.
|
|
381
|
+
*/
|
|
382
|
+
totalEvents: number;
|
|
383
|
+
/**
|
|
384
|
+
* The validation errors.
|
|
385
|
+
*/
|
|
386
|
+
validationErrors: ValidationErrors[];
|
|
387
|
+
/**
|
|
388
|
+
* A list of sample events that have the validation problems.
|
|
389
|
+
*/
|
|
390
|
+
sampleEvents: string[];
|
|
391
|
+
/**
|
|
392
|
+
* Timestamps from the sample events.
|
|
393
|
+
*/
|
|
394
|
+
sampleEventsTimestamps: string[];
|
|
395
|
+
}
|
|
396
|
+
interface ValidationErrors {
|
|
397
|
+
/**
|
|
398
|
+
* The validation error code.
|
|
399
|
+
*/
|
|
400
|
+
code: string;
|
|
401
|
+
/**
|
|
402
|
+
* The validation error path.
|
|
403
|
+
* See https://docs.coveo.com/en/nbde0312/analyze-usage-data/event-errors
|
|
404
|
+
*/
|
|
405
|
+
path: string;
|
|
406
|
+
/**
|
|
407
|
+
* The validation error message.
|
|
408
|
+
*/
|
|
409
|
+
message: string;
|
|
410
|
+
}
|
|
337
411
|
export {};
|