@magnetcustomer/sdk 1.0.0

package/docs/CRMCoreApi.md

@@ -0,0 +1,2805 @@
+# CRMCoreApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiContacts507f1f77bcf86cd799439011Get**](#apicontacts507f1f77bcf86cd799439011get) | **GET** /api/contacts/507f1f77bcf86cd799439011 | Get Contact|
+|[**apiContacts507f1f77bcf86cd799439011MeetingsGet**](#apicontacts507f1f77bcf86cd799439011meetingsget) | **GET** /api/contacts/507f1f77bcf86cd799439011/meetings | List Contact Meetings|
+|[**apiContacts507f1f77bcf86cd799439011ObservationsGet**](#apicontacts507f1f77bcf86cd799439011observationsget) | **GET** /api/contacts/507f1f77bcf86cd799439011/observations | List Contact Observations|
+|[**apiContacts507f1f77bcf86cd799439011Put**](#apicontacts507f1f77bcf86cd799439011put) | **PUT** /api/contacts/507f1f77bcf86cd799439011 | Update Contact|
+|[**apiContacts507f1f77bcf86cd799439011TasksGet**](#apicontacts507f1f77bcf86cd799439011tasksget) | **GET** /api/contacts/507f1f77bcf86cd799439011/tasks | List Contact Tasks|
+|[**apiContacts507f1f77bcf86cd799439011TicketsGet**](#apicontacts507f1f77bcf86cd799439011ticketsget) | **GET** /api/contacts/507f1f77bcf86cd799439011/tickets | List Contact Tickets|
+|[**apiContacts507f1f77bcf86cd799439011TreatmentsGet**](#apicontacts507f1f77bcf86cd799439011treatmentsget) | **GET** /api/contacts/507f1f77bcf86cd799439011/treatments | List Contact Treatments|
+|[**apiContactsFilters507f1f77bcf86cd799439300Delete**](#apicontactsfilters507f1f77bcf86cd799439300delete) | **DELETE** /api/contacts/filters/507f1f77bcf86cd799439300 | Delete Saved Filter|
+|[**apiContactsFilters507f1f77bcf86cd799439300Get**](#apicontactsfilters507f1f77bcf86cd799439300get) | **GET** /api/contacts/filters/507f1f77bcf86cd799439300 | Get Saved Filter|
+|[**apiContactsFiltersDefaultGet**](#apicontactsfiltersdefaultget) | **GET** /api/contacts/filters/default | Get Default Filter|
+|[**apiContactsFiltersGet**](#apicontactsfiltersget) | **GET** /api/contacts/filters | List Saved Filters|
+|[**apiContactsSelectedRemovePut**](#apicontactsselectedremoveput) | **PUT** /api/contacts/selected/remove | Remove Selected Contacts|
+|[**apiCustomers507f1f77bcf86cd799439066Get**](#apicustomers507f1f77bcf86cd799439066get) | **GET** /api/customers/507f1f77bcf86cd799439066 | Get Customer|
+|[**apiCustomers507f1f77bcf86cd799439066MeetingsGet**](#apicustomers507f1f77bcf86cd799439066meetingsget) | **GET** /api/customers/507f1f77bcf86cd799439066/meetings | List Customer Meetings|
+|[**apiCustomers507f1f77bcf86cd799439066ObservationsGet**](#apicustomers507f1f77bcf86cd799439066observationsget) | **GET** /api/customers/507f1f77bcf86cd799439066/observations | List Customer Observations|
+|[**apiCustomers507f1f77bcf86cd799439066Put**](#apicustomers507f1f77bcf86cd799439066put) | **PUT** /api/customers/507f1f77bcf86cd799439066 | Update Customer|
+|[**apiCustomers507f1f77bcf86cd799439066TasksGet**](#apicustomers507f1f77bcf86cd799439066tasksget) | **GET** /api/customers/507f1f77bcf86cd799439066/tasks | List Customer Tasks|
+|[**apiCustomers507f1f77bcf86cd799439066TicketsGet**](#apicustomers507f1f77bcf86cd799439066ticketsget) | **GET** /api/customers/507f1f77bcf86cd799439066/tickets | List Customer Tickets|
+|[**apiCustomers507f1f77bcf86cd799439066TreatmentsGet**](#apicustomers507f1f77bcf86cd799439066treatmentsget) | **GET** /api/customers/507f1f77bcf86cd799439066/treatments | List Customer Treatments|
+|[**apiCustomersFilters507f1f77bcf86cd799439300Delete**](#apicustomersfilters507f1f77bcf86cd799439300delete) | **DELETE** /api/customers/filters/507f1f77bcf86cd799439300 | Delete Saved Filter|
+|[**apiCustomersFilters507f1f77bcf86cd799439300Get**](#apicustomersfilters507f1f77bcf86cd799439300get) | **GET** /api/customers/filters/507f1f77bcf86cd799439300 | Get Saved Filter|
+|[**apiCustomersFiltersDefaultGet**](#apicustomersfiltersdefaultget) | **GET** /api/customers/filters/default | Get Default Filter|
+|[**apiCustomersFiltersGet**](#apicustomersfiltersget) | **GET** /api/customers/filters | List Saved Filters|
+|[**apiCustomersGet**](#apicustomersget) | **GET** /api/customers | List Customers|
+|[**apiCustomersPost**](#apicustomerspost) | **POST** /api/customers | Create Customer|
+|[**apiCustomersSelectedRemovePut**](#apicustomersselectedremoveput) | **PUT** /api/customers/selected/remove | Remove Selected Customers|
+|[**apiLeads507f1f77bcf86cd799439044Get**](#apileads507f1f77bcf86cd799439044get) | **GET** /api/leads/507f1f77bcf86cd799439044 | Get Lead|
+|[**apiLeads507f1f77bcf86cd799439044MeetingsGet**](#apileads507f1f77bcf86cd799439044meetingsget) | **GET** /api/leads/507f1f77bcf86cd799439044/meetings | List Lead Meetings|
+|[**apiLeads507f1f77bcf86cd799439044ObservationsGet**](#apileads507f1f77bcf86cd799439044observationsget) | **GET** /api/leads/507f1f77bcf86cd799439044/observations | List Lead Observations|
+|[**apiLeads507f1f77bcf86cd799439044Put**](#apileads507f1f77bcf86cd799439044put) | **PUT** /api/leads/507f1f77bcf86cd799439044 | Update Lead|
+|[**apiLeads507f1f77bcf86cd799439044TasksGet**](#apileads507f1f77bcf86cd799439044tasksget) | **GET** /api/leads/507f1f77bcf86cd799439044/tasks | List Lead Tasks|
+|[**apiLeads507f1f77bcf86cd799439044TicketsGet**](#apileads507f1f77bcf86cd799439044ticketsget) | **GET** /api/leads/507f1f77bcf86cd799439044/tickets | List Lead Tickets|
+|[**apiLeads507f1f77bcf86cd799439044TreatmentsGet**](#apileads507f1f77bcf86cd799439044treatmentsget) | **GET** /api/leads/507f1f77bcf86cd799439044/treatments | List Lead Treatments|
+|[**apiLeadsFilters507f1f77bcf86cd799439300Delete**](#apileadsfilters507f1f77bcf86cd799439300delete) | **DELETE** /api/leads/filters/507f1f77bcf86cd799439300 | Delete Saved Filter|
+|[**apiLeadsFilters507f1f77bcf86cd799439300Get**](#apileadsfilters507f1f77bcf86cd799439300get) | **GET** /api/leads/filters/507f1f77bcf86cd799439300 | Get Saved Filter|
+|[**apiLeadsFiltersDefaultGet**](#apileadsfiltersdefaultget) | **GET** /api/leads/filters/default | Get Default Filter|
+|[**apiLeadsFiltersGet**](#apileadsfiltersget) | **GET** /api/leads/filters | List Saved Filters|
+|[**apiLeadsGet**](#apileadsget) | **GET** /api/leads | List Leads|
+|[**apiLeadsPost**](#apileadspost) | **POST** /api/leads | Create Lead|
+|[**apiLeadsSelectedRemovePut**](#apileadsselectedremoveput) | **PUT** /api/leads/selected/remove | Remove Selected Leads|
+|[**apiOrganizations507f1f77bcf86cd799439055ContactsGet**](#apiorganizations507f1f77bcf86cd799439055contactsget) | **GET** /api/organizations/507f1f77bcf86cd799439055/contacts | List Organization Contacts|
+|[**apiOrganizations507f1f77bcf86cd799439055Get**](#apiorganizations507f1f77bcf86cd799439055get) | **GET** /api/organizations/507f1f77bcf86cd799439055 | Get Organization|
+|[**apiOrganizations507f1f77bcf86cd799439055Put**](#apiorganizations507f1f77bcf86cd799439055put) | **PUT** /api/organizations/507f1f77bcf86cd799439055 | Update Organization|
+|[**apiOrganizationsGet**](#apiorganizationsget) | **GET** /api/organizations | List Organizations|
+|[**apiOrganizationsPost**](#apiorganizationspost) | **POST** /api/organizations | Create Organization|
+|[**apiProspects507f1f77bcf86cd799439033Get**](#apiprospects507f1f77bcf86cd799439033get) | **GET** /api/prospects/507f1f77bcf86cd799439033 | Get Prospect|
+|[**apiProspects507f1f77bcf86cd799439033MeetingsGet**](#apiprospects507f1f77bcf86cd799439033meetingsget) | **GET** /api/prospects/507f1f77bcf86cd799439033/meetings | List Prospect Meetings|
+|[**apiProspects507f1f77bcf86cd799439033ObservationsGet**](#apiprospects507f1f77bcf86cd799439033observationsget) | **GET** /api/prospects/507f1f77bcf86cd799439033/observations | List Prospect Observations|
+|[**apiProspects507f1f77bcf86cd799439033Put**](#apiprospects507f1f77bcf86cd799439033put) | **PUT** /api/prospects/507f1f77bcf86cd799439033 | Update Prospect|
+|[**apiProspects507f1f77bcf86cd799439033TasksGet**](#apiprospects507f1f77bcf86cd799439033tasksget) | **GET** /api/prospects/507f1f77bcf86cd799439033/tasks | List Prospect Tasks|
+|[**apiProspects507f1f77bcf86cd799439033TicketsGet**](#apiprospects507f1f77bcf86cd799439033ticketsget) | **GET** /api/prospects/507f1f77bcf86cd799439033/tickets | List Prospect Tickets|
+|[**apiProspects507f1f77bcf86cd799439033TreatmentsGet**](#apiprospects507f1f77bcf86cd799439033treatmentsget) | **GET** /api/prospects/507f1f77bcf86cd799439033/treatments | List Prospect Treatments|
+|[**apiProspectsFilters507f1f77bcf86cd799439300Delete**](#apiprospectsfilters507f1f77bcf86cd799439300delete) | **DELETE** /api/prospects/filters/507f1f77bcf86cd799439300 | Delete Saved Filter|
+|[**apiProspectsFilters507f1f77bcf86cd799439300Get**](#apiprospectsfilters507f1f77bcf86cd799439300get) | **GET** /api/prospects/filters/507f1f77bcf86cd799439300 | Get Saved Filter|
+|[**apiProspectsFiltersDefaultGet**](#apiprospectsfiltersdefaultget) | **GET** /api/prospects/filters/default | Get Default Filter|
+|[**apiProspectsFiltersGet**](#apiprospectsfiltersget) | **GET** /api/prospects/filters | List Saved Filters|
+|[**apiProspectsGet**](#apiprospectsget) | **GET** /api/prospects | List Prospects|
+|[**apiProspectsPost**](#apiprospectspost) | **POST** /api/prospects | Create Prospect|
+|[**apiProspectsSelectedRemovePut**](#apiprospectsselectedremoveput) | **PUT** /api/prospects/selected/remove | Remove Selected Prospects|
+
+# **apiContacts507f1f77bcf86cd799439011Get**
+> ApiContacts507f1f77bcf86cd799439011Get200Response apiContacts507f1f77bcf86cd799439011Get()
+
+Retorna um contato pelo ID, incluindo campos customizados, owners e organizacoes vinculadas.  ## Path Parameters  | Parametro | Tipo | Descricao | |-----------|------|-----------| | `id` | ObjectId | ID do contato |  ## Responses  | Status | Descricao | |--------|-----------| | 200 | Contato encontrado | | 404 | Contato nao encontrado |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiContacts507f1f77bcf86cd799439011Get200Response**
+
+### 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 - Success |  -  |
+
+[[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)
+
+# **apiContacts507f1f77bcf86cd799439011MeetingsGet**
+> apiContacts507f1f77bcf86cd799439011MeetingsGet()
+
+Lista reunioes associadas ao contato.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011MeetingsGet(
+    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)
+
+# **apiContacts507f1f77bcf86cd799439011ObservationsGet**
+> apiContacts507f1f77bcf86cd799439011ObservationsGet()
+
+Lista observacoes do contato.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011ObservationsGet(
+    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)
+
+# **apiContacts507f1f77bcf86cd799439011Put**
+> ApiContacts507f1f77bcf86cd799439011Put200Response apiContacts507f1f77bcf86cd799439011Put()
+
+Atualiza um contato existente. Envie apenas os campos que deseja alterar (PATCH semantics).  ## Path Parameters  | Parametro | Tipo | Descricao | |-----------|------|-----------| | `id` | ObjectId | ID do contato |  ## Body (JSON)  Mesmos campos de Create Contact. Apenas os campos enviados serao atualizados.  ## Responses  | Status | Descricao | |--------|-----------| | 200 | Contato atualizado | | 400 | Dados invalidos | | 404 | Contato nao encontrado |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration,
+    ApiContacts507f1f77bcf86cd799439011PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let apiContacts507f1f77bcf86cd799439011PutRequest: ApiContacts507f1f77bcf86cd799439011PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011Put(
+    apiContacts507f1f77bcf86cd799439011PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiContacts507f1f77bcf86cd799439011PutRequest** | **ApiContacts507f1f77bcf86cd799439011PutRequest**|  | |
+
+
+### Return type
+
+**ApiContacts507f1f77bcf86cd799439011Put200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Update Contact |  -  |
+
+[[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)
+
+# **apiContacts507f1f77bcf86cd799439011TasksGet**
+> apiContacts507f1f77bcf86cd799439011TasksGet()
+
+Lista tarefas associadas ao contato.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011TasksGet(
+    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)
+
+# **apiContacts507f1f77bcf86cd799439011TicketsGet**
+> apiContacts507f1f77bcf86cd799439011TicketsGet()
+
+Lista tickets associados ao contato.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011TicketsGet(
+    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)
+
+# **apiContacts507f1f77bcf86cd799439011TreatmentsGet**
+> apiContacts507f1f77bcf86cd799439011TreatmentsGet()
+
+Lista atendimentos associados ao contato.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContacts507f1f77bcf86cd799439011TreatmentsGet(
+    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)
+
+# **apiContactsFilters507f1f77bcf86cd799439300Delete**
+> apiContactsFilters507f1f77bcf86cd799439300Delete()
+
+Remove um filtro salvo.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiContactsFilters507f1f77bcf86cd799439300Delete();
+```
+
+### 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)
+
+# **apiContactsFilters507f1f77bcf86cd799439300Get**
+> apiContactsFilters507f1f77bcf86cd799439300Get()
+
+Retorna um filtro salvo pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiContactsFilters507f1f77bcf86cd799439300Get();
+```
+
+### 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)
+
+# **apiContactsFiltersDefaultGet**
+> apiContactsFiltersDefaultGet()
+
+Retorna o filtro padrao do usuario.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiContactsFiltersDefaultGet();
+```
+
+### 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)
+
+# **apiContactsFiltersGet**
+> ApiContactsFiltersGet200Response apiContactsFiltersGet()
+
+Lista filtros salvos do usuario para Contacts.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiContactsFiltersGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiContactsFiltersGet200Response**
+
+### 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)
+
+# **apiContactsSelectedRemovePut**
+> apiContactsSelectedRemovePut()
+
+Remove multiplos contatos em lote.\\n\\n## Body (JSON)\\n\\n| Campo | Tipo | Obrigatorio | Descricao |\\n|-------|------|-------------|----------|\\n| `ids` | ObjectId[] | **Sim** | Array de IDs dos contatos a remover |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiContactsSelectedRemovePut(
+    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)
+
+# **apiCustomers507f1f77bcf86cd799439066Get**
+> apiCustomers507f1f77bcf86cd799439066Get()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066Get();
+```
+
+### 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**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**404** | 404 Not Found |  -  |
+
+[[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)
+
+# **apiCustomers507f1f77bcf86cd799439066MeetingsGet**
+> apiCustomers507f1f77bcf86cd799439066MeetingsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066MeetingsGet(
+    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)
+
+# **apiCustomers507f1f77bcf86cd799439066ObservationsGet**
+> apiCustomers507f1f77bcf86cd799439066ObservationsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066ObservationsGet(
+    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)
+
+# **apiCustomers507f1f77bcf86cd799439066Put**
+> apiCustomers507f1f77bcf86cd799439066Put()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration,
+    ApiProspects507f1f77bcf86cd799439033PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let apiProspects507f1f77bcf86cd799439033PutRequest: ApiProspects507f1f77bcf86cd799439033PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066Put(
+    apiProspects507f1f77bcf86cd799439033PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiProspects507f1f77bcf86cd799439033PutRequest** | **ApiProspects507f1f77bcf86cd799439033PutRequest**|  | |
+
+
+### 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)
+
+# **apiCustomers507f1f77bcf86cd799439066TasksGet**
+> apiCustomers507f1f77bcf86cd799439066TasksGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066TasksGet(
+    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)
+
+# **apiCustomers507f1f77bcf86cd799439066TicketsGet**
+> apiCustomers507f1f77bcf86cd799439066TicketsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066TicketsGet(
+    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)
+
+# **apiCustomers507f1f77bcf86cd799439066TreatmentsGet**
+> apiCustomers507f1f77bcf86cd799439066TreatmentsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiCustomers507f1f77bcf86cd799439066TreatmentsGet(
+    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)
+
+# **apiCustomersFilters507f1f77bcf86cd799439300Delete**
+> apiCustomersFilters507f1f77bcf86cd799439300Delete()
+
+Remove um filtro salvo.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomersFilters507f1f77bcf86cd799439300Delete();
+```
+
+### 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)
+
+# **apiCustomersFilters507f1f77bcf86cd799439300Get**
+> apiCustomersFilters507f1f77bcf86cd799439300Get()
+
+Retorna um filtro salvo pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomersFilters507f1f77bcf86cd799439300Get();
+```
+
+### 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)
+
+# **apiCustomersFiltersDefaultGet**
+> apiCustomersFiltersDefaultGet()
+
+Retorna o filtro padrao do usuario.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomersFiltersDefaultGet();
+```
+
+### 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)
+
+# **apiCustomersFiltersGet**
+> apiCustomersFiltersGet()
+
+Lista filtros salvos do usuario para Customers.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiCustomersFiltersGet();
+```
+
+### 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)
+
+# **apiCustomersGet**
+> ApiLeadsGet200Response apiCustomersGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(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)
+
+const { status, data } = await apiInstance.apiCustomersGet(
+    page,
+    limit,
+    sortBy,
+    sortType
+);
+```
+
+### 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|
+
+
+### Return type
+
+**ApiLeadsGet200Response**
+
+### 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)
+
+# **apiCustomersPost**
+> apiCustomersPost()
+
+Cria um novo customer.  ## Body (JSON)  | Campo | Tipo | Obrigatorio | Descricao | |-------|------|-------------|-----------| | `fullname` | string | **Sim** | Nome completo | | `email` | string | Nao | Email principal | | `phones` | array | Nao | Lista de telefones (ver estrutura abaixo) | | `type` | string | Nao | `physical` (padrao) ou `legal` | | `owners` | ObjectId[] | Nao | Array de IDs de staffs responsaveis | | `organization` | ObjectId | Nao | ID da organizacao vinculada | | `customFields` | array | Nao | Campos customizados (ver guide Custom Fields Usage) |  ### Estrutura de `phones`  ```json {   \"phones\": [     {       \"number\": \"+5511999990000\",       \"typePhone\": \"cellphone\",       \"ddi\": \"+55\"     }   ] } ```  | Campo | Tipo | Descricao | |-------|------|-----------| | `number` | string | Numero completo com DDI | | `typePhone` | string | `cellphone`, `commercial`, `home` ou `business` | | `ddi` | string | Codigo do pais (ex: `+55`) |  ## Responses  | Status | Descricao | |--------|-----------| | 201 | Customer criado com sucesso | | 400 | Dados invalidos (campo obrigatorio ausente) | | 401 | Token invalido ou expirado |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiCustomersPost(
+    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)
+
+# **apiCustomersSelectedRemovePut**
+> apiCustomersSelectedRemovePut()
+
+Remove multiplos customers em lote.\\n\\n## Body (JSON)\\n\\n| Campo | Tipo | Obrigatorio | Descricao |\\n|-------|------|-------------|----------|\\n| `ids` | ObjectId[] | **Sim** | Array de IDs dos customers a remover |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiCustomersSelectedRemovePut(
+    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)
+
+# **apiLeads507f1f77bcf86cd799439044Get**
+> ApiLeads507f1f77bcf86cd799439044Get200Response apiLeads507f1f77bcf86cd799439044Get()
+
+Retorna um lead pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiLeads507f1f77bcf86cd799439044Get200Response**
+
+### 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 |  -  |
+|**404** | 404 Not Found |  -  |
+
+[[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)
+
+# **apiLeads507f1f77bcf86cd799439044MeetingsGet**
+> apiLeads507f1f77bcf86cd799439044MeetingsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044MeetingsGet(
+    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)
+
+# **apiLeads507f1f77bcf86cd799439044ObservationsGet**
+> apiLeads507f1f77bcf86cd799439044ObservationsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044ObservationsGet(
+    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)
+
+# **apiLeads507f1f77bcf86cd799439044Put**
+> ApiContacts507f1f77bcf86cd799439011Put200Response apiLeads507f1f77bcf86cd799439044Put()
+
+Updates an existing lead\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): First name - `lastname` (string): Last name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"cellphone|commercial|home\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Contact type. One of: `physical`, `legal` - `doc` (string): CPF/CNPJ document number - `owners` (array of strings): IDs of staff members who own this lead - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `favoriteChannelToCommunication` (array of strings): Preferred communication channel IDs  ## Response  Returns the updated lead object with all current field values.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration,
+    ApiProspects507f1f77bcf86cd799439033PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let apiProspects507f1f77bcf86cd799439033PutRequest: ApiProspects507f1f77bcf86cd799439033PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044Put(
+    apiProspects507f1f77bcf86cd799439033PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiProspects507f1f77bcf86cd799439033PutRequest** | **ApiProspects507f1f77bcf86cd799439033PutRequest**|  | |
+
+
+### Return type
+
+**ApiContacts507f1f77bcf86cd799439011Put200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Update Lead |  -  |
+
+[[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)
+
+# **apiLeads507f1f77bcf86cd799439044TasksGet**
+> apiLeads507f1f77bcf86cd799439044TasksGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044TasksGet(
+    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)
+
+# **apiLeads507f1f77bcf86cd799439044TicketsGet**
+> apiLeads507f1f77bcf86cd799439044TicketsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044TicketsGet(
+    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)
+
+# **apiLeads507f1f77bcf86cd799439044TreatmentsGet**
+> apiLeads507f1f77bcf86cd799439044TreatmentsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeads507f1f77bcf86cd799439044TreatmentsGet(
+    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)
+
+# **apiLeadsFilters507f1f77bcf86cd799439300Delete**
+> apiLeadsFilters507f1f77bcf86cd799439300Delete()
+
+Remove um filtro salvo.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiLeadsFilters507f1f77bcf86cd799439300Delete();
+```
+
+### 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)
+
+# **apiLeadsFilters507f1f77bcf86cd799439300Get**
+> apiLeadsFilters507f1f77bcf86cd799439300Get()
+
+Retorna um filtro salvo pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiLeadsFilters507f1f77bcf86cd799439300Get();
+```
+
+### 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)
+
+# **apiLeadsFiltersDefaultGet**
+> apiLeadsFiltersDefaultGet()
+
+Retorna o filtro padrao do usuario.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiLeadsFiltersDefaultGet();
+```
+
+### 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)
+
+# **apiLeadsFiltersGet**
+> apiLeadsFiltersGet()
+
+Lista filtros salvos do usuario para Leads.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiLeadsFiltersGet();
+```
+
+### 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)
+
+# **apiLeadsGet**
+> ApiLeadsGet200Response apiLeadsGet()
+
+Lista leads com paginacao.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(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)
+
+const { status, data } = await apiInstance.apiLeadsGet(
+    page,
+    limit,
+    sortBy,
+    sortType
+);
+```
+
+### 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|
+
+
+### Return type
+
+**ApiLeadsGet200Response**
+
+### 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)
+
+# **apiLeadsPost**
+> ApiProspectsPost201Response apiLeadsPost()
+
+Cria um novo lead.  ## Body (JSON)  | Campo | Tipo | Obrigatorio | Descricao | |-------|------|-------------|-----------| | `fullname` | string | **Sim** | Nome completo | | `email` | string | Nao | Email principal | | `phones` | array | Nao | Lista de telefones (ver estrutura abaixo) | | `type` | string | Nao | `physical` (padrao) ou `legal` | | `owners` | ObjectId[] | Nao | Array de IDs de staffs responsaveis | | `organization` | ObjectId | Nao | ID da organizacao vinculada | | `customFields` | array | Nao | Campos customizados (ver guide Custom Fields Usage) |  ### Estrutura de `phones`  ```json {   \"phones\": [     {       \"number\": \"+5511999990000\",       \"typePhone\": \"cellphone\",       \"ddi\": \"+55\"     }   ] } ```  | Campo | Tipo | Descricao | |-------|------|-----------| | `number` | string | Numero completo com DDI | | `typePhone` | string | `cellphone`, `commercial`, `home` ou `business` | | `ddi` | string | Codigo do pais (ex: `+55`) |  ## Responses  | Status | Descricao | |--------|-----------| | 201 | Lead criado com sucesso | | 400 | Dados invalidos (campo obrigatorio ausente) | | 401 | Token invalido ou expirado |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiLeadsPost(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**ApiProspectsPost201Response**
+
+### 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 |  -  |
+|**400** | 400 Bad Request |  -  |
+
+[[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)
+
+# **apiLeadsSelectedRemovePut**
+> apiLeadsSelectedRemovePut()
+
+Remove multiplos leads em lote.\\n\\n## Body (JSON)\\n\\n| Campo | Tipo | Obrigatorio | Descricao |\\n|-------|------|-------------|----------|\\n| `ids` | ObjectId[] | **Sim** | Array de IDs dos leads a remover |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiLeadsSelectedRemovePut(
+    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)
+
+# **apiOrganizations507f1f77bcf86cd799439055ContactsGet**
+> apiOrganizations507f1f77bcf86cd799439055ContactsGet()
+
+Lista contatos vinculados a organizacao.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiOrganizations507f1f77bcf86cd799439055ContactsGet(
+    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)
+
+# **apiOrganizations507f1f77bcf86cd799439055Get**
+> ApiOrganizations507f1f77bcf86cd799439055Get200Response apiOrganizations507f1f77bcf86cd799439055Get()
+
+Retorna uma organizacao pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiOrganizations507f1f77bcf86cd799439055Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiOrganizations507f1f77bcf86cd799439055Get200Response**
+
+### 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 |  -  |
+|**404** | 404 Not Found |  -  |
+
+[[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)
+
+# **apiOrganizations507f1f77bcf86cd799439055Put**
+> ApiOrganizations507f1f77bcf86cd799439055Put200Response apiOrganizations507f1f77bcf86cd799439055Put()
+
+Updates an existing organization\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }`  ## Response  Returns the updated organization object with all current field values.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration,
+    ApiOrganizations507f1f77bcf86cd799439055PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let apiOrganizations507f1f77bcf86cd799439055PutRequest: ApiOrganizations507f1f77bcf86cd799439055PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiOrganizations507f1f77bcf86cd799439055Put(
+    apiOrganizations507f1f77bcf86cd799439055PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizations507f1f77bcf86cd799439055PutRequest** | **ApiOrganizations507f1f77bcf86cd799439055PutRequest**|  | |
+
+
+### Return type
+
+**ApiOrganizations507f1f77bcf86cd799439055Put200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Update Organization |  -  |
+
+[[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)
+
+# **apiOrganizationsGet**
+> ApiOrganizationsGet200Response apiOrganizationsGet()
+
+Lista organizacoes com paginacao.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiOrganizationsGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiOrganizationsGet200Response**
+
+### 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)
+
+# **apiOrganizationsPost**
+> ApiOrganizationsPost201Response apiOrganizationsPost()
+
+Creates a new organization (legal entity / company).  ## Request Body  - `name` (string, required): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Must be `legal` for organizations - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `source` (string): Origin of the record (e.g., `platform`, `api`)  ## Response  Returns the created organization object. If a duplicate is detected (same CNPJ or email), returns HTTP 409.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration,
+    ApiOrganizationsPostRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let apiOrganizationsPostRequest: ApiOrganizationsPostRequest; // (optional)
+
+const { status, data } = await apiInstance.apiOrganizationsPost(
+    apiOrganizationsPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizationsPostRequest** | **ApiOrganizationsPostRequest**|  | |
+
+
+### Return type
+
+**ApiOrganizationsPost201Response**
+
+### 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 |  -  |
+|**400** | 400 Bad Request |  -  |
+
+[[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)
+
+# **apiProspects507f1f77bcf86cd799439033Get**
+> ApiProspects507f1f77bcf86cd799439033Get200Response apiProspects507f1f77bcf86cd799439033Get()
+
+Retorna um prospect pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiProspects507f1f77bcf86cd799439033Get200Response**
+
+### 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 |  -  |
+|**404** | 404 Not Found |  -  |
+
+[[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)
+
+# **apiProspects507f1f77bcf86cd799439033MeetingsGet**
+> apiProspects507f1f77bcf86cd799439033MeetingsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033MeetingsGet(
+    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)
+
+# **apiProspects507f1f77bcf86cd799439033ObservationsGet**
+> apiProspects507f1f77bcf86cd799439033ObservationsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033ObservationsGet(
+    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)
+
+# **apiProspects507f1f77bcf86cd799439033Put**
+> ApiContacts507f1f77bcf86cd799439011Put200Response apiProspects507f1f77bcf86cd799439033Put()
+
+Updates an existing prospect\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): First name - `lastname` (string): Last name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"cellphone|commercial|home\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Contact type. One of: `physical`, `legal` - `doc` (string): CPF/CNPJ document number - `owners` (array of strings): IDs of staff members who own this prospect - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `favoriteChannelToCommunication` (array of strings): Preferred communication channel IDs  ## Response  Returns the updated prospect object with all current field values.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration,
+    ApiProspects507f1f77bcf86cd799439033PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let apiProspects507f1f77bcf86cd799439033PutRequest: ApiProspects507f1f77bcf86cd799439033PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033Put(
+    apiProspects507f1f77bcf86cd799439033PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiProspects507f1f77bcf86cd799439033PutRequest** | **ApiProspects507f1f77bcf86cd799439033PutRequest**|  | |
+
+
+### Return type
+
+**ApiContacts507f1f77bcf86cd799439011Put200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Update Prospect |  -  |
+
+[[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)
+
+# **apiProspects507f1f77bcf86cd799439033TasksGet**
+> apiProspects507f1f77bcf86cd799439033TasksGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033TasksGet(
+    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)
+
+# **apiProspects507f1f77bcf86cd799439033TicketsGet**
+> apiProspects507f1f77bcf86cd799439033TicketsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033TicketsGet(
+    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)
+
+# **apiProspects507f1f77bcf86cd799439033TreatmentsGet**
+> apiProspects507f1f77bcf86cd799439033TreatmentsGet()
+
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiProspects507f1f77bcf86cd799439033TreatmentsGet(
+    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)
+
+# **apiProspectsFilters507f1f77bcf86cd799439300Delete**
+> apiProspectsFilters507f1f77bcf86cd799439300Delete()
+
+Remove um filtro salvo.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiProspectsFilters507f1f77bcf86cd799439300Delete();
+```
+
+### 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)
+
+# **apiProspectsFilters507f1f77bcf86cd799439300Get**
+> apiProspectsFilters507f1f77bcf86cd799439300Get()
+
+Retorna um filtro salvo pelo ID.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiProspectsFilters507f1f77bcf86cd799439300Get();
+```
+
+### 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)
+
+# **apiProspectsFiltersDefaultGet**
+> apiProspectsFiltersDefaultGet()
+
+Retorna o filtro padrao do usuario.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiProspectsFiltersDefaultGet();
+```
+
+### 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)
+
+# **apiProspectsFiltersGet**
+> apiProspectsFiltersGet()
+
+Lista filtros salvos do usuario para Prospects.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+const { status, data } = await apiInstance.apiProspectsFiltersGet();
+```
+
+### 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)
+
+# **apiProspectsGet**
+> ApiProspectsGet200Response apiProspectsGet()
+
+Lista prospects com paginacao.
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(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)
+
+const { status, data } = await apiInstance.apiProspectsGet(
+    page,
+    limit,
+    sortBy,
+    sortType
+);
+```
+
+### 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|
+
+
+### Return type
+
+**ApiProspectsGet200Response**
+
+### 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)
+
+# **apiProspectsPost**
+> ApiProspectsPost201Response apiProspectsPost()
+
+Cria um novo prospect.  ## Body (JSON)  | Campo | Tipo | Obrigatorio | Descricao | |-------|------|-------------|-----------| | `fullname` | string | **Sim** | Nome completo | | `email` | string | Nao | Email principal | | `phones` | array | Nao | Lista de telefones (ver estrutura abaixo) | | `type` | string | Nao | `physical` (padrao) ou `legal` | | `owners` | ObjectId[] | Nao | Array de IDs de staffs responsaveis | | `organization` | ObjectId | Nao | ID da organizacao vinculada | | `customFields` | array | Nao | Campos customizados (ver guide Custom Fields Usage) |  ### Estrutura de `phones`  ```json {   \"phones\": [     {       \"number\": \"+5511999990000\",       \"typePhone\": \"cellphone\",       \"ddi\": \"+55\"     }   ] } ```  | Campo | Tipo | Descricao | |-------|------|-----------| | `number` | string | Numero completo com DDI | | `typePhone` | string | `cellphone`, `commercial`, `home` ou `business` | | `ddi` | string | Codigo do pais (ex: `+55`) |  ## Responses  | Status | Descricao | |--------|-----------| | 201 | Prospect criado com sucesso | | 400 | Dados invalidos (campo obrigatorio ausente) | | 401 | Token invalido ou expirado |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiProspectsPost(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**ApiProspectsPost201Response**
+
+### 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 |  -  |
+|**400** | 400 Bad Request |  -  |
+
+[[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)
+
+# **apiProspectsSelectedRemovePut**
+> apiProspectsSelectedRemovePut()
+
+Remove multiplos prospects em lote.\\n\\n## Body (JSON)\\n\\n| Campo | Tipo | Obrigatorio | Descricao |\\n|-------|------|-------------|----------|\\n| `ids` | ObjectId[] | **Sim** | Array de IDs dos prospects a remover |
+
+### Example
+
+```typescript
+import {
+    CRMCoreApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new CRMCoreApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiProspectsSelectedRemovePut(
+    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)
+