npm - @magnetcustomer/sdk - Versions diffs - 1.0.1 → 2.1.0 - Mend

@magnetcustomer/sdk 1.0.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1535) hide show

package/docs/ProspectsApi.md DELETED Viewed

@@ -1,1030 +0,0 @@
-# ProspectsApi
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**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|
-|[**apiProspectsCONTACTIDMeetingsGet**](#apiprospectscontactidmeetingsget) | **GET** /api/prospects/{CONTACT_ID}/meetings | List Meetings by Prospect|
-|[**apiProspectsCONTACTIDObservationsGet**](#apiprospectscontactidobservationsget) | **GET** /api/prospects/{CONTACT_ID}/observations | List Observations by Prospect|
-|[**apiProspectsCONTACTIDTasksGet**](#apiprospectscontactidtasksget) | **GET** /api/prospects/{CONTACT_ID}/tasks | List Tasks by Prospect|
-|[**apiProspectsCONTACTIDTicketsGet**](#apiprospectscontactidticketsget) | **GET** /api/prospects/{CONTACT_ID}/tickets | List Tickets by Prospect|
-|[**apiProspectsCONTACTIDTreatmentsGet**](#apiprospectscontactidtreatmentsget) | **GET** /api/prospects/{CONTACT_ID}/treatments | List Treatments by Prospect|
-|[**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|
-|[**apiProspectsIdGet**](#apiprospectsidget) | **GET** /api/prospects/{id} | Get One Prospect|
-|[**apiProspectsIdPut**](#apiprospectsidput) | **PUT** /api/prospects/{id} | Update One Prospect|
-|[**apiProspectsPost**](#apiprospectspost) | **POST** /api/prospects | Create Prospect|
-|[**apiProspectsSelectedRemovePut**](#apiprospectsselectedremoveput) | **PUT** /api/prospects/selected/remove | Remove Selected Prospects|
-# **apiProspects507f1f77bcf86cd799439033Get**
-> ApiProspects507f1f77bcf86cd799439033Get200Response apiProspects507f1f77bcf86cd799439033Get()
-Retorna um prospect pelo ID.
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration,
-    ApiProspects507f1f77bcf86cd799439033PutRequest
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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)
-# **apiProspectsCONTACTIDMeetingsGet**
-> apiProspectsCONTACTIDMeetingsGet()
-List meetings for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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.apiProspectsCONTACTIDMeetingsGet(
-    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)
-# **apiProspectsCONTACTIDObservationsGet**
-> apiProspectsCONTACTIDObservationsGet()
-List observations for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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.apiProspectsCONTACTIDObservationsGet(
-    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)
-# **apiProspectsCONTACTIDTasksGet**
-> apiProspectsCONTACTIDTasksGet()
-List tasks for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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.apiProspectsCONTACTIDTasksGet(
-    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)
-# **apiProspectsCONTACTIDTicketsGet**
-> apiProspectsCONTACTIDTicketsGet()
-List tickets for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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.apiProspectsCONTACTIDTicketsGet(
-    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)
-# **apiProspectsCONTACTIDTreatmentsGet**
-> apiProspectsCONTACTIDTreatmentsGet()
-List treatments for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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.apiProspectsCONTACTIDTreatmentsGet(
-    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)
-# **apiProspectsFilters507f1f77bcf86cd799439300Delete**
-> apiProspectsFilters507f1f77bcf86cd799439300Delete()
-Remove um filtro salvo.
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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)
-# **apiProspectsIdGet**
-> apiProspectsIdGet()
-Retrieves a specific prospect by ID.
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiProspectsIdGet(
-    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)
-# **apiProspectsIdPut**
-> apiProspectsIdPut()
-### Example
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiProspectsIdPut(
-    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)
-# **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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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 {
-    ProspectsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(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)