fulcrum-cem-client 0.0.2 → 0.0.3

package/docs/EventsList200Response.md

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

@@ -0,0 +1,34 @@
+
+# FailJobReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorMessage` | string
+
+## Example
+
+```typescript
+import type { FailJobReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorMessage": Failed to create VM: insufficient resources,
+} satisfies FailJobReq
+
+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 FailJobReq
+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/GeneratorDefinition.md

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

@@ -0,0 +1,62 @@
+
+# JobRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`providerId` | string
+`consumerId` | string
+`agentId` | string
+`serviceId` | string
+`action` | string
+`params` | { [key: string]: any; }
+`status` | [JobStatus](JobStatus.md)
+`priority` | number
+`errorMessage` | string
+`claimedAt` | Date
+`completedAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+`service` | [ServiceRes](ServiceRes.md)
+
+## Example
+
+```typescript
+import type { JobRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "consumerId": 123e4567-e89b-12d3-a456-426614174000,
+  "agentId": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceId": 123e4567-e89b-12d3-a456-426614174000,
+  "action": start,
+  "params": null,
+  "status": null,
+  "priority": 1,
+  "errorMessage": Failed to create VM: insufficient resources,
+  "claimedAt": null,
+  "completedAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "service": null,
+} satisfies JobRes
+
+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 JobRes
+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/JobStatus.md

@@ -0,0 +1,33 @@
+
+# JobStatus
+
+Job status transitions: - Pending: Job created and waiting for agent to claim - Processing: Job claimed by agent and in progress - Completed: Job successfully finished - Failed: Job encountered an error (error message drives service state transition via regexp) 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { JobStatus } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies JobStatus
+
+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 JobStatus
+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/JobsApi.md

@@ -0,0 +1,459 @@
+# JobsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**jobsClaim**](JobsApi.md#jobsclaim) | **POST** /jobs/{id}/claim | Claim a job |
+| [**jobsComplete**](JobsApi.md#jobscomplete) | **POST** /jobs/{id}/complete | Complete a job |
+| [**jobsFail**](JobsApi.md#jobsfail) | **POST** /jobs/{id}/fail | Fail a job |
+| [**jobsGet**](JobsApi.md#jobsget) | **GET** /jobs/{id} | Get a job |
+| [**jobsList**](JobsApi.md#jobslist) | **GET** /jobs | List jobs |
+| [**jobsPending**](JobsApi.md#jobspending) | **GET** /jobs/pending | Get pending jobs |
+
+
+
+## jobsClaim
+
+> jobsClaim(id)
+
+Claim a job
+
+Claims a job for processing by the authenticated agent
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from 'fulcrum-cem-client';
+import type { JobsClaimRequest } 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 JobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies JobsClaimRequest;
+
+  try {
+    const data = await api.jobsClaim(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** | Job claimed successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Job 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)
+
+
+## jobsComplete
+
+> jobsComplete(id, completeJobReq)
+
+Complete a job
+
+Marks a job as completed with results
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from 'fulcrum-cem-client';
+import type { JobsCompleteRequest } 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 JobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CompleteJobReq
+    completeJobReq: ...,
+  } satisfies JobsCompleteRequest;
+
+  try {
+    const data = await api.jobsComplete(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`] |
+| **completeJobReq** | [CompleteJobReq](CompleteJobReq.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Job completed successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Job 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)
+
+
+## jobsFail
+
+> jobsFail(id, failJobReq)
+
+Fail a job
+
+Marks a job as failed with an error message
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from 'fulcrum-cem-client';
+import type { JobsFailRequest } 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 JobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // FailJobReq
+    failJobReq: ...,
+  } satisfies JobsFailRequest;
+
+  try {
+    const data = await api.jobsFail(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`] |
+| **failJobReq** | [FailJobReq](FailJobReq.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Job marked as failed successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Job 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)
+
+
+## jobsGet
+
+> JobRes jobsGet(id)
+
+Get a job
+
+Retrieves a specific job by ID (admin route)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from 'fulcrum-cem-client';
+import type { JobsGetRequest } 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 JobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies JobsGetRequest;
+
+  try {
+    const data = await api.jobsGet(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
+
+[**JobRes**](JobRes.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 job details |  -  |
+| **404** | Job 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)
+
+
+## jobsList
+
+> JobsList200Response jobsList(page, pageSize)
+
+List jobs
+
+Retrieves a paginated list of jobs (admin route)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from 'fulcrum-cem-client';
+import type { JobsListRequest } 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 JobsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies JobsListRequest;
+
+  try {
+    const data = await api.jobsList(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
+
+[**JobsList200Response**](JobsList200Response.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 jobs |  -  |
+| **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)
+
+
+## jobsPending
+
+> Array<JobRes> jobsPending(limit)
+
+Get pending jobs
+
+Retrieves a list of pending jobs for the authenticated agent
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobsApi,
+} from 'fulcrum-cem-client';
+import type { JobsPendingRequest } 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 JobsApi(config);
+
+  const body = {
+    // number (optional)
+    limit: 56,
+  } satisfies JobsPendingRequest;
+
+  try {
+    const data = await api.jobsPending(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` |  | [Optional] [Defaults to `10`] |
+
+### Return type
+
+[**Array<JobRes>**](JobRes.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** | List of pending jobs |  -  |
+| **401** | Unauthorized |  -  |
+
+[[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/JobsList200Response.md

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