@streetlevel/api-clients 1.0.1

package/src/generated/zone/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ZonesApi';

package/src/generated/zone/docs/CheckPointInZonesRequest.md

@@ -0,0 +1,37 @@
+
+# CheckPointInZonesRequest
+
+Geographic coordinate with latitude and longitude
+
+## Properties
+
+Name | Type
+------------ | -------------
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { CheckPointInZonesRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "latitude": null,
+  "longitude": null,
+} satisfies CheckPointInZonesRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CheckPointInZonesRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/CreateZone400Response.md

@@ -0,0 +1,41 @@
+
+# CreateZone400Response
+
+Validation error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`violations` | [Array<CreateZone400ResponseViolationsInner>](CreateZone400ResponseViolationsInner.md)
+
+## Example
+
+```typescript
+import type { CreateZone400Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": VALIDATION_ERROR,
+  "message": null,
+  "timestamp": null,
+  "violations": null,
+} satisfies CreateZone400Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateZone400Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/CreateZone400ResponseViolationsInner.md

@@ -0,0 +1,37 @@
+
+# CreateZone400ResponseViolationsInner
+
+Validation violation for a specific field
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CreateZone400ResponseViolationsInner } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "field": null,
+  "message": null,
+} satisfies CreateZone400ResponseViolationsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateZone400ResponseViolationsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/CreateZoneRequest.md

@@ -0,0 +1,47 @@
+
+# CreateZoneRequest
+
+Request to create a zone
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`city` | string
+`region` | string
+`description` | string
+`boundaries` | [GeoJsonPolygon](GeoJsonPolygon.md)
+`center` | [CreateZoneRequestCenter](CreateZoneRequestCenter.md)
+`radiusKm` | number
+
+## Example
+
+```typescript
+import type { CreateZoneRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "city": null,
+  "region": null,
+  "description": null,
+  "boundaries": null,
+  "center": null,
+  "radiusKm": null,
+} satisfies CreateZoneRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateZoneRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/CreateZoneRequestCenter.md

@@ -0,0 +1,37 @@
+
+# CreateZoneRequestCenter
+
+Center point for circular zones
+
+## Properties
+
+Name | Type
+------------ | -------------
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { CreateZoneRequestCenter } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "latitude": null,
+  "longitude": null,
+} satisfies CreateZoneRequestCenter
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateZoneRequestCenter
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/GeoJsonPolygon.md

@@ -0,0 +1,37 @@
+
+# GeoJsonPolygon
+
+GeoJSON polygon representation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`coordinates` | Array<Array<Array<number>>>
+
+## Example
+
+```typescript
+import type { GeoJsonPolygon } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "coordinates": null,
+} satisfies GeoJsonPolygon
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GeoJsonPolygon
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/GetZone404Response.md

@@ -0,0 +1,41 @@
+
+# GetZone404Response
+
+Standard error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetZone404Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": null,
+  "message": null,
+  "timestamp": null,
+  "details": null,
+} satisfies GetZone404Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetZone404Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/ListZonesResponse.md

@@ -0,0 +1,41 @@
+
+# ListZonesResponse
+
+Paginated list of zones
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zones` | [Array<ZoneResponse>](ZoneResponse.md)
+`total` | number
+`offset` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { ListZonesResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "zones": null,
+  "total": null,
+  "offset": null,
+  "limit": null,
+} satisfies ListZonesResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListZonesResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/SyncZonesResponse.md

@@ -0,0 +1,43 @@
+
+# SyncZonesResponse
+
+Result of syncing zones from the LED provider
+
+## Properties
+
+Name | Type
+------------ | -------------
+`syncedAt` | Date
+`zonesCreated` | number
+`zonesUpdated` | number
+`totalZones` | number
+`zones` | [Array<ZoneResponse>](ZoneResponse.md)
+
+## Example
+
+```typescript
+import type { SyncZonesResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "syncedAt": null,
+  "zonesCreated": null,
+  "zonesUpdated": null,
+  "totalZones": null,
+  "zones": null,
+} satisfies SyncZonesResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SyncZonesResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/Terminal.md

@@ -0,0 +1,45 @@
+
+# Terminal
+
+An LED terminal (screen) in the network
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`name` | string
+`zoneId` | string
+`state` | string
+`lastSeen` | Date
+
+## Example
+
+```typescript
+import type { Terminal } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "name": null,
+  "zoneId": null,
+  "state": null,
+  "lastSeen": null,
+} satisfies Terminal
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Terminal
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/UpdateZoneRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateZoneRequest
+
+Request to update a zone
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { UpdateZoneRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+} satisfies UpdateZoneRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UpdateZoneRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/ZoneResponse.md

@@ -0,0 +1,65 @@
+
+# ZoneResponse
+
+Zone information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`name` | string
+`city` | string
+`region` | string
+`description` | string
+`boundaries` | [GeoJsonPolygon](GeoJsonPolygon.md)
+`center` | [ZoneResponseCenter](ZoneResponseCenter.md)
+`radiusKm` | number
+`terminalCount` | number
+`active` | boolean
+`publishedPlaylistId` | string
+`publishedAt` | Date
+`lastSyncedAt` | Date
+`createdAt` | Date
+`lastModifiedAt` | Date
+
+## Example
+
+```typescript
+import type { ZoneResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "name": null,
+  "city": null,
+  "region": null,
+  "description": null,
+  "boundaries": null,
+  "center": null,
+  "radiusKm": null,
+  "terminalCount": null,
+  "active": null,
+  "publishedPlaylistId": null,
+  "publishedAt": null,
+  "lastSyncedAt": null,
+  "createdAt": null,
+  "lastModifiedAt": null,
+} satisfies ZoneResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZoneResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/ZoneResponseCenter.md

@@ -0,0 +1,37 @@
+
+# ZoneResponseCenter
+
+Center point
+
+## Properties
+
+Name | Type
+------------ | -------------
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { ZoneResponseCenter } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "latitude": null,
+  "longitude": null,
+} satisfies ZoneResponseCenter
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZoneResponseCenter
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/generated/zone/docs/ZoneTerminalsResponse.md

@@ -0,0 +1,37 @@
+
+# ZoneTerminalsResponse
+
+Terminals in a zone
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zoneId` | string
+`terminals` | [Array<Terminal>](Terminal.md)
+
+## Example
+
+```typescript
+import type { ZoneTerminalsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "zoneId": null,
+  "terminals": null,
+} satisfies ZoneTerminalsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZoneTerminalsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+