@coveo/platform-client 37.9.0 → 37.11.0

package/README.md

@@ -263,18 +263,4 @@ ExperimentalPlatformClient.something.list();
 
 ## Contributing
 
-### Guidelines
-
--   Make sure your changes are fully tested (when applicable).
--   We tend to avoid comments in our code base, we strongly prefer good naming and code structure.
--   Avoid pushing similar changes in different commits if it's within the same feature, because we want the changelogs to be clear and simple. To avoid that, there are at least 2 options:
-    1. Squash the commits into one when merging (you need to edit the final commit message though)
-    1. amend the previous commit when making related changes (`git commit --amend --no-edit`)
-
-### Commit messages
-
-**Every commit message must comply with the [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format) specification. We use the commit messages to automatically bump the package version according to the semantic versionning notation. Moreover, we generate changlogs for each version using those commit messages.**
-
--   You can either manually write a commit message that follows the convention using your favorite method.
--   Or you can run `npm run commit-cli`. It will prompt you some questions about the nature of your changes, then it will commit your staged changes along with a generated message that follows our convention.
--   Commits containing breaking changes need to be marked as such in the commit footer. See [BREAKING CHANGE convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-footer).
+See [CONTRIBUTING.md](./CONTRIBUTING.md)

package/dist/APICore.js

