@magnetcustomer/sdk 1.0.0 → 2.0.0

package/dist/api/prospects-api.d.ts

@@ -1,763 +0,0 @@
-/**
- * MagnetCustomer API Reference
- * # MagnetCustomer API Reference  Documentacao oficial da API REST do CRM MagnetCustomer.  Esta referencia contem duas versoes da API:  | Versao | Status | Descricao | |--------|--------|----------| | **v2 (Current)** | Ativa | Versao atual com 294 endpoints documentados | | **v1 (Legacy)** | Manutencao | Versao legado para tenants ainda nao migrados |  ## Como Usar  1. Navegue para a versao desejada: **v2 (Current)** ou **v1 (Legacy)** 2. Configure as variaveis `subdomain`, `clientId` e `clientSecret` 3. O token OAuth2 sera renovado automaticamente pelo pre-request script  ## Autenticacao (OAuth2)  A API utiliza **OAuth2** com grant type `client_credentials` via Keycloak.  **Token endpoint:** `https://magnetcustomer.net/realms/platform/protocol/openid-connect/token`  ## Multi-tenancy  Cada tenant e identificado pelo seu subdominio. URL base:  ``` https://platform-api.{subdomain}.magnetcustomer.com/api/ ```  ## Paginacao  Todas as listagens suportam paginacao:  | Parametro | Default | Max | Descricao | |-----------|---------|-----|-----------| | `page` | 1 | - | Numero da pagina | | `limit` | 25 | 100 | Itens por pagina | | `sortBy` | - | - | Campo de ordenacao | | `sortType` | asc | - | `asc` ou `desc` |  ## Integracoes  - **Zapier:** Disponivel no marketplace — busque por \"MagnetCustomer\" - **n8n:** No nativo disponivel — busque por \"MagnetCustomer\"  ---  ## Changelog  ### v1.3.0 (2026-04-14)  **Wave 4 — Automacao, Jornadas e Segmentacao**  - Campaigns: CRUD, actions, enable/disable (8 requests) - Process Automation: CRUD, entities, execution, folders, dry-run (13 requests) - Journeys: CRUD, phases, health score, MRR, milestones, expansion (13 requests) - Segmentation: segmentation rules, sharing rules, preview, simulate (9 requests) - Estrutura unificada: v1 (Legacy) + v2 (Current) no mesmo workspace - Total de requests: ~294 (v2) + ~40 (v1)  ### v1.2.0 (2026-04-14)  **Wave 3 — Novos modulos**  - Email, Dashboards, Calendar, Reports (48 requests)  ### v1.1.0 (2026-04-14)  **Wave 2 — Sub-resources e operacoes em lote**  - Filters, Messages, Todos, Batch Operations (78 requests)  ### v1.0.0 (2026-04-14)  **Lancamento inicial**  - 125 requests em 6 modulos principais - OAuth2 com auto-refresh, 2 environments, documentacao publicada
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { Configuration } from '../configuration';
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import { type RequestArgs, BaseAPI } from '../base';
-import type { ApiContacts507f1f77bcf86cd799439011Put200Response } from '../models';
-import type { ApiProspects507f1f77bcf86cd799439033Get200Response } from '../models';
-import type { ApiProspects507f1f77bcf86cd799439033PutRequest } from '../models';
-import type { ApiProspectsGet200Response } from '../models';
-import type { ApiProspectsPost201Response } from '../models';
-/**
- * ProspectsApi - axios parameter creator
- */
-export declare const ProspectsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Retorna um prospect pelo ID.
-     * @summary Get Prospect
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Get: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary List Prospect Meetings
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033MeetingsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary List Prospect Observations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033ObservationsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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.
-     * @summary Update Prospect
-     * @param {ApiProspects507f1f77bcf86cd799439033PutRequest} [apiProspects507f1f77bcf86cd799439033PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Put: (apiProspects507f1f77bcf86cd799439033PutRequest?: ApiProspects507f1f77bcf86cd799439033PutRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary List Prospect Tasks
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TasksGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary List Prospect Tickets
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TicketsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary List Prospect Treatments
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TreatmentsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * List meetings for a specific prospect (by contact).
-     * @summary List Meetings by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDMeetingsGet: (cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * List observations for a specific prospect (by contact).
-     * @summary List Observations by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDObservationsGet: (cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * List tasks for a specific prospect (by contact).
-     * @summary List Tasks by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTasksGet: (cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * List tickets for a specific prospect (by contact).
-     * @summary List Tickets by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTicketsGet: (cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * List treatments for a specific prospect (by contact).
-     * @summary List Treatments by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTreatmentsGet: (cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Remove um filtro salvo.
-     * @summary Delete Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Delete: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retorna um filtro salvo pelo ID.
-     * @summary Get Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Get: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retorna o filtro padrao do usuario.
-     * @summary Get Default Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersDefaultGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lista filtros salvos do usuario para Prospects.
-     * @summary List Saved Filters
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lista prospects com paginacao.
-     * @summary List Prospects
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {string} [sortBy]
-     * @param {string} [sortType]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsGet: (page?: number, limit?: number, sortBy?: string, sortType?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retrieves a specific prospect by ID.
-     * @summary Get One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Update One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdPut: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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 |
-     * @summary Create Prospect
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsPost: (body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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 |
-     * @summary Remove Selected Prospects
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsSelectedRemovePut: (body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * ProspectsApi - functional programming interface
- */
-export declare const ProspectsApiFp: (configuration?: Configuration) => {
-    /**
-     * Retorna um prospect pelo ID.
-     * @summary Get Prospect
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiProspects507f1f77bcf86cd799439033Get200Response>>;
-    /**
-     *
-     * @summary List Prospect Meetings
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033MeetingsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary List Prospect Observations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033ObservationsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * 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.
-     * @summary Update Prospect
-     * @param {ApiProspects507f1f77bcf86cd799439033PutRequest} [apiProspects507f1f77bcf86cd799439033PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Put(apiProspects507f1f77bcf86cd799439033PutRequest?: ApiProspects507f1f77bcf86cd799439033PutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiContacts507f1f77bcf86cd799439011Put200Response>>;
-    /**
-     *
-     * @summary List Prospect Tasks
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TasksGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary List Prospect Tickets
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TicketsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary List Prospect Treatments
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TreatmentsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * List meetings for a specific prospect (by contact).
-     * @summary List Meetings by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDMeetingsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * List observations for a specific prospect (by contact).
-     * @summary List Observations by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDObservationsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * List tasks for a specific prospect (by contact).
-     * @summary List Tasks by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTasksGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * List tickets for a specific prospect (by contact).
-     * @summary List Tickets by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTicketsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * List treatments for a specific prospect (by contact).
-     * @summary List Treatments by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTreatmentsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Remove um filtro salvo.
-     * @summary Delete Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Delete(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Retorna um filtro salvo pelo ID.
-     * @summary Get Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Retorna o filtro padrao do usuario.
-     * @summary Get Default Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersDefaultGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Lista filtros salvos do usuario para Prospects.
-     * @summary List Saved Filters
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Lista prospects com paginacao.
-     * @summary List Prospects
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {string} [sortBy]
-     * @param {string} [sortType]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsGet(page?: number, limit?: number, sortBy?: string, sortType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiProspectsGet200Response>>;
-    /**
-     * Retrieves a specific prospect by ID.
-     * @summary Get One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary Update One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdPut(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * 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 |
-     * @summary Create Prospect
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsPost(body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiProspectsPost201Response>>;
-    /**
-     * 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 |
-     * @summary Remove Selected Prospects
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsSelectedRemovePut(body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-};
-/**
- * ProspectsApi - factory interface
- */
-export declare const ProspectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Retorna um prospect pelo ID.
-     * @summary Get Prospect
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Get(options?: RawAxiosRequestConfig): AxiosPromise<ApiProspects507f1f77bcf86cd799439033Get200Response>;
-    /**
-     *
-     * @summary List Prospect Meetings
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033MeetingsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary List Prospect Observations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033ObservationsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * 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.
-     * @summary Update Prospect
-     * @param {ApiProspects507f1f77bcf86cd799439033PutRequest} [apiProspects507f1f77bcf86cd799439033PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Put(apiProspects507f1f77bcf86cd799439033PutRequest?: ApiProspects507f1f77bcf86cd799439033PutRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiContacts507f1f77bcf86cd799439011Put200Response>;
-    /**
-     *
-     * @summary List Prospect Tasks
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TasksGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary List Prospect Tickets
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TicketsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary List Prospect Treatments
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TreatmentsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * List meetings for a specific prospect (by contact).
-     * @summary List Meetings by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDMeetingsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * List observations for a specific prospect (by contact).
-     * @summary List Observations by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDObservationsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * List tasks for a specific prospect (by contact).
-     * @summary List Tasks by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTasksGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * List tickets for a specific prospect (by contact).
-     * @summary List Tickets by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTicketsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * List treatments for a specific prospect (by contact).
-     * @summary List Treatments by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTreatmentsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Remove um filtro salvo.
-     * @summary Delete Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Delete(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Retorna um filtro salvo pelo ID.
-     * @summary Get Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Retorna o filtro padrao do usuario.
-     * @summary Get Default Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersDefaultGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Lista filtros salvos do usuario para Prospects.
-     * @summary List Saved Filters
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Lista prospects com paginacao.
-     * @summary List Prospects
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {string} [sortBy]
-     * @param {string} [sortType]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsGet(page?: number, limit?: number, sortBy?: string, sortType?: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiProspectsGet200Response>;
-    /**
-     * Retrieves a specific prospect by ID.
-     * @summary Get One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary Update One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdPut(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * 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 |
-     * @summary Create Prospect
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsPost(body?: object, options?: RawAxiosRequestConfig): AxiosPromise<ApiProspectsPost201Response>;
-    /**
-     * 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 |
-     * @summary Remove Selected Prospects
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsSelectedRemovePut(body?: object, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-};
-/**
- * ProspectsApi - object-oriented interface
- */
-export declare class ProspectsApi extends BaseAPI {
-    /**
-     * Retorna um prospect pelo ID.
-     * @summary Get Prospect
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Get(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiProspects507f1f77bcf86cd799439033Get200Response, any, {}>>;
-    /**
-     *
-     * @summary List Prospect Meetings
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033MeetingsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary List Prospect Observations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033ObservationsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * 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.
-     * @summary Update Prospect
-     * @param {ApiProspects507f1f77bcf86cd799439033PutRequest} [apiProspects507f1f77bcf86cd799439033PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033Put(apiProspects507f1f77bcf86cd799439033PutRequest?: ApiProspects507f1f77bcf86cd799439033PutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiContacts507f1f77bcf86cd799439011Put200Response, any, {}>>;
-    /**
-     *
-     * @summary List Prospect Tasks
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TasksGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary List Prospect Tickets
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TicketsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary List Prospect Treatments
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspects507f1f77bcf86cd799439033TreatmentsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * List meetings for a specific prospect (by contact).
-     * @summary List Meetings by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDMeetingsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * List observations for a specific prospect (by contact).
-     * @summary List Observations by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDObservationsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * List tasks for a specific prospect (by contact).
-     * @summary List Tasks by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTasksGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * List tickets for a specific prospect (by contact).
-     * @summary List Tickets by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTicketsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * List treatments for a specific prospect (by contact).
-     * @summary List Treatments by Prospect
-     * @param {string} cONTACTID
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsCONTACTIDTreatmentsGet(cONTACTID: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Remove um filtro salvo.
-     * @summary Delete Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Delete(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Retorna um filtro salvo pelo ID.
-     * @summary Get Saved Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFilters507f1f77bcf86cd799439300Get(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Retorna o filtro padrao do usuario.
-     * @summary Get Default Filter
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersDefaultGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Lista filtros salvos do usuario para Prospects.
-     * @summary List Saved Filters
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsFiltersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Lista prospects com paginacao.
-     * @summary List Prospects
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {string} [sortBy]
-     * @param {string} [sortType]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsGet(page?: number, limit?: number, sortBy?: string, sortType?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiProspectsGet200Response, any, {}>>;
-    /**
-     * Retrieves a specific prospect by ID.
-     * @summary Get One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary Update One Prospect
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsIdPut(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * 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 |
-     * @summary Create Prospect
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsPost(body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiProspectsPost201Response, any, {}>>;
-    /**
-     * 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 |
-     * @summary Remove Selected Prospects
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiProspectsSelectedRemovePut(body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-}