@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,764 @@
+# DevicesApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateDevice**](DevicesApi.md#activatedevice) | **POST** /devices/{device_id}/activate | Activate a device |
+| [**createDevice**](DevicesApi.md#createdeviceoperation) | **POST** /devices | Create a new device |
+| [**deactivateDevice**](DevicesApi.md#deactivatedevice) | **POST** /devices/{device_id}/deactivate | Deactivate a device |
+| [**decommissionDevice**](DevicesApi.md#decommissiondevice) | **POST** /devices/{device_id}/decommission | Decommission a device |
+| [**deleteDevice**](DevicesApi.md#deletedevice) | **DELETE** /devices/{device_id} | Delete a device |
+| [**getDevice**](DevicesApi.md#getdevice) | **GET** /devices/{device_id} | Get device by ID |
+| [**listDevices**](DevicesApi.md#listdevices) | **GET** /devices | List devices |
+| [**startDeviceMaintenance**](DevicesApi.md#startdevicemaintenance) | **POST** /devices/{device_id}/start-maintenance | Start device maintenance |
+| [**updateDevice**](DevicesApi.md#updatedeviceoperation) | **PUT** /devices/{device_id} | Update a device |
+| [**updateDeviceHeartbeat**](DevicesApi.md#updatedeviceheartbeat) | **POST** /devices/{device_id}/heartbeat | Report device heartbeat with location |
+| [**updateDeviceLocation**](DevicesApi.md#updatedevicelocationoperation) | **POST** /devices/{device_id}/location | Update device location |
+
+
+
+## activateDevice
+
+> DeviceResponse activateDevice(deviceId)
+
+Activate a device
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { ActivateDeviceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateDeviceRequest;
+
+  try {
+    const data = await api.activateDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device activated |  -  |
+| **404** | Device not found |  -  |
+| **409** | Invalid device state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createDevice
+
+> DeviceResponse createDevice(createDeviceRequest)
+
+Create a new device
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { CreateDeviceOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // CreateDeviceRequest
+    createDeviceRequest: ...,
+  } satisfies CreateDeviceOperationRequest;
+
+  try {
+    const data = await api.createDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createDeviceRequest** | [CreateDeviceRequest](CreateDeviceRequest.md) |  | |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Device created |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deactivateDevice
+
+> DeviceResponse deactivateDevice(deviceId)
+
+Deactivate a device
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { DeactivateDeviceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeactivateDeviceRequest;
+
+  try {
+    const data = await api.deactivateDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device deactivated |  -  |
+| **404** | Device not found |  -  |
+| **409** | Invalid device state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## decommissionDevice
+
+> DeviceResponse decommissionDevice(deviceId)
+
+Decommission a device
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { DecommissionDeviceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DecommissionDeviceRequest;
+
+  try {
+    const data = await api.decommissionDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device decommissioned |  -  |
+| **404** | Device not found |  -  |
+| **409** | Invalid device state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteDevice
+
+> deleteDevice(deviceId)
+
+Delete a device
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { DeleteDeviceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteDeviceRequest;
+
+  try {
+    const data = await api.deleteDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Device deleted |  -  |
+| **404** | Device not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDevice
+
+> DeviceResponse getDevice(deviceId)
+
+Get device by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { GetDeviceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetDeviceRequest;
+
+  try {
+    const data = await api.getDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device found |  -  |
+| **404** | Device not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDevices
+
+> ListDevicesResponse listDevices(status, offset, limit)
+
+List devices
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { ListDevicesRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // DeviceStatus (optional)
+    status: ...,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListDevicesRequest;
+
+  try {
+    const data = await api.listDevices(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **status** | `DeviceStatus` |  | [Optional] [Defaults to `undefined`] [Enum: ACTIVE, INACTIVE, MAINTENANCE, DECOMMISSIONED] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListDevicesResponse**](ListDevicesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of devices |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## startDeviceMaintenance
+
+> DeviceResponse startDeviceMaintenance(deviceId)
+
+Start device maintenance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { StartDeviceMaintenanceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies StartDeviceMaintenanceRequest;
+
+  try {
+    const data = await api.startDeviceMaintenance(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device maintenance started |  -  |
+| **404** | Device not found |  -  |
+| **409** | Invalid device state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateDevice
+
+> DeviceResponse updateDevice(deviceId, updateDeviceRequest)
+
+Update a device
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { UpdateDeviceOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateDeviceRequest
+    updateDeviceRequest: ...,
+  } satisfies UpdateDeviceOperationRequest;
+
+  try {
+    const data = await api.updateDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+| **updateDeviceRequest** | [UpdateDeviceRequest](UpdateDeviceRequest.md) |  | |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Device not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateDeviceHeartbeat
+
+> DeviceResponse updateDeviceHeartbeat(deviceId, deviceHeartbeatRequest)
+
+Report device heartbeat with location
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { UpdateDeviceHeartbeatRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // DeviceHeartbeatRequest
+    deviceHeartbeatRequest: ...,
+  } satisfies UpdateDeviceHeartbeatRequest;
+
+  try {
+    const data = await api.updateDeviceHeartbeat(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+| **deviceHeartbeatRequest** | [DeviceHeartbeatRequest](DeviceHeartbeatRequest.md) |  | |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Heartbeat recorded |  -  |
+| **404** | Device not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateDeviceLocation
+
+> DeviceResponse updateDeviceLocation(deviceId, updateDeviceLocationRequest)
+
+Update device location
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DevicesApi,
+} from '';
+import type { UpdateDeviceLocationOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DevicesApi();
+
+  const body = {
+    // string
+    deviceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateDeviceLocationRequest
+    updateDeviceLocationRequest: ...,
+  } satisfies UpdateDeviceLocationOperationRequest;
+
+  try {
+    const data = await api.updateDeviceLocation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+| **updateDeviceLocationRequest** | [UpdateDeviceLocationRequest](UpdateDeviceLocationRequest.md) |  | |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Location updated |  -  |
+| **404** | Device not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+