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.

Sign up for GitHub

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

Jump to bottom

Update segments documentation #190

Merged
merged 2 commits into from
Mar 11, 2024
Merged

Update segments documentation #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6d4370
Update segments documentation
esezen Mar 11, 2024
6b868fe
Remove extra space
esezen Mar 11, 2024
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
2 changes: 1 addition & 1 deletion src/modules/autocomplete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ class Autocomplete {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down
10 changes: 5 additions & 5 deletions src/modules/browse.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ class Browse {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down Expand Up @@ -344,7 +344,7 @@ class Browse {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down Expand Up @@ -409,7 +409,7 @@ class Browse {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down Expand Up @@ -468,7 +468,7 @@ class Browse {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down Expand Up @@ -524,7 +524,7 @@ class Browse {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down
4 changes: 2 additions & 2 deletions src/modules/quizzes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class Quizzes {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down Expand Up @@ -181,7 +181,7 @@ class Quizzes {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down
2 changes: 1 addition & 1 deletion src/modules/recommendations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class Recommendations {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down
4 changes: 2 additions & 2 deletions src/modules/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ class Search {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down Expand Up @@ -282,7 +282,7 @@ class Search {
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
* @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.userIp] - Origin user IP, from client
* @param {string} [userParameters.userAgent] - Origin user agent, from client
Expand Down
28 changes: 14 additions & 14 deletions src/modules/tracker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -237,7 +237,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -286,7 +286,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -387,7 +387,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -488,7 +488,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -575,7 +575,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -674,7 +674,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -790,7 +790,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -925,7 +925,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -1028,7 +1028,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -1160,7 +1160,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -1314,7 +1314,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -1467,7 +1467,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down Expand Up @@ -1615,7 +1615,7 @@ class Tracker {
* @param {number} userParameters.sessionId - Session ID, utilized to personalize results
* @param {string} userParameters.clientId - Client ID, utilized to personalize results
* @param {string} [userParameters.userId] - User ID, utilized to personalize results
* @param {string} [userParameters.segments] - User segments
* @param {string[]} [userParameters.segments] - User segments
* @param {object} [userParameters.testCells] - User test cells
* @param {string} [userParameters.originReferrer] - Client page URL (including path)
* @param {string} [userParameters.referer] - Client page URL (including path)
Expand Down
2 changes: 1 addition & 1 deletion src/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface UserParameters {
sessionId?: number;
clientId?: string;
userId?: string;
segments?: string;
segments?: string[];
testCells?: Record<string, any>;
userIp?: string;
userAgent?: string;
Expand Down
Loading