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.

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

Fix Vulnerable Dependencies in package-lock.json #119

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
Automated update to repo's documentation from github action
github-actions[bot] committed Nov 13, 2023
commit 0d37eca8eab6b35e609b9c263535cfdc7e7a12e0
2 changes: 1 addition & 1 deletion docs/analytics.action.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The action types accepted by the Analytics Events API.

<b>Signature:</b>
**Signature:**

```typescript
export declare type Action = `C_${string}` | `c_${string}` | 'ADD_TO_CART' | 'ALL_TAB_NAVIGATION' | 'APPLY' | 'AUTO_COMPLETE_SELECTION' | 'BACKWARD_PAGINATE' | 'BOOK' | 'BRAND_ICON' | 'CASE_START' | 'CASE_SUBMITTED' | 'CHAT_IMPRESSION' | 'CHAT_LINK_CLICK' | 'CHAT_RESPONSE' | 'COLLAPSE' | 'CTA_CLICK' | 'DRIVING_DIRECTIONS' | 'EVENT' | 'EXPAND' | 'FEATURED_MESSAGE' | 'FILTERING_WITHIN_SECTION' | 'FORWARD_PAGINATE' | 'HEADER_LINKS' | 'ITEM_IN_LIST' | 'MAP_CARD' | 'MAP_PIN' | 'MENU' | 'MESSAGE' | 'ORDER' | 'PAGINATE' | 'POST' | 'PRESET_PROMPT' | 'PRODUCT' | 'PROFILE' | 'QUESTION_FOCUS' | 'QUESTION_SUBMIT' | 'REMOVED_FILTER' | 'REVIEW' | 'SCROLL_TO_BOTTOM_OF_PAGE' | 'SEARCH_BAR_IMPRESSION' | 'SEARCH_CLEAR_BUTTON' | 'TAP_TO_CALL' | 'THUMBS_DOWN' | 'THUMBS_UP' | 'TICKET_URL' | 'TITLE' | 'VERTICAL_TAB_NAVIGATION' | 'VERTICAL_VIEW_ALL' | 'VOICE_START' | 'VOICE_STOP' | 'WEBSITE';
4 changes: 2 additions & 2 deletions docs/analytics.analytics.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The Yext Analytics Events SDK. Returns an AnalyticsEventService given an AnalyticsConfig.

<b>Signature:</b>
**Signature:**

```typescript
export declare function analytics(config: AnalyticsConfig): AnalyticsEventService;
@@ -18,7 +18,7 @@ export declare function analytics(config: AnalyticsConfig): AnalyticsEventServic
| --- | --- | --- |
| config | [AnalyticsConfig](./analytics.analyticsconfig.md) | |

<b>Returns:</b>
**Returns:**

[AnalyticsEventService](./analytics.analyticseventservice.md)

2 changes: 1 addition & 1 deletion docs/analytics.analyticsconfig.bearer.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The bearer token for accessing the Analytics Events API. Only one of key or bearer should be set.

<b>Signature:</b>
**Signature:**

```typescript
bearer?: string;
2 changes: 1 addition & 1 deletion docs/analytics.analyticsconfig.env.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The Yext environment to send requests to. Defaults to 'PRODUCTION'.

<b>Signature:</b>
**Signature:**

```typescript
env?: Environment;
2 changes: 1 addition & 1 deletion docs/analytics.analyticsconfig.forcefetch.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Used to force sending the request with fetch even if the browser does not support fetch with the keepalive flag (like Firefox). If the browser does support it, fetch is used by default.

<b>Signature:</b>
**Signature:**

```typescript
forceFetch?: boolean;
2 changes: 1 addition & 1 deletion docs/analytics.analyticsconfig.key.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The API Key or OAuth for accessing the Analytics Events API Only one of key or bearer should be set.

<b>Signature:</b>
**Signature:**

```typescript
key?: string;
18 changes: 9 additions & 9 deletions docs/analytics.analyticsconfig.md
Original file line number Diff line number Diff line change
@@ -6,20 +6,20 @@

