fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/ServicesApi.md

@@ -0,0 +1,1289 @@
+# ServicesApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cemServicesCreate**](ServicesApi.md#cemservicescreate) | **POST** /services | Create a new CEM service |
+| [**cemServicesDelete**](ServicesApi.md#cemservicesdelete) | **DELETE** /services/{id} | Delete a CEM service |
+| [**cemServicesGet**](ServicesApi.md#cemservicesget) | **GET** /services/{id} | Get a CEM service by ID |
+| [**cemServicesGetActiveOrder**](ServicesApi.md#cemservicesgetactiveorder) | **GET** /services/{id}/active-order | Get the active service order for a CEM service |
+| [**cemServicesList**](ServicesApi.md#cemserviceslist) | **GET** /services | List all CEM services |
+| [**cemServicesUpdate**](ServicesApi.md#cemservicesupdate) | **PATCH** /services/{id} | Update a CEM service |
+| [**serviceGroupsCreate**](ServicesApi.md#servicegroupscreate) | **POST** /service-groups | Create a service group |
+| [**serviceGroupsDelete**](ServicesApi.md#servicegroupsdelete) | **DELETE** /service-groups/{id} | Delete a service group |
+| [**serviceGroupsGet**](ServicesApi.md#servicegroupsget) | **GET** /service-groups/{id} | Get a service group |
+| [**serviceGroupsList**](ServicesApi.md#servicegroupslist) | **GET** /service-groups | List service groups |
+| [**serviceGroupsUpdate**](ServicesApi.md#servicegroupsupdate) | **PATCH** /service-groups/{id} | Update a service group |
+| [**serviceTypesCreate**](ServicesApi.md#servicetypescreate) | **POST** /service-types | Create a service type |
+| [**serviceTypesDelete**](ServicesApi.md#servicetypesdelete) | **DELETE** /service-types/{id} | Delete a service type |
+| [**serviceTypesGet**](ServicesApi.md#servicetypesget) | **GET** /service-types/{id} | Get a service type |
+| [**serviceTypesList**](ServicesApi.md#servicetypeslist) | **GET** /service-types | List service types |
+| [**serviceTypesUpdate**](ServicesApi.md#servicetypesupdate) | **PATCH** /service-types/{id} | Update a service type |
+| [**servicesAction**](ServicesApi.md#servicesactionoperation) | **POST** /services/{id}/{action} | Perform a lifecycle action on a service |
+
+
+
+## cemServicesCreate
+
+> ServiceRes cemServicesCreate(createCEMServiceReq)
+
+Create a new CEM service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { CemServicesCreateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // CreateCEMServiceReq
+    createCEMServiceReq: ...,
+  } satisfies CemServicesCreateRequest;
+
+  try {
+    const data = await api.cemServicesCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createCEMServiceReq** | [CreateCEMServiceReq](CreateCEMServiceReq.md) |  | |
+
+### Return type
+
+[**ServiceRes**](ServiceRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | CEM service created |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## cemServicesDelete
+
+> cemServicesDelete(id)
+
+Delete a CEM service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { CemServicesDeleteRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CemServicesDeleteRequest;
+
+  try {
+    const data = await api.cemServicesDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | CEM service deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | CEM service 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)
+
+
+## cemServicesGet
+
+> ServiceRes cemServicesGet(id)
+
+Get a CEM service by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { CemServicesGetRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CemServicesGetRequest;
+
+  try {
+    const data = await api.cemServicesGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ServiceRes**](ServiceRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | CEM service details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | CEM service 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)
+
+
+## cemServicesGetActiveOrder
+
+> ServiceOrderRes cemServicesGetActiveOrder(id)
+
+Get the active service order for a CEM service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { CemServicesGetActiveOrderRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CemServicesGetActiveOrderRequest;
+
+  try {
+    const data = await api.cemServicesGetActiveOrder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ServiceOrderRes**](ServiceOrderRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Active service order details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | CEM service or active order 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)
+
+
+## cemServicesList
+
+> Array<ServiceRes> cemServicesList(page, pageSize)
+
+List all CEM services
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { CemServicesListRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies CemServicesListRequest;
+
+  try {
+    const data = await api.cemServicesList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**Array<ServiceRes>**](ServiceRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A list of CEM services |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## cemServicesUpdate
+
+> ServiceRes cemServicesUpdate(id, updateCEMServiceReq)
+
+Update a CEM service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { CemServicesUpdateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateCEMServiceReq
+    updateCEMServiceReq: ...,
+  } satisfies CemServicesUpdateRequest;
+
+  try {
+    const data = await api.cemServicesUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **updateCEMServiceReq** | [UpdateCEMServiceReq](UpdateCEMServiceReq.md) |  | |
+
+### Return type
+
+[**ServiceRes**](ServiceRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | CEM service updated |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | CEM service 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)
+
+
+## serviceGroupsCreate
+
+> ServiceGroupRes serviceGroupsCreate(serviceGroupReq)
+
+Create a service group
+
+Creates a new service group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceGroupsCreateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // ServiceGroupReq
+    serviceGroupReq: ...,
+  } satisfies ServiceGroupsCreateRequest;
+
+  try {
+    const data = await api.serviceGroupsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **serviceGroupReq** | [ServiceGroupReq](ServiceGroupReq.md) |  | |
+
+### Return type
+
+[**ServiceGroupRes**](ServiceGroupRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Service group created successfully |  -  |
+| **400** | Invalid request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceGroupsDelete
+
+> serviceGroupsDelete(id)
+
+Delete a service group
+
+Deletes a service group by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceGroupsDeleteRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceGroupsDeleteRequest;
+
+  try {
+    const data = await api.serviceGroupsDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Service group deleted successfully |  -  |
+| **404** | Service group 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)
+
+
+## serviceGroupsGet
+
+> ServiceGroupRes serviceGroupsGet(id)
+
+Get a service group
+
+Retrieves a specific service group by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceGroupsGetRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceGroupsGetRequest;
+
+  try {
+    const data = await api.serviceGroupsGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ServiceGroupRes**](ServiceGroupRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The service group details |  -  |
+| **404** | Service group 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)
+
+
+## serviceGroupsList
+
+> ServiceGroupsList200Response serviceGroupsList(page, pageSize, sort, name)
+
+List service groups
+
+Retrieves a paginated list of service groups
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceGroupsListRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Sort field. Prefix with \'+\' for ascending or \'-\' for descending. Default is ascending. Supported fields: name (optional)
+    sort: +name,
+    // Array<string> | Filter by service group name (can specify multiple values) (optional)
+    name: ...,
+  } satisfies ServiceGroupsListRequest;
+
+  try {
+    const data = await api.serviceGroupsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **sort** | `string` | Sort field. Prefix with \&#39;+\&#39; for ascending or \&#39;-\&#39; for descending. Default is ascending. Supported fields: name | [Optional] [Defaults to `undefined`] |
+| **name** | `Array<string>` | Filter by service group name (can specify multiple values) | [Optional] |
+
+### Return type
+
+[**ServiceGroupsList200Response**](ServiceGroupsList200Response.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A paginated list of service groups |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceGroupsUpdate
+
+> ServiceGroupRes serviceGroupsUpdate(id, serviceGroupReq)
+
+Update a service group
+
+Updates an existing service group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceGroupsUpdateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ServiceGroupReq
+    serviceGroupReq: ...,
+  } satisfies ServiceGroupsUpdateRequest;
+
+  try {
+    const data = await api.serviceGroupsUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **serviceGroupReq** | [ServiceGroupReq](ServiceGroupReq.md) |  | |
+
+### Return type
+
+[**ServiceGroupRes**](ServiceGroupRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service group updated successfully |  -  |
+| **404** | Service group 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)
+
+
+## serviceTypesCreate
+
+> ServiceTypeRes serviceTypesCreate(createServiceTypeReq)
+
+Create a service type
+
+Creates a new service type with optional property schema
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceTypesCreateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // CreateServiceTypeReq
+    createServiceTypeReq: ...,
+  } satisfies ServiceTypesCreateRequest;
+
+  try {
+    const data = await api.serviceTypesCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createServiceTypeReq** | [CreateServiceTypeReq](CreateServiceTypeReq.md) |  | |
+
+### Return type
+
+[**ServiceTypeRes**](ServiceTypeRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Service type created successfully |  -  |
+| **400** | Invalid request body or validation errors |  -  |
+| **403** | Insufficient permissions (admin required) |  -  |
+| **409** | Service type with this name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceTypesDelete
+
+> serviceTypesDelete(id)
+
+Delete a service type
+
+Deletes a service type if no services depend on it
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceTypesDeleteRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceTypesDeleteRequest;
+
+  try {
+    const data = await api.serviceTypesDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Service type deleted successfully |  -  |
+| **403** | Insufficient permissions (admin required) |  -  |
+| **404** | Service type not found |  -  |
+| **409** | Cannot delete service type with dependent services |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceTypesGet
+
+> ServiceTypeRes serviceTypesGet(id)
+
+Get a service type
+
+Retrieves a specific service type by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceTypesGetRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceTypesGetRequest;
+
+  try {
+    const data = await api.serviceTypesGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ServiceTypeRes**](ServiceTypeRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The service type details |  -  |
+| **404** | Service type 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)
+
+
+## serviceTypesList
+
+> ServiceTypesList200Response serviceTypesList(page, pageSize)
+
+List service types
+
+Retrieves a paginated list of service types
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceTypesListRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies ServiceTypesListRequest;
+
+  try {
+    const data = await api.serviceTypesList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ServiceTypesList200Response**](ServiceTypesList200Response.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A paginated list of service types |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceTypesUpdate
+
+> ServiceTypeRes serviceTypesUpdate(id, updateServiceTypeReq)
+
+Update a service type
+
+Partially updates a service type (PATCH semantics)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServiceTypesUpdateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateServiceTypeReq
+    updateServiceTypeReq: ...,
+  } satisfies ServiceTypesUpdateRequest;
+
+  try {
+    const data = await api.serviceTypesUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **updateServiceTypeReq** | [UpdateServiceTypeReq](UpdateServiceTypeReq.md) |  | |
+
+### Return type
+
+[**ServiceTypeRes**](ServiceTypeRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service type updated successfully |  -  |
+| **400** | Invalid request body or validation errors |  -  |
+| **403** | Insufficient permissions (admin required) |  -  |
+| **404** | Service type not found |  -  |
+| **409** | Service type name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## servicesAction
+
+> ServiceRes servicesAction(id, action, servicesActionRequest)
+
+Perform a lifecycle action on a service
+
+Performs a generic lifecycle action on a service. The action name is specified in the URL path and must be defined in the service type\&#39;s lifecycle schema.  Common actions include: start, stop, restart, pause, resume, etc. Note: Use DELETE /services/{id} for delete actions and PATCH /services/{id} for update actions. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicesApi,
+} from 'fulcrum-cem-client';
+import type { ServicesActionOperationRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ServicesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | The lifecycle action to perform (e.g., start, stop, restart). Available actions are defined in the service type\'s lifecycle schema.
+    action: start,
+    // ServicesActionRequest | Optional properties for actions that require additional parameters (based on lifecycle schema requestSchemaType) (optional)
+    servicesActionRequest: ...,
+  } satisfies ServicesActionOperationRequest;
+
+  try {
+    const data = await api.servicesAction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **action** | `string` | The lifecycle action to perform (e.g., start, stop, restart). Available actions are defined in the service type\&#39;s lifecycle schema. | [Defaults to `undefined`] |
+| **servicesActionRequest** | [ServicesActionRequest](ServicesActionRequest.md) | Optional properties for actions that require additional parameters (based on lifecycle schema requestSchemaType) | [Optional] |
+
+### Return type
+
+[**ServiceRes**](ServiceRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service action initiated successfully |  -  |
+| **400** | Invalid action or service state does not allow this action |  -  |
+| **404** | Service 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)
+