@streetlevel/api-clients 1.0.1

package/src/generated/zone/models/ListZonesResponse.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Zone API
+ * API for managing geographic zones for ad targeting
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ZoneResponse } from './ZoneResponse';
+import {
+    ZoneResponseFromJSON,
+    ZoneResponseFromJSONTyped,
+    ZoneResponseToJSON,
+    ZoneResponseToJSONTyped,
+} from './ZoneResponse';
+
+/**
+ * Paginated list of zones
+ * @export
+ * @interface ListZonesResponse
+ */
+export interface ListZonesResponse {
+    /**
+     * 
+     * @type {Array<ZoneResponse>}
+     * @memberof ListZonesResponse
+     */
+    zones: Array<ZoneResponse>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListZonesResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListZonesResponse
+     */
+    offset: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListZonesResponse
+     */
+    limit: number;
+}
+
+/**
+ * Check if a given object implements the ListZonesResponse interface.
+ */
+export function instanceOfListZonesResponse(value: object): value is ListZonesResponse {
+    if (!('zones' in value) || value['zones'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    return true;
+}
+
+export function ListZonesResponseFromJSON(json: any): ListZonesResponse {
+    return ListZonesResponseFromJSONTyped(json, false);
+}
+
+export function ListZonesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListZonesResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'zones': ((json['zones'] as Array<any>).map(ZoneResponseFromJSON)),
+        'total': json['total'],
+        'offset': json['offset'],
+        'limit': json['limit'],
+    };
+}
+
+export function ListZonesResponseToJSON(json: any): ListZonesResponse {
+    return ListZonesResponseToJSONTyped(json, false);
+}
+
+export function ListZonesResponseToJSONTyped(value?: ListZonesResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'zones': ((value['zones'] as Array<any>).map(ZoneResponseToJSON)),
+        'total': value['total'],
+        'offset': value['offset'],
+        'limit': value['limit'],
+    };
+}
+

package/src/generated/zone/models/SyncZonesResponse.ts

@@ -0,0 +1,109 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Zone API
+ * API for managing geographic zones for ad targeting
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ZoneResponse } from './ZoneResponse';
+import {
+    ZoneResponseFromJSON,
+    ZoneResponseFromJSONTyped,
+    ZoneResponseToJSON,
+    ZoneResponseToJSONTyped,
+} from './ZoneResponse';
+
+/**
+ * Result of syncing zones from the LED provider
+ * @export
+ * @interface SyncZonesResponse
+ */
+export interface SyncZonesResponse {
+    /**
+     * When the sync completed
+     * @type {Date}
+     * @memberof SyncZonesResponse
+     */
+    syncedAt: Date;
+    /**
+     * Number of new zones created
+     * @type {number}
+     * @memberof SyncZonesResponse
+     */
+    zonesCreated: number;
+    /**
+     * Number of existing zones updated
+     * @type {number}
+     * @memberof SyncZonesResponse
+     */
+    zonesUpdated: number;
+    /**
+     * Total number of zones after sync
+     * @type {number}
+     * @memberof SyncZonesResponse
+     */
+    totalZones: number;
+    /**
+     * All zones after sync
+     * @type {Array<ZoneResponse>}
+     * @memberof SyncZonesResponse
+     */
+    zones?: Array<ZoneResponse>;
+}
+
+/**
+ * Check if a given object implements the SyncZonesResponse interface.
+ */
+export function instanceOfSyncZonesResponse(value: object): value is SyncZonesResponse {
+    if (!('syncedAt' in value) || value['syncedAt'] === undefined) return false;
+    if (!('zonesCreated' in value) || value['zonesCreated'] === undefined) return false;
+    if (!('zonesUpdated' in value) || value['zonesUpdated'] === undefined) return false;
+    if (!('totalZones' in value) || value['totalZones'] === undefined) return false;
+    return true;
+}
+
+export function SyncZonesResponseFromJSON(json: any): SyncZonesResponse {
+    return SyncZonesResponseFromJSONTyped(json, false);
+}
+
+export function SyncZonesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncZonesResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'syncedAt': (new Date(json['synced_at'])),
+        'zonesCreated': json['zones_created'],
+        'zonesUpdated': json['zones_updated'],
+        'totalZones': json['total_zones'],
+        'zones': json['zones'] == null ? undefined : ((json['zones'] as Array<any>).map(ZoneResponseFromJSON)),
+    };
+}
+
+export function SyncZonesResponseToJSON(json: any): SyncZonesResponse {
+    return SyncZonesResponseToJSONTyped(json, false);
+}
+
+export function SyncZonesResponseToJSONTyped(value?: SyncZonesResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'synced_at': value['syncedAt'].toISOString(),
+        'zones_created': value['zonesCreated'],
+        'zones_updated': value['zonesUpdated'],
+        'total_zones': value['totalZones'],
+        'zones': value['zones'] == null ? undefined : ((value['zones'] as Array<any>).map(ZoneResponseToJSON)),
+    };
+}
+

package/src/generated/zone/models/Terminal.ts

