fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/ParticipantsApi.md

@@ -0,0 +1,389 @@
+# ParticipantsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**participantsCreate**](ParticipantsApi.md#participantscreate) | **POST** /participants | Create a participant |
+| [**participantsDelete**](ParticipantsApi.md#participantsdelete) | **DELETE** /participants/{id} | Delete a participant |
+| [**participantsGet**](ParticipantsApi.md#participantsget) | **GET** /participants/{id} | Get a participant |
+| [**participantsList**](ParticipantsApi.md#participantslist) | **GET** /participants | List participants |
+| [**participantsUpdate**](ParticipantsApi.md#participantsupdate) | **PATCH** /participants/{id} | Update a participant |
+
+
+
+## participantsCreate
+
+> ParticipantRes participantsCreate(participantReq)
+
+Create a participant
+
+Creates a new participant
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ParticipantsApi,
+} from 'fulcrum-cem-client';
+import type { ParticipantsCreateRequest } 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 ParticipantsApi(config);
+
+  const body = {
+    // ParticipantReq
+    participantReq: ...,
+  } satisfies ParticipantsCreateRequest;
+
+  try {
+    const data = await api.participantsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **participantReq** | [ParticipantReq](ParticipantReq.md) |  | |
+
+### Return type
+
+[**ParticipantRes**](ParticipantRes.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** | Participant created successfully |  -  |
+| **400** | Invalid request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## participantsDelete
+
+> participantsDelete(id)
+
+Delete a participant
+
+Deletes a participant by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ParticipantsApi,
+} from 'fulcrum-cem-client';
+import type { ParticipantsDeleteRequest } 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 ParticipantsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ParticipantsDeleteRequest;
+
+  try {
+    const data = await api.participantsDelete(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** | Participant deleted successfully |  -  |
+| **404** | Participant 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)
+
+
+## participantsGet
+
+> ParticipantRes participantsGet(id)
+
+Get a participant
+
+Retrieves a specific participant by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ParticipantsApi,
+} from 'fulcrum-cem-client';
+import type { ParticipantsGetRequest } 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 ParticipantsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ParticipantsGetRequest;
+
+  try {
+    const data = await api.participantsGet(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
+
+[**ParticipantRes**](ParticipantRes.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 participant details |  -  |
+| **404** | Participant 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)
+
+
+## participantsList
+
+> ParticipantsList200Response participantsList(page, pageSize, sort, name, status)
+
+List participants
+
+Retrieves a paginated list of participants
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ParticipantsApi,
+} from 'fulcrum-cem-client';
+import type { ParticipantsListRequest } 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 ParticipantsApi(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: name (optional)
+    sort: +name,
+    // Array<string> | Filter by participant name (can specify multiple values) (optional)
+    name: ...,
+    // Array<'Enabled' | 'Disabled'> | Filter by participant status (can specify multiple values) (optional)
+    status: ...,
+  } satisfies ParticipantsListRequest;
+
+  try {
+    const data = await api.participantsList(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: name | [Optional] [Defaults to `undefined`] |
+| **name** | `Array<string>` | Filter by participant name (can specify multiple values) | [Optional] |
+| **status** | `Enabled`, `Disabled` | Filter by participant status (can specify multiple values) | [Optional] [Enum: Enabled, Disabled] |
+
+### Return type
+
+[**ParticipantsList200Response**](ParticipantsList200Response.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 participants |  -  |
+| **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)
+
+
+## participantsUpdate
+
+> ParticipantRes participantsUpdate(id, participantReq)
+
+Update a participant
+
+Updates an existing participant
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ParticipantsApi,
+} from 'fulcrum-cem-client';
+import type { ParticipantsUpdateRequest } 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 ParticipantsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ParticipantReq
+    participantReq: ...,
+  } satisfies ParticipantsUpdateRequest;
+
+  try {
+    const data = await api.participantsUpdate(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`] |
+| **participantReq** | [ParticipantReq](ParticipantReq.md) |  | |
+
+### Return type
+
+[**ParticipantRes**](ParticipantRes.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** | Participant updated successfully |  -  |
+| **404** | Participant 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/ParticipantsList200Response.md

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

@@ -0,0 +1,46 @@
+
+# PriceItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`price` | number
+`currency` | string
+`unit` | string
+`billingPeriod` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { PriceItem } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "price": null,
+  "currency": null,
+  "unit": null,
+  "billingPeriod": null,
+  "description": null,
+} satisfies PriceItem
+
+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 PriceItem
+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/PropertyDefinition.md

@@ -0,0 +1,54 @@
+
+# PropertyDefinition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`label` | string
+`required` | boolean
+`_default` | any
+`immutable` | boolean
+`authorizers` | [Array<AuthorizerDefinition>](AuthorizerDefinition.md)
+`secret` | [SecretDefinition](SecretDefinition.md)
+`generator` | [GeneratorDefinition](GeneratorDefinition.md)
+`validators` | [Array<ValidatorDefinition>](ValidatorDefinition.md)
+`properties` | [{ [key: string]: PropertyDefinition; }](PropertyDefinition.md)
+`items` | [PropertyDefinition](PropertyDefinition.md)
+
+## Example
+
+```typescript
+import type { PropertyDefinition } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "label": null,
+  "required": null,
+  "_default": null,
+  "immutable": null,
+  "authorizers": null,
+  "secret": null,
+  "generator": null,
+  "validators": null,
+  "properties": null,
+  "items": null,
+} satisfies PropertyDefinition
+
+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 PropertyDefinition
+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/SecretDefinition.md

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

@@ -0,0 +1,36 @@
+
+# ServiceGroupReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`consumerId` | string
+
+## Example
+
+```typescript
+import type { ServiceGroupReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Web Servers,
+  "consumerId": 123e4567-e89b-12d3-a456-426614174000,
+} satisfies ServiceGroupReq
+
+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 ServiceGroupReq
+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/ServiceGroupRes.md

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

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