fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/CompleteJobReq.md

@@ -0,0 +1,38 @@
+
+# CompleteJobReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`agentInstanceId` | string
+`agentInstanceData` | { [key: string]: any; }
+`properties` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { CompleteJobReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "agentInstanceId": i-1234567890abcdef0,
+  "agentInstanceData": null,
+  "properties": {ipAddress=192.168.1.100, port=8080},
+} satisfies CompleteJobReq
+
+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 CompleteJobReq
+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/CreateAgentReq.md

@@ -0,0 +1,44 @@
+
+# CreateAgentReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`providerId` | string
+`agentTypeId` | string
+`tags` | Array<string>
+`_configuration` | { [key: string]: any; }
+`servicePoolSetId` | string
+
+## Example
+
+```typescript
+import type { CreateAgentReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": aws-agent-01,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "agentTypeId": 123e4567-e89b-12d3-a456-426614174000,
+  "tags": [gpu, high-memory, ssd],
+  "_configuration": null,
+  "servicePoolSetId": 123e4567-e89b-12d3-a456-426614174000,
+} satisfies CreateAgentReq
+
+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 CreateAgentReq
+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/CreateAgentTypeReq.md

@@ -0,0 +1,38 @@
+
+# CreateAgentTypeReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`serviceTypeIds` | Array<string>
+`configurationSchema` | [{ [key: string]: PropertyDefinition; }](PropertyDefinition.md)
+
+## Example
+
+```typescript
+import type { CreateAgentTypeReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": VM Agent,
+  "serviceTypeIds": [550e8400-e29b-41d4-a716-446655440000, 550e8400-e29b-41d4-a716-446655440001],
+  "configurationSchema": {apiEndpoint={type=string, label=API Endpoint, required=true}, maxRetries={type=integer, label=Max Retries, default=3}},
+} satisfies CreateAgentTypeReq
+
+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 CreateAgentTypeReq
+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/CreateCEMServiceReq.md

@@ -0,0 +1,46 @@
+
+# CreateCEMServiceReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`groupId` | string
+`serviceOfferingId` | string
+`commitmentId` | string
+`variantId` | string
+`properties` | { [key: string]: any; }
+`autoRenew` | boolean
+
+## Example
+
+```typescript
+import type { CreateCEMServiceReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "groupId": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceOfferingId": 123e4567-e89b-12d3-a456-426614174000,
+  "commitmentId": 123e4567-e89b-12d3-a456-426614174000,
+  "variantId": null,
+  "properties": null,
+  "autoRenew": null,
+} satisfies CreateCEMServiceReq
+
+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 CreateCEMServiceReq
+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/CreateServiceTypeReq.md

@@ -0,0 +1,38 @@
+
+# CreateServiceTypeReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`propertySchema` | [{ [key: string]: PropertyDefinition; }](PropertyDefinition.md)
+`lifecycleSchema` | [LifecycleSchema](LifecycleSchema.md)
+
+## Example
+
+```typescript
+import type { CreateServiceTypeReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": VM Instance,
+  "propertySchema": null,
+  "lifecycleSchema": null,
+} satisfies CreateServiceTypeReq
+
+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 CreateServiceTypeReq
+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/ErrorRes.md

