From 2e5c0fceffb0b0a18a2d4386b8d414d539ac2e9d Mon Sep 17 00:00:00 2001
From: Ethan Jaffee <ejaffee01@users.noreply.github.com>
Date: Thu, 29 Feb 2024 11:39:48 -0500
Subject: [PATCH] EventsSDK: Fix doc comment for searchTerm in EventPayload
 (#140)

Fix doc comment for searchTerm in EventPayload

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
---
 docs/analytics.eventpayload.md            | 2 +-
 docs/analytics.eventpayload.searchterm.md | 2 ++
 etc/analytics.api.md                      | 1 -
 src/EventPayload.ts                       | 2 +-
 4 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md
index 525bcba..f4ed943 100644
--- a/docs/analytics.eventpayload.md
+++ b/docs/analytics.eventpayload.md
@@ -36,7 +36,7 @@ export interface EventPayload
 |  [pageUrl?](./analytics.eventpayload.pageurl.md) |  | string | <p>_(Optional)_ The URL of the page where the event occurred.</p><p>If not specified the system will automatically use the <code>Referrer</code> header from the autogenerated request headers.</p> |
 |  [referrerUrl?](./analytics.eventpayload.referrerurl.md) |  | string | <p>_(Optional)_ The URL of the page which the visitor came from prior to the event.</p><p>If not specified the system will automatically use the <code>Referrer</code> header from the autogenerated request headers.</p> |
 |  [search?](./analytics.eventpayload.search.md) |  | { searchId?: string; queryId?: string; verticalKey?: string; isDirectAnswer?: boolean; versionLabel?: [VersionLabel](./analytics.versionlabel.md)<!-- -->; versionNumber?: number; experienceKey: string; } | _(Optional)_ Fields specific to reporting Yext Search Analytics Events |
-|  [searchTerm?](./analytics.eventpayload.searchterm.md) |  | string | _(Optional)_ |
+|  [searchTerm?](./analytics.eventpayload.searchterm.md) |  | string | _(Optional)_ The query entered by the user. |
 |  [sessionId?](./analytics.eventpayload.sessionid.md) |  | string \| null | _(Optional)_ Unique identifier to tie together events in a single browsing session |
 |  [timestamp?](./analytics.eventpayload.timestamp.md) |  | Date \| string | <p>_(Optional)_ The timestamp at which the event occurred, in ISO format. For example, September 27, 2022 at 6 p.m. is represented as 2022-09-27 18:00:00.000. For more information, see https://www.iso.org/iso-8601-date-and-time-format.html.</p><p>If not specified the system will automatically use the time when the request was received in UTC as the event timestamp.</p> |
 |  [value?](./analytics.eventpayload.value.md) |  | { amount: number; currency: string; } | _(Optional)_ The monetary value of the event. |
diff --git a/docs/analytics.eventpayload.searchterm.md b/docs/analytics.eventpayload.searchterm.md
index ca6a744..ef1c37c 100644
--- a/docs/analytics.eventpayload.searchterm.md
+++ b/docs/analytics.eventpayload.searchterm.md
@@ -4,6 +4,8 @@
 
 ## EventPayload.searchTerm property
 
+The query entered by the user.
+
 **Signature:**
 
 ```typescript
diff --git a/etc/analytics.api.md b/etc/analytics.api.md
index 616419f..ea4aa75 100644
--- a/etc/analytics.api.md
+++ b/etc/analytics.api.md
@@ -81,7 +81,6 @@ export interface EventPayload {
         versionNumber?: number;
         experienceKey: string;
     };
-    // (undocumented)
     searchTerm?: string;
     sessionId?: string | null;
     timestamp?: Date | string;
diff --git a/src/EventPayload.ts b/src/EventPayload.ts
index 849b0bc..ae0dc55 100644
--- a/src/EventPayload.ts
+++ b/src/EventPayload.ts
@@ -146,7 +146,7 @@ export interface EventPayload {
     /** The identifier of the search experience. */
     experienceKey: string;
   };
-  /* The query entered by the user. */
+  /** The query entered by the user. */
   searchTerm?: string;
   /** Unique identifier to tie together events in a single browsing session */
   sessionId?: string | null;