@coveo/platform-client 35.1.0 → 35.3.0

package/dist/definitions/resources/Activities/Activities.d.ts

@@ -3,9 +3,11 @@ import Resource from '../Resource';
 import { ActivityModel, ListActivitiesParams, ListActivitiesFacetsParams, ActivityFacetModel, ActivityListingFilters } from './ActivitiesInterfaces';
 export default class Activity extends Resource {
     static getBaseUrl: () => string;
+    static getBaseUrlAllOrgs: () => string;
     get(activityId: string): Promise<ActivityModel>;
     getResourceTypes(): Promise<string[]>;
     list(params?: ListActivitiesParams, activityFacet?: ActivityListingFilters): Promise<PageModel<ActivityModel, "items">>;
     listFacets(params?: ListActivitiesFacetsParams, activityFacet?: ActivityListingFilters): Promise<ActivityFacetModel>;
+    listAll(params?: ListActivitiesParams, activityFacet?: ActivityListingFilters): Promise<PageModel<ActivityModel, "items">>;
     abortActivity(activityId: string, abortActivityModel: ActivityModel): Promise<Record<string, unknown>>;
 }

package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts

@@ -79,7 +79,8 @@ export declare enum ResourceSnapshotsReportResultCode {
     NoResourceRetrieved = "NO_RESOURCE_RETRIEVED",
     UnableToRetrieveResources = "UNABLE_TO_RETRIEVE_RESOURCES",
     ResourceDependencyCyle = "RESOURCE_DEPENDENCY_CYCLE",
-    ExternalServiceCommunicationError = "EXTERNAL_SERVICE_COMMUNICATION_ERROR"
+    ExternalServiceCommunicationError = "EXTERNAL_SERVICE_COMMUNICATION_ERROR",
+    AutoSynchronizationFailure = "AUTO_SYNCHRONIZATION_FAILURE"
 }
 export declare enum ResourceSnapshotsReportStatus {
     Pending = "PENDING",
@@ -144,7 +145,33 @@ export interface ResourceSnapshotsReportOperationResult {
     message: string;
 }
 export declare type ResourceSnapshotsReportOperationResults = Record<string, ResourceSnapshotsReportOperationResult[]>;
+export declare enum SnapshotsReportStages {
+    COMPUTING_OPERATIONS = "COMPUTING_OPERATIONS",
+    CREATING_SNAPSHOT = "CREATING_SNAPSHOT",
+    INITIAL_PROCESSING = "INITIAL_PROCESSING",
+    PERFORMING_OPERATIONS = "PERFORMING_OPERATIONS",
+    SYNCHRONIZING = "SYNCHRONIZING",
+    VALIDATING_OPERATIONS = "VALIDATING_OPERATIONS"
+}
 export interface ResourceSnapshotsReportModel {
+    /**
+     * Current stage of the report
+     */
+    currentStage?: {
+        /**
+         * The progress type of the current step
+         */
+        progressType: 'BINARY' | 'PERCENTAGE';
+        /**
+         * The progress value of the current step
+         * The value can be percentage type (from 0 to 100) binary type (0 or 1)
+         */
+        progressValue: number;
+        /**
+         * Current step name
+         */
+        stage: SnapshotsReportStages;
+    };
     /**
      * The unique identifier of the report.
      */
@@ -165,6 +192,14 @@ export interface ResourceSnapshotsReportModel {
      * The result code of the snapshot event, if applicable.
      */
     resultCode: ResourceSnapshotsReportResultCode;
+    /**
+     * The ordered stages the migration operation has to go through in order to complete.
+     */
+    stagesToExecute: SnapshotsReportStages[];
+    /**
+     * The start date ot the report in number of milliseconds since UNIX epoch.
+     */
+    startDate: number;
     /**
      * The status of the snapshot.
      */

package/dist/resources/Activities/Activities.js

@@ -20,10 +20,14 @@ var Activity = /** @class */ (function (_super) {
     Activity.prototype.listFacets = function (params, activityFacet) {
         return this.api.post(this.buildPath("".concat(Activity.getBaseUrl(), "/facets/public"), params), activityFacet);
     };
+    Activity.prototype.listAll = function (params, activityFacet) {
+        return this.api.post(this.buildPath(Activity.getBaseUrlAllOrgs(), params), activityFacet);
+    };
     Activity.prototype.abortActivity = function (activityId, abortActivityModel) {
         return this.api.post("".concat(Activity.getBaseUrl(), "/").concat(activityId, "/abort"), abortActivityModel);
     };
     Activity.getBaseUrl = function () { return "/rest/organizations/".concat(APICore_1.default.orgPlaceholder, "/activities"); };
+    Activity.getBaseUrlAllOrgs = function () { return "/rest/activities"; };
     return Activity;
 }(Resource_1.default));
 exports.default = Activity;

package/dist/resources/Activities/Activities.js.map

@@ -1 +1 @@
-{"version":3,"file":"Activities.js","sourceRoot":"","sources":["../../../src/resources/Activities/Activities.ts"],"names":[],"mappings":";;;AAAA,kEAAgC;AAEhC,iEAAmC;AASnC;IAAsC,oCAAQ;IAA9C;;IA2BA,CAAC;IAxBG,sBAAG,GAAH,UAAI,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,CAAE,CAAC,CAAC;IACjF,CAAC;IACD,mCAAgB,GAAhB;QACI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAW,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,CAAC,CAAC;IAC5E,CAAC;IAED,uBAAI,GAAJ,UAAK,MAA6B,EAAE,aAAsC;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,YAAS,EAAE,MAAM,CAAC,EACzD,aAAa,CAChB,CAAC;IACN,CAAC;IAED,6BAAU,GAAV,UAAW,MAAmC,EAAE,aAAsC;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,EAAE,MAAM,CAAC,EAChE,aAAa,CAChB,CAAC;IACN,CAAC;IAED,gCAAa,GAAb,UAAc,UAAkB,EAAE,kBAAiC;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,WAAQ,EAAE,kBAAkB,CAAC,CAAC;IAC7F,CAAC;IAzBM,mBAAU,GAAG,cAAM,OAAA,8BAAuB,iBAAG,CAAC,cAAc,gBAAa,EAAtD,CAAsD,CAAC;IA0BrF,eAAC;CAAA,AA3BD,CAAsC,kBAAQ,GA2B7C;kBA3BoB,QAAQ"}
+{"version":3,"file":"Activities.js","sourceRoot":"","sources":["../../../src/resources/Activities/Activities.ts"],"names":[],"mappings":";;;AAAA,kEAAgC;AAEhC,iEAAmC;AASnC;IAAsC,oCAAQ;IAA9C;;IAmCA,CAAC;IA/BG,sBAAG,GAAH,UAAI,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,CAAE,CAAC,CAAC;IACjF,CAAC;IACD,mCAAgB,GAAhB;QACI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAW,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,CAAC,CAAC;IAC5E,CAAC;IAED,uBAAI,GAAJ,UAAK,MAA6B,EAAE,aAAsC;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,YAAS,EAAE,MAAM,CAAC,EACzD,aAAa,CAChB,CAAC;IACN,CAAC;IAED,6BAAU,GAAV,UAAW,MAAmC,EAAE,aAAsC;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,EAAE,MAAM,CAAC,EAChE,aAAa,CAChB,CAAC;IACN,CAAC;IAED,0BAAO,GAAP,UAAQ,MAA6B,EAAE,aAAsC;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,EAAE,MAAM,CAAC,EACpD,aAAa,CAChB,CAAC;IACN,CAAC;IAED,gCAAa,GAAb,UAAc,UAAkB,EAAE,kBAAiC;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,WAAQ,EAAE,kBAAkB,CAAC,CAAC;IAC7F,CAAC;IAjCM,mBAAU,GAAG,cAAM,OAAA,8BAAuB,iBAAG,CAAC,cAAc,gBAAa,EAAtD,CAAsD,CAAC;IAC1E,0BAAiB,GAAG,cAAM,OAAA,kBAAkB,EAAlB,CAAkB,CAAC;IAiCxD,eAAC;CAAA,AAnCD,CAAsC,kBAAQ,GAmC7C;kBAnCoB,QAAQ"}

package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplyOptionsDeletionScope = exports.ResourceSnapshotContentType = exports.ResourceSnapshotSupportedFileTypes = exports.ResourceSnapshotsReportType = exports.ResourceSnapshotsSynchronizationPlanStatus = exports.ResourceSnapshotsReportStatus = exports.ResourceSnapshotsReportResultCode = exports.SnapshotExportContentFormat = exports.SnapshotAccessType = exports.ResourceSnapshotType = void 0;
+exports.ApplyOptionsDeletionScope = exports.SnapshotsReportStages = exports.ResourceSnapshotContentType = exports.ResourceSnapshotSupportedFileTypes = exports.ResourceSnapshotsReportType = exports.ResourceSnapshotsSynchronizationPlanStatus = exports.ResourceSnapshotsReportStatus = exports.ResourceSnapshotsReportResultCode = exports.SnapshotExportContentFormat = exports.SnapshotAccessType = exports.ResourceSnapshotType = void 0;
 /*
  * 'Resource' is defined as anything uniquely identified on the platform's domain that can be created, updated or deleted
  */
@@ -47,6 +47,7 @@ var ResourceSnapshotsReportResultCode;
     ResourceSnapshotsReportResultCode["UnableToRetrieveResources"] = "UNABLE_TO_RETRIEVE_RESOURCES";
     ResourceSnapshotsReportResultCode["ResourceDependencyCyle"] = "RESOURCE_DEPENDENCY_CYCLE";
     ResourceSnapshotsReportResultCode["ExternalServiceCommunicationError"] = "EXTERNAL_SERVICE_COMMUNICATION_ERROR";
+    ResourceSnapshotsReportResultCode["AutoSynchronizationFailure"] = "AUTO_SYNCHRONIZATION_FAILURE";
 })(ResourceSnapshotsReportResultCode = exports.ResourceSnapshotsReportResultCode || (exports.ResourceSnapshotsReportResultCode = {}));
 var ResourceSnapshotsReportStatus;
 (function (ResourceSnapshotsReportStatus) {
@@ -79,6 +80,15 @@ var ResourceSnapshotContentType;
     ResourceSnapshotContentType["PRIMARY"] = "PRIMARY";
     ResourceSnapshotContentType["CURRENT_STATE"] = "CURRENT_STATE";
 })(ResourceSnapshotContentType = exports.ResourceSnapshotContentType || (exports.ResourceSnapshotContentType = {}));
+var SnapshotsReportStages;
+(function (SnapshotsReportStages) {
+    SnapshotsReportStages["COMPUTING_OPERATIONS"] = "COMPUTING_OPERATIONS";
+    SnapshotsReportStages["CREATING_SNAPSHOT"] = "CREATING_SNAPSHOT";
+    SnapshotsReportStages["INITIAL_PROCESSING"] = "INITIAL_PROCESSING";
+    SnapshotsReportStages["PERFORMING_OPERATIONS"] = "PERFORMING_OPERATIONS";
+    SnapshotsReportStages["SYNCHRONIZING"] = "SYNCHRONIZING";
+    SnapshotsReportStages["VALIDATING_OPERATIONS"] = "VALIDATING_OPERATIONS";
+})(SnapshotsReportStages = exports.SnapshotsReportStages || (exports.SnapshotsReportStages = {}));
 var ApplyOptionsDeletionScope;
 (function (ApplyOptionsDeletionScope) {
     ApplyOptionsDeletionScope["AllManagedResources"] = "ALL_MANAGED_RESOURCES";

package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"ResourceSnapshotsInterfaces.js","sourceRoot":"","sources":["../../../src/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,oBAoBX;AApBD,WAAY,oBAAoB;IAC5B,+CAAuB,CAAA;IACvB,0DAAkC,CAAA;IAClC,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,4CAAoB,CAAA;IACpB,mEAA2C,CAAA;IAC3C,0DAAkC,CAAA;IAClC,wDAAgC,CAAA;IAChC,2EAAmD,CAAA;IACnD,gEAAwC,CAAA;IACxC,wDAAgC,CAAA;IAChC,kDAA0B,CAAA;IAC1B,8DAAsC,CAAA;IACtC,yCAAiB,CAAA;IACjB,8CAAsB,CAAA;IACtB,qDAA6B,CAAA;IAC7B,+CAAuB,CAAA;IACvB,2CAAmB,CAAA;AACvB,CAAC,EApBW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAoB/B;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,qCAAe,CAAA;AACnB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,4CAAa,CAAA;IACb,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AAED,IAAY,iCAUX;AAVD,WAAY,iCAAiC;IACzC,mEAA8B,CAAA;IAC9B,4EAAuC,CAAA;IACvC,wDAAmB,CAAA;IACnB,yEAAoC,CAAA;IACpC,kGAA6D,CAAA;IAC7D,kFAA6C,CAAA;IAC7C,+FAA0D,CAAA;IAC1D,yFAAoD,CAAA;IACpD,+GAA0E,CAAA;AAC9E,CAAC,EAVW,iCAAiC,GAAjC,yCAAiC,KAAjC,yCAAiC,QAU5C;AAED,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACrC,oDAAmB,CAAA;IACnB,2DAA0B,CAAA;IAC1B,wDAAuB,CAAA;IACvB,oDAAmB,CAAA;AACvB,CAAC,EALW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAKxC;AAED,IAAY,0CAIX;AAJD,WAAY,0CAA0C;IAClD,mEAAqB,CAAA;IACrB,iEAAmB,CAAA;IACnB,kEAAoB,CAAA;AACxB,CAAC,EAJW,0CAA0C,GAA1C,kDAA0C,KAA1C,kDAA0C,QAIrD;AAED,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACnC,iEAAkC,CAAA;IAClC,iDAAkB,CAAA;IAClB,8CAAe,CAAA;IACf,wFAAyD,CAAA;IACzD,sFAAuD,CAAA;AAC3D,CAAC,EANW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAMtC;AAED,IAAY,kCAGX;AAHD,WAAY,kCAAkC;IAC1C,iDAAW,CAAA;IACX,mDAAa,CAAA;AACjB,CAAC,EAHW,kCAAkC,GAAlC,0CAAkC,KAAlC,0CAAkC,QAG7C;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,kDAAmB,CAAA;IACnB,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AAwLD,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,0EAA6C,CAAA;IAC7C,+EAAkD,CAAA;AACtD,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC"}
+{"version":3,"file":"ResourceSnapshotsInterfaces.js","sourceRoot":"","sources":["../../../src/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,oBAoBX;AApBD,WAAY,oBAAoB;IAC5B,+CAAuB,CAAA;IACvB,0DAAkC,CAAA;IAClC,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,4CAAoB,CAAA;IACpB,mEAA2C,CAAA;IAC3C,0DAAkC,CAAA;IAClC,wDAAgC,CAAA;IAChC,2EAAmD,CAAA;IACnD,gEAAwC,CAAA;IACxC,wDAAgC,CAAA;IAChC,kDAA0B,CAAA;IAC1B,8DAAsC,CAAA;IACtC,yCAAiB,CAAA;IACjB,8CAAsB,CAAA;IACtB,qDAA6B,CAAA;IAC7B,+CAAuB,CAAA;IACvB,2CAAmB,CAAA;AACvB,CAAC,EApBW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAoB/B;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,qCAAe,CAAA;AACnB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,4CAAa,CAAA;IACb,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AAED,IAAY,iCAWX;AAXD,WAAY,iCAAiC;IACzC,mEAA8B,CAAA;IAC9B,4EAAuC,CAAA;IACvC,wDAAmB,CAAA;IACnB,yEAAoC,CAAA;IACpC,kGAA6D,CAAA;IAC7D,kFAA6C,CAAA;IAC7C,+FAA0D,CAAA;IAC1D,yFAAoD,CAAA;IACpD,+GAA0E,CAAA;IAC1E,gGAA2D,CAAA;AAC/D,CAAC,EAXW,iCAAiC,GAAjC,yCAAiC,KAAjC,yCAAiC,QAW5C;AAED,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACrC,oDAAmB,CAAA;IACnB,2DAA0B,CAAA;IAC1B,wDAAuB,CAAA;IACvB,oDAAmB,CAAA;AACvB,CAAC,EALW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAKxC;AAED,IAAY,0CAIX;AAJD,WAAY,0CAA0C;IAClD,mEAAqB,CAAA;IACrB,iEAAmB,CAAA;IACnB,kEAAoB,CAAA;AACxB,CAAC,EAJW,0CAA0C,GAA1C,kDAA0C,KAA1C,kDAA0C,QAIrD;AAED,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACnC,iEAAkC,CAAA;IAClC,iDAAkB,CAAA;IAClB,8CAAe,CAAA;IACf,wFAAyD,CAAA;IACzD,sFAAuD,CAAA;AAC3D,CAAC,EANW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAMtC;AAED,IAAY,kCAGX;AAHD,WAAY,kCAAkC;IAC1C,iDAAW,CAAA;IACX,mDAAa,CAAA;AACjB,CAAC,EAHW,kCAAkC,GAAlC,0CAAkC,KAAlC,0CAAkC,QAG7C;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,kDAAmB,CAAA;IACnB,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AA0CD,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC7B,sEAA6C,CAAA;IAC7C,gEAAuC,CAAA;IACvC,kEAAyC,CAAA;IACzC,wEAA+C,CAAA;IAC/C,wDAA+B,CAAA;IAC/B,wEAA+C,CAAA;AACnD,CAAC,EAPW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAOhC;AA0KD,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,0EAA6C,CAAA;IAC7C,+EAAkD,CAAA;AACtD,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "35.1.0",
+    "version": "35.3.0",
     "description": "",
     "main": "dist/Entry.js",
     "types": "dist/definitions/Entry.d.ts",
@@ -26,18 +26,18 @@
     "devDependencies": {
         "@commitlint/cli": "17.1.2",
         "@commitlint/config-conventional": "17.1.0",
-        "@types/jest": "29.1.2",
-        "@typescript-eslint/eslint-plugin": "5.40.0",
-        "@typescript-eslint/parser": "5.40.0",
+        "@types/jest": "29.2.0",
+        "@typescript-eslint/eslint-plugin": "5.40.1",
+        "@typescript-eslint/parser": "5.40.1",
         "abortcontroller-polyfill": "1.7.5",
         "cz-conventional-changelog": "3.3.0",
         "eslint": "8.25.0",
         "eslint-config-prettier": "8.5.0",
         "eslint-config-typescript": "3.0.0",
-        "eslint-plugin-jest": "27.1.1",
+        "eslint-plugin-jest": "27.1.2",
         "eslint-plugin-prettier": "4.2.1",
         "husky": "8.0.1",
-        "jest": "29.1.2",
+        "jest": "29.2.1",
         "jest-fetch-mock": "3.0.3",
         "jest-runner-eslint": "1.1.0",
         "lint-staged": "13.0.3",