@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,682 @@
+# ZonesApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateZone**](ZonesApi.md#activatezone) | **POST** /zones/{zone_id}/activate | Activate a zone |
+| [**checkPointInZones**](ZonesApi.md#checkpointinzonesoperation) | **POST** /zones/check-point | Check which zones contain a given point |
+| [**createZone**](ZonesApi.md#createzoneoperation) | **POST** /zones | Create a new zone |
+| [**deactivateZone**](ZonesApi.md#deactivatezone) | **POST** /zones/{zone_id}/deactivate | Deactivate a zone |
+| [**deleteZone**](ZonesApi.md#deletezone) | **DELETE** /zones/{zone_id} | Delete a zone |
+| [**getZone**](ZonesApi.md#getzone) | **GET** /zones/{zone_id} | Get zone by ID |
+| [**getZoneTerminals**](ZonesApi.md#getzoneterminals) | **GET** /zones/{zone_id}/terminals | Get terminals in a zone |
+| [**listZones**](ZonesApi.md#listzones) | **GET** /zones | List zones |
+| [**syncZonesFromProvider**](ZonesApi.md#synczonesfromprovider) | **POST** /zones/sync | Sync zones from the LED cloud provider |
+| [**updateZone**](ZonesApi.md#updatezoneoperation) | **PUT** /zones/{zone_id} | Update a zone |
+
+
+
+## activateZone
+
+> ZoneResponse activateZone(zoneId)
+
+Activate a zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { ActivateZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // string
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateZoneRequest;
+
+  try {
+    const data = await api.activateZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ZoneResponse**](ZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zone activated |  -  |
+| **404** | Zone 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)
+
+
+## checkPointInZones
+
+> ZonesContainingPointResponse checkPointInZones(checkPointInZonesRequest)
+
+Check which zones contain a given point
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { CheckPointInZonesOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // CheckPointInZonesRequest
+    checkPointInZonesRequest: ...,
+  } satisfies CheckPointInZonesOperationRequest;
+
+  try {
+    const data = await api.checkPointInZones(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **checkPointInZonesRequest** | [CheckPointInZonesRequest](CheckPointInZonesRequest.md) |  | |
+
+### Return type
+
+[**ZonesContainingPointResponse**](ZonesContainingPointResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zones containing the point |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createZone
+
+> ZoneResponse createZone(createZoneRequest)
+
+Create a new zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { CreateZoneOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // CreateZoneRequest
+    createZoneRequest: ...,
+  } satisfies CreateZoneOperationRequest;
+
+  try {
+    const data = await api.createZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createZoneRequest** | [CreateZoneRequest](CreateZoneRequest.md) |  | |
+
+### Return type
+
+[**ZoneResponse**](ZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Zone 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)
+
+
+## deactivateZone
+
+> ZoneResponse deactivateZone(zoneId)
+
+Deactivate a zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { DeactivateZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // string
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeactivateZoneRequest;
+
+  try {
+    const data = await api.deactivateZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ZoneResponse**](ZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zone deactivated |  -  |
+| **404** | Zone 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)
+
+
+## deleteZone
+
+> deleteZone(zoneId)
+
+Delete a zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { DeleteZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // string
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteZoneRequest;
+
+  try {
+    const data = await api.deleteZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zoneId** | `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** | Zone deleted |  -  |
+| **404** | Zone 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)
+
+
+## getZone
+
+> ZoneResponse getZone(zoneId)
+
+Get zone by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { GetZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // string
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetZoneRequest;
+
+  try {
+    const data = await api.getZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ZoneResponse**](ZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zone found |  -  |
+| **404** | Zone 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)
+
+
+## getZoneTerminals
+
+> ZoneTerminalsResponse getZoneTerminals(zoneId)
+
+Get terminals in a zone
+
+Returns all LED terminals belonging to this zone from the LED cloud provider.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { GetZoneTerminalsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // string
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetZoneTerminalsRequest;
+
+  try {
+    const data = await api.getZoneTerminals(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ZoneTerminalsResponse**](ZoneTerminalsResponse.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 terminals |  -  |
+| **404** | Zone 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)
+
+
+## listZones
+
+> ListZonesResponse listZones(active, offset, limit)
+
+List zones
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { ListZonesRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // boolean | Filter by active status (optional)
+    active: true,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListZonesRequest;
+
+  try {
+    const data = await api.listZones(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **active** | `boolean` | Filter by active status | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListZonesResponse**](ListZonesResponse.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 zones |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## syncZonesFromProvider
+
+> SyncZonesResponse syncZonesFromProvider()
+
+Sync zones from the LED cloud provider
+
+Fetches terminal groups from the configured LED cloud provider (e.g., ColorLight) and creates or updates corresponding zones in Street Level. This keeps zones in sync with the provider\'s terminal organization. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { SyncZonesFromProviderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  try {
+    const data = await api.syncZonesFromProvider();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SyncZonesResponse**](SyncZonesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Sync completed |  -  |
+| **500** | Sync failed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateZone
+
+> ZoneResponse updateZone(zoneId, updateZoneRequest)
+
+Update a zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ZonesApi,
+} from '';
+import type { UpdateZoneOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ZonesApi();
+
+  const body = {
+    // string
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateZoneRequest
+    updateZoneRequest: ...,
+  } satisfies UpdateZoneOperationRequest;
+
+  try {
+    const data = await api.updateZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zoneId** | `string` |  | [Defaults to `undefined`] |
+| **updateZoneRequest** | [UpdateZoneRequest](UpdateZoneRequest.md) |  | |
+
+### Return type
+
+[**ZoneResponse**](ZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zone updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Zone 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)
+

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

@@ -0,0 +1,35 @@
+
+# ZonesContainingPointResponse
+
+Zones that contain a point
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zones` | [Array<ZoneResponse>](ZoneResponse.md)
+
+## Example
+
+```typescript
+import type { ZonesContainingPointResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "zones": null,
+} satisfies ZonesContainingPointResponse
+
+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 ZonesContainingPointResponse
+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/index.ts

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