Skip to content

Commit 47d29fb

Browse files
committed
wording
1 parent d22d03d commit 47d29fb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/static/helpers/slasHelper.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export const generateCodeChallenge = async (
111111
* @param parameters.usid? - optional saved SLAS user id to link the new session to a previous session
112112
* @param privateClient? - flag to indicate if the client is private or not. Defaults to false.
113113
* @param options - an object containing the options for this function.
114-
* @param options.headers? - optional header to pass in the 'authorizeCustomer` endpoint.
114+
* @param options.headers? - optional header to pass in the ShopperLogin 'authorizeCustomer` method.
115115
* @returns login url, user id and authorization code if available
116116
*/
117117
export async function authorize(
@@ -262,7 +262,7 @@ export async function authorizeIDP(
262262
* @param parameters.usid? - Unique Shopper Identifier to enable personalization.
263263
* @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
264264
* @param options - an object containing the options for this function
265-
* @param options?.headers - optional headers to pass in the 'getAccessToken'
265+
* @param options?.headers - optional headers to pass in the ShopperLogin 'getAccessToken' method
266266
* @returns TokenResponse
267267
*/
268268
export async function loginIDPUser(
@@ -337,7 +337,7 @@ export async function loginIDPUser(
337337
* @param parameters.usid? - Unique Shopper Identifier to enable personalization.
338338
* @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
339339
* @param options - an object containing the options for this function.
340-
* @param option.headers? - optional headers to pass in the 'getAccessToken` endpoint.
340+
* @param option.headers? - optional headers to pass in the ShopperLogin 'getAccessToken' method
341341
* @returns TokenResponse
342342
*/
343343
export async function loginGuestUserPrivate(
@@ -391,7 +391,7 @@ export async function loginGuestUserPrivate(
391391
* @param parameters.usid? - Unique Shopper Identifier to enable personalization.
392392
* @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
393393
* @param options - an object containing the options for this function.
394-
* @param option.headers? - optional headers to pass in the 'getAccessToken` endpoint.
394+
* @param option.headers? - optional headers to pass in the ShopperLogin 'getAccessToken' method
395395
* @returns TokenResponse
396396
*/
397397
export async function loginGuestUser(
@@ -455,8 +455,8 @@ export async function loginGuestUser(
455455
* @param parameters.usid? - Unique Shopper Identifier to enable personalization.
456456
* @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
457457
* @param options - an object containing the options for this function.
458-
* @param options.headers - optional headers to pass in the 'getAccessToken' and 'authenticateCustomer' endpoints.
459-
* @param options.body - optional body parameters to pass in the 'authenticateCustomer' endpoint.
458+
* @param options.headers - optional headers to pass in the ShopperLogin 'getAccessToken' and 'authenticateCustomer' methods.
459+
* @param options.body - optional body parameters to pass in the ShopperLogin 'authenticateCustomer' method.
460460
* @returns TokenResponse
461461
*/
462462
export async function loginRegisteredUserB2C(
@@ -574,7 +574,7 @@ export async function loginRegisteredUserB2C(
574574
* @param parameters.locale - The locale of the template. Not needed for the callback mode
575575
* @param parameters.mode - Medium of sending login token
576576
* @param options - an object containing the options for this function.
577-
* @param options?.headers - optional headers to pass in the 'authorizePasswordlessCustomer' endpoint
577+
* @param options?.headers - optional headers to pass in the ShopperLogin 'authorizePasswordlessCustomer' method
578578
* @returns Promise of Response
579579
*/
580580
export async function authorizePasswordless(
@@ -656,7 +656,7 @@ export async function authorizePasswordless(
656656
* @param parameters.pwdlessLoginToken - Passwordless login token
657657
* @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
658658
* @param options - an object containing the options for this function.
659-
* @param options?.headers - optional headers to pass in the 'getPasswordLessAccessToken' endpoint
659+
* @param options?.headers - optional headers to pass in the ShopperLogin 'getPasswordLessAccessToken' method
660660
* @returns Promise of Response or Object
661661
*/
662662
export async function getPasswordLessAccessToken(
@@ -725,7 +725,7 @@ export async function getPasswordLessAccessToken(
725725
* @param credentials - the clientSecret (if applicable) to login with.
726726
* @param credentials.clientSecret - secret associated with client ID
727727
* @param options - an object containing the options for this function.
728-
* @param options?.headers - optional headers to pass in the 'getAccessToken' endpoint
728+
* @param options?.headers - optional headers to pass in the ShopperLogin 'getAccessToken' method
729729
* @returns TokenResponse
730730
*/
731731
export function refreshAccessToken(
@@ -778,7 +778,7 @@ export function refreshAccessToken(
778778
* @param parameters.accessToken - a valid access token to exchange for a new access token (and refresh token).
779779
* @param parameters.refreshToken - a valid refresh token to exchange for a new access token (and refresh token).
780780
* @param options - an object containing the options for this function.
781-
* @param options?.headers - optional headers to pass in the 'logoutCustomer' endpoint
781+
* @param options?.headers - optional headers to pass in the ShopperLogin 'logoutCustomer' method
782782
* @returns TokenResponse
783783
*/
784784
export function logout(

0 commit comments

Comments
 (0)