fulcrum-cem-client 0.0.8 → 0.0.9

package/docs/ServicePoolsApi.md

@@ -0,0 +1,617 @@
+# ServicePoolsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**servicePoolSetsCreate**](ServicePoolsApi.md#servicepoolsetscreate) | **POST** /service-pool-sets | Create a service pool set |
+| [**servicePoolSetsDelete**](ServicePoolsApi.md#servicepoolsetsdelete) | **DELETE** /service-pool-sets/{id} | Delete a service pool set |
+| [**servicePoolSetsUpdate**](ServicePoolsApi.md#servicepoolsetsupdate) | **PATCH** /service-pool-sets/{id} | Update a service pool set |
+| [**servicePoolValuesCreate**](ServicePoolsApi.md#servicepoolvaluescreate) | **POST** /service-pool-values | Create a service pool value |
+| [**servicePoolValuesDelete**](ServicePoolsApi.md#servicepoolvaluesdelete) | **DELETE** /service-pool-values/{id} | Delete a service pool value |
+| [**servicePoolsCreate**](ServicePoolsApi.md#servicepoolscreate) | **POST** /service-pools | Create a service pool |
+| [**servicePoolsDelete**](ServicePoolsApi.md#servicepoolsdelete) | **DELETE** /service-pools/{id} | Delete a service pool |
+| [**servicePoolsUpdate**](ServicePoolsApi.md#servicepoolsupdate) | **PATCH** /service-pools/{id} | Update a service pool |
+
+
+
+## servicePoolSetsCreate
+
+> ServicePoolSetRes servicePoolSetsCreate(createServicePoolSetReq)
+
+Create a service pool set
+
+Creates a new service pool set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolSetsCreateRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // CreateServicePoolSetReq
+    createServicePoolSetReq: ...,
+  } satisfies ServicePoolSetsCreateRequest;
+
+  try {
+    const data = await api.servicePoolSetsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createServicePoolSetReq** | [CreateServicePoolSetReq](CreateServicePoolSetReq.md) |  | |
+
+### Return type
+
+[**ServicePoolSetRes**](ServicePoolSetRes.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 pool set created successfully |  -  |
+| **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)
+
+
+## servicePoolSetsDelete
+
+> servicePoolSetsDelete(id)
+
+Delete a service pool set
+
+Deletes an existing service pool set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolSetsDeleteRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServicePoolSetsDeleteRequest;
+
+  try {
+    const data = await api.servicePoolSetsDelete(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 pool set deleted successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service pool set 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)
+
+
+## servicePoolSetsUpdate
+
+> ServicePoolSetRes servicePoolSetsUpdate(id, updateServicePoolSetReq)
+
+Update a service pool set
+
+Updates an existing service pool set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolSetsUpdateRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateServicePoolSetReq
+    updateServicePoolSetReq: ...,
+  } satisfies ServicePoolSetsUpdateRequest;
+
+  try {
+    const data = await api.servicePoolSetsUpdate(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`] |
+| **updateServicePoolSetReq** | [UpdateServicePoolSetReq](UpdateServicePoolSetReq.md) |  | |
+
+### Return type
+
+[**ServicePoolSetRes**](ServicePoolSetRes.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 pool set updated successfully |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service pool set 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)
+
+
+## servicePoolValuesCreate
+
+> ServicePoolValueRes servicePoolValuesCreate(createServicePoolValueReq)
+
+Create a service pool value
+
+Creates a new service pool value (for list generators only)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolValuesCreateRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // CreateServicePoolValueReq
+    createServicePoolValueReq: ...,
+  } satisfies ServicePoolValuesCreateRequest;
+
+  try {
+    const data = await api.servicePoolValuesCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createServicePoolValueReq** | [CreateServicePoolValueReq](CreateServicePoolValueReq.md) |  | |
+
+### Return type
+
+[**ServicePoolValueRes**](ServicePoolValueRes.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 pool value created successfully |  -  |
+| **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)
+
+
+## servicePoolValuesDelete
+
+> servicePoolValuesDelete(id)
+
+Delete a service pool value
+
+Deletes an existing service pool value (only if not allocated)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolValuesDeleteRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServicePoolValuesDeleteRequest;
+
+  try {
+    const data = await api.servicePoolValuesDelete(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 pool value deleted successfully |  -  |
+| **400** | Cannot delete allocated value |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service pool value 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)
+
+
+## servicePoolsCreate
+
+> ServicePoolRes servicePoolsCreate(createServicePoolReq)
+
+Create a service pool
+
+Creates a new service pool
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolsCreateRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // CreateServicePoolReq
+    createServicePoolReq: ...,
+  } satisfies ServicePoolsCreateRequest;
+
+  try {
+    const data = await api.servicePoolsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createServicePoolReq** | [CreateServicePoolReq](CreateServicePoolReq.md) |  | |
+
+### Return type
+
+[**ServicePoolRes**](ServicePoolRes.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 pool created successfully |  -  |
+| **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)
+
+
+## servicePoolsDelete
+
+> servicePoolsDelete(id)
+
+Delete a service pool
+
+Deletes an existing service pool
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolsDeleteRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServicePoolsDeleteRequest;
+
+  try {
+    const data = await api.servicePoolsDelete(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 pool deleted successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service pool 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)
+
+
+## servicePoolsUpdate
+
+> ServicePoolRes servicePoolsUpdate(id, updateServicePoolReq)
+
+Update a service pool
+
+Updates an existing service pool
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServicePoolsApi,
+} from 'fulcrum-cem-client';
+import type { ServicePoolsUpdateRequest } 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 ServicePoolsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateServicePoolReq
+    updateServicePoolReq: ...,
+  } satisfies ServicePoolsUpdateRequest;
+
+  try {
+    const data = await api.servicePoolsUpdate(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`] |
+| **updateServicePoolReq** | [UpdateServicePoolReq](UpdateServicePoolReq.md) |  | |
+
+### Return type
+
+[**ServicePoolRes**](ServicePoolRes.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 pool updated successfully |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service pool 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/docs/ServicePoolsList200Response.md

@@ -0,0 +1,44 @@
+
+# ServicePoolsList200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ServicePoolRes>](ServicePoolRes.md)
+`totalItems` | number
+`totalPages` | number
+`currentPage` | number
+`hasNext` | boolean
+`hasPrev` | boolean
+
+## Example
+
+```typescript
+import type { ServicePoolsList200Response } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "totalItems": null,
+  "totalPages": null,
+  "currentPage": null,
+  "hasNext": null,
+  "hasPrev": null,
+} satisfies ServicePoolsList200Response
+
+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 ServicePoolsList200Response
+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)
+
+