fulcrum-cem-client 0.0.1 → 0.0.3

package/docs/ServiceOrdersApi.md

@@ -0,0 +1,233 @@
+# ServiceOrdersApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**serviceOrdersGet**](ServiceOrdersApi.md#serviceordersget) | **GET** /service-orders/{id} | Get a service order by ID |
+| [**serviceOrdersList**](ServiceOrdersApi.md#serviceorderslist) | **GET** /service-orders | List all service orders |
+| [**serviceOrdersUpdate**](ServiceOrdersApi.md#serviceordersupdate) | **PATCH** /service-orders/{id} | Update a service order |
+
+
+
+## serviceOrdersGet
+
+> ServiceOrderRes serviceOrdersGet(id)
+
+Get a service order by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOrdersApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOrdersGetRequest } 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 ServiceOrdersApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceOrdersGetRequest;
+
+  try {
+    const data = await api.serviceOrdersGet(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** | Service order details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service 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)
+
+
+## serviceOrdersList
+
+> Array<ServiceOrderRes> serviceOrdersList(page, pageSize)
+
+List all service orders
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOrdersApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOrdersListRequest } 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 ServiceOrdersApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies ServiceOrdersListRequest;
+
+  try {
+    const data = await api.serviceOrdersList(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<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** | A list of service orders |  -  |
+| **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)
+
+
+## serviceOrdersUpdate
+
+> ServiceOrderRes serviceOrdersUpdate(id, serviceOrderReq)
+
+Update a service order
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOrdersApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOrdersUpdateRequest } 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 ServiceOrdersApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ServiceOrderReq
+    serviceOrderReq: ...,
+  } satisfies ServiceOrdersUpdateRequest;
+
+  try {
+    const data = await api.serviceOrdersUpdate(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`] |
+| **serviceOrderReq** | [ServiceOrderReq](ServiceOrderReq.md) |  | |
+
+### Return type
+
+[**ServiceOrderRes**](ServiceOrderRes.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 order updated |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service 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)
+

package/docs/ServiceReq.md

@@ -0,0 +1,44 @@
+
+# ServiceReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`properties` | { [key: string]: any; }
+`agentTags` | Array<string>
+`agentId` | string
+`serviceTypeId` | string
+`groupId` | string
+
+## Example
+
+```typescript
+import type { ServiceReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": web-server-01,
+  "properties": null,
+  "agentTags": ["gpu","high-memory"],
+  "agentId": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceTypeId": 123e4567-e89b-12d3-a456-426614174000,
+  "groupId": 123e4567-e89b-12d3-a456-426614174000,
+} satisfies ServiceReq
+
+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 ServiceReq
+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/docs/ServiceRes.md

@@ -0,0 +1,58 @@
+
+# ServiceRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`status` | string
+`properties` | { [key: string]: any; }
+`agentInstanceData` | { [key: string]: any; }
+`agentInstanceId` | string
+`providerId` | string
+`consumerId` | string
+`agentId` | string
+`serviceTypeId` | string
+`groupId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ServiceRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "name": web-server-01,
+  "status": Started,
+  "properties": null,
+  "agentInstanceData": null,
+  "agentInstanceId": null,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "consumerId": 123e4567-e89b-12d3-a456-426614174000,
+  "agentId": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceTypeId": 123e4567-e89b-12d3-a456-426614174000,
+  "groupId": 123e4567-e89b-12d3-a456-426614174000,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ServiceRes
+
+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 ServiceRes
+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/docs/ServiceTypeRes.md

@@ -0,0 +1,44 @@
+
+# ServiceTypeRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`propertySchema` | [{ [key: string]: PropertyDefinition; }](PropertyDefinition.md)
+`lifecycleSchema` | [LifecycleSchema](LifecycleSchema.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ServiceTypeRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "name": VM,
+  "propertySchema": null,
+  "lifecycleSchema": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ServiceTypeRes
+
+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 ServiceTypeRes
+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/docs/ServiceTypesList200Response.md

@@ -0,0 +1,44 @@
+
+# ServiceTypesList200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ServiceTypeRes>](ServiceTypeRes.md)
+`totalItems` | number
+`totalPages` | number
+`currentPage` | number
+`hasNext` | boolean
+`hasPrev` | boolean
+
+## Example
+
+```typescript
+import type { ServiceTypesList200Response } 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 ServiceTypesList200Response
+
+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 ServiceTypesList200Response
+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/docs/ServicesActionRequest.md

@@ -0,0 +1,34 @@
+
+# ServicesActionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`properties` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ServicesActionRequest } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "properties": null,
+} satisfies ServicesActionRequest
+
+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 ServicesActionRequest
+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)
+
+