Skip to content

Commit

Permalink
Analytics SDK: Update region/environment to be only upper case (#133)
Browse files Browse the repository at this point in the history
Instead of allowing upper and lower case region and environment names,
allow just upper-case names.

J=FUS-6250
TEST=manual

Ran npm i/npm run build/npm run test and made sure that all unit tests
passed.
  • Loading branch information
pcammarata1 authored Feb 21, 2024
1 parent b50fc28 commit 2b0b208
Show file tree
Hide file tree
Showing 9 changed files with 368 additions and 21 deletions.
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 = 'PRODUCTION' | 'SANDBOX' | 'production' | 'sandbox';
export type Environment = 'PRODUCTION' | 'SANDBOX';
```

## Remarks
Expand Down
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 = 'US' | 'EU' | 'us' | 'eu';
export type Region = 'US' | 'EU';
```

## Remarks
Expand Down
4 changes: 2 additions & 2 deletions etc/analytics.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface AnalyticsEventService {
}

// @public
export type Environment = 'PRODUCTION' | 'SANDBOX' | 'production' | 'sandbox';
export type Environment = 'PRODUCTION' | 'SANDBOX';

// @public
export interface EventPayload {
Expand Down Expand Up @@ -91,7 +91,7 @@ export interface EventPayload {
}

// @public
export type Region = 'US' | 'EU' | 'us' | 'eu';
export type Region = 'US' | 'EU';

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

0 comments on commit 2b0b208

Please sign in to comment.