@@ -13,6 +13,9 @@ var API = /** @class */ (function () {
     }
     Object.defineProperty(API.prototype, "organizationId", {
         get: function () {
+            if (this.config.organizationId === undefined) {
+                throw new Error('No organization ID found in the config.');
+            }
             return (0, Retriever_1.default)(this.config.organizationId);
         },
         enumerable: false,
@@ -34,7 +37,7 @@ var API = /** @class */ (function () {
                     case 3:
                         error_1 = _a.sent();
                         if (error_1.name === 'AbortError') {
-                            return [2 /*return*/]; // We don't want to resolve or reject the promise
+                            return [2 /*return*/, undefined]; // We don't want to resolve or reject the promise
                         }
                         else {
                             throw error_1;
@@ -61,7 +64,8 @@ var API = /** @class */ (function () {
                     case 3:
                         error_2 = _a.sent();
                         if (error_2.name === 'AbortError') {
-                            return [2 /*return*/]; // We don't want to resolve or reject the promise
+                            // We don't want to resolve or reject the promise
+                            return [2 /*return*/, undefined];
                         }
                         else {
                             throw error_2;

package/dist/APICore.js.map

@@ -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;yBAC5D;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,sBAAO,CAAC,iDAAiD;yBAC5D;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;IArKM,kBAAc,GAAG,oBAAoB,CAAC;IAsKjD,UAAC;CAAA,AAvKD,IAuKC;kBAvKoB,GAAG"}
+{"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"}

package/dist/definitions/APICore.d.ts

@@ -6,7 +6,7 @@ export default class API {
     static orgPlaceholder: string;
     private getRequestsController;
     private tokenInfo;
-    constructor(config: PlatformClientOptions, isServerlessHost?: boolean);
+    constructor(config: PlatformClientOptions, isServerlessHost?: boolean | undefined);
     get organizationId(): string;
     get<T = Record<string, unknown>>(url: string, args?: RequestInit): Promise<T>;
     getFile(url: string, args?: RequestInit): Promise<Blob>;

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

@@ -4,7 +4,7 @@ export type PageModel<T = any, TItemsKey extends string = 'items'> = {
     totalEntries: number;
     totalPages: number;
 };
-export type New<T, K extends string | number | symbol = null> = Omit<T, 'id' | K>;
+export type New<T, K extends keyof T | null = null> = Omit<T, 'id' | NonNullable<K>>;
 export interface IdAndDisplayNameModel {
     id: string;
     displayName?: string;

package/dist/definitions/resources/Pipelines/Conditions/Condition.d.ts

@@ -3,9 +3,36 @@ import Resource from '../../Resource';
 import { ConditionModel, ListConditionsOptions, NewConditionModel } from './ConditionInterfaces';
 export default class Condition extends Resource {
     static baseUrl: string;
+    /**
+     * Returns a paginated list of condition models.
+     * @param {ListConditionsOptions} options
+     */
     list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
+    /**
+     * Creates and returns a new condition model.
+     * @param {NewConditionModel} conditionModel
+     */
     create(conditionModel: NewConditionModel): Promise<ConditionModel>;
+    /**
+     * Delete a condition model.
+     * @param {string} conditionId The unique identifier of the condition to be deleted.
+     */
     delete(conditionId: string): Promise<Record<string, unknown>>;
+    /**
+     * Returns a condition model.
+     * @param {string} conditionId The unique identifier of the condition to be fetched.
+     */
     get(conditionId: string): Promise<ConditionModel>;
+    /**
+     * Update a condition model with the model sent and returns the updated condition model.
+     * @param {string} conditionId The unique identifier of the condition to be updated.
+     * @param {ConditionModel | NewConditionModel} conditionModel
+     */
     update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
+    /**
+     * Bulk get a list of conditions corresponding of the ids sent.
+     * @param {string[]} conditionIds The list of condition's ids to be fetched. Limit of 1000 incoming ids.
+     * @param {ListConditionsOptions} params
+     */
+    bulkGet(conditionIds: string[], params?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
 }

package/dist/definitions/resources/Pipelines/Conditions/ConditionInterfaces.d.ts

@@ -1,25 +1,87 @@
 import { Paginated } from '../../BaseInterfaces';
 import { ListStatementSortBy } from '../../Enums';
 export interface ConditionModel {
+    /**
+     * The unique identifier of this statement.
+     */
     id: string;
+    /**
+     * The intented purpose of thi statement in an actual implementation.
+     */
     description: string;
+    /**
+     * The query pipeline language expression that defines this statement.
+     */
     definition: string;
+    /**
+     * The structured object of the query pipeline language expression of this statement.
+     */
     detailed: any;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     childrenCount: number;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     feature: string;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     position: number;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     ready: boolean;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     parent?: string;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     condition?: string;
 }
 export interface NewConditionModel {
+    /**
+     * The query pipeline language expression that defines this statement.
+     */
     definition: string;
+    /**
+     * The unique identifier of this statement.
+     */
     id?: string;
+    /**
+     * The intented purpose of this statement in an actual implementation.
+     */
     description?: string;
 }
 export interface ListConditionsOptions extends Paginated {
-    isOrderDescending?: boolean;
+    /**
+     * Whether to sort the results in ascending order.
+     * @default true
+     */
+    isOrderAscending?: boolean;
+    /**
+     * The query filter to match.
+     * This allows you to search within query pipeline statement definitions and descriptions.
+     * By default, results are not required to match a specific query filter.
+     */
     filter?: string;
+    /**
+     * The sort criteria to apply on the results.
+     * @default ListStatementSortBy.Position
+     */
     sortBy?: ListStatementSortBy;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     * The value set by default is provided by the API resource
+     */
     organizationId?: string;
 }

package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociations.d.ts

@@ -1,6 +1,6 @@
 import { PageModel } from '../../BaseInterfaces';
 import Resource from '../../Resource';
-import { AssociatedPipelinesData, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
+import { AssociatedPipelinesData, BulkGetAssociationsParams, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
 export default class MLAssociations extends Resource {
     static getBaseUrl: (pipelineId: string) => string;
     list(pipelineId: string, options?: ListAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
@@ -10,4 +10,5 @@ export default class MLAssociations extends Resource {
     updateAssociation(pipelineId: string, associationId: string, options?: EditAssociation): Promise<Record<string, unknown>>;
     updatePosition(pipelineId: string, associationId: string, position: number): Promise<Record<string, unknown>>;
     getAssociatedPipelines(): Promise<AssociatedPipelinesData[]>;
+    bulkGet(pipelineId: string, { ids, ...allQueryStringOptions }: BulkGetAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
 }

package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociationsInterfaces.d.ts

@@ -30,6 +30,9 @@ export interface MLAssociationModel {
 }
 export interface ListAssociationsParams extends Paginated {
 }
+export interface BulkGetAssociationsParams extends Paginated {
+    ids: string[];
+}
 export interface CreateAssociation extends EditAssociation {
     modelId: string;
 }

package/dist/definitions/resources/Pipelines/PipelinesInterfaces.d.ts

@@ -166,7 +166,7 @@ export interface PipelineModel extends PipelineShared {
     last_modified_by?: string;
     statementComposition?: {
         totalCount?: number;
-        [key: string]: number;
+        [key: string]: number | undefined;
     };
 }
 export interface NewPipelineModel extends PipelineShared, GranularResource {

package/dist/definitions/resources/UsageAnalytics/Read/Administration/Administration.d.ts

@@ -1,10 +1,21 @@
 import { RedshiftEndpointStatus } from '../../../Enums';
-import Resource from '../../../Resource';
+import ReadServiceResource from '../ReadServiceResource';
 import { AccountInfoModelV15, AccountResponseV15, StrictValidationTestParams, StrictValidationTestResponseV15 } from './AdministrationInterfaces';
-export default class Administration extends Resource {
+export default class Administration extends ReadServiceResource {
     static baseUrl: string;
+    /**
+     * Get an account.
+     */
     getAccount(): Promise<AccountResponseV15>;
+    /**
+     * Edit an account.
+     *
+     * @param model The account information.
+     */
     updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
     setRedshiftStatus(endpoint: string, status: RedshiftEndpointStatus): Promise<Record<string, unknown>>;
+    /**
+     * Get example values that would be rejected by strict validation for the specified dimension.
+     */
     getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
 }

package/dist/definitions/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.d.ts

@@ -1,3 +1,4 @@
+import { DeprecatedShortPaginatedParamParts, OrganizationParamParts, TimeRangeParamParts } from '../CommonParamParts';
 export interface AccountInfoModelV15 {
     internalEventIps: string[];
     useStrictFieldValidation: boolean;
@@ -11,11 +12,9 @@ export interface StrictValidationTestResponseV15 {
     dimensionName: string;
     validationTestResults: Array<Record<string, unknown>>;
 }
-export interface StrictValidationTestParams {
-    from: string;
-    to: string;
+export interface StrictValidationTestParams extends OrganizationParamParts, TimeRangeParamParts, DeprecatedShortPaginatedParamParts {
+    /**
+     * The dimension to fetch.
+     */
     d: string;
-    p?: number;
-    n?: number;
-    org?: string;
 }

package/dist/definitions/resources/UsageAnalytics/Read/CommonParamParts.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Almost all calls of the Read service have an optional `org` query parameter.
+ * (Notable exceptions are service status monitoring calls).
+ */
+export interface OrganizationParamParts {
+    /**
+     * The name of the organization (Coveo Cloud V2 only)
+     */
+    org?: string;
+}
+/**
+ * Required `d` parameter, encoding dimensions.
+ */
+export interface EventDimensionsParamParts {
+    /**
+     * The dimensions to fetch.
+     */
+    d: string[];
+}
+/**
+ * Optional `f` parameter, encoding dimension filters.
+ */
+export interface EventDimensionsFilterParamParts {
+    /**
+     * The filter that will be applied to the event dimensions.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    f?: string[];
+}
+/**
+ * Optional `fn` parameter, encoding dimension based exclusion filters.
+ */
+export interface EventDimensionsExcludeFilterParamParts {
+    /**
+     * The filter that will be applied to dimensions to exclude events from the results.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    fn?: string[];
+}
+/**
+ * Optional `fn` parameter, encoding dimension based event exclusion filters.
+ */
+export interface EventDimensionsHideEventsFilterParamParts {
+    /**
+     * Each specified filter is inverted in order to hide events.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    hideEventFilters?: string[];
+}
+/**
+ * Required `m` parameter, encoding metrics.
+ */
+export interface EventMetricsParamParts {
+    /**
+     * The metrics to fetch.
+     */
+    m: string[];
+}
+/**
+ * Optional `i` parameter, encoding the interval to use when calculating metrics.
+ */
+export interface EventMetricsIntervalParamParts {
+    /**
+     * The metrics to fetch.
+     */
+    i?: string[];
+}
+/**
+ * Optional `fm` parameter, encoding metric based filters.
+ */
+export interface EventMetricsFilterParamParts {
+    /**
+     * The filter that will be applied to the metrics.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    fm?: string[];
+}
+/**
+ * Required `from` and `to` parameters, encoding a time range.
+ */
+export interface TimeRangeParamParts {
+    /**
+     * The beginning date of the date range for the request, as an ISO-8601 encoded string.
+     * The date/time should include an offset, or `Z` for UTC.
+     * Format: `YYYY-MM-DDThh:mm:ss.sssZ`.
+     */
+    from: string;
+    /**
+     * The end date of the date range for the request, as an ISO-8601 encoded string.
+     * The date/time should include an offset, or `Z` for UTC.
+     * Format: `YYYY-MM-DDThh:mm:ss.sssZ`.
+     */
+    to: string;
+}
+/**
+ * Optional `tz` parameters, encoding a time zone.
+ */
+export interface TimeZoneParamParts {
+    /**
+     * Timezone/offset used for calculations.
+     * Defaults to `Z` (UTC).
+     */
+    tz?: string;
+}
+/**
+ * Paginated `p` and `n` query parameters used by some Read service calls.
+ * (Deprecated because it doesn't align with Coveo's standard `page` (0-based) and `perPage` query parameters).
+ */
+export interface DeprecatedShortPaginatedParamParts {
+    /**
+     * The response's page to access, starting at 1.
+     */
+    p?: number;
+    /**
+     * The number of result to include in a page.
+     */
+    n?: number;
+}

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShare.d.ts

@@ -1,9 +1,21 @@
-import Resource from '../../../Resource';
+import ReadServiceResource from '../ReadServiceResource';
 import { SnowflakeAccountDataSharingParams, SnowflakeAccountDataSharingAccountModel, SnowflakeAccountDataSharingRegionsModel } from './DataShareInterfaces';
-export default class DataShare extends Resource {
+export default class DataShare extends ReadServiceResource {
     static baseUrl: string;
+    /**
+     * Retrieve Snowflake accounts currently associated in Secure Data Sharing.
+     */
     listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
-    addSnowflakeAccount(snowflakeAccount: SnowflakeAccountDataSharingParams): Promise<void>;
+    /**
+     * Add a Snowflake account to Secure Data Sharing.
+     */
+    addSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
+    /**
+     * Removes a Snowflake account from Secure Data Sharing.
+     */
     deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
+    /**
+     * Retrieve allowed Snowflake regions for Secure Data Sharing.
+     */
     listAllowedSnowflakeRegions(): Promise<SnowflakeAccountDataSharingRegionsModel>;
 }

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/Dimensions.d.ts

@@ -1,21 +1,84 @@
 import { DimensionEventTypes } from '../../../Enums';
-import Resource from '../../../Resource';
+import ReadServiceResource from '../ReadServiceResource';
 import { CreateCustomDimensionParams, CustomDimensionModel, CustomDimensionSuggestionModel, DimensionModel, DimensionValuesModel, GetDimensionValuesParams, ListDimensionsParams, ListUncreatedDimensionsParams } from './DimensionsInterfaces';
-export default class Dimensions extends Resource {
+export default class Dimensions extends ReadServiceResource {
     static baseUrl: string;
+    /**
+     * Get all the dimensions.
+     */
     list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    /**
+     * Get all the exportable dimensions.
+     */
     listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    /**
+     * Get a dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     */
     get(apiName: string): Promise<DimensionModel>;
+    /**
+     * Get the values for a dimension.
+     *
+     * @param dimension The dimension to fetch.
+     */
     getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    /**
+     * Get the dimensions service status.
+     */
     getStatus(): Promise<Record<string, string>>;
+    /**
+     * Health check for the dimensions service.
+     */
     checkHealth(): Promise<Record<string, string>>;
+    /**
+     * Get all the custom dimensions.
+     *
+     * @param includeOnlyParents This will filter out dimensions which are covered by others.
+     * Only parent/master dimensions will be output.
+     */
     listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
+    /**
+     * Create a custom dimension.
+     */
     createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
+    /**
+     * Get a custom dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     */
     getCustomDimension(apiName: string): Promise<DimensionModel>;
+    /**
+     * Get the values for a custom dimension.
+     *
+     * @param dimension The dimension to fetch.
+     */
     getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    /**
+     * Create or edit a custom dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     * @param updatePastEvents Whether to update the custom dimension in past events (deprecated).
+     */
     updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
+    /**
+     * Delete a custom dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     */
     deleteCustomDimension(apiName: string): Promise<void>;
+    /**
+     * Get the custom dimensions service status.
+     */
     getCustomDimensionStatus(): Promise<Record<string, string>>;
+    /**
+     * Health check for the custom dimensions service.
+     */
     checkCustomDimensionHealth(): Promise<Record<string, string>>;
+    /**
+     * Get a list of dimensions that have data but are not created yet.
+     *
+     * @param event The type of event for which to look for suggestions.
+     */
     listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionModel[]>;
 }

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.d.ts

@@ -1,4 +1,5 @@
 import { DimensionStatus, DimensionType } from '../../../Enums';
+import { DeprecatedShortPaginatedParamParts, EventDimensionsFilterParamParts, OrganizationParamParts, TimeRangeParamParts, TimeZoneParamParts } from '../CommonParamParts';
 export interface DimensionModel {
     /**
      * A collection of possible names to use when querying the statistics service with this dimension
@@ -59,43 +60,43 @@ export interface CustomDimensionModel {
      */
     path?: string[];
 }
-export interface ListDimensionsParams {
-    org?: string;
+export interface ListDimensionsParams extends OrganizationParamParts {
+    /**
+     * This will filter out dimensions which are covered by others.
+     * Only parent/master dimensions will be output.
+     */
     includeOnlyParents?: boolean;
+    /**
+     * Whether to include custom dimensions within the results.
+     */
     includeCustom?: boolean;
 }
-export interface GetDimensionValuesParams {
-    from: string;
-    to: string;
-    tz?: string;
-    org?: string;
-    f?: string[];
-    p?: number;
-    n?: number;
+export interface GetDimensionValuesParams extends OrganizationParamParts, EventDimensionsFilterParamParts, TimeRangeParamParts, TimeZoneParamParts, DeprecatedShortPaginatedParamParts {
 }
-export interface CreateCustomDimensionParams {
+export interface CreateCustomDimensionParams extends OrganizationParamParts {
     /**
      * The name of the custom dimension. It should start with the 'c_' prefix.
      * If not present, the prefix will be added automatically.
      */
     name: string;
-    /**
-     * The name of the organization (Coveo Cloud V2 only)
-     */
-    org?: string;
     /**
      * The types of event where this dimension will be added.
      */
     event?: string[];
     /**
      * Whether to update the custom dimension in past events.
+     *
+     * @deprecated
      */
     updatePastEvents?: boolean;
 }
-export interface ListUncreatedDimensionsParams {
-    org?: string;
-    from?: string;
-    to?: string;
+export interface ListUncreatedDimensionsParams extends OrganizationParamParts, TimeRangeParamParts {
+    /**
+     * Whether value samples should be included in the response.
+     */
     includeValueSamples?: boolean;
+    /**
+     * The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.
+     */
     depth?: number;
 }