fulcrum-cem-client 0.0.2 → 0.0.3

package/docs/LifecycleAction.md

@@ -0,0 +1,38 @@
+
+# LifecycleAction
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`requestSchemaType` | string
+`transitions` | [Array<LifecycleTransition>](LifecycleTransition.md)
+
+## Example
+
+```typescript
+import type { LifecycleAction } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": start,
+  "requestSchemaType": properties,
+  "transitions": null,
+} satisfies LifecycleAction
+
+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 LifecycleAction
+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/LifecycleSchema.md

@@ -0,0 +1,43 @@
+
+# LifecycleSchema
+
+Schema-driven lifecycle definition for service state management. Each ServiceType can define its own custom lifecycle with states, actions, and transitions. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`states` | [Array<LifecycleState>](LifecycleState.md)
+`actions` | [Array<LifecycleAction>](LifecycleAction.md)
+`initialState` | string
+`terminalStates` | Array<string>
+`runningStates` | Array<string>
+
+## Example
+
+```typescript
+import type { LifecycleSchema } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "states": [{name=New}, {name=Stopped}, {name=Started}, {name=Deleted}],
+  "actions": null,
+  "initialState": New,
+  "terminalStates": [Deleted],
+  "runningStates": [Started],
+} satisfies LifecycleSchema
+
+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 LifecycleSchema
+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/LifecycleState.md

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

@@ -0,0 +1,40 @@
+
+# LifecycleTransition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`from` | string
+`to` | string
+`onError` | boolean
+`onErrorRegexp` | string
+
+## Example
+
+```typescript
+import type { LifecycleTransition } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "from": Stopped,
+  "to": Started,
+  "onError": null,
+  "onErrorRegexp": quota.*exceeded,
+} satisfies LifecycleTransition
+
+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 LifecycleTransition
+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/MetricEntityType.md

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

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

@@ -0,0 +1,42 @@
+
+# MetricEntryReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceId` | string
+`agentInstanceId` | string
+`resourceId` | string
+`value` | number
+`typeName` | string
+
+## Example
+
+```typescript
+import type { MetricEntryReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceId": 123e4567-e89b-12d3-a456-426614174000,
+  "agentInstanceId": i-12345,
+  "resourceId": cpu-1,
+  "value": 78.5,
+  "typeName": cpu.usage,
+} satisfies MetricEntryReq
+
+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 MetricEntryReq
+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/MetricEntryRes.md

@@ -0,0 +1,52 @@
+
+# MetricEntryRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`providerId` | string
+`consumerId` | string
+`agentId` | string
+`serviceId` | string
+`resourceId` | string
+`value` | number
+`typeId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { MetricEntryRes } 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,
+  "resourceId": cpu-1,
+  "value": 78.5,
+  "typeId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies MetricEntryRes
+
+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 MetricEntryRes
+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/MetricTypeReq.md

@@ -0,0 +1,36 @@
+
+# MetricTypeReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`entityType` | [MetricEntityType](MetricEntityType.md)
+
+## Example
+
+```typescript
+import type { MetricTypeReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": cpu_usage,
+  "entityType": null,
+} satisfies MetricTypeReq
+
+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 MetricTypeReq
+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/MetricTypeRes.md

@@ -0,0 +1,42 @@
+
+# MetricTypeRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`entityType` | [MetricEntityType](MetricEntityType.md)
+`name` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { MetricTypeRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "entityType": null,
+  "name": cpu_usage,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies MetricTypeRes
+
+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 MetricTypeRes
+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/MetricTypesList200Response.md

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

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