The main configuration options for Analytics Events.

<b>Signature:</b>
**Signature:**

```typescript
export interface AnalyticsConfig
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [bearer?](./analytics.analyticsconfig.bearer.md) | string | <i>(Optional)</i> The bearer token for accessing the Analytics Events API. Only one of key or bearer should be set. |
| [env?](./analytics.analyticsconfig.env.md) | [Environment](./analytics.environment.md) | <i>(Optional)</i> The Yext environment to send requests to. Defaults to 'PRODUCTION'. |
| [forceFetch?](./analytics.analyticsconfig.forcefetch.md) | boolean | <i>(Optional)</i> Used to force sending the request with fetch even if the browser does not support fetch with the keepalive flag (like Firefox). If the browser does support it, fetch is used by default. |
| [key?](./analytics.analyticsconfig.key.md) | string | <i>(Optional)</i> The API Key or OAuth for accessing the Analytics Events API Only one of key or bearer should be set. |
| [region?](./analytics.analyticsconfig.region.md) | [Region](./analytics.region.md) | <i>(Optional)</i> The region to send requests to. Defaults to 'US'. |
| [sessionTrackingEnabled?](./analytics.analyticsconfig.sessiontrackingenabled.md) | boolean | <i>(Optional)</i> Whether to enable session tracking for analytics events. Defaults to true for both environments. If set to false, sessionId will automatically be set to undefined in the event payload. |
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [bearer?](./analytics.analyticsconfig.bearer.md) | | string | _(Optional)_ The bearer token for accessing the Analytics Events API. Only one of key or bearer should be set. |
| [env?](./analytics.analyticsconfig.env.md) | | [Environment](./analytics.environment.md) | _(Optional)_ The Yext environment to send requests to. Defaults to 'PRODUCTION'. |
| [forceFetch?](./analytics.analyticsconfig.forcefetch.md) | | boolean | _(Optional)_ Used to force sending the request with fetch even if the browser does not support fetch with the keepalive flag (like Firefox). If the browser does support it, fetch is used by default. |
| [key?](./analytics.analyticsconfig.key.md) | | string | _(Optional)_ The API Key or OAuth for accessing the Analytics Events API Only one of key or bearer should be set. |
| [region?](./analytics.analyticsconfig.region.md) | | [Region](./analytics.region.md) | _(Optional)_ The region to send requests to. Defaults to 'US'. |
| [sessionTrackingEnabled?](./analytics.analyticsconfig.sessiontrackingenabled.md) | | boolean | _(Optional)_ Whether to enable session tracking for analytics events. Defaults to true for both environments. If set to false, sessionId will automatically be set to undefined in the event payload. |

2 changes: 1 addition & 1 deletion docs/analytics.analyticsconfig.region.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The region to send requests to. Defaults to 'US'.

<b>Signature:</b>
**Signature:**

```typescript
region?: Region;
2 changes: 1 addition & 1 deletion docs/analytics.analyticsconfig.sessiontrackingenabled.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Whether to enable session tracking for analytics events. Defaults to true for both environments. If set to false, sessionId will automatically be set to undefined in the event payload.

<b>Signature:</b>
**Signature:**

```typescript
sessionTrackingEnabled?: boolean;
2 changes: 1 addition & 1 deletion docs/analytics.analyticseventservice.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

A service for reporting Yext analytics events

<b>Signature:</b>
**Signature:**

```typescript
export interface AnalyticsEventService
6 changes: 3 additions & 3 deletions docs/analytics.analyticseventservice.report.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Reports an analytics event. Operand will throw an error if the request fails. The request will default to being sent via fetch, with keepalive set to true, if supported by the browser, and a Promise of an EventAPIResponse will be returned. Otherwise, the request will be sent via the Beacon API, unless the forceFetch flag is toggled, and a boolean will be returned.

<b>Signature:</b>
**Signature:**

