Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 📓 add missing sub inline documentation to close #4 #11

Merged
merged 1 commit into from
Aug 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/promo-node-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Loading