@coveo/platform-client 57.0.0 → 57.2.0

package/dist/cjs/resources/ApiKeyTemplate/ApiKeyTemplate.js

@@ -7,6 +7,9 @@ class ApiKeyTemplate extends Resource_js_1.default {
     get(apiKeyTemplateId) {
         return this.api.get(`${ApiKeyTemplate.baseUrl}/${apiKeyTemplateId}`);
     }
+    listAPIKeysEligibility() {
+        return this.api.get(`${ApiKeyTemplate.baseUrl}/privileges/eligibility`);
+    }
 }
 exports.default = ApiKeyTemplate;
 //# sourceMappingURL=ApiKeyTemplate.js.map

package/dist/cjs/resources/ApiKeyTemplate/ApiKeyTemplate.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKeyTemplate.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeyTemplate/ApiKeyTemplate.ts"],"names":[],"mappings":";;;AAAA,yEAAsC;AAGtC,MAAqB,cAAe,SAAQ,qBAAQ;IAChD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C,GAAG,CAAC,gBAAwB;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,GAAG,cAAc,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,CAAC;IAC9F,CAAC;;AALL,iCAMC"}
+{"version":3,"file":"ApiKeyTemplate.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeyTemplate/ApiKeyTemplate.ts"],"names":[],"mappings":";;;AAAA,yEAAsC;AAGtC,MAAqB,cAAe,SAAQ,qBAAQ;IAChD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C,GAAG,CAAC,gBAAwB;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,GAAG,cAAc,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,sBAAsB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,cAAc,CAAC,OAAO,yBAAyB,CACrD,CAAC;IACN,CAAC;;AAXL,iCAYC"}

package/dist/cjs/resources/License/LicenseInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"LicenseInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/License/LicenseInterfaces.ts"],"names":[],"mappings":";;;AA4IA;;GAEG;AACH,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAC9B;;OAEG;IACH,yDAA+B,CAAA;IAC/B;;;OAGG;IACH,+DAAqC,CAAA;IACrC;;OAEG;IACH,mEAAyC,CAAA;IACzC;;;OAGG;IACH,uEAA6C,CAAA;AACjD,CAAC,EAnBW,sBAAsB,sCAAtB,sBAAsB,QAmBjC;AAED;;GAEG;AACH,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,qCAAa,CAAA;IACb;;OAEG;IACH,2CAAmB,CAAA;IACnB;;;OAGG;IACH,qCAAa,CAAA;AACjB,CAAC,EAdW,oBAAoB,oCAApB,oBAAoB,QAc/B;AAED;;GAEG;AACH,IAAY,6BASX;AATD,WAAY,6BAA6B;IACrC;;OAEG;IACH,8CAAa,CAAA;IACb;;OAEG;IACH,8CAAa,CAAA;AACjB,CAAC,EATW,6BAA6B,6CAA7B,6BAA6B,QASxC;AAED;;GAEG;AACH,IAAY,mCAKX;AALD,WAAY,mCAAmC;IAC3C;;OAEG;IACH,sDAAe,CAAA;AACnB,CAAC,EALW,mCAAmC,mDAAnC,mCAAmC,QAK9C"}
+{"version":3,"file":"LicenseInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/License/LicenseInterfaces.ts"],"names":[],"mappings":";;;AA6LA;;GAEG;AACH,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAC9B;;OAEG;IACH,yDAA+B,CAAA;IAC/B;;;OAGG;IACH,+DAAqC,CAAA;IACrC;;OAEG;IACH,mEAAyC,CAAA;IACzC;;;OAGG;IACH,uEAA6C,CAAA;AACjD,CAAC,EAnBW,sBAAsB,sCAAtB,sBAAsB,QAmBjC;AAED;;GAEG;AACH,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,qCAAa,CAAA;IACb;;OAEG;IACH,2CAAmB,CAAA;IACnB;;;OAGG;IACH,qCAAa,CAAA;AACjB,CAAC,EAdW,oBAAoB,oCAApB,oBAAoB,QAc/B;AAED;;GAEG;AACH,IAAY,6BASX;AATD,WAAY,6BAA6B;IACrC;;OAEG;IACH,8CAAa,CAAA;IACb;;OAEG;IACH,8CAAa,CAAA;AACjB,CAAC,EATW,6BAA6B,6CAA7B,6BAA6B,QASxC;AAED;;GAEG;AACH,IAAY,mCAKX;AALD,WAAY,mCAAmC;IAC3C;;OAEG;IACH,sDAAe,CAAA;AACnB,CAAC,EALW,mCAAmC,mDAAnC,mCAAmC,QAK9C"}