@@ -0,0 +1,120 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Zone API
+ * API for managing geographic zones for ad targeting
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * An LED terminal (screen) in the network
+ * @export
+ * @interface Terminal
+ */
+export interface Terminal {
+    /**
+     * Street Level terminal ID
+     * @type {string}
+     * @memberof Terminal
+     */
+    id: string;
+    /**
+     * LED provider's terminal ID
+     * @type {string}
+     * @memberof Terminal
+     */
+    externalId?: string;
+    /**
+     * Terminal name
+     * @type {string}
+     * @memberof Terminal
+     */
+    name: string;
+    /**
+     * Zone this terminal belongs to
+     * @type {string}
+     * @memberof Terminal
+     */
+    zoneId?: string;
+    /**
+     * Terminal connection state
+     * @type {TerminalStateEnum}
+     * @memberof Terminal
+     */
+    state: TerminalStateEnum;
+    /**
+     * When the terminal was last seen online
+     * @type {Date}
+     * @memberof Terminal
+     */
+    lastSeen?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const TerminalStateEnum = {
+    Online: 'ONLINE',
+    Offline: 'OFFLINE',
+    Unknown: 'UNKNOWN'
+} as const;
+export type TerminalStateEnum = typeof TerminalStateEnum[keyof typeof TerminalStateEnum];
+
+
+/**
+ * Check if a given object implements the Terminal interface.
+ */
+export function instanceOfTerminal(value: object): value is Terminal {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    return true;
+}
+
+export function TerminalFromJSON(json: any): Terminal {
+    return TerminalFromJSONTyped(json, false);
+}
+
+export function TerminalFromJSONTyped(json: any, ignoreDiscriminator: boolean): Terminal {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'name': json['name'],
+        'zoneId': json['zone_id'] == null ? undefined : json['zone_id'],
+        'state': json['state'],
+        'lastSeen': json['last_seen'] == null ? undefined : (new Date(json['last_seen'])),
+    };
+}
+
+export function TerminalToJSON(json: any): Terminal {
+    return TerminalToJSONTyped(json, false);
+}
+
+export function TerminalToJSONTyped(value?: Terminal | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'external_id': value['externalId'],
+        'name': value['name'],
+        'zone_id': value['zoneId'],
+        'state': value['state'],
+        'last_seen': value['lastSeen'] == null ? value['lastSeen'] : value['lastSeen'].toISOString(),
+    };
+}
+

