diff --git a/plugins/home/api-report.md b/plugins/home/api-report.md index 536032a8eb..8c0177e251 100644 --- a/plugins/home/api-report.md +++ b/plugins/home/api-report.md @@ -225,7 +225,7 @@ export type VisitFilter = { // @public export interface VisitsApi { listUserVisits(queryParams?: VisitsApiQueryParams): Promise; - saveVisit(pageVisit: Omit): Promise; + saveVisit(saveParams: VisitsApiSaveParams): Promise; } // @public @@ -238,6 +238,11 @@ export type VisitsApiQueryParams = { // @public (undocumented) export const visitsApiRef: ApiRef; +// @public +export type VisitsApiSaveParams = { + visit: Omit; +}; + // @public export const WelcomeTitle: ({ language, diff --git a/plugins/home/src/api/VisitsApi.ts b/plugins/home/src/api/VisitsApi.ts index 8d5ae3f8cb..c461a5159b 100644 --- a/plugins/home/src/api/VisitsApi.ts +++ b/plugins/home/src/api/VisitsApi.ts @@ -85,6 +85,14 @@ export type VisitsApiQueryParams = { filterBy?: VisitFilter[]; }; +/** + * @public + * This data structure represents the parameters associated with saving visits. + */ +export type VisitsApiSaveParams = { + visit: Omit; +}; + /** * @public * Visits API public contract. @@ -94,7 +102,7 @@ export interface VisitsApi { * Persist a new visit. * @param pageVisit - a new visit data */ - saveVisit(pageVisit: Omit): Promise; + saveVisit(saveParams: VisitsApiSaveParams): Promise; /** * Get the logged user visits. * @param queryParams - optional search query params.