@streetlevel/api-clients 1.0.1

package/src/generated/clientzone/docs/ClientZonesApi.md

@@ -0,0 +1,700 @@
+# ClientZonesApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateClientZone**](ClientZonesApi.md#activateclientzone) | **POST** /client-zones/{client_zone_id}/activate | Activate a client zone |
+| [**addClientZoneItem**](ClientZonesApi.md#addclientzoneitem) | **POST** /client-zones/{client_zone_id}/items | Add an item to the client zone |
+| [**createClientZone**](ClientZonesApi.md#createclientzoneoperation) | **POST** /client-zones | Create a new client zone |
+| [**deactivateClientZone**](ClientZonesApi.md#deactivateclientzone) | **POST** /client-zones/{client_zone_id}/deactivate | Deactivate a client zone |
+| [**deleteClientZone**](ClientZonesApi.md#deleteclientzone) | **DELETE** /client-zones/{client_zone_id} | Delete a client zone |
+| [**getClientZone**](ClientZonesApi.md#getclientzone) | **GET** /client-zones/{client_zone_id} | Get client zone by ID |
+| [**listClientZoneItems**](ClientZonesApi.md#listclientzoneitems) | **GET** /client-zones/{client_zone_id}/items | List items in a client zone |
+| [**listClientZones**](ClientZonesApi.md#listclientzones) | **GET** /client-zones | List client zones |
+| [**removeClientZoneItem**](ClientZonesApi.md#removeclientzoneitem) | **DELETE** /client-zones/{client_zone_id}/items/{item_id} | Remove an item from the client zone |
+| [**updateClientZone**](ClientZonesApi.md#updateclientzoneoperation) | **PUT** /client-zones/{client_zone_id} | Update a client zone |
+
+
+
+## activateClientZone
+
+> ClientZoneResponse activateClientZone(clientZoneId)
+
+Activate a client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { ActivateClientZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateClientZoneRequest;
+
+  try {
+    const data = await api.activateClientZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ClientZoneResponse**](ClientZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Client zone activated |  -  |
+| **404** | Client 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)
+
+
+## addClientZoneItem
+
+> ClientZoneItemResponse addClientZoneItem(clientZoneId, createClientZoneItemRequest)
+
+Add an item to the client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { AddClientZoneItemRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CreateClientZoneItemRequest
+    createClientZoneItemRequest: ...,
+  } satisfies AddClientZoneItemRequest;
+
+  try {
+    const data = await api.addClientZoneItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+| **createClientZoneItemRequest** | [CreateClientZoneItemRequest](CreateClientZoneItemRequest.md) |  | |
+
+### Return type
+
+[**ClientZoneItemResponse**](ClientZoneItemResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Item added |  -  |
+| **400** | Validation error |  -  |
+| **404** | Client 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)
+
+
+## createClientZone
+
+> ClientZoneResponse createClientZone(createClientZoneRequest)
+
+Create a new client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { CreateClientZoneOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // CreateClientZoneRequest
+    createClientZoneRequest: ...,
+  } satisfies CreateClientZoneOperationRequest;
+
+  try {
+    const data = await api.createClientZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createClientZoneRequest** | [CreateClientZoneRequest](CreateClientZoneRequest.md) |  | |
+
+### Return type
+
+[**ClientZoneResponse**](ClientZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Client 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)
+
+
+## deactivateClientZone
+
+> ClientZoneResponse deactivateClientZone(clientZoneId)
+
+Deactivate a client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { DeactivateClientZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeactivateClientZoneRequest;
+
+  try {
+    const data = await api.deactivateClientZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ClientZoneResponse**](ClientZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Client zone deactivated |  -  |
+| **404** | Client 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)
+
+
+## deleteClientZone
+
+> deleteClientZone(clientZoneId)
+
+Delete a client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { DeleteClientZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteClientZoneRequest;
+
+  try {
+    const data = await api.deleteClientZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `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** | Client zone deleted |  -  |
+| **404** | Client 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)
+
+
+## getClientZone
+
+> ClientZoneResponse getClientZone(clientZoneId)
+
+Get client zone by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { GetClientZoneRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetClientZoneRequest;
+
+  try {
+    const data = await api.getClientZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ClientZoneResponse**](ClientZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Client zone found |  -  |
+| **404** | Client 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)
+
+
+## listClientZoneItems
+
+> ListClientZoneItemsResponse listClientZoneItems(clientZoneId)
+
+List items in a client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { ListClientZoneItemsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ListClientZoneItemsRequest;
+
+  try {
+    const data = await api.listClientZoneItems(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ListClientZoneItemsResponse**](ListClientZoneItemsResponse.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 client zone items |  -  |
+| **404** | Client 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)
+
+
+## listClientZones
+
+> ListClientZonesResponse listClientZones(clientId, zoneId, active, offset, limit)
+
+List client zones
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { ListClientZonesRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string | Filter by client ID (optional)
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Filter by zone ID (optional)
+    zoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Filter by active status (optional)
+    active: true,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListClientZonesRequest;
+
+  try {
+    const data = await api.listClientZones(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` | Filter by client ID | [Optional] [Defaults to `undefined`] |
+| **zoneId** | `string` | Filter by zone ID | [Optional] [Defaults to `undefined`] |
+| **active** | `boolean` | Filter by active status | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListClientZonesResponse**](ListClientZonesResponse.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 client zones |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeClientZoneItem
+
+> removeClientZoneItem(clientZoneId, itemId)
+
+Remove an item from the client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { RemoveClientZoneItemRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies RemoveClientZoneItemRequest;
+
+  try {
+    const data = await api.removeClientZoneItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+| **itemId** | `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** | Item removed |  -  |
+| **404** | Item 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)
+
+
+## updateClientZone
+
+> ClientZoneResponse updateClientZone(clientZoneId, updateClientZoneRequest)
+
+Update a client zone
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientZonesApi,
+} from '';
+import type { UpdateClientZoneOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientZonesApi();
+
+  const body = {
+    // string
+    clientZoneId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateClientZoneRequest
+    updateClientZoneRequest: ...,
+  } satisfies UpdateClientZoneOperationRequest;
+
+  try {
+    const data = await api.updateClientZone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientZoneId** | `string` |  | [Defaults to `undefined`] |
+| **updateClientZoneRequest** | [UpdateClientZoneRequest](UpdateClientZoneRequest.md) |  | |
+
+### Return type
+
+[**ClientZoneResponse**](ClientZoneResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Client zone updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Client 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)
+