fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/AgentsList200Response.md

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

@@ -0,0 +1,34 @@
+
+# AgentsUpdateStatusRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [AgentStatus](AgentStatus.md)
+
+## Example
+
+```typescript
+import type { AgentsUpdateStatusRequest } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+} satisfies AgentsUpdateStatusRequest
+
+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 AgentsUpdateStatusRequest
+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/AuthRole.md

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

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

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

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

@@ -0,0 +1,40 @@
+
+# CommitmentReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`duration` | number
+`billingFrequency` | number
+`prepaid` | boolean
+
+## Example
+
+```typescript
+import type { CommitmentReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "duration": null,
+  "billingFrequency": null,
+  "prepaid": null,
+} satisfies CommitmentReq
+
+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 CommitmentReq
+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/CommitmentRes.md

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

@@ -0,0 +1,379 @@
+# CommitmentsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**commitmentsCreate**](CommitmentsApi.md#commitmentscreate) | **POST** /commitments | Create a new commitment |
+| [**commitmentsDelete**](CommitmentsApi.md#commitmentsdelete) | **DELETE** /commitments/{id} | Delete a commitment |
+| [**commitmentsGet**](CommitmentsApi.md#commitmentsget) | **GET** /commitments/{id} | Get a commitment by ID |
+| [**commitmentsList**](CommitmentsApi.md#commitmentslist) | **GET** /commitments | List all commitments |
+| [**commitmentsUpdate**](CommitmentsApi.md#commitmentsupdate) | **PATCH** /commitments/{id} | Update a commitment |
+
+
+
+## commitmentsCreate
+
+> CommitmentRes commitmentsCreate(commitmentReq)
+
+Create a new commitment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CommitmentsApi,
+} from 'fulcrum-cem-client';
+import type { CommitmentsCreateRequest } 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 CommitmentsApi(config);
+
+  const body = {
+    // CommitmentReq
+    commitmentReq: ...,
+  } satisfies CommitmentsCreateRequest;
+
+  try {
+    const data = await api.commitmentsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **commitmentReq** | [CommitmentReq](CommitmentReq.md) |  | |
+
+### Return type
+
+[**CommitmentRes**](CommitmentRes.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** | Commitment created |  -  |
+| **400** | Bad Request |  -  |
+| **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)
+
+
+## commitmentsDelete
+
+> commitmentsDelete(id)
+
+Delete a commitment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CommitmentsApi,
+} from 'fulcrum-cem-client';
+import type { CommitmentsDeleteRequest } 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 CommitmentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CommitmentsDeleteRequest;
+
+  try {
+    const data = await api.commitmentsDelete(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** | Commitment deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Commitment 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)
+
+
+## commitmentsGet
+
+> CommitmentRes commitmentsGet(id)
+
+Get a commitment by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CommitmentsApi,
+} from 'fulcrum-cem-client';
+import type { CommitmentsGetRequest } 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 CommitmentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CommitmentsGetRequest;
+
+  try {
+    const data = await api.commitmentsGet(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
+
+[**CommitmentRes**](CommitmentRes.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** | Commitment details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Commitment 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)
+
+
+## commitmentsList
+
+> Array<CommitmentRes> commitmentsList(page, pageSize)
+
+List all commitments
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CommitmentsApi,
+} from 'fulcrum-cem-client';
+import type { CommitmentsListRequest } 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 CommitmentsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies CommitmentsListRequest;
+
+  try {
+    const data = await api.commitmentsList(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<CommitmentRes>**](CommitmentRes.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 commitments |  -  |
+| **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)
+
+
+## commitmentsUpdate
+
+> CommitmentRes commitmentsUpdate(id, commitmentReq)
+
+Update a commitment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CommitmentsApi,
+} from 'fulcrum-cem-client';
+import type { CommitmentsUpdateRequest } 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 CommitmentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CommitmentReq
+    commitmentReq: ...,
+  } satisfies CommitmentsUpdateRequest;
+
+  try {
+    const data = await api.commitmentsUpdate(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`] |
+| **commitmentReq** | [CommitmentReq](CommitmentReq.md) |  | |
+
+### Return type
+
+[**CommitmentRes**](CommitmentRes.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** | Commitment updated |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Commitment 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)
+