Skip to content

Commit

Permalink
Automated update to repo's documentation from github action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 25, 2023
1 parent 8650c76 commit 8283a9c
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/analytics.eventpayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ export interface EventPayload
| [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. |
| [value?](./analytics.eventpayload.value.md) | { amount: number; currency: string; } | <i>(Optional)</i> The monetary value of the event. |
| [visitor?](./analytics.eventpayload.visitor.md) | Record&lt;string, string&gt; | <i>(Optional)</i> Information used to associate analytics with a particular user. |

16 changes: 16 additions & 0 deletions docs/analytics.eventpayload.value.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [EventPayload](./analytics.eventpayload.md) &gt; [value](./analytics.eventpayload.value.md)

## EventPayload.value property

The monetary value of the event.

<b>Signature:</b>

```typescript
value?: {
amount: number;
currency: string;
};
```
4 changes: 4 additions & 0 deletions etc/analytics.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ export interface EventPayload {
template?: string;
};
timestamp?: Date | string;
value?: {
amount: number;
currency: string;
};
visitor?: Record<string, string>;
}

Expand Down

0 comments on commit 8283a9c

Please sign in to comment.