From a29b7f3b92eab1b69cd75570363973cf527c9fa8 Mon Sep 17 00:00:00 2001 From: Yury Shkoda Date: Fri, 21 Apr 2023 11:06:48 +0300 Subject: [PATCH] docs(refreshTokensForViya): added notes about limitation --- src/SASViyaApiClient.ts | 1 + src/auth/getTokens.ts | 1 + src/auth/refreshTokensForViya.ts | 1 + 3 files changed, 3 insertions(+) diff --git a/src/SASViyaApiClient.ts b/src/SASViyaApiClient.ts index 643bf74..ea5cdb0 100644 --- a/src/SASViyaApiClient.ts +++ b/src/SASViyaApiClient.ts @@ -548,6 +548,7 @@ export class SASViyaApiClient { /** * Exchanges the refresh token for an access token for the given client. + * This method can only be used by Node. * @param clientId - the client ID to authenticate with. * @param clientSecret - the client secret to authenticate with. * @param refreshToken - the refresh token received from the server. diff --git a/src/auth/getTokens.ts b/src/auth/getTokens.ts index 340331a..b4557e2 100644 --- a/src/auth/getTokens.ts +++ b/src/auth/getTokens.ts @@ -10,6 +10,7 @@ import { refreshTokensForSasjs } from './refreshTokensForSasjs' /** * Returns the auth configuration, refreshing the tokens if necessary. + * This function can only be used by Node, if a server type is SASVIYA. * @param requestClient - the pre-configured HTTP request client * @param authConfig - an object containing a client ID, secret, access token and refresh token * @param serverType - server type for which refreshing the tokens, defaults to SASVIYA diff --git a/src/auth/refreshTokensForViya.ts b/src/auth/refreshTokensForViya.ts index fe5f2b7..4fb8f80 100644 --- a/src/auth/refreshTokensForViya.ts +++ b/src/auth/refreshTokensForViya.ts @@ -6,6 +6,7 @@ import { isNode } from '../utils' /** * Exchanges the refresh token for an access token for the given client. + * This function can only be used by Node. * @param requestClient - the pre-configured HTTP request client * @param clientId - the client ID to authenticate with. * @param clientSecret - the client secret to authenticate with.