@streetlevel/api-clients 1.0.1

package/src/generated/car/docs/AssignDriverRequest.md

@@ -0,0 +1,37 @@
+
+# AssignDriverRequest
+
+Request to assign a driver
+
+## Properties
+
+Name | Type
+------------ | -------------
+`driverName` | string
+`driverPhone` | string
+
+## Example
+
+```typescript
+import type { AssignDriverRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "driverName": null,
+  "driverPhone": null,
+} satisfies AssignDriverRequest
+
+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 AssignDriverRequest
+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/car/docs/CarResponse.md

@@ -0,0 +1,61 @@
+
+# CarResponse
+
+Car information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`carSupplierId` | string
+`clientId` | string
+`licensePlate` | string
+`vehicleType` | [VehicleType](VehicleType.md)
+`make` | string
+`model` | string
+`year` | number
+`color` | string
+`status` | [CarStatus](CarStatus.md)
+`driverName` | string
+`driverPhone` | string
+`createdAt` | Date
+`lastModifiedAt` | Date
+
+## Example
+
+```typescript
+import type { CarResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "carSupplierId": null,
+  "clientId": null,
+  "licensePlate": null,
+  "vehicleType": null,
+  "make": null,
+  "model": null,
+  "year": null,
+  "color": null,
+  "status": null,
+  "driverName": null,
+  "driverPhone": null,
+  "createdAt": null,
+  "lastModifiedAt": null,
+} satisfies CarResponse
+
+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 CarResponse
+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/car/docs/CarStatus.md

@@ -0,0 +1,33 @@
+
+# CarStatus
+
+Car operational status
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { CarStatus } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies CarStatus
+
+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 CarStatus
+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/car/docs/CarsApi.md

@@ -0,0 +1,561 @@
+# CarsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**assignDriverToCar**](CarsApi.md#assigndrivertocar) | **POST** /cars/{car_id}/assign-driver | Assign a driver to the car |
+| [**createCar**](CarsApi.md#createcaroperation) | **POST** /cars | Create a new car |
+| [**deleteCar**](CarsApi.md#deletecar) | **DELETE** /cars/{car_id} | Delete a car |
+| [**getCar**](CarsApi.md#getcar) | **GET** /cars/{car_id} | Get car by ID |
+| [**listCars**](CarsApi.md#listcars) | **GET** /cars | List cars |
+| [**makeCarAvailable**](CarsApi.md#makecaravailable) | **POST** /cars/{car_id}/available | Make car available |
+| [**putCarInService**](CarsApi.md#putcarinservice) | **POST** /cars/{car_id}/in-service | Put car in service |
+| [**updateCar**](CarsApi.md#updatecaroperation) | **PUT** /cars/{car_id} | Update a car |
+
+
+
+## assignDriverToCar
+
+> CarResponse assignDriverToCar(carId, assignDriverRequest)
+
+Assign a driver to the car
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { AssignDriverToCarRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string
+    carId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AssignDriverRequest
+    assignDriverRequest: ...,
+  } satisfies AssignDriverToCarRequest;
+
+  try {
+    const data = await api.assignDriverToCar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carId** | `string` |  | [Defaults to `undefined`] |
+| **assignDriverRequest** | [AssignDriverRequest](AssignDriverRequest.md) |  | |
+
+### Return type
+
+[**CarResponse**](CarResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Driver assigned |  -  |
+| **404** | Car 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)
+
+
+## createCar
+
+> CarResponse createCar(createCarRequest)
+
+Create a new car
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { CreateCarOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // CreateCarRequest
+    createCarRequest: ...,
+  } satisfies CreateCarOperationRequest;
+
+  try {
+    const data = await api.createCar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createCarRequest** | [CreateCarRequest](CreateCarRequest.md) |  | |
+
+### Return type
+
+[**CarResponse**](CarResponse.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 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)
+
+
+## deleteCar
+
+> deleteCar(carId)
+
+Delete a car
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { DeleteCarRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string
+    carId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteCarRequest;
+
+  try {
+    const data = await api.deleteCar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carId** | `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 deleted |  -  |
+| **404** | Car 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)
+
+
+## getCar
+
+> CarResponse getCar(carId)
+
+Get car by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { GetCarRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string
+    carId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCarRequest;
+
+  try {
+    const data = await api.getCar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CarResponse**](CarResponse.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 found |  -  |
+| **404** | Car 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)
+
+
+## listCars
+
+> ListCarsResponse listCars(carSupplierId, status, offset, limit)
+
+List cars
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { ListCarsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string | Filter by car supplier ID (optional)
+    carSupplierId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CarStatus (optional)
+    status: ...,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListCarsRequest;
+
+  try {
+    const data = await api.listCars(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carSupplierId** | `string` | Filter by car supplier ID | [Optional] [Defaults to `undefined`] |
+| **status** | `CarStatus` |  | [Optional] [Defaults to `undefined`] [Enum: ACTIVE, INACTIVE, MAINTENANCE, DECOMMISSIONED] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListCarsResponse**](ListCarsResponse.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 cars |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## makeCarAvailable
+
+> CarResponse makeCarAvailable(carId)
+
+Make car available
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { MakeCarAvailableRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string
+    carId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies MakeCarAvailableRequest;
+
+  try {
+    const data = await api.makeCarAvailable(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CarResponse**](CarResponse.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 made available |  -  |
+| **404** | Car not found |  -  |
+| **409** | Invalid car state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putCarInService
+
+> CarResponse putCarInService(carId)
+
+Put car in service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { PutCarInServiceRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string
+    carId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PutCarInServiceRequest;
+
+  try {
+    const data = await api.putCarInService(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CarResponse**](CarResponse.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 put in service |  -  |
+| **404** | Car not found |  -  |
+| **409** | Invalid car state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateCar
+
+> CarResponse updateCar(carId, updateCarRequest)
+
+Update a car
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarsApi,
+} from '';
+import type { UpdateCarOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CarsApi();
+
+  const body = {
+    // string
+    carId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateCarRequest
+    updateCarRequest: ...,
+  } satisfies UpdateCarOperationRequest;
+
+  try {
+    const data = await api.updateCar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **carId** | `string` |  | [Defaults to `undefined`] |
+| **updateCarRequest** | [UpdateCarRequest](UpdateCarRequest.md) |  | |
+
+### Return type
+
+[**CarResponse**](CarResponse.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 updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Car 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)
+