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 Nov 13, 2023
1 parent be90b35 commit e57c209
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
17 changes: 0 additions & 17 deletions docs/analytics.analyticsgtm.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| Function | Description |
| --- | --- |
| [analytics(config)](./analytics.analytics.md) | The Yext Analytics Events SDK. Returns an AnalyticsEventService given an AnalyticsConfig. |
| [analyticsGTM()](./analytics.analyticsgtm.md) | The exported function of Yext Analytics Events SDK used for Google Tag Manager. |
| [reportBrowserAnalytics()](./analytics.reportbrowseranalytics.md) | An alternative entry point for the Yext Analytics Events SDK, currently used by Google Tag Manager. This method reads the config and payload from the variable analyticsEventPayload stored in the global window object. The config and payload are then passed to the report function to be sent to the Yext Analytics Events API. |

## Interfaces

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

[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [reportBrowserAnalytics](./analytics.reportbrowseranalytics.md)

## reportBrowserAnalytics() function

An alternative entry point for the Yext Analytics Events SDK, currently used by Google Tag Manager. This method reads the config and payload from the variable analyticsEventPayload stored in the global window object. The config and payload are then passed to the report function to be sent to the Yext Analytics Events API.

<b>Signature:</b>

```typescript
export declare function reportBrowserAnalytics(): Promise<string>;
```
<b>Returns:</b>

Promise&lt;string&gt;

6 changes: 3 additions & 3 deletions etc/analytics.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@ export interface AnalyticsEventService {
with(payload: EventPayload): AnalyticsEventService;
}

// @public
export function analyticsGTM(): Promise<string>;

// @public
export type EnumOrString<T extends string> = T | `${T}`;

Expand Down Expand Up @@ -108,6 +105,9 @@ export enum RegionEnum {
US = "us"
}

// @public
export function reportBrowserAnalytics(): Promise<string>;

// @public
export type VersionLabel = EnumOrString<VersionLabelEnum>;

Expand Down

0 comments on commit e57c209

Please sign in to comment.