@@ -0,0 +1,36 @@
+
+# ErrorRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`error` | string
+
+## Example
+
+```typescript
+import type { ErrorRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": Invalid request,
+  "error": The field 'name' is required,
+} satisfies ErrorRes
+
+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 ErrorRes
+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/EventAckReq.md

@@ -0,0 +1,38 @@
+
+# EventAckReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subscriberId` | string
+`instanceId` | string
+`lastEventSequenceProcessed` | number
+
+## Example
+
+```typescript
+import type { EventAckReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subscriberId": external-system,
+  "instanceId": instance-1,
+  "lastEventSequenceProcessed": 150,
+} satisfies EventAckReq
+
+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 EventAckReq
+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/EventAckRes.md

@@ -0,0 +1,34 @@
+
+# EventAckRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lastEventSequenceProcessed` | number
+
+## Example
+
+```typescript
+import type { EventAckRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lastEventSequenceProcessed": 150,
+} satisfies EventAckRes
+
+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 EventAckRes
+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/EventApi.md

@@ -0,0 +1,253 @@
+# EventApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**eventsAck**](EventApi.md#eventsack) | **POST** /events/ack | Acknowledge processed events |
+| [**eventsLease**](EventApi.md#eventslease) | **POST** /events/lease | Acquire event lease and fetch events |
+| [**eventsList**](EventApi.md#eventslist) | **GET** /events | List events |
+
+
+
+## eventsAck
+
+> EventAckRes eventsAck(eventAckReq)
+
+Acknowledge processed events
+
+Acknowledge processed events and update progress (Option B - does not renew lease)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EventApi,
+} from 'fulcrum-cem-client';
+import type { EventsAckRequest } 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 EventApi(config);
+
+  const body = {
+    // EventAckReq
+    eventAckReq: ...,
+  } satisfies EventsAckRequest;
+
+  try {
+    const data = await api.eventsAck(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **eventAckReq** | [EventAckReq](EventAckReq.md) |  | |
+
+### Return type
+
+[**EventAckRes**](EventAckRes.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** | Events acknowledged successfully |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **409** | Acknowledgement conflict - lease not held or sequence regression |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## eventsLease
+
+> EventLeaseRes eventsLease(eventLeaseReq)
+
+Acquire event lease and fetch events
+
+Acquire or renew a lease for event processing and fetch events in chronological order
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EventApi,
+} from 'fulcrum-cem-client';
+import type { EventsLeaseRequest } 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 EventApi(config);
+
+  const body = {
+    // EventLeaseReq
+    eventLeaseReq: ...,
+  } satisfies EventsLeaseRequest;
+
+  try {
+    const data = await api.eventsLease(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **eventLeaseReq** | [EventLeaseReq](EventLeaseReq.md) |  | |
+
+### Return type
+
+[**EventLeaseRes**](EventLeaseRes.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** | Lease acquired successfully with events |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **409** | Lease conflict - held by another instance |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## eventsList
+
+> EventsList200Response eventsList(page, pageSize, sort, initiatorType, initiatorId, type)
+
+List events
+
+Retrieves a paginated list of events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EventApi,
+} from 'fulcrum-cem-client';
+import type { EventsListRequest } 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 EventApi(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: createdAt (optional)
+    sort: +createdAt,
+    // Array<string> | Filter by initiator type (can specify multiple values) (optional)
+    initiatorType: ...,
+    // Array<string> | Filter by initiator ID (can specify multiple values) (optional)
+    initiatorId: ...,
+    // Array<string> | Filter by event type (can specify multiple values) (optional)
+    type: ...,
+  } satisfies EventsListRequest;
+
+  try {
+    const data = await api.eventsList(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: createdAt | [Optional] [Defaults to `undefined`] |
+| **initiatorType** | `Array<string>` | Filter by initiator type (can specify multiple values) | [Optional] |
+| **initiatorId** | `Array<string>` | Filter by initiator ID (can specify multiple values) | [Optional] |
+| **type** | `Array<string>` | Filter by event type (can specify multiple values) | [Optional] |
+
+### Return type
+
+[**EventsList200Response**](EventsList200Response.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 events |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[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/EventLeaseReq.md

@@ -0,0 +1,40 @@
+
+# EventLeaseReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subscriberId` | string
+`instanceId` | string
+`leaseDurationSeconds` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { EventLeaseReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subscriberId": external-system,
+  "instanceId": instance-1,
+  "leaseDurationSeconds": 300,
+  "limit": 100,
+} satisfies EventLeaseReq
+
+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 EventLeaseReq
+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/EventLeaseRes.md

@@ -0,0 +1,38 @@
+
+# EventLeaseRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`events` | [Array<EventRes>](EventRes.md)
+`leaseExpiresAt` | Date
+`lastEventSequenceProcessed` | number
+
+## Example
+
+```typescript
+import type { EventLeaseRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "events": null,
+  "leaseExpiresAt": null,
+  "lastEventSequenceProcessed": 150,
+} satisfies EventLeaseRes
+
+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 EventLeaseRes
+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/EventRes.md

@@ -0,0 +1,54 @@
+
+# EventRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sequenceNumber` | number
+`initiatorType` | string
+`initiatorId` | string
+`type` | string
+`properties` | { [key: string]: any; }
+`providerId` | string
+`agentId` | string
+`consumerId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { EventRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "sequenceNumber": null,
+  "initiatorType": user,
+  "initiatorId": admin,
+  "type": service.created,
+  "properties": null,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "agentId": 123e4567-e89b-12d3-a456-426614174000,
+  "consumerId": 123e4567-e89b-12d3-a456-426614174000,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies EventRes
+
+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 EventRes
+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)
+
+