Add EnvoyMetaZone

docs/README.md

@@ -117,6 +117,7 @@
 - [EnvoyMetaCompany](README.md#envoymetacompany)
 - [EnvoyMetaJob](README.md#envoymetajob)
 - [EnvoyMetaLocation](README.md#envoymetalocation)
+- [EnvoyMetaZone](README.md#envoymetazone)
 - [EnvoyRouteMeta](README.md#envoyroutemeta)
 
 ### Request Type aliases
@@ -910,6 +911,7 @@ Metadata that will be included in the request body for events.
 | `install_id` | `string` |
 | `job` | [EnvoyMetaJob](README.md#envoymetajob)<Event\> |
 | `location` | [EnvoyMetaLocation](README.md#envoymetalocation) |
+| `zone` | [EnvoyMetaZone](README.md#envoymetazone) |
 | `plugin_id` | `string` |
 
 #### Defined in
@@ -1016,6 +1018,22 @@ ___
 
 [sdk/EnvoyMeta.ts:13](https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/410ee70/src/sdk/EnvoyMeta.ts#L13)
 
+### EnvoyMetaZone
+
+Ƭ **EnvoyMetaZone**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `attributes` | `Object` |
+| `attributes.address` | `string` \| ``null`` |
+| `attributes.logo-url` | `string` \| ``null`` |
+| `attributes.name` | `string` |
+| `attributes.time-zone` | `string` |
+| `id` | `string` |
+| `type` | ``"zones"`` |
+
 ___
 
 ### EnvoyRouteMeta
@@ -1042,6 +1060,7 @@ like validation URLs or options URLs.
 | `forwarded_bearer_token?` | `string` |
 | `install_id` | `string` |
 | `location` | [EnvoyMetaLocation](README.md#envoymetalocation) |
+| `zone` | [EnvoyMetaZone](README.md#envoymetazone) |
 | `params` | `Params` |
 | `plugin_id` | `string` |
 | `route` | `string` |

src/factories/eventBodyFactory.ts

@@ -13,6 +13,7 @@ export type EventBodyFactoryOptions<Event, Config, Payload> = {
   scope: Array<EnvoyUserAPIScope>,
   locationId?: string,
   companyId?: string,
+  zoneId?: string,
 };
 
 export default function eventBodyFactory<
@@ -29,6 +30,7 @@ export default function eventBodyFactory<
       options.scope,
       options.locationId || eventBodyFactoryDefaultIds.locationId,
       options.companyId || eventBodyFactoryDefaultIds.companyId,
+      options.zoneId || eventBodyFactoryDefaultIds.zoneId,
     ).build(),
     payload: options.payload,
   };

src/factories/metaFactory.ts

@@ -6,6 +6,7 @@ import {
   EnvoyMetaCompany,
   EnvoyMetaJob,
   EnvoyMetaLocation,
+  EnvoyMetaZone,
   EnvoyRouteMeta,
 } from '../sdk/EnvoyMeta';
 import { EnvoyUserAPIScope } from '../sdk/EnvoyUserAPI';
@@ -55,6 +56,20 @@ export function companyFactory(id: string): Sync.Factory<EnvoyMetaCompany> {
   });
 }
 
+export function zoneFactory(id: string): Sync.Factory<EnvoyMetaZone> {
+  const street = faker.address.streetAddress();
+  return Sync.makeFactory<EnvoyMetaZone>({
+    id,
+    type: 'zones',
+    attributes: {
+      address: street,
+      'logo-url': null,
+      name: faker.company.companyName(),
+      'time-zone': faker.address.timeZone(),
+    },
+  });
+}
+
 export function authFactory(): Sync.Factory<EnvoyMetaAuth> {
   return Sync.makeFactory<EnvoyMetaAuth>({
     token_type: 'Bearer',
@@ -75,12 +90,14 @@ export function routeMetaFactory<
   scope: Array<EnvoyUserAPIScope>,
   locationId: string,
   companyId: string,
+  zoneId: string,
 ): Sync.Factory<EnvoyRouteMeta> {
   return Sync.makeFactory<EnvoyRouteMeta>({
     plugin_id: faker.datatype.uuid(),
     install_id: Math.ceil(Math.abs(faker.datatype.number())).toString(),
     location: locationFactory(locationId).build(),
     company: companyFactory(companyId).build(),
+    zone: zoneFactory(zoneId).build(),
     auth: scope.length ? authFactory().build() : null,
     forwarded_bearer_token: faker.random.alphaNumeric(),
     route,
@@ -95,13 +112,15 @@ export function eventMetaFactory<Config extends Record<string, unknown> = Record
   scope: Array<EnvoyUserAPIScope>,
   locationId: string,
   companyId: string,
+  zoneId: string,
 ): Sync.Factory<EnvoyEventMeta> {
   return Sync.makeFactory<EnvoyEventMeta>({
     plugin_id: faker.datatype.uuid(),
     install_id: Math.ceil(Math.abs(faker.datatype.number())).toString(),
     job: jobFactory(event).build(),
     location: locationFactory(locationId).build(),
     company: companyFactory(companyId).build(),
+    zone: zoneFactory(zoneId).build(),
     auth: scope.length ? authFactory().build() : null,
     event,
     config,

src/factories/routeBodyFactory.ts

@@ -4,6 +4,7 @@ import { routeMetaFactory } from './metaFactory';
 export const routeBodyFactoryDefaultIds = {
   locationId: '1',
   companyId: '1',
+  zoneId: '1',
 };
 
 export type RouteBodyFactoryOptions<Config, Params, Payload> = {
@@ -13,6 +14,7 @@ export type RouteBodyFactoryOptions<Config, Params, Payload> = {
   scope?: Array<EnvoyUserAPIScope>,
   locationId?: string,
   companyId?: string,
+  zoneId?: string,
   route?: string,
 };
 
@@ -31,6 +33,7 @@ export default function routeBodyFactory<
       options.scope || [],
       options.locationId || routeBodyFactoryDefaultIds.locationId,
       options.companyId || routeBodyFactoryDefaultIds.companyId,
+      options.zoneId || routeBodyFactoryDefaultIds.zoneId,
     ).build(),
     payload: options.payload,
   };

src/sdk/EnvoyMeta.ts

@@ -44,6 +44,20 @@ export type EnvoyMetaCompany = {
   }
 };
 
+/**
+ * @category Meta
+ */
+export type EnvoyMetaZone = {
+  id: string,
+  type: 'zones',
+  attributes: {
+    address: string | null,
+    'logo-url': string | null,
+    name: string,
+    'time-zone': string,
+  }
+};
+
 /**
  * A short-lived `userAPI` token.
  * Will be used to construct the `userAPI` property found in `req.envoy.userAPI`.
@@ -71,6 +85,7 @@ export type EnvoyEventMeta<Event extends string = string, Config = Record<string
   job: EnvoyMetaJob<Event>,
   location: EnvoyMetaLocation,
   company: EnvoyMetaCompany,
+  zone: EnvoyMetaZone,
   auth: EnvoyMetaAuth | null,
 };
 
@@ -88,6 +103,7 @@ export type EnvoyRouteMeta<Config = Record<string, unknown>, Params = Record<str
   params: Params,
   location: EnvoyMetaLocation,
   company: EnvoyMetaCompany,
+  zone: EnvoyMetaZone,
   auth: EnvoyMetaAuth | null,
   forwarded_bearer_token?: string,
 };