package/src/generated/zone/models/UpdateZoneRequest.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Zone API
+ * API for managing geographic zones for ad targeting
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Request to update a zone
+ * @export
+ * @interface UpdateZoneRequest
+ */
+export interface UpdateZoneRequest {
+    /**
+     * Zone name
+     * @type {string}
+     * @memberof UpdateZoneRequest
+     */
+    name: string;
+    /**
+     * Zone description
+     * @type {string}
+     * @memberof UpdateZoneRequest
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the UpdateZoneRequest interface.
+ */
+export function instanceOfUpdateZoneRequest(value: object): value is UpdateZoneRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function UpdateZoneRequestFromJSON(json: any): UpdateZoneRequest {
+    return UpdateZoneRequestFromJSONTyped(json, false);
+}
+
+export function UpdateZoneRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateZoneRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function UpdateZoneRequestToJSON(json: any): UpdateZoneRequest {
+    return UpdateZoneRequestToJSONTyped(json, false);
+}
+
+export function UpdateZoneRequestToJSONTyped(value?: UpdateZoneRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+

package/src/generated/zone/models/ZoneResponse.ts

@@ -0,0 +1,207 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Zone API
+ * API for managing geographic zones for ad targeting
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { GeoJsonPolygon } from './GeoJsonPolygon';
+import {
+    GeoJsonPolygonFromJSON,
+    GeoJsonPolygonFromJSONTyped,
+    GeoJsonPolygonToJSON,
+    GeoJsonPolygonToJSONTyped,
+} from './GeoJsonPolygon';
+import type { ZoneResponseCenter } from './ZoneResponseCenter';
+import {
+    ZoneResponseCenterFromJSON,
+    ZoneResponseCenterFromJSONTyped,
+    ZoneResponseCenterToJSON,
+    ZoneResponseCenterToJSONTyped,
+} from './ZoneResponseCenter';
+
+/**
+ * Zone information
+ * @export
+ * @interface ZoneResponse
+ */
+export interface ZoneResponse {
+    /**
+     * Zone unique identifier
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    id: string;
+    /**
+     * External LED provider's ID for this zone (e.g., ColorLight terminal group ID).
+     * Null if zone was created locally and not synced from provider.
+     * 
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    externalId?: string;
+    /**
+     * Zone name
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    name: string;
+    /**
+     * City where the zone is located
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    city?: string;
+    /**
+     * Region or district within the city
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    region?: string;
+    /**
+     * Zone description
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    description?: string;
+    /**
+     * 
+     * @type {GeoJsonPolygon}
+     * @memberof ZoneResponse
+     */
+    boundaries?: GeoJsonPolygon;
+    /**
+     * 
+     * @type {ZoneResponseCenter}
+     * @memberof ZoneResponse
+     */
+    center?: ZoneResponseCenter;
+    /**
+     * Radius in kilometers
+     * @type {number}
+     * @memberof ZoneResponse
+     */
+    radiusKm?: number;
+    /**
+     * Number of LED terminals in this zone
+     * @type {number}
+     * @memberof ZoneResponse
+     */
+    terminalCount?: number;
+    /**
+     * Whether zone is active
+     * @type {boolean}
+     * @memberof ZoneResponse
+     */
+    active: boolean;
+    /**
+     * ID of the playlist currently published to this zone (null if none)
+     * @type {string}
+     * @memberof ZoneResponse
+     */
+    publishedPlaylistId?: string;
+    /**
+     * When the current playlist was published to this zone
+     * @type {Date}
+     * @memberof ZoneResponse
+     */
+    publishedAt?: Date;
+    /**
+     * When this zone was last synced from the LED provider
+     * @type {Date}
+     * @memberof ZoneResponse
+     */
+    lastSyncedAt?: Date;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof ZoneResponse
+     */
+    createdAt: Date;
+    /**
+     * Last modification timestamp
+     * @type {Date}
+     * @memberof ZoneResponse
+     */
+    lastModifiedAt: Date;
+}
+
+/**
+ * Check if a given object implements the ZoneResponse interface.
+ */
+export function instanceOfZoneResponse(value: object): value is ZoneResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('active' in value) || value['active'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('lastModifiedAt' in value) || value['lastModifiedAt'] === undefined) return false;
+    return true;
+}
+
+export function ZoneResponseFromJSON(json: any): ZoneResponse {
+    return ZoneResponseFromJSONTyped(json, false);
+}
+
+export function ZoneResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZoneResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'name': json['name'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'region': json['region'] == null ? undefined : json['region'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'boundaries': json['boundaries'] == null ? undefined : GeoJsonPolygonFromJSON(json['boundaries']),
+        'center': json['center'] == null ? undefined : ZoneResponseCenterFromJSON(json['center']),
+        'radiusKm': json['radius_km'] == null ? undefined : json['radius_km'],
+        'terminalCount': json['terminal_count'] == null ? undefined : json['terminal_count'],
+        'active': json['active'],
+        'publishedPlaylistId': json['published_playlist_id'] == null ? undefined : json['published_playlist_id'],
+        'publishedAt': json['published_at'] == null ? undefined : (new Date(json['published_at'])),
+        'lastSyncedAt': json['last_synced_at'] == null ? undefined : (new Date(json['last_synced_at'])),
+        'createdAt': (new Date(json['created_at'])),
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+    };
+}
+
+export function ZoneResponseToJSON(json: any): ZoneResponse {
+    return ZoneResponseToJSONTyped(json, false);
+}
+
+export function ZoneResponseToJSONTyped(value?: ZoneResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'external_id': value['externalId'],
+        'name': value['name'],
+        'city': value['city'],
+        'region': value['region'],
+        'description': value['description'],
+        'boundaries': GeoJsonPolygonToJSON(value['boundaries']),
+        'center': ZoneResponseCenterToJSON(value['center']),
+        'radius_km': value['radiusKm'],
+        'terminal_count': value['terminalCount'],
+        'active': value['active'],
+        'published_playlist_id': value['publishedPlaylistId'],
+        'published_at': value['publishedAt'] == null ? value['publishedAt'] : value['publishedAt'].toISOString(),
+        'last_synced_at': value['lastSyncedAt'] == null ? value['lastSyncedAt'] : value['lastSyncedAt'].toISOString(),
+        'created_at': value['createdAt'].toISOString(),
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+    };
+}
+

package/src/generated/zone/models/ZoneResponseCenter.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Zone API
+ * API for managing geographic zones for ad targeting
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Center point
+ * @export
+ * @interface ZoneResponseCenter
+ */
+export interface ZoneResponseCenter {
+    /**
+     * Latitude in degrees
+     * @type {number}
+     * @memberof ZoneResponseCenter
+     */
+    latitude: number;
+    /**
+     * Longitude in degrees
+     * @type {number}
+     * @memberof ZoneResponseCenter
+     */
+    longitude: number;
+}
+
+/**
+ * Check if a given object implements the ZoneResponseCenter interface.
+ */
+export function instanceOfZoneResponseCenter(value: object): value is ZoneResponseCenter {
+    if (!('latitude' in value) || value['latitude'] === undefined) return false;
+    if (!('longitude' in value) || value['longitude'] === undefined) return false;
+    return true;
+}
+
+export function ZoneResponseCenterFromJSON(json: any): ZoneResponseCenter {
+    return ZoneResponseCenterFromJSONTyped(json, false);
+}
+
+export function ZoneResponseCenterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZoneResponseCenter {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'latitude': json['latitude'],
+        'longitude': json['longitude'],
+    };
+}
+
+export function ZoneResponseCenterToJSON(json: any): ZoneResponseCenter {
+    return ZoneResponseCenterToJSONTyped(json, false);
+}
+
+export function ZoneResponseCenterToJSONTyped(value?: ZoneResponseCenter | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'latitude': value['latitude'],
+        'longitude': value['longitude'],
+    };
+}
+