fulcrum-cem-client 0.0.2 → 0.0.3

package/docs/SubmitNotaryJobReq.md

@@ -0,0 +1,38 @@
+
+# SubmitNotaryJobReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceOfferingId` | string
+`filename` | string
+`fileContent` | string
+
+## Example
+
+```typescript
+import type { SubmitNotaryJobReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceOfferingId": 123e4567-e89b-12d3-a456-426614174000,
+  "filename": certificate.pdf,
+  "fileContent": null,
+} satisfies SubmitNotaryJobReq
+
+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 SubmitNotaryJobReq
+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/TokenReq.md

@@ -0,0 +1,40 @@
+
+# TokenReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`role` | [AuthRole](AuthRole.md)
+`expireAt` | Date
+`scopeId` | string
+
+## Example
+
+```typescript
+import type { TokenReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": API Access Token,
+  "role": null,
+  "expireAt": 2025-12-31T23:59:59Z,
+  "scopeId": 123e4567-e89b-12d3-a456-426614174000,
+} satisfies TokenReq
+
+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 TokenReq
+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/TokenRes.md

@@ -0,0 +1,50 @@
+
+# TokenRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`role` | [AuthRole](AuthRole.md)
+`expireAt` | Date
+`participantId` | string
+`agentId` | string
+`createdAt` | Date
+`updatedAt` | Date
+`value` | string
+
+## Example
+
+```typescript
+import type { TokenRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "name": API Access Token,
+  "role": null,
+  "expireAt": null,
+  "participantId": 123e4567-e89b-12d3-a456-426614174000,
+  "agentId": 123e4567-e89b-12d3-a456-426614174000,
+  "createdAt": null,
+  "updatedAt": null,
+  "value": eyJhbGciOiJIUzI1NiIsInR5c...,
+} satisfies TokenRes
+
+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 TokenRes
+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/TokensApi.md

@@ -0,0 +1,453 @@
+# TokensApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**tokensCreate**](TokensApi.md#tokenscreate) | **POST** /tokens | Create a token |
+| [**tokensDelete**](TokensApi.md#tokensdelete) | **DELETE** /tokens/{id} | Delete a token |
+| [**tokensGet**](TokensApi.md#tokensget) | **GET** /tokens/{id} | Get a token |
+| [**tokensList**](TokensApi.md#tokenslist) | **GET** /tokens | List tokens |
+| [**tokensRegenerate**](TokensApi.md#tokensregenerate) | **POST** /tokens/{id}/regenerate | Regenerate token value |
+| [**tokensUpdate**](TokensApi.md#tokensupdateoperation) | **PATCH** /tokens/{id} | Update a token |
+
+
+
+## tokensCreate
+
+> TokenRes tokensCreate(tokenReq)
+
+Create a token
+
+Creates a new authentication token. The plain token value is only returned in this response and cannot be retrieved later.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokensApi,
+} from 'fulcrum-cem-client';
+import type { TokensCreateRequest } 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 TokensApi(config);
+
+  const body = {
+    // TokenReq
+    tokenReq: ...,
+  } satisfies TokensCreateRequest;
+
+  try {
+    const data = await api.tokensCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenReq** | [TokenReq](TokenReq.md) |  | |
+
+### Return type
+
+[**TokenRes**](TokenRes.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** | Token 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)
+
+
+## tokensDelete
+
+> tokensDelete(id)
+
+Delete a token
+
+Deletes a token by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokensApi,
+} from 'fulcrum-cem-client';
+import type { TokensDeleteRequest } 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 TokensApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies TokensDeleteRequest;
+
+  try {
+    const data = await api.tokensDelete(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** | Token deleted successfully |  -  |
+| **404** | Token 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)
+
+
+## tokensGet
+
+> TokenRes tokensGet(id)
+
+Get a token
+
+Retrieves a specific token by ID. Note that the plain token value is not returned in this endpoint.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokensApi,
+} from 'fulcrum-cem-client';
+import type { TokensGetRequest } 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 TokensApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies TokensGetRequest;
+
+  try {
+    const data = await api.tokensGet(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
+
+[**TokenRes**](TokenRes.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 token details |  -  |
+| **404** | Token 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)
+
+
+## tokensList
+
+> TokensList200Response tokensList(page, pageSize)
+
+List tokens
+
+Retrieves a paginated list of tokens
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokensApi,
+} from 'fulcrum-cem-client';
+import type { TokensListRequest } 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 TokensApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies TokensListRequest;
+
+  try {
+    const data = await api.tokensList(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
+
+[**TokensList200Response**](TokensList200Response.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 tokens |  -  |
+| **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)
+
+
+## tokensRegenerate
+
+> TokenRes tokensRegenerate(id)
+
+Regenerate token value
+
+Regenerates the value for an existing token. The new plain token value is returned in the response and cannot be retrieved later.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokensApi,
+} from 'fulcrum-cem-client';
+import type { TokensRegenerateRequest } 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 TokensApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies TokensRegenerateRequest;
+
+  try {
+    const data = await api.tokensRegenerate(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
+
+[**TokenRes**](TokenRes.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** | Token value regenerated successfully |  -  |
+| **404** | Token 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)
+
+
+## tokensUpdate
+
+> TokenRes tokensUpdate(id, tokensUpdateRequest)
+
+Update a token
+
+Updates an existing token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TokensApi,
+} from 'fulcrum-cem-client';
+import type { TokensUpdateOperationRequest } 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 TokensApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // TokensUpdateRequest
+    tokensUpdateRequest: ...,
+  } satisfies TokensUpdateOperationRequest;
+
+  try {
+    const data = await api.tokensUpdate(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`] |
+| **tokensUpdateRequest** | [TokensUpdateRequest](TokensUpdateRequest.md) |  | |
+
+### Return type
+
+[**TokenRes**](TokenRes.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** | Token updated successfully |  -  |
+| **404** | Token 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/TokensList200Response.md

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

@@ -0,0 +1,40 @@
+
+# TokensUpdateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`role` | [AuthRole](AuthRole.md)
+`expireAt` | Date
+`scopeId` | string
+
+## Example
+
+```typescript
+import type { TokensUpdateRequest } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Updated Token Name,
+  "role": null,
+  "expireAt": null,
+  "scopeId": 123e4567-e89b-12d3-a456-426614174000,
+} satisfies TokensUpdateRequest
+
+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 TokensUpdateRequest
+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/TransactionEntityType.md

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