@coveo/platform-client 48.1.0 → 48.3.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.
Files changed (26) hide show
  1. package/dist/cjs/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.js +3 -0
  2. package/dist/cjs/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.js.map +1 -0
  3. package/dist/cjs/resources/HostedInterfacesCore/index.js +1 -0
  4. package/dist/cjs/resources/HostedInterfacesCore/index.js.map +1 -1
  5. package/dist/cjs/resources/InsightPanelInterfaces/InsightPanelInterface.js +12 -0
  6. package/dist/cjs/resources/InsightPanelInterfaces/InsightPanelInterface.js.map +1 -1
  7. package/dist/cjs/resources/InsightPanelInterfaces/InsightPanelInterface.model.js.map +1 -1
  8. package/dist/cjs/resources/Projects/Project.js +11 -2
  9. package/dist/cjs/resources/Projects/Project.js.map +1 -1
  10. package/dist/esm/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.js +2 -0
  11. package/dist/esm/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.js.map +1 -0
  12. package/dist/esm/resources/HostedInterfacesCore/index.js +1 -0
  13. package/dist/esm/resources/HostedInterfacesCore/index.js.map +1 -1
  14. package/dist/esm/resources/InsightPanelInterfaces/InsightPanelInterface.js +12 -0
  15. package/dist/esm/resources/InsightPanelInterfaces/InsightPanelInterface.js.map +1 -1
  16. package/dist/esm/resources/InsightPanelInterfaces/InsightPanelInterface.model.js.map +1 -1
  17. package/dist/esm/resources/Projects/Project.js +11 -2
  18. package/dist/esm/resources/Projects/Project.js.map +1 -1
  19. package/dist/types/resources/HostedInterfacesCore/HostedInterfaceCoreConfig.model.d.ts +1 -1
  20. package/dist/types/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.d.ts +121 -0
  21. package/dist/types/resources/HostedInterfacesCore/index.d.ts +1 -0
  22. package/dist/types/resources/InsightPanelInterfaces/InsightPanelInterface.d.ts +6 -2
  23. package/dist/types/resources/InsightPanelInterfaces/InsightPanelInterface.model.d.ts +14 -3
  24. package/dist/types/resources/Projects/Project.d.ts +10 -3
  25. package/dist/types/resources/Resources/ResourcesInterfaces.d.ts +1 -0
  26. package/package.json +4 -4
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=HostedInterfaceVersionsCore.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"HostedInterfaceVersionsCore.js","sourceRoot":"","sources":["../../../../src/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.ts"],"names":[],"mappings":""}
@@ -2,4 +2,5 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
4
  tslib_1.__exportStar(require("./HostedInterfaceCoreConfig.model.js"), exports);
5
+ tslib_1.__exportStar(require("./HostedInterfaceVersionsCore.js"), exports);
5
6
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/HostedInterfacesCore/index.ts"],"names":[],"mappings":";;;AAAA,+EAAqD"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/HostedInterfacesCore/index.ts"],"names":[],"mappings":";;;AAAA,+EAAqD;AACrD,2EAAiD"}
@@ -21,6 +21,18 @@ class InsightPanelInterface extends Resource_js_1.default {
21
21
  const { id, ...body } = ipInterfaceConfig;
22
22
  return this.api.put(`${InsightPanelInterface.baseUrl}/${id}`, body);
23
23
  }
24
+ listVersions(insightPanelInterfaceId, options) {
25
+ return this.api.get(this.buildPath(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions`, options));
26
+ }
27
+ getVersion(insightPanelInterfaceId, versionNumber) {
28
+ return this.api.get(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions/${versionNumber}`);
29
+ }
30
+ restoreVersion(insightPanelInterfaceId, versionNumber, body) {
31
+ return this.api.post(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions/${versionNumber}/restore`, body);
32
+ }
33
+ updateVersionLabel(insightPanelInterfaceId, versionNumber, body) {
34
+ return this.api.put(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions/${versionNumber}/label`, body);
35
+ }
24
36
  }
25
37
  exports.default = InsightPanelInterface;
