@magnetcustomer/sdk 1.0.0

package/docs/ProcessAutomationApi.md

@@ -0,0 +1,576 @@
+# ProcessAutomationApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiProcessautomations507f1f77bcf86cd799439a00EntitiesGet**](#apiprocessautomations507f1f77bcf86cd799439a00entitiesget) | **GET** /api/processautomations/507f1f77bcf86cd799439a00/entities | List Automation Entities|
+|[**apiProcessautomations507f1f77bcf86cd799439a00Get**](#apiprocessautomations507f1f77bcf86cd799439a00get) | **GET** /api/processautomations/507f1f77bcf86cd799439a00 | Get Process Automation|
+|[**apiProcessautomations507f1f77bcf86cd799439a00RetryEntity507f1f77bcf86cd799439011Post**](#apiprocessautomations507f1f77bcf86cd799439a00retryentity507f1f77bcf86cd799439011post) | **POST** /api/processautomations/507f1f77bcf86cd799439a00/retry-entity/507f1f77bcf86cd799439011 | Retry Failed Entity|
+|[**apiProcessautomations507f1f77bcf86cd799439a00TestPost**](#apiprocessautomations507f1f77bcf86cd799439a00testpost) | **POST** /api/processautomations/507f1f77bcf86cd799439a00/test | Test Automation (Dry Run)|
+|[**apiProcessautomationsEntitiesGet**](#apiprocessautomationsentitiesget) | **GET** /api/processautomations/entities | List Supported Entities|
+|[**apiProcessautomationsEventsGet**](#apiprocessautomationseventsget) | **GET** /api/processautomations/events | List Available Events|
+|[**apiProcessautomationsFolders507f1f77bcf86cd799439a10FreezeAllPut**](#apiprocessautomationsfolders507f1f77bcf86cd799439a10freezeallput) | **PUT** /api/processautomations/folders/507f1f77bcf86cd799439a10/freeze-all | Freeze All in Folder|
+|[**apiProcessautomationsFolders507f1f77bcf86cd799439a10StatsGet**](#apiprocessautomationsfolders507f1f77bcf86cd799439a10statsget) | **GET** /api/processautomations/folders/507f1f77bcf86cd799439a10/stats | Get Folder Stats|
+|[**apiProcessautomationsFoldersPost**](#apiprocessautomationsfolderspost) | **POST** /api/processautomations/folders | Create Folder|
+|[**apiProcessautomationsFoldersTreeGet**](#apiprocessautomationsfolderstreeget) | **GET** /api/processautomations/folders/tree | List Folders|
+|[**apiProcessautomationsGet**](#apiprocessautomationsget) | **GET** /api/processautomations | List Process Automations|
+|[**apiProcessautomationsGlobalStatsGet**](#apiprocessautomationsglobalstatsget) | **GET** /api/processautomations/global-stats | Global Stats|
+|[**apiProcessautomationsPost**](#apiprocessautomationspost) | **POST** /api/processautomations | Create Process Automation|
+
+# **apiProcessautomations507f1f77bcf86cd799439a00EntitiesGet**
+> apiProcessautomations507f1f77bcf86cd799439a00EntitiesGet()
+
+Lista entidades processadas pela automacao (status: pending, processing, completed, failed).
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProcessautomations507f1f77bcf86cd799439a00EntitiesGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomations507f1f77bcf86cd799439a00Get**
+> apiProcessautomations507f1f77bcf86cd799439a00Get()
+
+Retorna detalhes de uma automacao.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomations507f1f77bcf86cd799439a00Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomations507f1f77bcf86cd799439a00RetryEntity507f1f77bcf86cd799439011Post**
+> apiProcessautomations507f1f77bcf86cd799439a00RetryEntity507f1f77bcf86cd799439011Post()
+
+Reprocessa uma entidade que falhou.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomations507f1f77bcf86cd799439a00RetryEntity507f1f77bcf86cd799439011Post();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomations507f1f77bcf86cd799439a00TestPost**
+> apiProcessautomations507f1f77bcf86cd799439a00TestPost()
+
+Executa a automacao em modo de teste sem persistir alteracoes.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomations507f1f77bcf86cd799439a00TestPost();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsEntitiesGet**
+> apiProcessautomationsEntitiesGet()
+
+Lista entidades suportadas para automacao.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomationsEntitiesGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsEventsGet**
+> apiProcessautomationsEventsGet()
+
+Lista eventos disponiveis para triggers de automacao.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomationsEventsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsFolders507f1f77bcf86cd799439a10FreezeAllPut**
+> apiProcessautomationsFolders507f1f77bcf86cd799439a10FreezeAllPut()
+
+Pausa todas as automacoes de uma pasta.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomationsFolders507f1f77bcf86cd799439a10FreezeAllPut();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsFolders507f1f77bcf86cd799439a10StatsGet**
+> apiProcessautomationsFolders507f1f77bcf86cd799439a10StatsGet()
+
+Retorna estatisticas da pasta (automacoes ativas, execucoes, taxa de sucesso).
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomationsFolders507f1f77bcf86cd799439a10StatsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsFoldersPost**
+> apiProcessautomationsFoldersPost()
+
+Cria uma pasta para organizar automacoes.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiProcessautomationsFoldersPost(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsFoldersTreeGet**
+> apiProcessautomationsFoldersTreeGet()
+
+Retorna arvore de pastas de automacoes.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomationsFoldersTreeGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsGet**
+> ApiProcessautomationsGet200Response apiProcessautomationsGet()
+
+Lista automacoes de processo com paginacao.
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProcessautomationsGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiProcessautomationsGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 200 OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsGlobalStatsGet**
+> ApiProcessautomationsGlobalStatsGet200Response apiProcessautomationsGlobalStatsGet()
+
+Retorna estatisticas globais de todas as automacoes (total, ativas, pausadas, execucoes).
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+const { status, data } = await apiInstance.apiProcessautomationsGlobalStatsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiProcessautomationsGlobalStatsGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 200 OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **apiProcessautomationsPost**
+> ApiProcessautomationsPost201Response apiProcessautomationsPost()
+
+Cria uma nova automacao de processo.\\n\\n## Body (JSON)\\n\\n| Campo | Tipo | Obrigatorio | Descricao |\\n|-------|------|-------------|----------|\\n| `title` | string | **Sim** | Nome da automacao |\\n| `sourceEntity` | string | **Sim** | Entidade: `Contact`, `Deal`, `Organization`, `Task`, `Meeting`, `Ticket` |\\n| `triggerType` | string | **Sim** | Tipo: `filter`, `event` ou `hybrid` |\\n| `status` | string | Nao | `WAITING` (padrao), `FREEZE` |\\n| `automationActions` | array | Nao | Lista de acoes a executar |
+
+### Example
+
+```typescript
+import {
+    ProcessAutomationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ProcessAutomationApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiProcessautomationsPost(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**ApiProcessautomationsPost201Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | 201 Created |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+