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 Jan 26, 2024
1 parent 3243eac commit 482849f
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/analytics.action.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ The action types accepted by the Analytics Events API.
**Signature:**

```typescript
export 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' | 'PAGE_VIEW' | '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';
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' | 'PAGE_VIEW' | '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';
```
2 changes: 1 addition & 1 deletion docs/analytics.enumorstring.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A TypeScript utility type which creates a union of an enum member and its string
**Signature:**

```typescript
export type EnumOrString<T extends string> = T | `${T}`;
export declare type EnumOrString<T extends string> = T | `${T}`;
```

## Remarks
Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Yext Environments
**Signature:**

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

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.partialpayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A Payload that is a subset of the EventPayload
**Signature:**

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

2 changes: 1 addition & 1 deletion docs/analytics.region.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The physical region of the Yext account
**Signature:**

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

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.versionlabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Search Version Label
**Signature:**

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

Expand Down

0 comments on commit 482849f

Please sign in to comment.