package/dist/esm/resources/ApiKeyTemplate/ApiKeyTemplate.js

@@ -4,5 +4,8 @@ export default class ApiKeyTemplate extends Resource {
     get(apiKeyTemplateId) {
         return this.api.get(`${ApiKeyTemplate.baseUrl}/${apiKeyTemplateId}`);
     }
+    listAPIKeysEligibility() {
+        return this.api.get(`${ApiKeyTemplate.baseUrl}/privileges/eligibility`);
+    }
 }
 //# sourceMappingURL=ApiKeyTemplate.js.map

package/dist/esm/resources/ApiKeyTemplate/ApiKeyTemplate.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKeyTemplate.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeyTemplate/ApiKeyTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,QAAQ;IAChD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C,GAAG,CAAC,gBAAwB;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,GAAG,cAAc,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,CAAC;IAC9F,CAAC"}
+{"version":3,"file":"ApiKeyTemplate.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeyTemplate/ApiKeyTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,QAAQ;IAChD,MAAM,CAAC,OAAO,GAAG,yBAAyB,CAAC;IAE3C,GAAG,CAAC,gBAAwB;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,GAAG,cAAc,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,sBAAsB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,GAAG,cAAc,CAAC,OAAO,yBAAyB,CACrD,CAAC;IACN,CAAC"}

package/dist/esm/resources/License/LicenseInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"LicenseInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/License/LicenseInterfaces.ts"],"names":[],"mappings":"AA4IA;;GAEG;AACH,MAAM,CAAN,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAC9B;;OAEG;IACH,yDAA+B,CAAA;IAC/B;;;OAGG;IACH,+DAAqC,CAAA;IACrC;;OAEG;IACH,mEAAyC,CAAA;IACzC;;;OAGG;IACH,uEAA6C,CAAA;AACjD,CAAC,EAnBW,sBAAsB,KAAtB,sBAAsB,QAmBjC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,qCAAa,CAAA;IACb;;OAEG;IACH,2CAAmB,CAAA;IACnB;;;OAGG;IACH,qCAAa,CAAA;AACjB,CAAC,EAdW,oBAAoB,KAApB,oBAAoB,QAc/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,6BASX;AATD,WAAY,6BAA6B;IACrC;;OAEG;IACH,8CAAa,CAAA;IACb;;OAEG;IACH,8CAAa,CAAA;AACjB,CAAC,EATW,6BAA6B,KAA7B,6BAA6B,QASxC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,mCAKX;AALD,WAAY,mCAAmC;IAC3C;;OAEG;IACH,sDAAe,CAAA;AACnB,CAAC,EALW,mCAAmC,KAAnC,mCAAmC,QAK9C"}
+{"version":3,"file":"LicenseInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/License/LicenseInterfaces.ts"],"names":[],"mappings":"AA6LA;;GAEG;AACH,MAAM,CAAN,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAC9B;;OAEG;IACH,yDAA+B,CAAA;IAC/B;;;OAGG;IACH,+DAAqC,CAAA;IACrC;;OAEG;IACH,mEAAyC,CAAA;IACzC;;;OAGG;IACH,uEAA6C,CAAA;AACjD,CAAC,EAnBW,sBAAsB,KAAtB,sBAAsB,QAmBjC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,qCAAa,CAAA;IACb;;OAEG;IACH,2CAAmB,CAAA;IACnB;;;OAGG;IACH,qCAAa,CAAA;AACjB,CAAC,EAdW,oBAAoB,KAApB,oBAAoB,QAc/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,6BASX;AATD,WAAY,6BAA6B;IACrC;;OAEG;IACH,8CAAa,CAAA;IACb;;OAEG;IACH,8CAAa,CAAA;AACjB,CAAC,EATW,6BAA6B,KAA7B,6BAA6B,QASxC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,mCAKX;AALD,WAAY,mCAAmC;IAC3C;;OAEG;IACH,sDAAe,CAAA;AACnB,CAAC,EALW,mCAAmC,KAAnC,mCAAmC,QAK9C"}

