From e6cfa62ef561267f17eaa59f8dd3d1b2437257f7 Mon Sep 17 00:00:00 2001
From: Henrique Nascimento
 <124307300+HNascimento-coveo@users.noreply.github.com>
Date: Thu, 28 Nov 2024 15:37:25 -0500
Subject: [PATCH] feat(api-keys): adding should show in consumption dashboard
 to entitlement model (#888)

---
 src/resources/License/LicenseInterfaces.ts | 51 +++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

diff --git a/src/resources/License/LicenseInterfaces.ts b/src/resources/License/LicenseInterfaces.ts
index 2d9306ace..c3b08307d 100644
--- a/src/resources/License/LicenseInterfaces.ts
+++ b/src/resources/License/LicenseInterfaces.ts
@@ -100,21 +100,70 @@ export interface LicenseModel {
 }
 
 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;
-    useCase: string;
+    /**
+     * 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;
 }
 
 /**