fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/TransactionRecordReq.md

@@ -0,0 +1,56 @@
+
+# TransactionRecordReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceOrderId` | string
+`transactionType` | [TransactionType](TransactionType.md)
+`debtorType` | [TransactionEntityType](TransactionEntityType.md)
+`debtorId` | string
+`creditorType` | [TransactionEntityType](TransactionEntityType.md)
+`creditorId` | string
+`amount` | number
+`billingPeriodStart` | Date
+`billingPeriodEnd` | Date
+`calculationData` | { [key: string]: any; }
+`priceItemId` | string
+`notes` | string
+
+## Example
+
+```typescript
+import type { TransactionRecordReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceOrderId": 123e4567-e89b-12d3-a456-426614174000,
+  "transactionType": null,
+  "debtorType": null,
+  "debtorId": 123e4567-e89b-12d3-a456-426614174000,
+  "creditorType": null,
+  "creditorId": 123e4567-e89b-12d3-a456-426614174000,
+  "amount": null,
+  "billingPeriodStart": null,
+  "billingPeriodEnd": null,
+  "calculationData": null,
+  "priceItemId": null,
+  "notes": null,
+} satisfies TransactionRecordReq
+
+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 TransactionRecordReq
+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/TransactionRecordRes.md

@@ -0,0 +1,74 @@
+
+# TransactionRecordRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`serviceOrderId` | string
+`transactionType` | [TransactionType](TransactionType.md)
+`debtorType` | [TransactionEntityType](TransactionEntityType.md)
+`debtorId` | string
+`creditorType` | [TransactionEntityType](TransactionEntityType.md)
+`creditorId` | string
+`amount` | number
+`billingPeriodStart` | Date
+`billingPeriodEnd` | Date
+`calculationData` | { [key: string]: any; }
+`priceItemId` | string
+`externalId` | string
+`status` | [TransactionStatus](TransactionStatus.md)
+`errorMessage` | string
+`notes` | string
+`serviceOrder` | [ServiceOrderRes](ServiceOrderRes.md)
+`debtor` | [ParticipantRes](ParticipantRes.md)
+`creditor` | [ParticipantRes](ParticipantRes.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { TransactionRecordRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceOrderId": 123e4567-e89b-12d3-a456-426614174000,
+  "transactionType": null,
+  "debtorType": null,
+  "debtorId": 123e4567-e89b-12d3-a456-426614174000,
+  "creditorType": null,
+  "creditorId": 123e4567-e89b-12d3-a456-426614174000,
+  "amount": null,
+  "billingPeriodStart": null,
+  "billingPeriodEnd": null,
+  "calculationData": null,
+  "priceItemId": null,
+  "externalId": null,
+  "status": null,
+  "errorMessage": null,
+  "notes": null,
+  "serviceOrder": null,
+  "debtor": null,
+  "creditor": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies TransactionRecordRes
+
+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 TransactionRecordRes
+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/TransactionStatus.md

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

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

@@ -0,0 +1,525 @@
+# TransactionsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**transactionsCreate**](TransactionsApi.md#transactionscreate) | **POST** /transactions | Create a new transaction record |
+| [**transactionsDelete**](TransactionsApi.md#transactionsdelete) | **DELETE** /transactions/{id} | Delete a transaction record |
+| [**transactionsDeleteByPeriod**](TransactionsApi.md#transactionsdeletebyperiod) | **DELETE** /transactions/periods | Delete transaction records by period |
+| [**transactionsGenerateByPeriod**](TransactionsApi.md#transactionsgeneratebyperiod) | **POST** /transactions/periods | Generate transaction records by period |
+| [**transactionsGet**](TransactionsApi.md#transactionsget) | **GET** /transactions/{id} | Get a transaction record by ID |
+| [**transactionsList**](TransactionsApi.md#transactionslist) | **GET** /transactions | List all transaction records |
+| [**transactionsUpdate**](TransactionsApi.md#transactionsupdateoperation) | **PATCH** /transactions/{id} | Update a transaction record |
+
+
+
+## transactionsCreate
+
+> TransactionRecordRes transactionsCreate(transactionRecordReq)
+
+Create a new transaction record
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsCreateRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // TransactionRecordReq
+    transactionRecordReq: ...,
+  } satisfies TransactionsCreateRequest;
+
+  try {
+    const data = await api.transactionsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **transactionRecordReq** | [TransactionRecordReq](TransactionRecordReq.md) |  | |
+
+### Return type
+
+[**TransactionRecordRes**](TransactionRecordRes.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** | Transaction record 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)
+
+
+## transactionsDelete
+
+> transactionsDelete(id)
+
+Delete a transaction record
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsDeleteRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies TransactionsDeleteRequest;
+
+  try {
+    const data = await api.transactionsDelete(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** | Transaction record deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Transaction record 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)
+
+
+## transactionsDeleteByPeriod
+
+> transactionsDeleteByPeriod(byPeriodReq)
+
+Delete transaction records by period
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsDeleteByPeriodRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // ByPeriodReq
+    byPeriodReq: ...,
+  } satisfies TransactionsDeleteByPeriodRequest;
+
+  try {
+    const data = await api.transactionsDeleteByPeriod(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **byPeriodReq** | [ByPeriodReq](ByPeriodReq.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Transaction records deleted |  -  |
+| **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)
+
+
+## transactionsGenerateByPeriod
+
+> transactionsGenerateByPeriod(byPeriodReq)
+
+Generate transaction records by period
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsGenerateByPeriodRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // ByPeriodReq
+    byPeriodReq: ...,
+  } satisfies TransactionsGenerateByPeriodRequest;
+
+  try {
+    const data = await api.transactionsGenerateByPeriod(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **byPeriodReq** | [ByPeriodReq](ByPeriodReq.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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** | Transaction records generated |  -  |
+| **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)
+
+
+## transactionsGet
+
+> TransactionRecordRes transactionsGet(id)
+
+Get a transaction record by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsGetRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies TransactionsGetRequest;
+
+  try {
+    const data = await api.transactionsGet(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
+
+[**TransactionRecordRes**](TransactionRecordRes.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** | Transaction record details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Transaction record 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)
+
+
+## transactionsList
+
+> Array<TransactionRecordRes> transactionsList(page, pageSize)
+
+List all transaction records
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsListRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies TransactionsListRequest;
+
+  try {
+    const data = await api.transactionsList(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<TransactionRecordRes>**](TransactionRecordRes.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 transaction records |  -  |
+| **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)
+
+
+## transactionsUpdate
+
+> TransactionRecordRes transactionsUpdate(id, transactionsUpdateRequest)
+
+Update a transaction record
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from 'fulcrum-cem-client';
+import type { TransactionsUpdateOperationRequest } 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 TransactionsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // TransactionsUpdateRequest
+    transactionsUpdateRequest: ...,
+  } satisfies TransactionsUpdateOperationRequest;
+
+  try {
+    const data = await api.transactionsUpdate(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`] |
+| **transactionsUpdateRequest** | [TransactionsUpdateRequest](TransactionsUpdateRequest.md) |  | |
+
+### Return type
+
+[**TransactionRecordRes**](TransactionRecordRes.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** | Transaction record updated |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Transaction record 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)
+