package/dist/types/resources/ApiKeyTemplate/ApiKeyTemplate.d.ts

@@ -1,6 +1,7 @@
 import Resource from '../Resource.js';
-import { ApiKeyTemplateModel } from './ApiKeyTemplateInterface.js';
+import { ApiKeyTemplateEligibilityResponseModel, ApiKeyTemplateModel } from './ApiKeyTemplateInterface.js';
 export default class ApiKeyTemplate extends Resource {
     static baseUrl: string;
     get(apiKeyTemplateId: string): Promise<ApiKeyTemplateModel>;
+    listAPIKeysEligibility(): Promise<ApiKeyTemplateEligibilityResponseModel[]>;
 }

package/dist/types/resources/ApiKeyTemplate/ApiKeyTemplateInterface.d.ts

@@ -25,3 +25,17 @@ export interface ApiKeyTemplateModel {
      */
     privileges?: PrivilegeModel[];
 }
+export interface ApiKeyTemplateEligibilityResponseModel {
+    /**
+     * The id of the template
+     */
+    id: string;
+    /**
+     * The list of privileges missing to access the template
+     */
+    missingPrivileges: PrivilegeModel[];
+    /**
+     * If the user can generate an API key from this template
+     */
+    canGenerate: boolean;
+}

package/dist/types/resources/License/LicenseInterfaces.d.ts

@@ -86,21 +86,70 @@ export interface LicenseModel {
     type: string;
 }
 export interface EntitlementModel {
+    /**
+     * Limit of items
+     */
     itemLimit: number;
+    /**
+     * Limit of Queries Per Month for product listing
+     */
     lrpmLimit: number;
+    /**
+     * The unique identifier of the entitlement
+     */
     id: string;
+    /**
+     * The unique identifier of the product on Salesforce
+     */
     productId: string;
+    /**
+     * Name of the product on Salesforce
+     */
     productName: string;
+    /**
+     * Unit on which the price is based on
+     */
     pricingUnit: string;
+    /**
+     * Name of the product on Coveo
+     */
     displayName: string;
+    /**
+     * Queries per month limit
+     */
     qpmLimit: number;
+    /**
+     * Reommendation Limit
+     */
     recommendationLimit: number;
+    /**
+     * Status of the entitlement
+     */
     status: string;
+    /**
+     * Flag that informs if entitlement allow unlimited Queries Per Month
+     */
     unlimitedQPM: boolean;
+    /**
+     * Flag that informs if entitlement allow unlimited recommendations
+     */
     unlimitedRecommendations: boolean;
+    /**
+     * Flag that informs if entitlement allow unlimited users
+     */
     unlimitedUsers: boolean;
+    /**
+     * Use case of the entitlement
+     */
     useCase: string;
+    /**
+     * Limit of users for the entitlement
+     */
     userLimit: number;
+    /**
+     * Flag to control if the entitlement should be shown in the consumption dashboard
+     */
+    shouldShowInConsumptionDashboard: boolean;
 }
 /**
  * Simplified version of a License's LicenseConnectorModel

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "57.0.0",
+    "version": "57.2.0",
     "description": "",
     "type": "module",
     "exports": {