@magnetcustomer/sdk 1.0.0

package/docs/FoldersApi.md

@@ -0,0 +1,174 @@
+# FoldersApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+
+# **apiProcessautomationsFolders507f1f77bcf86cd799439a10FreezeAllPut**
+> apiProcessautomationsFolders507f1f77bcf86cd799439a10FreezeAllPut()
+
+Pausa todas as automacoes de uma pasta.
+
+### Example
+
+```typescript
+import {
+    FoldersApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new FoldersApi(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 {
+    FoldersApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new FoldersApi(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 {
+    FoldersApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new FoldersApi(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 {
+    FoldersApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new FoldersApi(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)
+

package/docs/GuidesApi.md

@@ -0,0 +1,509 @@
+# GuidesApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiContactsGet**](#apicontactsget) | **GET** /api/contacts | Pagination Example|
+|[**apiContactsIdPut**](#apicontactsidput) | **PUT** /api/contacts/{id} | Update contact customFields|
+|[**apiContactsPost**](#apicontactspost) | **POST** /api/contacts | Create Contact with Custom Fields|
+|[**apiCustomfieldsGet**](#apicustomfieldsget) | **GET** /api/customfields | List Custom Fields for Contacts|
+|[**apiDealsIdPut**](#apidealsidput) | **PUT** /api/deals/{id} | Update deal customFields|
+|[**apiWebhooksPost**](#apiwebhookspost) | **POST** /api/webhooks | Create Webhook Example|
+|[**apiWebhooksTriggersGet**](#apiwebhookstriggersget) | **GET** /api/webhooks/triggers | List Available Triggers|
+|[**revokePost**](#revokepost) | **POST** /revoke | Revoke Token|
+|[**tokenPost**](#tokenpost) | **POST** /token | Client Credentials Flow|
+|[**userinfoGet**](#userinfoget) | **GET** /userinfo | User Info|
+|[**wellKnownOpenidConfigurationGet**](#wellknownopenidconfigurationget) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery Endpoint|
+
+# **apiContactsGet**
+> apiContactsGet()
+
+# Paginacao e Filtros  Todas as listagens da API suportam paginacao e ordenacao.  ## Parametros de Paginacao  | Parametro | Tipo | Default | Max | Descricao | |-----------|------|---------|-----|-----------| | `page` | number | 1 | - | Numero da pagina | | `limit` | number | 25 | 100 | Itens por pagina | | `sortBy` | string | - | - | Campo para ordenacao | | `sortType` | string | asc | - | `asc` ou `desc` |  ## Resposta Paginada  Toda listagem retorna: ```json {   \"data\": [...],   \"page\": 2,   \"pages\": 10,   \"limit\": 10,   \"total\": 95 } ```  ## Busca Textual  Use o parametro `search` para buscar por texto em campos como nome, email e telefone: ``` GET /api/contacts?search=joao&page=1&limit=25 ```
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+let sortBy: string; // (optional) (default to undefined)
+let sortType: string; // (optional) (default to undefined)
+let search: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContactsGet(
+    page,
+    limit,
+    sortBy,
+    sortType,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **sortBy** | [**string**] |  | (optional) defaults to undefined|
+| **sortType** | [**string**] |  | (optional) defaults to undefined|
+| **search** | [**string**] |  | (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)
+
+# **apiContactsIdPut**
+> apiContactsIdPut()
+
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiContactsIdPut(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | 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)
+
+# **apiContactsPost**
+> apiContactsPost()
+
+Exemplo de criacao de contato com campos customizados preenchidos.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiContactsPost(
+    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)
+
+# **apiCustomfieldsGet**
+> apiCustomfieldsGet()
+
+# Campos Customizados  Campos customizados permitem estender as entidades do CRM com dados especificos do seu negocio.  ## Conceitos  - **Feature**: A entidade associada (contact, deal, organization, ticket, etc)      - **Field Type**: O tipo de dado (text, number, date, select, multiselect, etc)      - **Block**: Agrupamento visual dos campos no formulario      - **Slug**: Identificador unico do campo (usado em `customFields` das entidades)       ## Uso em Entidades  Ao criar/atualizar uma entidade, envie customFields como array:  ``` json {   \"fullname\": \"Joao Silva\",   \"customFields\": [     {       \"customField\": \"507f1f77bcf86cd799439150\",       \"k\": \"data_nascimento\",       \"v\": \"1990-05-15\"     }   ] }   ```  ## Tipos Disponiveis  Use `GET /api/customfieldtypes` para listar todos os tipos.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+let feature: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiCustomfieldsGet(
+    feature
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **feature** | [**string**] |  | (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)
+
+# **apiDealsIdPut**
+> apiDealsIdPut()
+
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiDealsIdPut(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | 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)
+
+# **apiWebhooksPost**
+> apiWebhooksPost()
+
+Exemplo de criacao de webhook para receber notificacoes de eventos de oportunidades e contatos.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiWebhooksPost(
+    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)
+
+# **apiWebhooksTriggersGet**
+> apiWebhooksTriggersGet()
+
+# Configuracao de Webhooks  Webhooks permitem que seu sistema receba notificacoes HTTP em tempo real quando eventos ocorrem no CRM.  ## Como Funciona  1. **Liste triggers disponiveis** com esta request      2. **Crie um webhook** em `POST /api/webhooks` com a URL do seu endpoint e os triggers desejados      3. **Teste o webhook** com `POST /api/webhooks/:id/test`      4. **Monitore entregas** com `GET /api/webhooks/:id/stats`       ## Payload Recebido  Seu endpoint recebera um POST com:  ``` json {   \"event\": \"deal.created\",   \"timestamp\": \"2026-01-15T10:30:00Z\",   \"data\": { ... } }   ```  ## Seguranca  - Valide o header `X-Webhook-Signature` para garantir autenticidade      - Responda com HTTP 200 em ate 5 segundos      - Webhooks com falha sao retentados ate 3 vezes com backoff exponencial       ## Requer Permissao  Todas as operacoes de webhook requerem permissao de administrador.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+const { status, data } = await apiInstance.apiWebhooksTriggersGet();
+```
+
+### 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)
+
+# **revokePost**
+> revokePost()
+
+Revoga um token ativo.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+const { status, data } = await apiInstance.revokePost();
+```
+
+### 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)
+
+# **tokenPost**
+> TokenPost200Response tokenPost()
+
+Fluxo recomendado para integracoes server-to-server. Retorna um access_token JWT valido por ~5 minutos.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+const { status, data } = await apiInstance.tokenPost();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**TokenPost200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Client Credentials Flow |  -  |
+
+[[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)
+
+# **userinfoGet**
+> UserinfoGet200Response userinfoGet()
+
+Retorna informacoes do usuario autenticado pelo token atual.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+const { status, data } = await apiInstance.userinfoGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserinfoGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful User Info |  -  |
+
+[[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)
+
+# **wellKnownOpenidConfigurationGet**
+> wellKnownOpenidConfigurationGet()
+
+The endpoint makes an HTTP GET request to retrieve the OpenID configuration. The response contains various endpoints and supported features related to the OpenID Connect protocol, including authorization, token, userinfo, and revocation endpoints.
+
+### Example
+
+```typescript
+import {
+    GuidesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GuidesApi(configuration);
+
+const { status, data } = await apiInstance.wellKnownOpenidConfigurationGet();
+```
+
+### 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)
+