```typescript
report(payload?: PartialPayload): Promise<string>;
@@ -16,9 +16,9 @@ report(payload?: PartialPayload): Promise<string>;

| Parameter | Type | Description |
| --- | --- | --- |
| payload | [PartialPayload](./analytics.partialpayload.md) | desired values to be applied. The new payload will override any overlapping values. |
| payload | [PartialPayload](./analytics.partialpayload.md) | _(Optional)_ desired values to be applied. The new payload will override any overlapping values. |

<b>Returns:</b>
**Returns:**

Promise&lt;string&gt;

4 changes: 2 additions & 2 deletions docs/analytics.analyticseventservice.with.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Creates a new AnalyticsEventService with the following values defined as the default when making a report.

<b>Signature:</b>
**Signature:**

```typescript
with(payload: EventPayload): AnalyticsEventService;
@@ -18,7 +18,7 @@ with(payload: EventPayload): AnalyticsEventService;
| --- | --- | --- |
| payload | [EventPayload](./analytics.eventpayload.md) | desired values to be applied. The new payload will override any overlapping values. |

<b>Returns:</b>
**Returns:**

[AnalyticsEventService](./analytics.analyticseventservice.md)

2 changes: 1 addition & 1 deletion docs/analytics.enumorstring.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

A TypeScript utility type which creates a union of an enum member and its string representation.

<b>Signature:</b>
**Signature:**

```typescript
export declare type EnumOrString<T extends string> = T | `${T}`;
4 changes: 2 additions & 2 deletions docs/analytics.environment.md
Original file line number Diff line number Diff line change
@@ -6,12 +6,12 @@

The Yext Environments

<b>Signature:</b>
**Signature:**

```typescript
export declare type Environment = EnumOrString<EnvironmentEnum>;
```
<b>References:</b> [EnumOrString](./analytics.enumorstring.md)<!-- -->, [EnvironmentEnum](./analytics.environmentenum.md)
**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [EnvironmentEnum](./analytics.environmentenum.md)

## Remarks

2 changes: 1 addition & 1 deletion docs/analytics.environmentenum.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

An enum for the Yext Environments

<b>Signature:</b>
**Signature:**

```typescript
export declare enum EnvironmentEnum
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.action.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION

<b>Signature:</b>
**Signature:**

```typescript
action: Action;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.authorization.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The authorization token for the request. This will be setup from the Key or Bearer in the config.

<b>Signature:</b>
**Signature:**

```typescript
authorization?: string;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.bot.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Whether the event is the result of bot activity.

<b>Signature:</b>
**Signature:**

