fulcrum-cem-client 0.0.1 → 0.0.3

package/docs/MetricsApi.md

@@ -0,0 +1,531 @@
+# MetricsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**metricEntriesCreate**](MetricsApi.md#metricentriescreate) | **POST** /metric-entries | Create a metric entry |
+| [**metricEntriesList**](MetricsApi.md#metricentrieslist) | **GET** /metric-entries | List metric entries |
+| [**metricTypesCreate**](MetricsApi.md#metrictypescreate) | **POST** /metric-types | Create a metric type |
+| [**metricTypesDelete**](MetricsApi.md#metrictypesdelete) | **DELETE** /metric-types/{id} | Delete a metric type |
+| [**metricTypesGet**](MetricsApi.md#metrictypesget) | **GET** /metric-types/{id} | Get a metric type |
+| [**metricTypesList**](MetricsApi.md#metrictypeslist) | **GET** /metric-types | List metric types |
+| [**metricTypesUpdate**](MetricsApi.md#metrictypesupdateoperation) | **PATCH** /metric-types/{id} | Update a metric type |
+
+
+
+## metricEntriesCreate
+
+> MetricEntryRes metricEntriesCreate(metricEntryReq)
+
+Create a metric entry
+
+Creates a new metric entry
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricEntriesCreateRequest } 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 MetricsApi(config);
+
+  const body = {
+    // MetricEntryReq
+    metricEntryReq: ...,
+  } satisfies MetricEntriesCreateRequest;
+
+  try {
+    const data = await api.metricEntriesCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **metricEntryReq** | [MetricEntryReq](MetricEntryReq.md) |  | |
+
+### Return type
+
+[**MetricEntryRes**](MetricEntryRes.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** | Metric entry created successfully |  -  |
+| **400** | Invalid request |  -  |
+| **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)
+
+
+## metricEntriesList
+
+> MetricEntriesList200Response metricEntriesList(page, pageSize)
+
+List metric entries
+
+Retrieves a paginated list of metric entries
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricEntriesListRequest } 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 MetricsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies MetricEntriesListRequest;
+
+  try {
+    const data = await api.metricEntriesList(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
+
+[**MetricEntriesList200Response**](MetricEntriesList200Response.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 metric entries |  -  |
+| **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)
+
+
+## metricTypesCreate
+
+> MetricTypeRes metricTypesCreate(metricTypeReq)
+
+Create a metric type
+
+Creates a new metric type
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricTypesCreateRequest } 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 MetricsApi(config);
+
+  const body = {
+    // MetricTypeReq
+    metricTypeReq: ...,
+  } satisfies MetricTypesCreateRequest;
+
+  try {
+    const data = await api.metricTypesCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **metricTypeReq** | [MetricTypeReq](MetricTypeReq.md) |  | |
+
+### Return type
+
+[**MetricTypeRes**](MetricTypeRes.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** | Metric type 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)
+
+
+## metricTypesDelete
+
+> metricTypesDelete(id)
+
+Delete a metric type
+
+Deletes a metric type by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricTypesDeleteRequest } 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 MetricsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies MetricTypesDeleteRequest;
+
+  try {
+    const data = await api.metricTypesDelete(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** | Metric type deleted successfully |  -  |
+| **404** | Metric type 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)
+
+
+## metricTypesGet
+
+> MetricTypeRes metricTypesGet(id)
+
+Get a metric type
+
+Retrieves a specific metric type by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricTypesGetRequest } 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 MetricsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies MetricTypesGetRequest;
+
+  try {
+    const data = await api.metricTypesGet(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
+
+[**MetricTypeRes**](MetricTypeRes.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 metric type details |  -  |
+| **404** | Metric type 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)
+
+
+## metricTypesList
+
+> MetricTypesList200Response metricTypesList(page, pageSize)
+
+List metric types
+
+Retrieves a paginated list of metric types
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricTypesListRequest } 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 MetricsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies MetricTypesListRequest;
+
+  try {
+    const data = await api.metricTypesList(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
+
+[**MetricTypesList200Response**](MetricTypesList200Response.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 metric types |  -  |
+| **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)
+
+
+## metricTypesUpdate
+
+> MetricTypeRes metricTypesUpdate(id, metricTypesUpdateRequest)
+
+Update a metric type
+
+Updates an existing metric type
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetricsApi,
+} from 'fulcrum-cem-client';
+import type { MetricTypesUpdateOperationRequest } 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 MetricsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // MetricTypesUpdateRequest
+    metricTypesUpdateRequest: ...,
+  } satisfies MetricTypesUpdateOperationRequest;
+
+  try {
+    const data = await api.metricTypesUpdate(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`] |
+| **metricTypesUpdateRequest** | [MetricTypesUpdateRequest](MetricTypesUpdateRequest.md) |  | |
+
+### Return type
+
+[**MetricTypeRes**](MetricTypeRes.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** | Metric type updated successfully |  -  |
+| **404** | Metric type 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/NotaryJobRes.md

@@ -0,0 +1,54 @@
+
+# NotaryJobRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`serviceOfferingId` | string
+`providerId` | string
+`externalJobId` | string
+`status` | [NotaryJobStatus](NotaryJobStatus.md)
+`lastPolledAt` | Date
+`error` | string
+`certifications` | Array<string>
+`serviceOffering` | [ServiceOfferingRes](ServiceOfferingRes.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { NotaryJobRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceOfferingId": 123e4567-e89b-12d3-a456-426614174000,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "externalJobId": null,
+  "status": null,
+  "lastPolledAt": null,
+  "error": null,
+  "certifications": null,
+  "serviceOffering": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies NotaryJobRes
+
+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 NotaryJobRes
+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/NotaryJobStatus.md

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