fix

src/EventPayload.ts

@@ -82,7 +82,7 @@ export interface EventPayload {
     /** The IPv4 address associated with the event.
      *
      * If not specified the system will use the Source IP address
-     * from the IP header of the request.
+     * from the autogenerated IP header of the request.
      */
     address: string;
     /** The algorithm to use to anonymize the IP address after collection. */
@@ -93,12 +93,13 @@ export interface EventPayload {
   /** The locale of the user who generated the event.
    *
    * If not specified the system will automatically
-   * determine the locale from the Accept-Language header.
+   * determine the locale from the autogenerated Accept-Language header.
    */
   locale?: string;
   /** The location information of the visitor for the event.
    * Either a Coordinates object with both latitude and longitude or a string
    * with the country of the visitor for the event, as a ISO 3166-1 alpha-2 country code.
+   * For more information see https://www.iso.org/iso-3166-country-codes.html.
    *
    * If not specified the system will automatically
    * determine all location information from the request's IP address,
@@ -117,13 +118,13 @@ export interface EventPayload {
   /** The URL of the page where the event occurred.
    *
    * If not specified the system will automatically
-   * use the `Referrer` header from the auto-generated request headers.
+   * use the `Referrer` header from the autogenerated request headers.
    */
   pageUrl?: string;
   /** The URL of the page which the visitor came from prior to the event.
    *
    * If not specified the system will automatically
-   * use the `Referrer` header from the auto-generated request headers.
+   * use the `Referrer` header from the autogenerated request headers.
    */
   referrerUrl?: string;
   /** Fields specific to reporting Yext Search Analytics Events */
@@ -150,9 +151,10 @@ export interface EventPayload {
   /** 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.
    *
    * If not specified the system will automatically
-   * use the time when the request was received as the event timestamp.
+   * use the time when the request was received in UTC as the event timestamp.
    */
   timestamp?: Date | string;
   /** The monetary value of the event. */
@@ -161,6 +163,8 @@ export interface EventPayload {
     amount: number;
     /** The ISO 4217 currency code of the currency the value is expressed in.
      * For example, "USD" for US dollars.
+     *
+     * For more information see https://www.iso.org/iso-4217-currency-codes.html.
      */
     currency: string;
   };