```typescript
bot?: boolean;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.browseragent.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Information about the visitors device and browser.

<b>Signature:</b>
**Signature:**

```typescript
browserAgent?: {
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.chat.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Fields specific to reporting Chat Analytics Events

<b>Signature:</b>
**Signature:**

```typescript
chat?: {
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.clientsdk.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

For the Yext client SDKs involved in the event, this is an object mapping the names of those SDKs to the version labels of those SDKs.

<b>Signature:</b>
**Signature:**

```typescript
clientSdk?: Record<string, string>;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.count.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

When the record summarizes multiple events, the number of events the record represents. The event is treated as if it is duplicated this many times.

<b>Signature:</b>
**Signature:**

```typescript
count?: number;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.customtags.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Up to 10 pairs matching custom string keys to string values to associate with the event. Keys are case-insensitive; values are case-sensitive.

<b>Signature:</b>
**Signature:**

```typescript
customTags?: Record<string, string>;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.customvalues.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Up to 10 pairs matching custom string keys to number values to associate with the event. Keys are case-insensitive.

<b>Signature:</b>
**Signature:**

```typescript
customValues?: Record<string, number>;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.destinationurl.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The URL of the page the event is directing the visitor to.

<b>Signature:</b>
**Signature:**

```typescript
destinationUrl?: string;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.entity.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The Yext entity to which the event corresponds. If passed as a string, the value is the mutable, customer-settable entity ID for the entity associated with the event. If passed as a number, it is the immutable entity ID (UID) set by the system. This is an internal ID.

<b>Signature:</b>
**Signature:**

```typescript
entity?: string | number;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.internaluser.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Indicates whether the event is the result of internal activity.

<b>Signature:</b>
**Signature:**

```typescript
internalUser?: boolean;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.ip.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The IP address for the event.

<b>Signature:</b>
**Signature:**

```typescript
ip?: {
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.label.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

A label assigned to the event, e.g. a CTA label.

<b>Signature:</b>
**Signature:**

```typescript
label?: string;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.locale.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The locale of the user who generated the event.

<b>Signature:</b>
**Signature:**

```typescript
locale?: string;
50 changes: 25 additions & 25 deletions docs/analytics.eventpayload.md
Original file line number Diff line number Diff line change
@@ -6,36 +6,36 @@

The payload accepted by the Analytics Events API.

<b>Signature:</b>
**Signature:**

```typescript
export interface EventPayload
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [action](./analytics.eventpayload.action.md) | [Action](./analytics.action.md) | The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION |
| [authorization?](./analytics.eventpayload.authorization.md) | string | <i>(Optional)</i> The authorization token for the request. This will be setup from the Key or Bearer in the config. |
| [bot?](./analytics.eventpayload.bot.md) | boolean | <i>(Optional)</i> Whether the event is the result of bot activity. |
| [browserAgent?](./analytics.eventpayload.browseragent.md) | { browser?: string; browserVersion?: string; os?: string; osVersion?: string; device?: string; deviceClass?: string; userAgent?: string; } | <i>(Optional)</i> Information about the visitors device and browser. |
| [chat?](./analytics.eventpayload.chat.md) | { botId: string; conversationId?: string; responseId?: string; } | <i>(Optional)</i> Fields specific to reporting Chat Analytics Events |
| [clientSdk?](./analytics.eventpayload.clientsdk.md) | Record&lt;string, string&gt; | <i>(Optional)</i> For the Yext client SDKs involved in the event, this is an object mapping the names of those SDKs to the version labels of those SDKs. |
| [count?](./analytics.eventpayload.count.md) | number | <i>(Optional)</i> When the record summarizes multiple events, the number of events the record represents. The event is treated as if it is duplicated this many times. |
| [customTags?](./analytics.eventpayload.customtags.md) | Record&lt;string, string&gt; | <i>(Optional)</i> Up to 10 pairs matching custom string keys to string values to associate with the event. Keys are case-insensitive; values are case-sensitive. |
| [customValues?](./analytics.eventpayload.customvalues.md) | Record&lt;string, number&gt; | <i>(Optional)</i> Up to 10 pairs matching custom string keys to number values to associate with the event. Keys are case-insensitive. |
| [destinationUrl?](./analytics.eventpayload.destinationurl.md) | string | <i>(Optional)</i> The URL of the page the event is directing the visitor to. |
| [entity?](./analytics.eventpayload.entity.md) | string \| number | <i>(Optional)</i> The Yext entity to which the event corresponds. If passed as a string, the value is the mutable, customer-settable entity ID for the entity associated with the event. If passed as a number, it is the immutable entity ID (UID) set by the system. This is an internal ID. |
| [internalUser?](./analytics.eventpayload.internaluser.md) | boolean | <i>(Optional)</i> Indicates whether the event is the result of internal activity. |
| [ip?](./analytics.eventpayload.ip.md) | { address: string; algorithm?: string; } | <i>(Optional)</i> The IP address for the event. |
| [label?](./analytics.eventpayload.label.md) | string | <i>(Optional)</i> A label assigned to the event, e.g. a CTA label. |
| [locale?](./analytics.eventpayload.locale.md) | string | <i>(Optional)</i> The locale of the user who generated the event. |
| [pageUrl?](./analytics.eventpayload.pageurl.md) | string | <i>(Optional)</i> The URL of the page where the event occurred |
| [referrerUrl?](./analytics.eventpayload.referrerurl.md) | string | <i>(Optional)</i> The URL of the page which the visitor came from prior to the event. |
| [search?](./analytics.eventpayload.search.md) | { searchId?: string; queryId?: string; verticalKey?: string; isDirectAnswer?: boolean; versionLabel?: [VersionLabel](./analytics.versionlabel.md)<!-- -->; versionNumber?: number; experienceKey: string; } | <i>(Optional)</i> Fields specific to reporting Yext Search Analytics Events |
| [sessionId?](./analytics.eventpayload.sessionid.md) | string \| null | <i>(Optional)</i> Unique identifier to tie together events in a single browsing session |
| [sites?](./analytics.eventpayload.sites.md) | { siteUid?: number; template?: string; } | <i>(Optional)</i> Fields specific to reporting Yext Pages Analytics Events |
| [timestamp?](./analytics.eventpayload.timestamp.md) | Date \| string | <i>(Optional)</i> The timestamp at which the event occurred, in ISO format. |
| [visitor?](./analytics.eventpayload.visitor.md) | Record&lt;string, string&gt; | <i>(Optional)</i> Information used to associate analytics with a particular user. |
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [action](./analytics.eventpayload.action.md) | | [Action](./analytics.action.md) | The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION |
| [authorization?](./analytics.eventpayload.authorization.md) | | string | _(Optional)_ The authorization token for the request. This will be setup from the Key or Bearer in the config. |
| [bot?](./analytics.eventpayload.bot.md) | | boolean | _(Optional)_ Whether the event is the result of bot activity. |
| [browserAgent?](./analytics.eventpayload.browseragent.md) | | { browser?: string; browserVersion?: string; os?: string; osVersion?: string; device?: string; deviceClass?: string; userAgent?: string; } | _(Optional)_ Information about the visitors device and browser. |
| [chat?](./analytics.eventpayload.chat.md) | | { botId: string; conversationId?: string; responseId?: string; } | _(Optional)_ Fields specific to reporting Chat Analytics Events |
| [clientSdk?](./analytics.eventpayload.clientsdk.md) | | Record&lt;string, string&gt; | _(Optional)_ For the Yext client SDKs involved in the event, this is an object mapping the names of those SDKs to the version labels of those SDKs. |
| [count?](./analytics.eventpayload.count.md) | | number | _(Optional)_ When the record summarizes multiple events, the number of events the record represents. The event is treated as if it is duplicated this many times. |
| [customTags?](./analytics.eventpayload.customtags.md) | | Record&lt;string, string&gt; | _(Optional)_ Up to 10 pairs matching custom string keys to string values to associate with the event. Keys are case-insensitive; values are case-sensitive. |
| [customValues?](./analytics.eventpayload.customvalues.md) | | Record&lt;string, number&gt; | _(Optional)_ Up to 10 pairs matching custom string keys to number values to associate with the event. Keys are case-insensitive. |
| [destinationUrl?](./analytics.eventpayload.destinationurl.md) | | string | _(Optional)_ The URL of the page the event is directing the visitor to. |
| [entity?](./analytics.eventpayload.entity.md) | | string \| number | _(Optional)_ The Yext entity to which the event corresponds. If passed as a string, the value is the mutable, customer-settable entity ID for the entity associated with the event. If passed as a number, it is the immutable entity ID (UID) set by the system. This is an internal ID. |
| [internalUser?](./analytics.eventpayload.internaluser.md) | | boolean | _(Optional)_ Indicates whether the event is the result of internal activity. |
| [ip?](./analytics.eventpayload.ip.md) | | { address: string; algorithm?: string; } | _(Optional)_ The IP address for the event. |
| [label?](./analytics.eventpayload.label.md) | | string | _(Optional)_ A label assigned to the event, e.g. a CTA label. |
| [locale?](./analytics.eventpayload.locale.md) | | string | _(Optional)_ The locale of the user who generated the event. |
| [pageUrl?](./analytics.eventpayload.pageurl.md) | | string | _(Optional)_ The URL of the page where the event occurred |
| [referrerUrl?](./analytics.eventpayload.referrerurl.md) | | string | _(Optional)_ The URL of the page which the visitor came from prior to the event. |
| [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 |
| [sessionId?](./analytics.eventpayload.sessionid.md) | | string \| null | _(Optional)_ Unique identifier to tie together events in a single browsing session |
| [sites?](./analytics.eventpayload.sites.md) | | { siteUid?: number; template?: string; } | _(Optional)_ Fields specific to reporting Yext Pages Analytics Events |
| [timestamp?](./analytics.eventpayload.timestamp.md) | | Date \| string | _(Optional)_ The timestamp at which the event occurred, in ISO format. |
| [visitor?](./analytics.eventpayload.visitor.md) | | Record&lt;string, string&gt; | _(Optional)_ Information used to associate analytics with a particular user. |

2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.pageurl.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The URL of the page where the event occurred

<b>Signature:</b>
**Signature:**

```typescript
pageUrl?: string;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.referrerurl.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The URL of the page which the visitor came from prior to the event.

<b>Signature:</b>
**Signature:**

```typescript
referrerUrl?: string;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.search.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Fields specific to reporting Yext Search Analytics Events

<b>Signature:</b>
**Signature:**

```typescript
search?: {
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.sessionid.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Unique identifier to tie together events in a single browsing session

<b>Signature:</b>
**Signature:**

```typescript
sessionId?: string | null;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.sites.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Fields specific to reporting Yext Pages Analytics Events

<b>Signature:</b>
**Signature:**

```typescript
sites?: {
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.timestamp.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

The timestamp at which the event occurred, in ISO format.

<b>Signature:</b>
**Signature:**

```typescript
timestamp?: Date | string;
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.visitor.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

Information used to associate analytics with a particular user.

<b>Signature:</b>
**Signature:**

```typescript
visitor?: Record<string, string>;
4 changes: 2 additions & 2 deletions docs/analytics.partialpayload.md
Original file line number Diff line number Diff line change
@@ -6,10 +6,10 @@

A Payload that is a subset of the EventPayload

<b>Signature:</b>
**Signature:**

```typescript
export declare type PartialPayload = Partial<Record<keyof EventPayload, unknown>>;
```
<b>References:</b> [EventPayload](./analytics.eventpayload.md)
**References:** [EventPayload](./analytics.eventpayload.md)

4 changes: 2 additions & 2 deletions docs/analytics.region.md
Original file line number Diff line number Diff line change
@@ -6,12 +6,12 @@

The physical region of the Yext account

<b>Signature:</b>
**Signature:**

```typescript
export declare type Region = EnumOrString<RegionEnum>;
```
<b>References:</b> [EnumOrString](./analytics.enumorstring.md)<!-- -->, [RegionEnum](./analytics.regionenum.md)
**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [RegionEnum](./analytics.regionenum.md)

## Remarks

2 changes: 1 addition & 1 deletion docs/analytics.regionenum.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

An enum of the physical region the Yext account

<b>Signature:</b>
**Signature:**

```typescript
export declare enum RegionEnum
4 changes: 2 additions & 2 deletions docs/analytics.versionlabel.md
Original file line number Diff line number Diff line change
@@ -6,12 +6,12 @@

The Search Version Label

<b>Signature:</b>
**Signature:**

```typescript
export declare type VersionLabel = EnumOrString<VersionLabelEnum>;
```
<b>References:</b> [EnumOrString](./analytics.enumorstring.md)<!-- -->, [VersionLabelEnum](./analytics.versionlabelenum.md)
**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [VersionLabelEnum](./analytics.versionlabelenum.md)

## Remarks

2 changes: 1 addition & 1 deletion docs/analytics.versionlabelenum.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

An enum for the Search Version Labels

<b>Signature:</b>
**Signature:**

```typescript
export declare enum VersionLabelEnum