26
38
  //# sourceMappingURL=InsightPanelInterface.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"InsightPanelInterface.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAGnC,yEAAsC;AAMtC,MAAqB,qBAAsB,SAAQ,qBAAQ;IACvD,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,iCAAiC,CAAC;IAE5F,IAAI,CAAC,OAAoC;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CACzD,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAsE;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqC,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,uBAA+B;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,GAAG,CAAC,uBAA+B;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAChE,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAiE;QACpE,MAAM,EAAC,EAAE,EAAE,GAAG,IAAI,EAAC,GAAG,iBAAiB,CAAC;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,EAAE,EAAE,EACxC,IAAI,CACP,CAAC;IACN,CAAC;;AA9BL,wCA+BC"}
1
+ {"version":3,"file":"InsightPanelInterface.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAQnC,yEAAsC;AAOtC,MAAqB,qBAAsB,SAAQ,qBAAQ;IACvD,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,iCAAiC,CAAC;IAE5F,IAAI,CAAC,OAAoC;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CACzD,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAsE;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqC,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,uBAA+B;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,GAAG,CAAC,uBAA+B;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAChE,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAiE;QACpE,MAAM,EAAC,EAAE,EAAE,GAAG,IAAI,EAAC,GAAG,iBAAiB,CAAC;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,EAAE,EAAE,EACxC,IAAI,CACP,CAAC;IACN,CAAC;IAED,YAAY,CAAC,uBAA+B,EAAE,OAA0C;QACpF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,WAAW,EAAE,OAAO,CAAC,CAClG,CAAC;IACN,CAAC;IAED,UAAU,CAAC,uBAA+B,EAAE,aAAqB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,aAAa,aAAa,EAAE,CAC1F,CAAC;IACN,CAAC;IAED,cAAc,CAAC,uBAA+B,EAAE,aAAqB,EAAE,IAAmC;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,aAAa,aAAa,UAAU,EAC/F,IAAI,CACP,CAAC;IACN,CAAC;IAED,kBAAkB,CACd,uBAA+B,EAC/B,aAAqB,EACrB,IAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,aAAa,aAAa,QAAQ,EAC7F,IAAI,CACP,CAAC;IACN,CAAC;;AA5DL,wCA6DC"}
@@ -1 +1 @@
1
- {"version":3,"file":"InsightPanelInterface.model.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.model.ts"],"names":[],"mappings":";;;AAaA,IAAY,gCAGX;AAHD,WAAY,gCAAgC;IACxC,uDAAmB,CAAA;IACnB,2DAAuB,CAAA;AAC3B,CAAC,EAHW,gCAAgC,gDAAhC,gCAAgC,QAG3C"}
1
+ {"version":3,"file":"InsightPanelInterface.model.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.model.ts"],"names":[],"mappings":";;;AAeA,IAAY,gCAGX;AAHD,WAAY,gCAAgC;IACxC,uDAAmB,CAAA;IACnB,2DAAuB,CAAA;AAC3B,CAAC,EAHW,gCAAgC,gDAAhC,gCAAgC,QAG3C"}
@@ -50,11 +50,20 @@ class Project extends Resource_js_1.default {
50
50
  delete(projectId) {
51
51
  return this.api.delete(this.buildPath(`${Project.baseUrl}/${projectId}`));
52
52
  }
53
+ /**
54
+ * Returns resource IDs grouped by resource status, for a given project.
55
+ *
56
+ * @param {string} projectId
57
+ * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
58
+ */
59
+ listResourcesByStatus(projectId) {
60
+ return this.api.get(this.buildPath(`${Project.baseUrl}/${projectId}/resources`));
61
+ }
53
62
  /**
54
63
  * Returns a paginated list of resources associated to a project.
55
64
  *
56
- * @param projectId
57
- * @param resourceType
65
+ * @param {string} projectId
66
+ * @param {ProjectResourceType} resourceType
58
67
  * @param {ResourceParams} params
59
68
  * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
60
69
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAEnC,yEAAsC;AAItC,MAAqB,OAAQ,SAAQ,qBAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC;;AArEL,0BAsEC"}
1
+ {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAEnC,yEAAsC;AAItC,MAAqB,OAAQ,SAAQ,qBAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,YAAY,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC;;AAjFL,0BAkFC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=HostedInterfaceVersionsCore.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"HostedInterfaceVersionsCore.js","sourceRoot":"","sources":["../../../../src/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.ts"],"names":[],"mappings":""}
@@ -1,2 +1,3 @@
1
1
  export * from './HostedInterfaceCoreConfig.model.js';
2
+ export * from './HostedInterfaceVersionsCore.js';
2
3
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/HostedInterfacesCore/index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/HostedInterfacesCore/index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC"}
@@ -18,5 +18,17 @@ export default class InsightPanelInterface extends Resource {
18
18
  const { id, ...body } = ipInterfaceConfig;
19
19
  return this.api.put(`${InsightPanelInterface.baseUrl}/${id}`, body);
20
20
  }
21
+ listVersions(insightPanelInterfaceId, options) {
22
+ return this.api.get(this.buildPath(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions`, options));
23
+ }
24
+ getVersion(insightPanelInterfaceId, versionNumber) {
25
+ return this.api.get(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions/${versionNumber}`);
26
+ }
27
+ restoreVersion(insightPanelInterfaceId, versionNumber, body) {
28
+ return this.api.post(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions/${versionNumber}/restore`, body);
29
+ }
30
+ updateVersionLabel(insightPanelInterfaceId, versionNumber, body) {
31
+ return this.api.put(`${InsightPanelInterface.baseUrl}/${insightPanelInterfaceId}/versions/${versionNumber}/label`, body);
32
+ }
21
33
  }
22
34
  //# sourceMappingURL=InsightPanelInterface.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"InsightPanelInterface.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAGnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAMtC,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,QAAQ;IACvD,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,iCAAiC,CAAC;IAE5F,IAAI,CAAC,OAAoC;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CACzD,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAsE;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqC,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,uBAA+B;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,GAAG,CAAC,uBAA+B;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAChE,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAiE;QACpE,MAAM,EAAC,EAAE,EAAE,GAAG,IAAI,EAAC,GAAG,iBAAiB,CAAC;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,EAAE,EAAE,EACxC,IAAI,CACP,CAAC;IACN,CAAC"}
1
+ {"version":3,"file":"InsightPanelInterface.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAQnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAOtC,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,QAAQ;IACvD,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,iCAAiC,CAAC;IAE5F,IAAI,CAAC,OAAoC;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CACzD,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAsE;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqC,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,uBAA+B;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,GAAG,CAAC,uBAA+B;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,EAAE,CAChE,CAAC;IACN,CAAC;IAED,MAAM,CAAC,iBAAiE;QACpE,MAAM,EAAC,EAAE,EAAE,GAAG,IAAI,EAAC,GAAG,iBAAiB,CAAC;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,EAAE,EAAE,EACxC,IAAI,CACP,CAAC;IACN,CAAC;IAED,YAAY,CAAC,uBAA+B,EAAE,OAA0C;QACpF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,WAAW,EAAE,OAAO,CAAC,CAClG,CAAC;IACN,CAAC;IAED,UAAU,CAAC,uBAA+B,EAAE,aAAqB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,aAAa,aAAa,EAAE,CAC1F,CAAC;IACN,CAAC;IAED,cAAc,CAAC,uBAA+B,EAAE,aAAqB,EAAE,IAAmC;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,aAAa,aAAa,UAAU,EAC/F,IAAI,CACP,CAAC;IACN,CAAC;IAED,kBAAkB,CACd,uBAA+B,EAC/B,aAAqB,EACrB,IAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,qBAAqB,CAAC,OAAO,IAAI,uBAAuB,aAAa,aAAa,QAAQ,EAC7F,IAAI,CACP,CAAC;IACN,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"InsightPanelInterface.model.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.model.ts"],"names":[],"mappings":"AAaA,MAAM,CAAN,IAAY,gCAGX;AAHD,WAAY,gCAAgC;IACxC,uDAAmB,CAAA;IACnB,2DAAuB,CAAA;AAC3B,CAAC,EAHW,gCAAgC,KAAhC,gCAAgC,QAG3C"}
1
+ {"version":3,"file":"InsightPanelInterface.model.js","sourceRoot":"","sources":["../../../../src/resources/InsightPanelInterfaces/InsightPanelInterface.model.ts"],"names":[],"mappings":"AAeA,MAAM,CAAN,IAAY,gCAGX;AAHD,WAAY,gCAAgC;IACxC,uDAAmB,CAAA;IACnB,2DAAuB,CAAA;AAC3B,CAAC,EAHW,gCAAgC,KAAhC,gCAAgC,QAG3C"}
@@ -47,11 +47,20 @@ export default class Project extends Resource {
47
47
  delete(projectId) {
48
48
  return this.api.delete(this.buildPath(`${Project.baseUrl}/${projectId}`));
49
49
  }
50
+ /**
51
+ * Returns resource IDs grouped by resource status, for a given project.
52
+ *
53
+ * @param {string} projectId
54
+ * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
55
+ */
56
+ listResourcesByStatus(projectId) {
57
+ return this.api.get(this.buildPath(`${Project.baseUrl}/${projectId}/resources`));
58
+ }
50
59
  /**
51
60
  * Returns a paginated list of resources associated to a project.
52
61
  *
53
- * @param projectId
54
- * @param resourceType
62
+ * @param {string} projectId
63
+ * @param {ProjectResourceType} resourceType
55
64
  * @param {ResourceParams} params
56
65
  * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
57
66
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAItC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC"}
1
+ {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAItC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,YAAY,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC"}
@@ -130,7 +130,7 @@ export interface HostedInterfaceConfiguration {
130
130
  */
131
131
  id: string;
132
132
  /**
133
- * The name of the insight panel interface configuration.
133
+ * The name of the interface configuration.
134
134
  */
135
135
  name: string;
136
136
  /**
@@ -0,0 +1,121 @@
1
+ import { Paginated } from '../BaseInterfaces.js';
2
+ export interface HostedInterfaceChangeInfo {
3
+ /**
4
+ * The change date and time in ISO-8601 format.
5
+ */
6
+ date: string;
7
+ /**
8
+ * The user identity in the following form: `user@domain-provider`.
9
+ */
10
+ by: string;
11
+ /**
12
+ * The user's first name specified in the provider's user profile (e.g., the Google account).
13
+ */
14
+ firstName?: string;
15
+ /**
16
+ * The user's last name specified in the provider's user profile (e.g., the Google account).
17
+ */
18
+ lastName?: string;
19
+ }
20
+ export interface HostedInterfaceVersionInfo {
21
+ /**
22
+ * The version number.
23
+ */
24
+ version: number;
25
+ /**
26
+ * The optional version label.
27
+ */
28
+ label?: string;
29
+ /**
30
+ * The version creation information.
31
+ */
32
+ created: HostedInterfaceChangeInfo;
33
+ /**
34
+ * The version update information.
35
+ */
36
+ updated: HostedInterfaceChangeInfo;
37
+ /**
38
+ * Indicates whether the version is currently published.
39
+ */
40
+ isPublished: boolean;
41
+ }
42
+ /**
43
+ * @param <T> - Hosted interface config model
44
+ */
45
+ export interface HostedInterfaceVersion<T> {
46
+ /**
47
+ * The version number.
48
+ */
49
+ version: number;
50
+ /**
51
+ * The optional version label.
52
+ */
53
+ label?: string;
54
+ /**
55
+ * The version creation information.
56
+ */
57
+ created: HostedInterfaceChangeInfo;
58
+ /**
59
+ * The version update information.
60
+ */
61
+ updated: HostedInterfaceChangeInfo;
62
+ /**
63
+ * Indicates whether the version is currently published.
64
+ */
65
+ isPublished: boolean;
66
+ /**
67
+ * This version's interface config.
68
+ */
69
+ configuration: T;
70
+ /**
71
+ * When an interface is restored, indicates the source version number.
72
+ */
73
+ restoredFromVersion?: number;
74
+ }
75
+ export interface ListHostedInterfaceVersionsParams extends Paginated {
76
+ /**
77
+ * The zero-based page to retrieve.
78
+ *
79
+ * @default `0`
80
+ */
81
+ page?: number;
82
+ /**
83
+ * The number of versions to return per page.
84
+ *
85
+ * @default `10`
86
+ */
87
+ perPage?: number;
88
+ /**
89
+ * A substring that must appear in a version label for this configuration to appear in results.
90
+ */
91
+ filter?: string;
92
+ /**
93
+ * The sort order to apply on the interface version number.
94
+ *
95
+ * **Allowed values:**
96
+ * - `undefined`: Configurations are returned in no specific order.
97
+ * - `asc`: Sort version by number in ascending order.
98
+ * - `desc`: Sort version by number in descending order.
99
+ *
100
+ * @default `undefined`
101
+ */
102
+ order?: 'asc' | 'desc';
103
+ }
104
+ export interface UpdateVersionedHostedInterfaceExtraParams {
105
+ /**
106
+ * The label to describe this particular interface version being created.
107
+ */
108
+ versionLabel?: string;
109
+ }
110
+ export interface UpdateInterfaceVersionLabelParams {
111
+ /**
112
+ * The optional version label.
113
+ */
114
+ label?: string;
115
+ }
116
+ export interface RestoreInterfaceVersionParams {
117
+ /**
118
+ * The optional version label.
119
+ */
120
+ label?: string;
121
+ }
@@ -1 +1,2 @@
1
1
  export * from './HostedInterfaceCoreConfig.model.js';
