@streetlevel/api-clients 1.0.1

package/src/generated/carsupplier/docs/CarSuppliersApi.md

@@ -0,0 +1,486 @@
+# CarSuppliersApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateCarSupplier**](CarSuppliersApi.md#activatecarsupplier) | **POST** /car-suppliers/{supplier_id}/activate | Activate a car supplier |
+| [**createCarSupplier**](CarSuppliersApi.md#createcarsupplieroperation) | **POST** /car-suppliers | Create a new car supplier |
+| [**deactivateCarSupplier**](CarSuppliersApi.md#deactivatecarsupplier) | **POST** /car-suppliers/{supplier_id}/deactivate | Deactivate a car supplier |
+| [**deleteCarSupplier**](CarSuppliersApi.md#deletecarsupplier) | **DELETE** /car-suppliers/{supplier_id} | Delete a car supplier |
+| [**getCarSupplier**](CarSuppliersApi.md#getcarsupplier) | **GET** /car-suppliers/{supplier_id} | Get car supplier by ID |
+| [**listCarSuppliers**](CarSuppliersApi.md#listcarsuppliers) | **GET** /car-suppliers | List car suppliers |
+| [**updateCarSupplier**](CarSuppliersApi.md#updatecarsupplieroperation) | **PUT** /car-suppliers/{supplier_id} | Update a car supplier |
+
+
+
+## activateCarSupplier
+
+> CarSupplierResponse activateCarSupplier(supplierId)
+
+Activate a car supplier
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { ActivateCarSupplierRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // string
+    supplierId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateCarSupplierRequest;
+
+  try {
+    const data = await api.activateCarSupplier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **supplierId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CarSupplierResponse**](CarSupplierResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Car supplier activated |  -  |
+| **404** | Car supplier 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)
+
+
+## createCarSupplier
+
+> CarSupplierResponse createCarSupplier(createCarSupplierRequest)
+
+Create a new car supplier
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { CreateCarSupplierOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // CreateCarSupplierRequest
+    createCarSupplierRequest: ...,
+  } satisfies CreateCarSupplierOperationRequest;
+
+  try {
+    const data = await api.createCarSupplier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createCarSupplierRequest** | [CreateCarSupplierRequest](CreateCarSupplierRequest.md) |  | |
+
+### Return type
+
+[**CarSupplierResponse**](CarSupplierResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Car supplier 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)
+
+
+## deactivateCarSupplier
+
+> CarSupplierResponse deactivateCarSupplier(supplierId)
+
+Deactivate a car supplier
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { DeactivateCarSupplierRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // string
+    supplierId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeactivateCarSupplierRequest;
+
+  try {
+    const data = await api.deactivateCarSupplier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **supplierId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CarSupplierResponse**](CarSupplierResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Car supplier deactivated |  -  |
+| **404** | Car supplier 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)
+
+
+## deleteCarSupplier
+
+> deleteCarSupplier(supplierId)
+
+Delete a car supplier
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { DeleteCarSupplierRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // string
+    supplierId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteCarSupplierRequest;
+
+  try {
+    const data = await api.deleteCarSupplier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **supplierId** | `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** | Car supplier deleted |  -  |
+| **404** | Car supplier 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)
+
+
+## getCarSupplier
+
+> CarSupplierResponse getCarSupplier(supplierId)
+
+Get car supplier by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { GetCarSupplierRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // string
+    supplierId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCarSupplierRequest;
+
+  try {
+    const data = await api.getCarSupplier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **supplierId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CarSupplierResponse**](CarSupplierResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Car supplier found |  -  |
+| **404** | Car supplier 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)
+
+
+## listCarSuppliers
+
+> ListCarSuppliersResponse listCarSuppliers(active, offset, limit)
+
+List car suppliers
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { ListCarSuppliersRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // boolean | Filter by active status (optional)
+    active: true,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListCarSuppliersRequest;
+
+  try {
+    const data = await api.listCarSuppliers(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
+
+[**ListCarSuppliersResponse**](ListCarSuppliersResponse.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 car suppliers |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateCarSupplier
+
+> CarSupplierResponse updateCarSupplier(supplierId, updateCarSupplierRequest)
+
+Update a car supplier
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarSuppliersApi,
+} from '';
+import type { UpdateCarSupplierOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarSuppliersApi();
+
+  const body = {
+    // string
+    supplierId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateCarSupplierRequest
+    updateCarSupplierRequest: ...,
+  } satisfies UpdateCarSupplierOperationRequest;
+
+  try {
+    const data = await api.updateCarSupplier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **supplierId** | `string` |  | [Defaults to `undefined`] |
+| **updateCarSupplierRequest** | [UpdateCarSupplierRequest](UpdateCarSupplierRequest.md) |  | |
+
+### Return type
+
+[**CarSupplierResponse**](CarSupplierResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Car supplier updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Car supplier 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/carsupplier/docs/CreateCarSupplier400Response.md

@@ -0,0 +1,41 @@
+
+# CreateCarSupplier400Response
+
+Validation error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`violations` | [Array<CreateCarSupplier400ResponseViolationsInner>](CreateCarSupplier400ResponseViolationsInner.md)
+
+## Example
+
+```typescript
+import type { CreateCarSupplier400Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": VALIDATION_ERROR,
+  "message": null,
+  "timestamp": null,
+  "violations": null,
+} satisfies CreateCarSupplier400Response
+
+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 CreateCarSupplier400Response
+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/carsupplier/docs/CreateCarSupplier400ResponseViolationsInner.md

@@ -0,0 +1,37 @@
+
+# CreateCarSupplier400ResponseViolationsInner
+
+Validation violation for a specific field
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CreateCarSupplier400ResponseViolationsInner } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "field": null,
+  "message": null,
+} satisfies CreateCarSupplier400ResponseViolationsInner
+
+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 CreateCarSupplier400ResponseViolationsInner
+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/carsupplier/docs/CreateCarSupplierRequest.md

@@ -0,0 +1,43 @@
+
+# CreateCarSupplierRequest
+
+Request to create a car supplier
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`contactName` | string
+`contactEmail` | string
+`contactPhone` | string
+`address` | string
+
+## Example
+
+```typescript
+import type { CreateCarSupplierRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "contactName": null,
+  "contactEmail": null,
+  "contactPhone": null,
+  "address": null,
+} satisfies CreateCarSupplierRequest
+
+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 CreateCarSupplierRequest
+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/carsupplier/docs/GetCarSupplier404Response.md

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

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