fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/NotaryJobsApi.md

@@ -0,0 +1,381 @@
+# NotaryJobsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**notaryJobsCancel**](NotaryJobsApi.md#notaryjobscancel) | **DELETE** /notary-jobs/{id} | Cancel a notary job |
+| [**notaryJobsGet**](NotaryJobsApi.md#notaryjobsget) | **GET** /notary-jobs/{id} | Get a notary job by ID |
+| [**notaryJobsList**](NotaryJobsApi.md#notaryjobslist) | **GET** /notary-jobs | List all notary jobs |
+| [**notaryJobsPoll**](NotaryJobsApi.md#notaryjobspoll) | **POST** /notary-jobs/{id}/poll | Poll notary job status |
+| [**notaryJobsSubmit**](NotaryJobsApi.md#notaryjobssubmit) | **POST** /notary-jobs | Submit a file for notarization |
+
+
+
+## notaryJobsCancel
+
+> notaryJobsCancel(id)
+
+Cancel a notary job
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotaryJobsApi,
+} from 'fulcrum-cem-client';
+import type { NotaryJobsCancelRequest } 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 NotaryJobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies NotaryJobsCancelRequest;
+
+  try {
+    const data = await api.notaryJobsCancel(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** | Notary job cancelled successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Notary job 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)
+
+
+## notaryJobsGet
+
+> NotaryJobRes notaryJobsGet(id)
+
+Get a notary job by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotaryJobsApi,
+} from 'fulcrum-cem-client';
+import type { NotaryJobsGetRequest } 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 NotaryJobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies NotaryJobsGetRequest;
+
+  try {
+    const data = await api.notaryJobsGet(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
+
+[**NotaryJobRes**](NotaryJobRes.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** | Notary job details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Notary job 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)
+
+
+## notaryJobsList
+
+> Array<NotaryJobRes> notaryJobsList(page, pageSize, serviceOfferingId)
+
+List all notary jobs
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotaryJobsApi,
+} from 'fulcrum-cem-client';
+import type { NotaryJobsListRequest } 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 NotaryJobsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Filter by service offering ID (optional)
+    serviceOfferingId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies NotaryJobsListRequest;
+
+  try {
+    const data = await api.notaryJobsList(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`] |
+| **serviceOfferingId** | `string` | Filter by service offering ID | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<NotaryJobRes>**](NotaryJobRes.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 notary jobs |  -  |
+| **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)
+
+
+## notaryJobsPoll
+
+> notaryJobsPoll(id)
+
+Poll notary job status
+
+Manually poll the notary service to update job status
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotaryJobsApi,
+} from 'fulcrum-cem-client';
+import type { NotaryJobsPollRequest } 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 NotaryJobsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies NotaryJobsPollRequest;
+
+  try {
+    const data = await api.notaryJobsPoll(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 |
+|-------------|-------------|------------------|
+| **200** | Notary job status updated |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Notary job 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)
+
+
+## notaryJobsSubmit
+
+> NotaryJobRes notaryJobsSubmit(submitNotaryJobReq)
+
+Submit a file for notarization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NotaryJobsApi,
+} from 'fulcrum-cem-client';
+import type { NotaryJobsSubmitRequest } 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 NotaryJobsApi(config);
+
+  const body = {
+    // SubmitNotaryJobReq
+    submitNotaryJobReq: ...,
+  } satisfies NotaryJobsSubmitRequest;
+
+  try {
+    const data = await api.notaryJobsSubmit(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **submitNotaryJobReq** | [SubmitNotaryJobReq](SubmitNotaryJobReq.md) |  | |
+
+### Return type
+
+[**NotaryJobRes**](NotaryJobRes.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** | Notary job submitted successfully |  -  |
+| **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)
+

package/docs/PageRes.md

@@ -0,0 +1,44 @@
+
+# PageRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | Array<object>
+`totalItems` | number
+`totalPages` | number
+`currentPage` | number
+`hasNext` | boolean
+`hasPrev` | boolean
+
+## Example
+
+```typescript
+import type { PageRes } 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 PageRes
+
+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 PageRes
+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/ParticipantReq.md

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

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

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