@streetlevel/api-clients 1.0.1

package/src/generated/device/docs/GetDevice404Response.md

@@ -0,0 +1,41 @@
+
+# GetDevice404Response
+
+Standard error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetDevice404Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": null,
+  "message": null,
+  "timestamp": null,
+  "details": null,
+} satisfies GetDevice404Response
+
+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 GetDevice404Response
+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/device/docs/ListDevicesResponse.md

@@ -0,0 +1,41 @@
+
+# ListDevicesResponse
+
+Paginated list of devices
+
+## Properties
+
+Name | Type
+------------ | -------------
+`devices` | [Array<DeviceResponse>](DeviceResponse.md)
+`total` | number
+`offset` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { ListDevicesResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "devices": null,
+  "total": null,
+  "offset": null,
+  "limit": null,
+} satisfies ListDevicesResponse
+
+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 ListDevicesResponse
+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/device/docs/StartMaintenanceRequest.md

@@ -0,0 +1,37 @@
+
+# StartMaintenanceRequest
+
+Request to start device maintenance
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reason` | string
+`estimatedDurationHours` | number
+
+## Example
+
+```typescript
+import type { StartMaintenanceRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "reason": null,
+  "estimatedDurationHours": null,
+} satisfies StartMaintenanceRequest
+
+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 StartMaintenanceRequest
+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/device/docs/UpdateDeviceLocationRequest.md

