yext / analytics / 8085316004

84%

push

github

EventsSDK: Document eligible $auto fields (#132)

The SDK EventPayload does not make it clear if certain fields do not
need to be set by the user because they can be automatically inferred
when the the value is set to `$auto` (which is the default value for
several fields).

This change adds documentation to the EventPayload so these fields are
indicated.

[J=FUS-6251](https://yexttest.atlassian.net/browse/FUS-6251)
R=abenno, mtian
TEST=manual

Ran `npm run build` to confirm everything is formatted correctly.

---------

Co-authored-by: Ethan Jaffee <ejaffee@yext.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

73 of 84 branches covered (86.9%)

Branch coverage included in aggregate %.

80 of 99 relevant lines covered (80.81%)

8.01 hits per line