From 278977db62ba8e5a451be4a8a1682c3395d8b731 Mon Sep 17 00:00:00 2001
From: "Jason R. Stevens, CFA" <jason@thinkjrs.dev>
Date: Fri, 18 Aug 2023 09:11:16 -0500
Subject: [PATCH] :bug: :notebook: add missing sub inline documentation to
 close #4

---
 src/promo-node-utils.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/promo-node-utils.ts b/src/promo-node-utils.ts
index d58387a..6bb1893 100644
--- a/src/promo-node-utils.ts
+++ b/src/promo-node-utils.ts
@@ -42,6 +42,10 @@ interface PromoAccessTokenJwt {
  * @param appId the string appId from the tincre.dev dashboard
  * @param clientSecret the string clientSecret from the tincre.dev dashboard
  * @param expiration optional expiration number in seconds; defaults to 30 min
+ * @param sub optional subject string client email; defaults to nothing which
+ *   gives the scope parameter when validated within the Promo API a value of
+ *   'userRW'. If an email is included, it is checked against the emails within
+ *   the permissions tokens available.
  * @returns string JWT signed with the clientSecret provided
  */
 function generateAccessToken(