@coveo/platform-client 37.10.0 → 37.11.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/APICore.js +6 -2
- package/dist/APICore.js.map +1 -1
- package/dist/definitions/APICore.d.ts +1 -1
- package/dist/definitions/resources/BaseInterfaces.d.ts +1 -1
- package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociations.d.ts +2 -1
- package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts +3 -0
- package/dist/definitions/resources/Pipelines/PipelinesInterfaces.d.ts +1 -1
- package/dist/definitions/resources/UsageAnalytics/Read/Administration/Administration.d.ts +13 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.d.ts +5 -6
- package/dist/definitions/resources/UsageAnalytics/Read/CommonParamParts.d.ts +118 -0
- package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShare.d.ts +15 -3
- package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/Dimensions.d.ts +65 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.d.ts +20 -19
- package/dist/definitions/resources/UsageAnalytics/Read/Exports/Exports.d.ts +60 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Exports/ExportsInterfaces.d.ts +28 -23
- package/dist/definitions/resources/UsageAnalytics/Read/Filters/Filters.d.ts +44 -26
- package/dist/definitions/resources/UsageAnalytics/Read/ReadServiceResource.d.ts +16 -0
- package/dist/definitions/resources/UsageAnalytics/Read/Reports/Reports.d.ts +35 -17
- package/dist/definitions/resources/UsageAnalytics/Read/Reports/ReportsInterfaces.d.ts +13 -14
- package/dist/definitions/resources/UsageAnalytics/Read/Snowflake/Snowflake.d.ts +41 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Snowflake/SnowflakeInterfaces.d.ts +8 -16
- package/dist/definitions/resources/UsageAnalytics/Read/Statistics/Statistics.d.ts +55 -4
- package/dist/definitions/resources/UsageAnalytics/Read/Statistics/StatisticsInterfaces.d.ts +71 -93
- package/dist/definitions/resources/UsageAnalytics/Read/Users/Users.d.ts +33 -2
- package/dist/definitions/resources/UsageAnalytics/Read/Users/UsersInterfaces.d.ts +11 -9
- package/dist/definitions/resources/UsageAnalytics/Read/index.d.ts +1 -0
- package/dist/definitions/resources/UsageAnalytics/UsageAnalytics.d.ts +5 -5
- package/dist/definitions/utils/normalizePaginatedOptions.d.ts +1 -1
- package/dist/resources/Activities/Activities.js +2 -2
- package/dist/resources/Activities/Activities.js.map +1 -1
- package/dist/resources/Pipelines/MLAssociations/MLAssociations.js +4 -0
- package/dist/resources/Pipelines/MLAssociations/MLAssociations.js.map +1 -1
- package/dist/resources/ResourceSnapshots/ResourceSnapshots.js +1 -1
- package/dist/resources/ResourceSnapshots/ResourceSnapshots.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Administration/Administration.js +16 -5
- package/dist/resources/UsageAnalytics/Read/Administration/Administration.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/CommonParamParts.js +3 -0
- package/dist/resources/UsageAnalytics/Read/CommonParamParts.js.map +1 -0
- package/dist/resources/UsageAnalytics/Read/DataShare/DataShare.js +19 -7
- package/dist/resources/UsageAnalytics/Read/DataShare/DataShare.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Dimensions/Dimensions.js +76 -13
- package/dist/resources/UsageAnalytics/Read/Dimensions/Dimensions.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Exports/Exports.js +73 -15
- package/dist/resources/UsageAnalytics/Read/Exports/Exports.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Filters/Filters.js +58 -40
- package/dist/resources/UsageAnalytics/Read/Filters/Filters.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/ReadServiceResource.js +28 -0
- package/dist/resources/UsageAnalytics/Read/ReadServiceResource.js.map +1 -0
- package/dist/resources/UsageAnalytics/Read/Reports/Reports.js +48 -38
- package/dist/resources/UsageAnalytics/Read/Reports/Reports.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Reports/ReportsInterfaces.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Snowflake/Snowflake.js +52 -13
- package/dist/resources/UsageAnalytics/Read/Snowflake/Snowflake.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Statistics/Statistics.js +66 -13
- package/dist/resources/UsageAnalytics/Read/Statistics/Statistics.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/Users/Users.js +38 -7
- package/dist/resources/UsageAnalytics/Read/Users/Users.js.map +1 -1
- package/dist/resources/UsageAnalytics/Read/index.js +1 -0
- package/dist/resources/UsageAnalytics/Read/index.js.map +1 -1
- package/dist/resources/UsageAnalytics/UsageAnalytics.js +5 -5
- package/dist/resources/UsageAnalytics/UsageAnalytics.js.map +1 -1
- package/dist/utils/normalizePaginatedOptions.js +1 -1
- package/dist/utils/normalizePaginatedOptions.js.map +1 -1
- package/package.json +6 -6
package/dist/APICore.js
CHANGED
|
@@ -13,6 +13,9 @@ var API = /** @class */ (function () {
|
|
|
13
13
|
}
|
|
14
14
|
Object.defineProperty(API.prototype, "organizationId", {
|
|
15
15
|
get: function () {
|
|
16
|
+
if (this.config.organizationId === undefined) {
|
|
17
|
+
throw new Error('No organization ID found in the config.');
|
|
18
|
+
}
|
|
16
19
|
return (0, Retriever_1.default)(this.config.organizationId);
|
|
17
20
|
},
|
|
18
21
|
enumerable: false,
|
|
@@ -34,7 +37,7 @@ var API = /** @class */ (function () {
|
|
|
34
37
|
case 3:
|
|
35
38
|
error_1 = _a.sent();
|
|
36
39
|
if (error_1.name === 'AbortError') {
|
|
37
|
-
return [2 /*return
|
|
40
|
+
return [2 /*return*/, undefined]; // We don't want to resolve or reject the promise
|
|
38
41
|
}
|
|
39
42
|
else {
|
|
40
43
|
throw error_1;
|
|
@@ -61,7 +64,8 @@ var API = /** @class */ (function () {
|
|
|
61
64
|
case 3:
|
|
62
65
|
error_2 = _a.sent();
|
|
63
66
|
if (error_2.name === 'AbortError') {
|
|
64
|
-
|
|
67
|
+
// We don't want to resolve or reject the promise
|
|
68
|
+
return [2 /*return*/, undefined];
|
|
65
69
|
}
|
|
66
70
|
else {
|
|
67
71
|
throw error_2;
|
package/dist/APICore.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,2DAA4C;AAE5C,+DAA6D;AAE7D,sFAAsG;AAEtG,wEAAyC;AAEzC;IAMI,aAAoB,MAA6B,EAAU,gBAA0B;QAAjE,WAAM,GAAN,MAAM,CAAuB;QAAU,qBAAgB,GAAhB,gBAAgB,CAAU;QACjF,IAAI,CAAC,qBAAqB,GAAG,IAAI,eAAe,EAAE,CAAC;IACvD,CAAC;IAED,sBAAI,+BAAc;aAAlB;YACI,OAAO,IAAA,mBAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChD,CAAC;;;OAAA;IAEK,iBAAG,GAAT,UAAuC,GAAW,EAAE,IAAmC;QAAnC,qBAAA,EAAA,SAAqB,MAAM,EAAE,KAAK,EAAC;;;;;;wBACnF,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;;;;wBAEpD,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;wBAExC,IAAI,OAAK,CAAC,IAAI,KAAK,YAAY,EAAE;4BAC7B,sBAAO,CAAC,iDAAiD;
|
|
1
|
+
{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,2DAA4C;AAE5C,+DAA6D;AAE7D,sFAAsG;AAEtG,wEAAyC;AAEzC;IAMI,aAAoB,MAA6B,EAAU,gBAA0B;QAAjE,WAAM,GAAN,MAAM,CAAuB;QAAU,qBAAgB,GAAhB,gBAAgB,CAAU;QACjF,IAAI,CAAC,qBAAqB,GAAG,IAAI,eAAe,EAAE,CAAC;IACvD,CAAC;IAED,sBAAI,+BAAc;aAAlB;YACI,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,OAAO,IAAA,mBAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChD,CAAC;;;OAAA;IAEK,iBAAG,GAAT,UAAuC,GAAW,EAAE,IAAmC;QAAnC,qBAAA,EAAA,SAAqB,MAAM,EAAE,KAAK,EAAC;;;;;;wBACnF,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;;;;wBAEpD,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;wBAExC,IAAI,OAAK,CAAC,IAAI,KAAK,YAAY,EAAE;4BAC7B,sBAAO,SAAc,EAAC,CAAC,iDAAiD;yBAC3E;6BAAM;4BACH,MAAM,OAAK,CAAC;yBACf;;;;;;KAER;IAEK,qBAAO,GAAb,UAAc,GAAW,EAAE,IAAmC;QAAnC,qBAAA,EAAA,SAAqB,MAAM,EAAE,KAAK,EAAC;;;;;;wBAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;;;;wBAEpD,qBAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAxC,sBAAO,SAAiC,EAAC;;;wBAEzC,IAAI,OAAK,CAAC,IAAI,KAAK,YAAY,EAAE;4BAC7B,iDAAiD;4BACjD,sBAAO,SAA4B,EAAC;yBACvC;6BAAM;4BACH,MAAM,OAAK,CAAC;yBACf;;;;;;KAER;IAEK,kBAAI,GAAV,UACI,GAAW,EACX,IAAc,EACd,IAA+G;QAD/G,qBAAA,EAAA,SAAc;QACd,qBAAA,EAAA,SAAqB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC,EAAC;;;;4BAExG,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;;KAC3C;IAEK,sBAAQ,GAAd,UACI,GAAW,EACX,IAAc,EACd,IAAgD;QAAhD,qBAAA,EAAA,SAAqB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAC;;;;4BAEzC,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;;KAC3C;IAEK,iBAAG,GAAT,UACI,GAAW,EACX,IAAc,EACd,IAA8G;QAD9G,qBAAA,EAAA,SAAc;QACd,qBAAA,EAAA,SAAqB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC,EAAC;;;;4BAEvG,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;;KAC3C;IAEK,mBAAK,GAAX,UACI,GAAW,EACX,IAAc,EACd,IAAgH;QADhH,qBAAA,EAAA,SAAc;QACd,qBAAA,EAAA,SAAqB,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC,EAAC;;;;4BAEzG,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;;KAC3C;IAEK,oBAAM,GAAZ,UAA0C,GAAW,EAAE,IAAsC;QAAtC,qBAAA,EAAA,SAAqB,MAAM,EAAE,QAAQ,EAAC;;;;4BAClF,qBAAM,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;;KAC3C;IAED,8BAAgB,GAAhB;QACI,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,qBAAqB,GAAG,IAAI,eAAe,EAAE,CAAC;IACvD,CAAC;IAEK,wBAAU,GAAhB;;;;;;wBACU,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;wBAChC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;wBAC3C,KAAA,IAAI,CAAA;wBAAa,qBAAM,IAAI,CAAC,QAAQ,CAAM,oBAAoB,EAAE,QAAQ,CAAC,EAAA;;wBAAzE,GAAK,SAAS,GAAG,SAAwD,CAAC;;;;;KAC7E;IAED,sBAAI,4BAAW;aAAf;;YACI,OAAO,MAAA,IAAI,CAAC,SAAS,0CAAE,cAAc,CAAC;QAC1C,CAAC;;;OAAA;IAED,sBAAY,yBAAQ;aAApB;YACI,IAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC;YAC1D,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,0CAAuB,CAAC;QAC5E,CAAC;;;OAAA;IAED,sBAAY,4BAAW;aAAvB;YACI,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,uBAAW,CAAC,IAAI,CAAC;QACvD,CAAC;;;OAAA;IAED,sBAAY,uBAAM;aAAlB;YACI,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,kBAAM,CAAC,EAAE,CAAC;QAC3C,CAAC;;;OAAA;IAED,sBAAY,yBAAQ;aAApB;YACI,OAAO,CACH,IAAA,mBAAQ,EAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC/E,IAAA,mBAAW,EAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,CACpE,CAAC;QACN,CAAC;;;OAAA;IAED,sBAAY,4BAAW;aAAvB;YACI,OAAO,IAAA,mBAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7C,CAAC;;;OAAA;IAED,sBAAY,sCAAqB;aAAjC;YACI,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,IAAI,EAAE,CAAC;QACnD,CAAC;;;OAAA;IAEO,6BAAe,GAAvB,UAAwB,KAAa;QACjC,OAAO,UAAG,IAAI,CAAC,QAAQ,SAAG,KAAK,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACvF,CAAC;IAEa,qBAAO,GAArB,UAAyB,KAAa,EAAE,IAAiB;;;;;;;wBAC/C,IAAI,0DACH,IAAI,CAAC,qBAAqB,GAC1B,IAAI,KACP,OAAO,sCACH,aAAa,EAAE,iBAAU,IAAI,CAAC,WAAW,CAAE,IACxC,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,IAAI,EAAE,CAAC,GAC1C,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,IAE9B,CAAC;wBAEI,GAAG,GAAG;;;;4CACS,qBAAM,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAAA;;wCAAzD,QAAQ,GAAG,SAA8C;wCAC/D,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;4CACnC,MAAM,QAAQ,CAAC;yCAClB;wCACD,sBAAO,QAAQ,EAAC;;;6BACnB,CAAC;wBAEU,qBAAM,IAAA,6BAAO,EAAC,GAAG,EAAE,EAAC,KAAK,EAAE,UAAC,CAAW,IAAK,OAAA,KAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,EAA1B,CAA0B,EAAC,CAAC,EAAA;;wBAA9E,GAAG,GAAG,SAAwE;wBACpF,sBAAO,IAAA,0BAAc,EAAI,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAC;;;;KAChD;IAEa,yBAAW,GAAzB,UAA0B,KAAa,EAAE,IAAiB;;;;;;wBAChD,IAAI,0DACH,IAAI,CAAC,qBAAqB,GAC1B,IAAI,KACP,OAAO,sCACH,aAAa,EAAE,iBAAU,IAAI,CAAC,WAAW,CAAE,IACxC,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,IAAI,EAAE,CAAC,GAC1C,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,IAE9B,CAAC;wBACe,qBAAM,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAAA;;wBAAzD,QAAQ,GAAG,SAA8C;wBAC/D,sBAAO,IAAA,0BAAc,EAAO,QAAQ,EAAE;gCAClC,mCAAgB,CAAC,SAAS;gCAC1B,mCAAgB,CAAC,WAAW;gCAC5B,mCAAgB,CAAC,KAAK;6BACzB,CAAC,EAAC;;;;KACN;IAEO,yBAAW,GAAnB,UAAoB,MAAc;QAC9B,OAAO,MAAM,KAAK,GAAG,CAAC;IAC1B,CAAC;IAzKM,kBAAc,GAAG,oBAAoB,CAAC;IA0KjD,UAAC;CAAA,AA3KD,IA2KC;kBA3KoB,GAAG"}
|
|
@@ -6,7 +6,7 @@ export default class API {
|
|
|
6
6
|
static orgPlaceholder: string;
|
|
7
7
|
private getRequestsController;
|
|
8
8
|
private tokenInfo;
|
|
9
|
-
constructor(config: PlatformClientOptions, isServerlessHost?: boolean);
|
|
9
|
+
constructor(config: PlatformClientOptions, isServerlessHost?: boolean | undefined);
|
|
10
10
|
get organizationId(): string;
|
|
11
11
|
get<T = Record<string, unknown>>(url: string, args?: RequestInit): Promise<T>;
|
|
12
12
|
getFile(url: string, args?: RequestInit): Promise<Blob>;
|
|
@@ -4,7 +4,7 @@ export type PageModel<T = any, TItemsKey extends string = 'items'> = {
|
|
|
4
4
|
totalEntries: number;
|
|
5
5
|
totalPages: number;
|
|
6
6
|
};
|
|
7
|
-
export type New<T, K extends
|
|
7
|
+
export type New<T, K extends keyof T | null = null> = Omit<T, 'id' | NonNullable<K>>;
|
|
8
8
|
export interface IdAndDisplayNameModel {
|
|
9
9
|
id: string;
|
|
10
10
|
displayName?: string;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { PageModel } from '../../BaseInterfaces';
|
|
2
2
|
import Resource from '../../Resource';
|
|
3
|
-
import { AssociatedPipelinesData, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
|
|
3
|
+
import { AssociatedPipelinesData, BulkGetAssociationsParams, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
|
|
4
4
|
export default class MLAssociations extends Resource {
|
|
5
5
|
static getBaseUrl: (pipelineId: string) => string;
|
|
6
6
|
list(pipelineId: string, options?: ListAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
|
|
@@ -10,4 +10,5 @@ export default class MLAssociations extends Resource {
|
|
|
10
10
|
updateAssociation(pipelineId: string, associationId: string, options?: EditAssociation): Promise<Record<string, unknown>>;
|
|
11
11
|
updatePosition(pipelineId: string, associationId: string, position: number): Promise<Record<string, unknown>>;
|
|
12
12
|
getAssociatedPipelines(): Promise<AssociatedPipelinesData[]>;
|
|
13
|
+
bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
|
|
13
14
|
}
|
|
@@ -30,6 +30,9 @@ export interface MLAssociationModel {
|
|
|
30
30
|
}
|
|
31
31
|
export interface ListAssociationsParams extends Paginated {
|
|
32
32
|
}
|
|
33
|
+
export interface BulkGetAssociationsParams extends Paginated {
|
|
34
|
+
ids: string[];
|
|
35
|
+
}
|
|
33
36
|
export interface CreateAssociation extends EditAssociation {
|
|
34
37
|
modelId: string;
|
|
35
38
|
}
|
|
@@ -166,7 +166,7 @@ export interface PipelineModel extends PipelineShared {
|
|
|
166
166
|
last_modified_by?: string;
|
|
167
167
|
statementComposition?: {
|
|
168
168
|
totalCount?: number;
|
|
169
|
-
[key: string]: number;
|
|
169
|
+
[key: string]: number | undefined;
|
|
170
170
|
};
|
|
171
171
|
}
|
|
172
172
|
export interface NewPipelineModel extends PipelineShared, GranularResource {
|
|
@@ -1,10 +1,21 @@
|
|
|
1
1
|
import { RedshiftEndpointStatus } from '../../../Enums';
|
|
2
|
-
import
|
|
2
|
+
import ReadServiceResource from '../ReadServiceResource';
|
|
3
3
|
import { AccountInfoModelV15, AccountResponseV15, StrictValidationTestParams, StrictValidationTestResponseV15 } from './AdministrationInterfaces';
|
|
4
|
-
export default class Administration extends
|
|
4
|
+
export default class Administration extends ReadServiceResource {
|
|
5
5
|
static baseUrl: string;
|
|
6
|
+
/**
|
|
7
|
+
* Get an account.
|
|
8
|
+
*/
|
|
6
9
|
getAccount(): Promise<AccountResponseV15>;
|
|
10
|
+
/**
|
|
11
|
+
* Edit an account.
|
|
12
|
+
*
|
|
13
|
+
* @param model The account information.
|
|
14
|
+
*/
|
|
7
15
|
updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
|
|
8
16
|
setRedshiftStatus(endpoint: string, status: RedshiftEndpointStatus): Promise<Record<string, unknown>>;
|
|
17
|
+
/**
|
|
18
|
+
* Get example values that would be rejected by strict validation for the specified dimension.
|
|
19
|
+
*/
|
|
9
20
|
getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
|
|
10
21
|
}
|
package/dist/definitions/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DeprecatedShortPaginatedParamParts, OrganizationParamParts, TimeRangeParamParts } from '../CommonParamParts';
|
|
1
2
|
export interface AccountInfoModelV15 {
|
|
2
3
|
internalEventIps: string[];
|
|
3
4
|
useStrictFieldValidation: boolean;
|
|
@@ -11,11 +12,9 @@ export interface StrictValidationTestResponseV15 {
|
|
|
11
12
|
dimensionName: string;
|
|
12
13
|
validationTestResults: Array<Record<string, unknown>>;
|
|
13
14
|
}
|
|
14
|
-
export interface StrictValidationTestParams {
|
|
15
|
-
|
|
16
|
-
|
|
15
|
+
export interface StrictValidationTestParams extends OrganizationParamParts, TimeRangeParamParts, DeprecatedShortPaginatedParamParts {
|
|
16
|
+
/**
|
|
17
|
+
* The dimension to fetch.
|
|
18
|
+
*/
|
|
17
19
|
d: string;
|
|
18
|
-
p?: number;
|
|
19
|
-
n?: number;
|
|
20
|
-
org?: string;
|
|
21
20
|
}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Almost all calls of the Read service have an optional `org` query parameter.
|
|
3
|
+
* (Notable exceptions are service status monitoring calls).
|
|
4
|
+
*/
|
|
5
|
+
export interface OrganizationParamParts {
|
|
6
|
+
/**
|
|
7
|
+
* The name of the organization (Coveo Cloud V2 only)
|
|
8
|
+
*/
|
|
9
|
+
org?: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Required `d` parameter, encoding dimensions.
|
|
13
|
+
*/
|
|
14
|
+
export interface EventDimensionsParamParts {
|
|
15
|
+
/**
|
|
16
|
+
* The dimensions to fetch.
|
|
17
|
+
*/
|
|
18
|
+
d: string[];
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Optional `f` parameter, encoding dimension filters.
|
|
22
|
+
*/
|
|
23
|
+
export interface EventDimensionsFilterParamParts {
|
|
24
|
+
/**
|
|
25
|
+
* The filter that will be applied to the event dimensions.
|
|
26
|
+
* Multiple filter parameters are joined with the AND operator.
|
|
27
|
+
*/
|
|
28
|
+
f?: string[];
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Optional `fn` parameter, encoding dimension based exclusion filters.
|
|
32
|
+
*/
|
|
33
|
+
export interface EventDimensionsExcludeFilterParamParts {
|
|
34
|
+
/**
|
|
35
|
+
* The filter that will be applied to dimensions to exclude events from the results.
|
|
36
|
+
* Multiple filter parameters are joined with the AND operator.
|
|
37
|
+
*/
|
|
38
|
+
fn?: string[];
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Optional `fn` parameter, encoding dimension based event exclusion filters.
|
|
42
|
+
*/
|
|
43
|
+
export interface EventDimensionsHideEventsFilterParamParts {
|
|
44
|
+
/**
|
|
45
|
+
* Each specified filter is inverted in order to hide events.
|
|
46
|
+
* Multiple filter parameters are joined with the AND operator.
|
|
47
|
+
*/
|
|
48
|
+
hideEventFilters?: string[];
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Required `m` parameter, encoding metrics.
|
|
52
|
+
*/
|
|
53
|
+
export interface EventMetricsParamParts {
|
|
54
|
+
/**
|
|
55
|
+
* The metrics to fetch.
|
|
56
|
+
*/
|
|
57
|
+
m: string[];
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Optional `i` parameter, encoding the interval to use when calculating metrics.
|
|
61
|
+
*/
|
|
62
|
+
export interface EventMetricsIntervalParamParts {
|
|
63
|
+
/**
|
|
64
|
+
* The metrics to fetch.
|
|
65
|
+
*/
|
|
66
|
+
i?: string[];
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Optional `fm` parameter, encoding metric based filters.
|
|
70
|
+
*/
|
|
71
|
+
export interface EventMetricsFilterParamParts {
|
|
72
|
+
/**
|
|
73
|
+
* The filter that will be applied to the metrics.
|
|
74
|
+
* Multiple filter parameters are joined with the AND operator.
|
|
75
|
+
*/
|
|
76
|
+
fm?: string[];
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Required `from` and `to` parameters, encoding a time range.
|
|
80
|
+
*/
|
|
81
|
+
export interface TimeRangeParamParts {
|
|
82
|
+
/**
|
|
83
|
+
* The beginning date of the date range for the request, as an ISO-8601 encoded string.
|
|
84
|
+
* The date/time should include an offset, or `Z` for UTC.
|
|
85
|
+
* Format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
|
86
|
+
*/
|
|
87
|
+
from: string;
|
|
88
|
+
/**
|
|
89
|
+
* The end date of the date range for the request, as an ISO-8601 encoded string.
|
|
90
|
+
* The date/time should include an offset, or `Z` for UTC.
|
|
91
|
+
* Format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
|
92
|
+
*/
|
|
93
|
+
to: string;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Optional `tz` parameters, encoding a time zone.
|
|
97
|
+
*/
|
|
98
|
+
export interface TimeZoneParamParts {
|
|
99
|
+
/**
|
|
100
|
+
* Timezone/offset used for calculations.
|
|
101
|
+
* Defaults to `Z` (UTC).
|
|
102
|
+
*/
|
|
103
|
+
tz?: string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Paginated `p` and `n` query parameters used by some Read service calls.
|
|
107
|
+
* (Deprecated because it doesn't align with Coveo's standard `page` (0-based) and `perPage` query parameters).
|
|
108
|
+
*/
|
|
109
|
+
export interface DeprecatedShortPaginatedParamParts {
|
|
110
|
+
/**
|
|
111
|
+
* The response's page to access, starting at 1.
|
|
112
|
+
*/
|
|
113
|
+
p?: number;
|
|
114
|
+
/**
|
|
115
|
+
* The number of result to include in a page.
|
|
116
|
+
*/
|
|
117
|
+
n?: number;
|
|
118
|
+
}
|
|
@@ -1,9 +1,21 @@
|
|
|
1
|
-
import
|
|
1
|
+
import ReadServiceResource from '../ReadServiceResource';
|
|
2
2
|
import { SnowflakeAccountDataSharingParams, SnowflakeAccountDataSharingAccountModel, SnowflakeAccountDataSharingRegionsModel } from './DataShareInterfaces';
|
|
3
|
-
export default class DataShare extends
|
|
3
|
+
export default class DataShare extends ReadServiceResource {
|
|
4
4
|
static baseUrl: string;
|
|
5
|
+
/**
|
|
6
|
+
* Retrieve Snowflake accounts currently associated in Secure Data Sharing.
|
|
7
|
+
*/
|
|
5
8
|
listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
|
|
6
|
-
|
|
9
|
+
/**
|
|
10
|
+
* Add a Snowflake account to Secure Data Sharing.
|
|
11
|
+
*/
|
|
12
|
+
addSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
|
|
13
|
+
/**
|
|
14
|
+
* Removes a Snowflake account from Secure Data Sharing.
|
|
15
|
+
*/
|
|
7
16
|
deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
|
|
17
|
+
/**
|
|
18
|
+
* Retrieve allowed Snowflake regions for Secure Data Sharing.
|
|
19
|
+
*/
|
|
8
20
|
listAllowedSnowflakeRegions(): Promise<SnowflakeAccountDataSharingRegionsModel>;
|
|
9
21
|
}
|
|
@@ -1,21 +1,84 @@
|
|
|
1
1
|
import { DimensionEventTypes } from '../../../Enums';
|
|
2
|
-
import
|
|
2
|
+
import ReadServiceResource from '../ReadServiceResource';
|
|
3
3
|
import { CreateCustomDimensionParams, CustomDimensionModel, CustomDimensionSuggestionModel, DimensionModel, DimensionValuesModel, GetDimensionValuesParams, ListDimensionsParams, ListUncreatedDimensionsParams } from './DimensionsInterfaces';
|
|
4
|
-
export default class Dimensions extends
|
|
4
|
+
export default class Dimensions extends ReadServiceResource {
|
|
5
5
|
static baseUrl: string;
|
|
6
|
+
/**
|
|
7
|
+
* Get all the dimensions.
|
|
8
|
+
*/
|
|
6
9
|
list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
|
|
10
|
+
/**
|
|
11
|
+
* Get all the exportable dimensions.
|
|
12
|
+
*/
|
|
7
13
|
listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
|
|
14
|
+
/**
|
|
15
|
+
* Get a dimension.
|
|
16
|
+
*
|
|
17
|
+
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
18
|
+
*/
|
|
8
19
|
get(apiName: string): Promise<DimensionModel>;
|
|
20
|
+
/**
|
|
21
|
+
* Get the values for a dimension.
|
|
22
|
+
*
|
|
23
|
+
* @param dimension The dimension to fetch.
|
|
24
|
+
*/
|
|
9
25
|
getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
|
|
26
|
+
/**
|
|
27
|
+
* Get the dimensions service status.
|
|
28
|
+
*/
|
|
10
29
|
getStatus(): Promise<Record<string, string>>;
|
|
30
|
+
/**
|
|
31
|
+
* Health check for the dimensions service.
|
|
32
|
+
*/
|
|
11
33
|
checkHealth(): Promise<Record<string, string>>;
|
|
34
|
+
/**
|
|
35
|
+
* Get all the custom dimensions.
|
|
36
|
+
*
|
|
37
|
+
* @param includeOnlyParents This will filter out dimensions which are covered by others.
|
|
38
|
+
* Only parent/master dimensions will be output.
|
|
39
|
+
*/
|
|
12
40
|
listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
|
|
41
|
+
/**
|
|
42
|
+
* Create a custom dimension.
|
|
43
|
+
*/
|
|
13
44
|
createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
|
|
45
|
+
/**
|
|
46
|
+
* Get a custom dimension.
|
|
47
|
+
*
|
|
48
|
+
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
49
|
+
*/
|
|
14
50
|
getCustomDimension(apiName: string): Promise<DimensionModel>;
|
|
51
|
+
/**
|
|
52
|
+
* Get the values for a custom dimension.
|
|
53
|
+
*
|
|
54
|
+
* @param dimension The dimension to fetch.
|
|
55
|
+
*/
|
|
15
56
|
getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
|
|
57
|
+
/**
|
|
58
|
+
* Create or edit a custom dimension.
|
|
59
|
+
*
|
|
60
|
+
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
61
|
+
* @param updatePastEvents Whether to update the custom dimension in past events (deprecated).
|
|
62
|
+
*/
|
|
16
63
|
updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
|
|
64
|
+
/**
|
|
65
|
+
* Delete a custom dimension.
|
|
66
|
+
*
|
|
67
|
+
* @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
|
|
68
|
+
*/
|
|
17
69
|
deleteCustomDimension(apiName: string): Promise<void>;
|
|
70
|
+
/**
|
|
71
|
+
* Get the custom dimensions service status.
|
|
72
|
+
*/
|
|
18
73
|
getCustomDimensionStatus(): Promise<Record<string, string>>;
|
|
74
|
+
/**
|
|
75
|
+
* Health check for the custom dimensions service.
|
|
76
|
+
*/
|
|
19
77
|
checkCustomDimensionHealth(): Promise<Record<string, string>>;
|
|
78
|
+
/**
|
|
79
|
+
* Get a list of dimensions that have data but are not created yet.
|
|
80
|
+
*
|
|
81
|
+
* @param event The type of event for which to look for suggestions.
|
|
82
|
+
*/
|
|
20
83
|
listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionModel[]>;
|
|
21
84
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { DimensionStatus, DimensionType } from '../../../Enums';
|
|
2
|
+
import { DeprecatedShortPaginatedParamParts, EventDimensionsFilterParamParts, OrganizationParamParts, TimeRangeParamParts, TimeZoneParamParts } from '../CommonParamParts';
|
|
2
3
|
export interface DimensionModel {
|
|
3
4
|
/**
|
|
4
5
|
* A collection of possible names to use when querying the statistics service with this dimension
|
|
@@ -59,43 +60,43 @@ export interface CustomDimensionModel {
|
|
|
59
60
|
*/
|
|
60
61
|
path?: string[];
|
|
61
62
|
}
|
|
62
|
-
export interface ListDimensionsParams {
|
|
63
|
-
|
|
63
|
+
export interface ListDimensionsParams extends OrganizationParamParts {
|
|
64
|
+
/**
|
|
65
|
+
* This will filter out dimensions which are covered by others.
|
|
66
|
+
* Only parent/master dimensions will be output.
|
|
67
|
+
*/
|
|
64
68
|
includeOnlyParents?: boolean;
|
|
69
|
+
/**
|
|
70
|
+
* Whether to include custom dimensions within the results.
|
|
71
|
+
*/
|
|
65
72
|
includeCustom?: boolean;
|
|
66
73
|
}
|
|
67
|
-
export interface GetDimensionValuesParams {
|
|
68
|
-
from: string;
|
|
69
|
-
to: string;
|
|
70
|
-
tz?: string;
|
|
71
|
-
org?: string;
|
|
72
|
-
f?: string[];
|
|
73
|
-
p?: number;
|
|
74
|
-
n?: number;
|
|
74
|
+
export interface GetDimensionValuesParams extends OrganizationParamParts, EventDimensionsFilterParamParts, TimeRangeParamParts, TimeZoneParamParts, DeprecatedShortPaginatedParamParts {
|
|
75
75
|
}
|
|
76
|
-
export interface CreateCustomDimensionParams {
|
|
76
|
+
export interface CreateCustomDimensionParams extends OrganizationParamParts {
|
|
77
77
|
/**
|
|
78
78
|
* The name of the custom dimension. It should start with the 'c_' prefix.
|
|
79
79
|
* If not present, the prefix will be added automatically.
|
|
80
80
|
*/
|
|
81
81
|
name: string;
|
|
82
|
-
/**
|
|
83
|
-
* The name of the organization (Coveo Cloud V2 only)
|
|
84
|
-
*/
|
|
85
|
-
org?: string;
|
|
86
82
|
/**
|
|
87
83
|
* The types of event where this dimension will be added.
|
|
88
84
|
*/
|
|
89
85
|
event?: string[];
|
|
90
86
|
/**
|
|
91
87
|
* Whether to update the custom dimension in past events.
|
|
88
|
+
*
|
|
89
|
+
* @deprecated
|
|
92
90
|
*/
|
|
93
91
|
updatePastEvents?: boolean;
|
|
94
92
|
}
|
|
95
|
-
export interface ListUncreatedDimensionsParams {
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
93
|
+
export interface ListUncreatedDimensionsParams extends OrganizationParamParts, TimeRangeParamParts {
|
|
94
|
+
/**
|
|
95
|
+
* Whether value samples should be included in the response.
|
|
96
|
+
*/
|
|
99
97
|
includeValueSamples?: boolean;
|
|
98
|
+
/**
|
|
99
|
+
* The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.
|
|
100
|
+
*/
|
|
100
101
|
depth?: number;
|
|
101
102
|
}
|
|
@@ -1,20 +1,78 @@
|
|
|
1
|
-
import
|
|
1
|
+
import ReadServiceResource from '../ReadServiceResource';
|
|
2
2
|
import { CreateExportScheduleModel, EstimateExportParams, EstimateVisitExportParams, ExportDownloadLink, ExportEstimateModel, ExportModel, ExportScheduleModel, GenerateExportParams, GenerateVisitExportParams } from './ExportsInterfaces';
|
|
3
|
-
export default class Exports extends
|
|
3
|
+
export default class Exports extends ReadServiceResource {
|
|
4
4
|
static baseUrl: string;
|
|
5
|
+
/**
|
|
6
|
+
* Lists all exports.
|
|
7
|
+
*/
|
|
5
8
|
list(): Promise<ExportModel[]>;
|
|
9
|
+
/**
|
|
10
|
+
* Generate an export.
|
|
11
|
+
*/
|
|
6
12
|
generate(params: GenerateExportParams): Promise<ExportModel>;
|
|
13
|
+
/**
|
|
14
|
+
* Get information on an export.
|
|
15
|
+
*
|
|
16
|
+
* @param exportId The export's unique identifier.
|
|
17
|
+
* @param redirect Whether to return a HTTP redirect to the actual file.
|
|
18
|
+
*/
|
|
7
19
|
get(exportId: string, redirect?: boolean): Promise<ExportModel>;
|
|
20
|
+
/**
|
|
21
|
+
* Get the download link of an export.
|
|
22
|
+
*
|
|
23
|
+
* @param exportId The export's unique identifier.
|
|
24
|
+
*/
|
|
8
25
|
getExportDownloadLink(exportId: string): Promise<ExportDownloadLink>;
|
|
26
|
+
/**
|
|
27
|
+
* Delete an export.
|
|
28
|
+
*
|
|
29
|
+
* @param exportId The export's unique identifier.
|
|
30
|
+
*/
|
|
9
31
|
delete(exportId: string): Promise<void>;
|
|
32
|
+
/**
|
|
33
|
+
* Estimate the number of rows in an export.
|
|
34
|
+
*/
|
|
10
35
|
estimateRowsCount(params: EstimateExportParams): Promise<ExportEstimateModel>;
|
|
36
|
+
/**
|
|
37
|
+
* Get the exports service status.
|
|
38
|
+
*/
|
|
11
39
|
getStatus(): Promise<Record<string, string>>;
|
|
40
|
+
/**
|
|
41
|
+
* Health check for the exports service.
|
|
42
|
+
*/
|
|
12
43
|
checkHealth(): Promise<Record<string, string>>;
|
|
44
|
+
/**
|
|
45
|
+
* Generate a visit export.
|
|
46
|
+
*/
|
|
13
47
|
generateVisitExport(params: GenerateVisitExportParams): Promise<ExportModel>;
|
|
48
|
+
/**
|
|
49
|
+
* Estimate the number of rows in a visit export.
|
|
50
|
+
*/
|
|
14
51
|
estimateVisitExportRowsCount(params: EstimateVisitExportParams): Promise<ExportEstimateModel>;
|
|
52
|
+
/**
|
|
53
|
+
* Get all the export schedules.
|
|
54
|
+
*/
|
|
15
55
|
listSchedules(): Promise<ExportScheduleModel[]>;
|
|
56
|
+
/**
|
|
57
|
+
* Create an export schedule.
|
|
58
|
+
*/
|
|
16
59
|
createSchedule(model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
|
|
60
|
+
/**
|
|
61
|
+
* Get information on an export schedule.
|
|
62
|
+
*
|
|
63
|
+
* @param exportScheduleId The export schedule's unique identifier.
|
|
64
|
+
*/
|
|
17
65
|
getSchedule(exportScheduleId: string): Promise<ExportScheduleModel>;
|
|
66
|
+
/**
|
|
67
|
+
* Update an existing export schedule.
|
|
68
|
+
*
|
|
69
|
+
* @param exportScheduleId The export schedule's unique identifier.
|
|
70
|
+
*/
|
|
18
71
|
updateSchedule(exportScheduleId: string, model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
|
|
72
|
+
/**
|
|
73
|
+
* Delete an export schedule.
|
|
74
|
+
*
|
|
75
|
+
* @param exportScheduleId The export schedule's unique identifier.
|
|
76
|
+
*/
|
|
19
77
|
deleteSchedule(exportScheduleId: string): Promise<void>;
|
|
20
78
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTablesType } from '../../../Enums';
|
|
2
|
+
import { EventDimensionsExcludeFilterParamParts, EventDimensionsFilterParamParts, EventDimensionsHideEventsFilterParamParts, TimeRangeParamParts } from '../CommonParamParts';
|
|
2
3
|
export interface ExportModel {
|
|
3
4
|
id: string;
|
|
4
5
|
author: string;
|
|
@@ -22,24 +23,19 @@ export interface ExportEstimateModel {
|
|
|
22
23
|
}
|
|
23
24
|
export interface ExportDownloadLink {
|
|
24
25
|
/**
|
|
25
|
-
* The export's unique identifier
|
|
26
|
+
* The export's unique identifier.
|
|
26
27
|
*/
|
|
27
28
|
id: string;
|
|
28
29
|
/**
|
|
29
|
-
* The export download link. Only appears when export is ready
|
|
30
|
+
* The export download link. Only appears when export is ready.
|
|
30
31
|
*/
|
|
31
32
|
downloadLink?: string;
|
|
32
33
|
}
|
|
33
|
-
interface
|
|
34
|
-
from: string;
|
|
35
|
-
to: string;
|
|
34
|
+
export interface EstimateExportParams extends TimeRangeParamParts, EventDimensionsFilterParamParts {
|
|
36
35
|
/**
|
|
37
|
-
* The
|
|
38
|
-
*
|
|
36
|
+
* The tables that will be included.
|
|
37
|
+
* If not provided, all tables will be included.
|
|
39
38
|
*/
|
|
40
|
-
f?: string[];
|
|
41
|
-
}
|
|
42
|
-
export interface EstimateExportParams extends EstimateExportCommonParams {
|
|
43
39
|
tables?: ExportTablesType[];
|
|
44
40
|
/**
|
|
45
41
|
* The filter that will be applied to the click and search events dimensions.
|
|
@@ -52,29 +48,38 @@ export interface EstimateExportParams extends EstimateExportCommonParams {
|
|
|
52
48
|
*/
|
|
53
49
|
fc?: string[];
|
|
54
50
|
}
|
|
55
|
-
export interface EstimateVisitExportParams extends
|
|
56
|
-
|
|
51
|
+
export interface EstimateVisitExportParams extends TimeRangeParamParts, EventDimensionsFilterParamParts, EventDimensionsExcludeFilterParamParts, EventDimensionsHideEventsFilterParamParts {
|
|
52
|
+
}
|
|
53
|
+
export interface GenerateExportParams extends EstimateExportParams {
|
|
57
54
|
/**
|
|
58
|
-
*
|
|
59
|
-
* Multiple filter parameters are joined with the AND operator.
|
|
55
|
+
* Can only contain US-ASCII characters. If not provided, it will be set to the export's id.
|
|
60
56
|
*/
|
|
61
|
-
fn?: string[];
|
|
62
|
-
}
|
|
63
|
-
interface GenerateExportCommonParams {
|
|
64
57
|
filename?: string;
|
|
65
58
|
/**
|
|
66
59
|
* Export's description.
|
|
67
60
|
*/
|
|
68
61
|
d?: string;
|
|
62
|
+
/**
|
|
63
|
+
* The dimensions that will be exported. If not provided, all dimensions will be exported.
|
|
64
|
+
*/
|
|
69
65
|
dimensions?: string[];
|
|
66
|
+
/**
|
|
67
|
+
* The format of the generated CSV files.
|
|
68
|
+
*/
|
|
70
69
|
format?: CSVFileFormat;
|
|
70
|
+
/**
|
|
71
|
+
* Whether to use the display names in the export's header. If false, the api names will be used.
|
|
72
|
+
*/
|
|
71
73
|
useDisplayNames?: boolean;
|
|
72
74
|
}
|
|
73
|
-
export
|
|
74
|
-
|
|
75
|
+
export interface GenerateVisitExportParams extends GenerateExportParams {
|
|
76
|
+
/**
|
|
77
|
+
* Whether to order the rows by datetime in the export.
|
|
78
|
+
* If the number of rows exported is too large, this parameter will be ignored and data will be unsorted.
|
|
79
|
+
*/
|
|
75
80
|
ordered?: boolean;
|
|
76
|
-
}
|
|
77
|
-
interface
|
|
81
|
+
}
|
|
82
|
+
interface ExportScheduleModelCommonProperties {
|
|
78
83
|
frequency: ExportScheduleFrequency;
|
|
79
84
|
dayOfWeek?: DayOfWeek;
|
|
80
85
|
timezone: string;
|
|
@@ -82,7 +87,7 @@ interface ScheduleCommonProperties {
|
|
|
82
87
|
usingDisplayNames?: boolean;
|
|
83
88
|
notificationsEmails?: string[];
|
|
84
89
|
}
|
|
85
|
-
export interface ExportScheduleModel extends
|
|
90
|
+
export interface ExportScheduleModel extends ExportScheduleModelCommonProperties {
|
|
86
91
|
id: string;
|
|
87
92
|
author: string;
|
|
88
93
|
filters: Record<string, string>;
|
|
@@ -90,7 +95,7 @@ export interface ExportScheduleModel extends ScheduleCommonProperties {
|
|
|
90
95
|
description: string;
|
|
91
96
|
errorInfo?: Record<string, string>;
|
|
92
97
|
}
|
|
93
|
-
export interface CreateExportScheduleModel extends
|
|
98
|
+
export interface CreateExportScheduleModel extends ExportScheduleModelCommonProperties {
|
|
94
99
|
commonFilters?: string[];
|
|
95
100
|
searchesFilters?: string[];
|
|
96
101
|
customEventsFilters?: string[];
|