2
+ export * from './HostedInterfaceVersionsCore.js';
@@ -1,7 +1,7 @@
1
1
  import { New, PageModel } from '../BaseInterfaces.js';
2
- import { ListHostedInterfacesParams } from '../HostedInterfacesCore/index.js';
2
+ import { ListHostedInterfaceVersionsParams, ListHostedInterfacesParams, RestoreInterfaceVersionParams, UpdateInterfaceVersionLabelParams } from '../HostedInterfacesCore/index.js';
3
3
  import Resource from '../Resource.js';
4
- import { InsightPanelInterfaceConfiguration, InsightPanelInterfaceConfigurationUpdateParams } from './InsightPanelInterface.model.js';
4
+ import { InsightPanelInterfaceConfiguration, InsightPanelInterfaceConfigurationUpdateParams, InsightPanelInterfaceVersion } from './InsightPanelInterface.model.js';
5
5
  export default class InsightPanelInterface extends Resource {
6
6
  static baseUrl: string;
7
7
  list(options?: ListHostedInterfacesParams): Promise<PageModel<InsightPanelInterfaceConfiguration>>;
@@ -9,4 +9,8 @@ export default class InsightPanelInterface extends Resource {
9
9
  delete(insightPanelInterfaceId: string): Promise<Record<string, unknown>>;
10
10
  get(insightPanelInterfaceId: string): Promise<InsightPanelInterfaceConfiguration>;
11
11
  update(ipInterfaceConfig: InsightPanelInterfaceConfigurationUpdateParams): Promise<InsightPanelInterfaceConfigurationUpdateParams>;
12
+ listVersions(insightPanelInterfaceId: string, options: ListHostedInterfaceVersionsParams): Promise<PageModel<InsightPanelInterfaceVersion>>;
13
+ getVersion(insightPanelInterfaceId: string, versionNumber: number): Promise<InsightPanelInterfaceVersion>;
14
+ restoreVersion(insightPanelInterfaceId: string, versionNumber: number, body: RestoreInterfaceVersionParams): Promise<InsightPanelInterfaceConfiguration>;
15
+ updateVersionLabel(insightPanelInterfaceId: string, versionNumber: number, body: UpdateInterfaceVersionLabelParams): Promise<InsightPanelInterfaceConfiguration>;
12
16
  }
@@ -1,5 +1,5 @@
1
1
  import { WithOptional } from '../BaseInterfaces.js';
2
- import { HostedInterfaceCondition, HostedInterfaceConfiguration, HostedInterfaceFacet, HostedInterfaceOption, HostedInterfaceResultTemplate, HostedInterfaceResultTemplateBadge, HostedInterfaceResultTemplateDetail, HostedInterfaceTab, ListHostedInterfacesParams } from '../HostedInterfacesCore/index.js';
2
+ import { HostedInterfaceCondition, HostedInterfaceConfiguration, HostedInterfaceFacet, HostedInterfaceOption, HostedInterfaceResultTemplate, HostedInterfaceResultTemplateBadge, HostedInterfaceResultTemplateDetail, HostedInterfaceTab, HostedInterfaceVersion, ListHostedInterfacesParams, UpdateVersionedHostedInterfaceExtraParams } from '../HostedInterfacesCore/index.js';
3
3
  export declare enum InsightPanelResultTemplateLayout {
4
4
  Default = "default",
5
5
  Thumbnail = "thumbnail"
@@ -128,6 +128,10 @@ export interface InsightPanelSettings {
128
128
  * An option enabling the use of smart snippets.
129
129
  */
130
130
  smartSnippets: InsightPanelOption;
131
+ /**
132
+ * Indicates whether dynamic facet navigation is disabled.
133
+ */
134
+ disableDynamicNavigation: InsightPanelOption;
131
135
  }
132
136
  export interface InsightPanelInterfaceConfiguration extends HostedInterfaceConfiguration {
133
137
  /**
@@ -146,13 +150,20 @@ export interface InsightPanelInterfaceConfiguration extends HostedInterfaceConfi
146
150
  * The insight panel settings.
147
151
  */
148
152
  settings: InsightPanelSettings;
153
+ /**
154
+ * This config's published version.
155
+ * This is usually the latest version.
156
+ */
157
+ publishedVersion?: number;
149
158
  }
150
159
  export interface IListInsightPanelInterfacesParameters extends ListHostedInterfacesParams {
151
160
  }
152
- export interface InsightPanelInterfaceConfigurationUpdateParams extends Omit<InsightPanelInterfaceConfiguration, 'settings'> {
161
+ export interface InsightPanelInterfaceConfigurationUpdateParams extends Omit<InsightPanelInterfaceConfiguration, 'settings' | 'publishedVersion'>, UpdateVersionedHostedInterfaceExtraParams {
153
162
  /**
154
163
  * The insight panel settings.
155
164
  */
156
- settings: WithOptional<InsightPanelSettings, 'smartSnippets'>;
165
+ settings: WithOptional<InsightPanelSettings, 'smartSnippets' | 'disableDynamicNavigation'>;
166
+ }
167
+ export interface InsightPanelInterfaceVersion extends HostedInterfaceVersion<InsightPanelInterfaceConfiguration> {
157
168
  }
158
169
  export {};
@@ -1,6 +1,6 @@
1
1
  import { PageModel } from '../BaseInterfaces.js';
2
2
  import Resource from '../Resource.js';
3
- import { ResourceModel, ResourceParams } from '../Resources/index.js';
3
+ import { ResourceModel, ResourceParams, ResourceStatus } from '../Resources/index.js';
4
4
  import { ListProjectParams, ProjectModel, BaseProjectModel, ProjectResourceType } from './ProjectInterfaces.js';
5
5
  export default class Project extends Resource {
6
6
  static baseUrl: string;
@@ -39,11 +39,18 @@ export default class Project extends Resource {
39
39
  * @param {string} projectId
40
40
  */
41
41
  delete(projectId: string): Promise<void>;
42
+ /**
43
+ * Returns resource IDs grouped by resource status, for a given project.
44
+ *
45
+ * @param {string} projectId
46
+ * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
47
+ */
48
+ listResourcesByStatus(projectId: string): Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>;
42
49
  /**
43
50
  * Returns a paginated list of resources associated to a project.
44
51
  *
45
- * @param projectId
46
- * @param resourceType
52
+ * @param {string} projectId
53
+ * @param {ProjectResourceType} resourceType
47
54
  * @param {ResourceParams} params
48
55
  * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
49
56
  */
@@ -1,4 +1,5 @@
1
1
  import { Paginated } from '../BaseInterfaces.js';
2
+ export type ResourceStatus = 'existingResources' | 'deletedResources';
2
3
  export interface ResourceModel {
3
4
  /**
4
5
  * The unique identifier of a resource within a project
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "48.1.0",
3
+ "version": "48.3.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {
@@ -32,8 +32,8 @@
32
32
  "prepare": "husky install"
33
33
  },
34
34
  "devDependencies": {
35
- "@commitlint/cli": "17.7.2",
36
- "@commitlint/config-conventional": "17.7.0",
35
+ "@commitlint/cli": "17.8.0",
36
+ "@commitlint/config-conventional": "17.8.0",
37
37
  "@types/jest": "29.5.5",
38
38
  "@typescript-eslint/eslint-plugin": "6.7.5",
39
39
  "@typescript-eslint/parser": "6.7.5",
@@ -48,7 +48,7 @@
48
48
  "jest": "29.7.0",
49
49
  "jest-fetch-mock": "3.0.3",
50
50
  "jest-runner-eslint": "2.1.2",
51
- "lint-staged": "14.0.1",
51
+ "lint-staged": "15.0.1",
52
52
  "prettier": "3.0.3",
53
53
  "semantic-release": "22.0.5",
54
54
  "ts-jest": "29.1.1",