Automated update to repo's documentation from github action

yext · Jan 30, 2024 · d426ba6 · d426ba6
1 parent ef32739
commit d426ba6
Show file tree

Hide file tree

Showing 9 changed files with 8 additions and 139 deletions.
diff --git a/docs/analytics.enumorstring.md b/docs/analytics.enumorstring.md
diff --git a/docs/analytics.environment.md b/docs/analytics.environment.md
@@ -9,9 +9,8 @@ The Yext Environments
 **Signature:**
 
 ```typescript
-export type Environment = EnumOrString<EnvironmentEnum>;
+export type Environment = 'PRODUCTION' | 'SANDBOX';
 ```
-**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [EnvironmentEnum](./analytics.environmentenum.md)
 
 ## Remarks
 

diff --git a/docs/analytics.environmentenum.md b/docs/analytics.environmentenum.md
diff --git a/docs/analytics.md b/docs/analytics.md
@@ -4,14 +4,6 @@
 
 ## analytics package
 
-## Enumerations
-
-|  Enumeration | Description |
-|  --- | --- |
-|  [EnvironmentEnum](./analytics.environmentenum.md) | An enum for the Yext Environments |
-|  [RegionEnum](./analytics.regionenum.md) | An enum of the physical region the Yext account |
-|  [VersionLabelEnum](./analytics.versionlabelenum.md) | An enum for the Search Version Labels |
-
 ## Functions
 
 |  Function | Description |
@@ -32,8 +24,7 @@
 |  Type Alias | Description |
 |  --- | --- |
 |  [Action](./analytics.action.md) | The action types accepted by the Analytics Events API. |
-|  [EnumOrString](./analytics.enumorstring.md) | A TypeScript utility type which creates a union of an enum member and its string representation. |
 |  [Environment](./analytics.environment.md) | The Yext Environments |
 |  [Region](./analytics.region.md) | The physical region of the Yext account |
-|  [VersionLabel](./analytics.versionlabel.md) | The Search Version Label |
+|  [VersionLabel](./analytics.versionlabel.md) | An enum for the Search Version Labels |
 
diff --git a/docs/analytics.region.md b/docs/analytics.region.md
@@ -9,9 +9,8 @@ The physical region of the Yext account
 **Signature:**
 
 ```typescript
-export type Region = EnumOrString<RegionEnum>;
+export type Region = 'US' | 'EU';
 ```
-**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [RegionEnum](./analytics.regionenum.md)
 
 ## Remarks
 

diff --git a/docs/analytics.regionenum.md b/docs/analytics.regionenum.md
diff --git a/docs/analytics.versionlabel.md b/docs/analytics.versionlabel.md
@@ -4,14 +4,13 @@
 
 ## VersionLabel type
 
-The Search Version Label
+An enum for the Search Version Labels
 
 **Signature:**
 
 ```typescript
-export type VersionLabel = EnumOrString<VersionLabelEnum>;
+export type VersionLabel = 'PRODUCTION' | 'STAGING';
 ```
-**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [VersionLabelEnum](./analytics.versionlabelenum.md)
 
 ## Remarks
 

diff --git a/docs/analytics.versionlabelenum.md b/docs/analytics.versionlabelenum.md
diff --git a/etc/analytics.api.md b/etc/analytics.api.md
@@ -27,17 +27,7 @@ export interface AnalyticsEventService {
 }
 
 // @public
-export type EnumOrString<T extends string> = T | `${T}`;
-
-// @public
-export type Environment = EnumOrString<EnvironmentEnum>;
-
-// @public
-export enum EnvironmentEnum {
-    // (undocumented)
-    Production = "PRODUCTION",
-    Sandbox = "SANDBOX"
-}
+export type Environment = 'PRODUCTION' | 'SANDBOX';
 
 // @public
 export interface EventPayload {
@@ -100,29 +90,13 @@ export interface EventPayload {
 }
 
 // @public
-export type Region = EnumOrString<RegionEnum>;
-
-// @public
-export enum RegionEnum {
-    // (undocumented)
-    EU = "eu",
-    // (undocumented)
-    US = "us"
-}
+export type Region = 'US' | 'EU';
 
 // @public
 export function reportBrowserAnalytics(): Promise<string>;
 
 // @public
-export type VersionLabel = EnumOrString<VersionLabelEnum>;
-
-// @public
-export enum VersionLabelEnum {
-    // (undocumented)
-    Production = "PRODUCTION",
-    // (undocumented)
-    Staging = "STAGING"
-}
+export type VersionLabel = 'PRODUCTION' | 'STAGING';
 
 // (No @packageDocumentation comment for this package)