@coveo/platform-client 54.11.0 → 54.12.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/Extensions/Extensions.js +12 -0
- package/dist/cjs/resources/Extensions/Extensions.js.map +1 -1
- package/dist/esm/resources/Extensions/Extensions.js +12 -0
- package/dist/esm/resources/Extensions/Extensions.js.map +1 -1
- package/dist/types/resources/Extensions/Extensions.d.ts +9 -1
- package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts +17 -0
- package/package.json +1 -1
|
@@ -26,6 +26,18 @@ class Extension extends Resource_js_1.default {
|
|
|
26
26
|
list() {
|
|
27
27
|
return this.api.get(Extension.baseUrl);
|
|
28
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
31
|
+
*/
|
|
32
|
+
listVersions(extensionId) {
|
|
33
|
+
return this.api.get(`${Extension.baseUrl}/${extensionId}/versions`);
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
37
|
+
*/
|
|
38
|
+
getVersion(extensionId, versionId) {
|
|
39
|
+
return this.api.get(`${Extension.baseUrl}/${extensionId}/versions/${versionId}`);
|
|
40
|
+
}
|
|
29
41
|
/**
|
|
30
42
|
* Validates the extension's script
|
|
31
43
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;
|
|
1
|
+
{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;AAStC,MAAqB,SAAU,SAAQ,qBAAQ;IAC3C,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,aAAa,CAAC;IAExE,MAAM,CAAC,SAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAiB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,UAAU,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;IACxF,CAAC;IAED,GAAG,CAAC,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiC,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,WAAW,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,WAAmB,EAAE,SAAiB;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,aAAa,SAAS,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,aAAmC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAyB,GAAG,SAAS,CAAC,OAAO,eAAe,EAAE,aAAa,CAAC,CAAC;IACrG,CAAC;;AApDL,4BAqDC"}
|
|
@@ -23,6 +23,18 @@ export default class Extension extends Resource {
|
|
|
23
23
|
list() {
|
|
24
24
|
return this.api.get(Extension.baseUrl);
|
|
25
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
28
|
+
*/
|
|
29
|
+
listVersions(extensionId) {
|
|
30
|
+
return this.api.get(`${Extension.baseUrl}/${extensionId}/versions`);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
34
|
+
*/
|
|
35
|
+
getVersion(extensionId, versionId) {
|
|
36
|
+
return this.api.get(`${Extension.baseUrl}/${extensionId}/versions/${versionId}`);
|
|
37
|
+
}
|
|
26
38
|
/**
|
|
27
39
|
* Validates the extension's script
|
|
28
40
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAStC,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,aAAa,CAAC;IAExE,MAAM,CAAC,SAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAiB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,UAAU,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;IACxF,CAAC;IAED,GAAG,CAAC,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiC,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,WAAW,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,WAAmB,EAAE,SAAiB;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,aAAa,SAAS,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,aAAmC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAyB,GAAG,SAAS,CAAC,OAAO,eAAe,EAAE,aAAa,CAAC,CAAC;IACrG,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import Resource from '../Resource.js';
|
|
2
|
-
import { CreateExtension, ExtensionCompileCode, ExtensionCompileResult, ExtensionModel } from './ExtensionsInterfaces.js';
|
|
2
|
+
import { CreateExtension, ExtensionCompileCode, ExtensionCompileResult, ExtensionContentVersionModel, ExtensionModel } from './ExtensionsInterfaces.js';
|
|
3
3
|
export default class Extension extends Resource {
|
|
4
4
|
static baseUrl: string;
|
|
5
5
|
create(extension: CreateExtension): Promise<ExtensionModel>;
|
|
@@ -9,6 +9,14 @@ export default class Extension extends Resource {
|
|
|
9
9
|
disable(extensionId: string, reason?: string): Promise<void>;
|
|
10
10
|
get(extensionId: string): Promise<ExtensionModel>;
|
|
11
11
|
list(): Promise<ExtensionModel[]>;
|
|
12
|
+
/**
|
|
13
|
+
* Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
14
|
+
*/
|
|
15
|
+
listVersions(extensionId: string): Promise<ExtensionContentVersionModel[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
|
|
18
|
+
*/
|
|
19
|
+
getVersion(extensionId: string, versionId: string): Promise<ExtensionModel>;
|
|
12
20
|
/**
|
|
13
21
|
* Validates the extension's script
|
|
14
22
|
*
|
|
@@ -87,4 +87,21 @@ export interface ExtensionCompileError {
|
|
|
87
87
|
*/
|
|
88
88
|
type: string;
|
|
89
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* An [extension](https://docs.coveo.com/en/206/) version.
|
|
92
|
+
*/
|
|
93
|
+
export interface ExtensionContentVersionModel {
|
|
94
|
+
/**
|
|
95
|
+
* The date at which the extension version was created (in number of milliseconds since UNIX epoch), i.e., the date of the modification of the extension when this extension version was created.
|
|
96
|
+
*
|
|
97
|
+
* @example 1556308241000
|
|
98
|
+
*/
|
|
99
|
+
lastModified: number;
|
|
100
|
+
/**
|
|
101
|
+
* The unique identifier of the extension target version.
|
|
102
|
+
*
|
|
103
|
+
* @example hdJSDb4hTkdnsCynNtF.d657FgLSDydcj
|
|
104
|
+
*/
|
|
105
|
+
id: string;
|
|
106
|
+
}
|
|
90
107
|
export {};
|