@@ -0,0 +1,45 @@
+
+# UpdateDeviceLocationRequest
+
+Request to update device location
+
+## Properties
+
+Name | Type
+------------ | -------------
+`latitude` | number
+`longitude` | number
+`accuracy` | number
+`speed` | number
+`heading` | number
+`timestamp` | Date
+
+## Example
+
+```typescript
+import type { UpdateDeviceLocationRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "latitude": null,
+  "longitude": null,
+  "accuracy": null,
+  "speed": null,
+  "heading": null,
+  "timestamp": null,
+} satisfies UpdateDeviceLocationRequest
+
+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 UpdateDeviceLocationRequest
+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/device/docs/UpdateDeviceRequest.md

@@ -0,0 +1,41 @@
+
+# UpdateDeviceRequest
+
+Request to update a device
+
+## Properties
+
+Name | Type
+------------ | -------------
+`carId` | string
+`model` | string
+`firmwareVersion` | string
+`status` | [DeviceStatus](DeviceStatus.md)
+
+## Example
+
+```typescript
+import type { UpdateDeviceRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "carId": null,
+  "model": null,
+  "firmwareVersion": null,
+  "status": null,
+} satisfies UpdateDeviceRequest
+
+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 UpdateDeviceRequest
+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/device/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/generated/device/models/CreateDevice400Response.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Device API
+ * API for managing ad display devices
+ *
+ * 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 { CreateDevice400ResponseViolationsInner } from './CreateDevice400ResponseViolationsInner';
+import {
+    CreateDevice400ResponseViolationsInnerFromJSON,
+    CreateDevice400ResponseViolationsInnerFromJSONTyped,
+    CreateDevice400ResponseViolationsInnerToJSON,
+    CreateDevice400ResponseViolationsInnerToJSONTyped,
+} from './CreateDevice400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface CreateDevice400Response
+ */
+export interface CreateDevice400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDevice400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDevice400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreateDevice400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<CreateDevice400ResponseViolationsInner>}
+     * @memberof CreateDevice400Response
+     */
+    violations: Array<CreateDevice400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateDevice400Response interface.
+ */
+export function instanceOfCreateDevice400Response(value: object): value is CreateDevice400Response {
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('violations' in value) || value['violations'] === undefined) return false;
+    return true;
+}
+
+export function CreateDevice400ResponseFromJSON(json: any): CreateDevice400Response {
+    return CreateDevice400ResponseFromJSONTyped(json, false);
+}
+
+export function CreateDevice400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDevice400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorCode': json['error_code'],
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+        'violations': ((json['violations'] as Array<any>).map(CreateDevice400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function CreateDevice400ResponseToJSON(json: any): CreateDevice400Response {
+    return CreateDevice400ResponseToJSONTyped(json, false);
+}
+
+export function CreateDevice400ResponseToJSONTyped(value?: CreateDevice400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error_code': value['errorCode'],
+        'message': value['message'],
+        'timestamp': value['timestamp'].toISOString(),
+        'violations': ((value['violations'] as Array<any>).map(CreateDevice400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/device/models/CreateDevice400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Device API
+ * API for managing ad display devices
+ *
+ * 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';
+/**
+ * Validation violation for a specific field
+ * @export
+ * @interface CreateDevice400ResponseViolationsInner
+ */
+export interface CreateDevice400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof CreateDevice400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof CreateDevice400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreateDevice400ResponseViolationsInner interface.
+ */
+export function instanceOfCreateDevice400ResponseViolationsInner(value: object): value is CreateDevice400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CreateDevice400ResponseViolationsInnerFromJSON(json: any): CreateDevice400ResponseViolationsInner {
+    return CreateDevice400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function CreateDevice400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDevice400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function CreateDevice400ResponseViolationsInnerToJSON(json: any): CreateDevice400ResponseViolationsInner {
+    return CreateDevice400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function CreateDevice400ResponseViolationsInnerToJSONTyped(value?: CreateDevice400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+

package/src/generated/device/models/CreateDeviceRequest.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Device API
+ * API for managing ad display devices
+ *
+ * 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 create a device
+ * @export
+ * @interface CreateDeviceRequest
+ */
+export interface CreateDeviceRequest {
+    /**
+     * ID of the car this device is installed in
+     * @type {string}
+     * @memberof CreateDeviceRequest
+     */
+    carId?: string;
+    /**
+     * ID of the client
+     * @type {string}
+     * @memberof CreateDeviceRequest
+     */
+    clientId?: string;
+    /**
+     * Device serial number
+     * @type {string}
+     * @memberof CreateDeviceRequest
+     */
+    serialNumber: string;
+    /**
+     * Device model
+     * @type {string}
+     * @memberof CreateDeviceRequest
+     */
+    model?: string;
+    /**
+     * Device manufacturer
+     * @type {string}
+     * @memberof CreateDeviceRequest
+     */
+    manufacturer?: string;
+    /**
+     * Device firmware version
+     * @type {string}
+     * @memberof CreateDeviceRequest
+     */
+    firmwareVersion?: string;
+}
+
+/**
+ * Check if a given object implements the CreateDeviceRequest interface.
+ */
+export function instanceOfCreateDeviceRequest(value: object): value is CreateDeviceRequest {
+    if (!('serialNumber' in value) || value['serialNumber'] === undefined) return false;
+    return true;
+}
+
+export function CreateDeviceRequestFromJSON(json: any): CreateDeviceRequest {
+    return CreateDeviceRequestFromJSONTyped(json, false);
+}
+
+export function CreateDeviceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDeviceRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'carId': json['car_id'] == null ? undefined : json['car_id'],
+        'clientId': json['client_id'] == null ? undefined : json['client_id'],
+        'serialNumber': json['serial_number'],
+        'model': json['model'] == null ? undefined : json['model'],
+        'manufacturer': json['manufacturer'] == null ? undefined : json['manufacturer'],
+        'firmwareVersion': json['firmware_version'] == null ? undefined : json['firmware_version'],
+    };
+}
+
+export function CreateDeviceRequestToJSON(json: any): CreateDeviceRequest {
+    return CreateDeviceRequestToJSONTyped(json, false);
+}
+
+export function CreateDeviceRequestToJSONTyped(value?: CreateDeviceRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'car_id': value['carId'],
+        'client_id': value['clientId'],
+        'serial_number': value['serialNumber'],
+        'model': value['model'],
+        'manufacturer': value['manufacturer'],
+        'firmware_version': value['firmwareVersion'],
+    };
+}
+

package/src/generated/device/models/DeviceDecommissionRequest.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Device API
+ * API for managing ad display devices
+ *
+ * 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 decommission a device
+ * @export
+ * @interface DeviceDecommissionRequest
+ */
+export interface DeviceDecommissionRequest {
+    /**
+     * Reason for decommissioning
+     * @type {string}
+     * @memberof DeviceDecommissionRequest
+     */
+    reason?: string;
+}
+
+/**
+ * Check if a given object implements the DeviceDecommissionRequest interface.
+ */
+export function instanceOfDeviceDecommissionRequest(value: object): value is DeviceDecommissionRequest {
+    return true;
+}
+
+export function DeviceDecommissionRequestFromJSON(json: any): DeviceDecommissionRequest {
+    return DeviceDecommissionRequestFromJSONTyped(json, false);
+}
+
+export function DeviceDecommissionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeviceDecommissionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+
+export function DeviceDecommissionRequestToJSON(json: any): DeviceDecommissionRequest {
+    return DeviceDecommissionRequestToJSONTyped(json, false);
+}
+
+export function DeviceDecommissionRequestToJSONTyped(value?: DeviceDecommissionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reason': value['reason'],
+    };
+}
+

package/src/generated/device/models/DeviceHeartbeatRequest.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Device API
+ * API for managing ad display devices
+ *
+ * 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';
+/**
+ * Device heartbeat with location
+ * @export
+ * @interface DeviceHeartbeatRequest
+ */
+export interface DeviceHeartbeatRequest {
+    /**
+     * Device latitude
+     * @type {number}
+     * @memberof DeviceHeartbeatRequest
+     */
+    latitude?: number;
+    /**
+     * Device longitude
+     * @type {number}
+     * @memberof DeviceHeartbeatRequest
+     */
+    longitude?: number;
+}
+
+/**
+ * Check if a given object implements the DeviceHeartbeatRequest interface.
+ */
+export function instanceOfDeviceHeartbeatRequest(value: object): value is DeviceHeartbeatRequest {
+    return true;
+}
+
+export function DeviceHeartbeatRequestFromJSON(json: any): DeviceHeartbeatRequest {
+    return DeviceHeartbeatRequestFromJSONTyped(json, false);
+}
+
+export function DeviceHeartbeatRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeviceHeartbeatRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'latitude': json['latitude'] == null ? undefined : json['latitude'],
+        'longitude': json['longitude'] == null ? undefined : json['longitude'],
+    };
+}
+
+export function DeviceHeartbeatRequestToJSON(json: any): DeviceHeartbeatRequest {
+    return DeviceHeartbeatRequestToJSONTyped(json, false);
+}
+
+export function DeviceHeartbeatRequestToJSONTyped(value?: DeviceHeartbeatRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'latitude': value['latitude'],
+        'longitude': value['longitude'],
+    };
+}
+