@magnetcustomer/sdk 1.0.0

package/docs/LeadsApi.md

@@ -0,0 +1,1030 @@
+# LeadsApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+|[**apiLeadsCONTACTIDMeetingsGet**](#apileadscontactidmeetingsget) | **GET** /api/leads/{CONTACT_ID}/meetings | List Meetings by Lead|
+|[**apiLeadsCONTACTIDObservationsGet**](#apileadscontactidobservationsget) | **GET** /api/leads/{CONTACT_ID}/observations | List Observations by Lead|
+|[**apiLeadsCONTACTIDTasksGet**](#apileadscontactidtasksget) | **GET** /api/leads/{CONTACT_ID}/tasks | List Tasks by Lead|
+|[**apiLeadsCONTACTIDTicketsGet**](#apileadscontactidticketsget) | **GET** /api/leads/{CONTACT_ID}/tickets | List Tickets by Lead|
+|[**apiLeadsCONTACTIDTreatmentsGet**](#apileadscontactidtreatmentsget) | **GET** /api/leads/{CONTACT_ID}/treatments | List Treatments by Lead|
+|[**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|
+|[**apiLeadsIdGet**](#apileadsidget) | **GET** /api/leads/{id} | Get One Lead|
+|[**apiLeadsIdPut**](#apileadsidput) | **PUT** /api/leads/{id} | Update One Lead|
+|[**apiLeadsPost**](#apileadspost) | **POST** /api/leads | Create Lead|
+|[**apiLeadsSelectedRemovePut**](#apileadsselectedremoveput) | **PUT** /api/leads/selected/remove | Remove Selected Leads|
+
+# **apiLeads507f1f77bcf86cd799439044Get**
+> ApiLeads507f1f77bcf86cd799439044Get200Response apiLeads507f1f77bcf86cd799439044Get()
+
+Retorna um lead pelo ID.
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration,
+    ApiProspects507f1f77bcf86cd799439033PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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)
+
+# **apiLeadsCONTACTIDMeetingsGet**
+> apiLeadsCONTACTIDMeetingsGet()
+
+List meetings for a specific lead (by contact).
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let cONTACTID: string; // (default to undefined)
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsCONTACTIDMeetingsGet(
+    cONTACTID,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cONTACTID** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **apiLeadsCONTACTIDObservationsGet**
+> apiLeadsCONTACTIDObservationsGet()
+
+List observations for a specific lead (by contact).
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let cONTACTID: string; // (default to undefined)
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsCONTACTIDObservationsGet(
+    cONTACTID,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cONTACTID** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **apiLeadsCONTACTIDTasksGet**
+> apiLeadsCONTACTIDTasksGet()
+
+List tasks for a specific lead (by contact).
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let cONTACTID: string; // (default to undefined)
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsCONTACTIDTasksGet(
+    cONTACTID,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cONTACTID** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **apiLeadsCONTACTIDTicketsGet**
+> apiLeadsCONTACTIDTicketsGet()
+
+List tickets for a specific lead (by contact).
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let cONTACTID: string; // (default to undefined)
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsCONTACTIDTicketsGet(
+    cONTACTID,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cONTACTID** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **apiLeadsCONTACTIDTreatmentsGet**
+> apiLeadsCONTACTIDTreatmentsGet()
+
+List treatments for a specific lead (by contact).
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let cONTACTID: string; // (default to undefined)
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsCONTACTIDTreatmentsGet(
+    cONTACTID,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cONTACTID** | [**string**] |  | defaults to undefined|
+| **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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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)
+
+# **apiLeadsIdGet**
+> apiLeadsIdGet()
+
+Retrieves a specific lead by ID.
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsIdGet(
+    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)
+
+# **apiLeadsIdPut**
+> apiLeadsIdPut()
+
+
+### Example
+
+```typescript
+import {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiLeadsIdPut(
+    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)
+
+# **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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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 {
+    LeadsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LeadsApi(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)
+