@magnetcustomer/sdk 1.0.1 → 2.0.0

package/dist/generated/api/pipelines-api.js

@@ -0,0 +1,279 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * API da Magnet Customer
+ * A API REST da Magnet Customer permite ler e gravar os registros do CRM a partir dos seus sistemas.  # Comece aqui  ## 1. Crie um Service Account  No CRM, abra **Configurações › Service Accounts** (apenas administradores), clique em **Novo service account**, escolha a validade e as permissões, e copie o **Client ID** e o **Client Secret**. O secret aparece uma única vez.  ## 2. Solicite um token  ```bash curl -X POST https://magnetcustomer.net/realms/platform/protocol/openid-connect/token \\   -H \"Content-Type: application/x-www-form-urlencoded\" \\   -d \"grant_type=client_credentials\" \\   -d \"client_id=SEU_CLIENT_ID\" \\   -d \"client_secret=SEU_CLIENT_SECRET\" ```  ```json { \"access_token\": \"eyJhbGciOiJSUzI1NiIs...\", \"expires_in\": 900, \"token_type\": \"Bearer\" } ```  O token vale 15 minutos e este fluxo não tem refresh token: quando vencer, ou ao receber `401`, repita o pedido.  ## 3. Chame a API  Cada conta tem o seu endereço. Troque `sua-conta` pelo subdomínio que você usa para abrir o CRM:  ```bash curl \"https://sua-conta.platform-api.magnetcustomer.com/api/deals?page=1&limit=15\" \\   -H \"Authorization: Bearer SEU_TOKEN\" ```  Requisições com corpo levam também `Content-Type: application/json`.  # Convenções  ## Paginação  Envie sempre `page`. Com ele, toda listagem devolve o mesmo envelope:  ```json { \"docs\": [], \"total\": 132, \"pages\": 9, \"page\": 1, \"limit\": 15 } ```  | Parâmetro | Padrão | Descrição | |---|---|---| | `page` | — | Página, a partir de 1. **Obrigatório na prática** | | `limit` | 15 | Registros por página. Máximo 100: acima disso a API usa 100 | | `sortBy` | varia por recurso | Campo de ordenação | | `sortType` | `desc` | `asc` ou `desc` | | `search` | — | Busca textual, quando o recurso aceita |  Sem `page`, a maioria das listagens devolve uma lista simples (`[...]`), sem o envelope, e ignora `limit`. Para percorrer tudo, peça `page=1` e avance até `page` ser igual a `pages`. Uma página além do fim devolve `docs` vazio.  O tamanho de página padrão é 15, com duas exceções: 25 em Leads, Prospects e Clientes, e 100 em Usuários. Um `limit` inválido cai no padrão.  ## Identificadores e datas  Todo ID é um texto de 24 caracteres hexadecimais, como `507f1f77bcf86cd799439011`. Ao gravar, envie a referência como **ID em texto** — nunca o objeto.  Um ID fora desse formato hoje é respondido com `500`, não `400`: valide o formato antes de enviar.  No corpo e nas respostas, datas são ISO 8601 em UTC, como `2026-05-15T10:00:00Z`. Nos filtros de data da URL (`minDate`, `dateOfExpires_minDate`...), o valor é um **timestamp em milissegundos**, como `1798761600000`; uma data ISO ali não filtra o que você espera.  ## Campos ausentes  Campo sem valor costuma vir **ausente** da resposta, não como `null`. Trate a falta da chave como vazio.  ## Campos personalizados  Os campos criados pelo administrador da conta vão na lista `customFields`:  ```json { \"customFields\": [ { \"customField\": \"507f1f77bcf86cd799439014\", \"k\": \"segmento\", \"v\": \"Tecnologia\" } ] } ```  O valor vai em **`v`**. Um item com `value` é aceito sem erro, mas o campo fica vazio. Descubra os campos e os IDs com `GET /api/customfields?page=1&feature=deal` (troque `deal` por `meeting`, `task`, `contact`...). Com `&required=true` vêm só os obrigatórios da conta.  ## Erros  ```json {   \"reason\": \"Missing required parameters\",   \"message\": \"Missing required parameters\",   \"code\": \"VALIDATION_ERROR\",   \"errors\": [ { \"field\": \"title\", \"message\": \"must NOT have fewer than 1 characters\", \"keyword\": \"minLength\" } ] } ```  | Status | Quando | |---|---| | `400` | Corpo inválido: campo obrigatório ausente, tipo errado, valor fora da lista | | `401` | Token ausente, inválido ou vencido. Corpo: `{\"reason\": \"Access Denied\"}` | | `403` | O Service Account não tem a permissão da rota (`type: SA_PERMISSION_DENIED`, com `requiredPermission`) ou a rota exige administrador (`type: ADMIN_REQUIRED`) | | `404` | Registro não encontrado | | `409` | O registro não está no estado que a operação exige | | `429` | Limite de requisições excedido. Espere o tempo de `Retry-After` |  ## Limite de requisições  Os limites são aplicados por conta. Ao receber `429`, espere os segundos indicados em `Retry-After` e tente de novo com intervalo crescente.  ## Área de trabalho  Em contas com áreas de trabalho, a API define a área do registro pela credencial ou pelo registro pai. Não envie `workspace`.  # Cobertura  Esta referência cobre Contatos (leads, prospects e clientes), Empresas, Oportunidades, Pipelines e etapas, Reuniões, Tarefas, Observações, Usuários e Campos personalizados. Tickets, Atendimentos e Webhooks entram nas próximas revisões.
+ *
+ * The version of the OpenAPI document: 2026-11
+ * Contact: suporte@magnetcustomer.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListPipelinesSortTypeEnum = exports.PipelinesApi = exports.PipelinesApiFactory = exports.PipelinesApiFp = exports.PipelinesApiAxiosParamCreator = void 0;
+const axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * PipelinesApi - axios parameter creator
+ */
+const PipelinesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Obter pipeline
+         * @param {string} id ID do registro.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPipeline: async (id, options = {}) => {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('getPipeline', 'id', id);
+            const localVarPath = `/api/pipelines/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ServiceAccount required
+            // oauth required
+            await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "ServiceAccount", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
+         * @summary Listar etapas do pipeline
+         * @param {string} id ID do registro.
+         * @param {string} [search] Busca no nome da etapa.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPipelineStages: async (id, search, options = {}) => {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('listPipelineStages', 'id', id);
+            const localVarPath = `/api/pipelines/{id}/stages`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ServiceAccount required
+            // oauth required
+            await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "ServiceAccount", [], configuration);
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Use para descobrir o `pipeline` de uma oportunidade.
+         * @summary Listar pipelines
+         * @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
+         * @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
+         * @param {string} [sortBy] Campo de ordenação. O padrão varia por recurso.
+         * @param {ListPipelinesSortTypeEnum} [sortType] Direção da ordenação.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPipelines: async (page, limit, sortBy, sortType, options = {}) => {
+            const localVarPath = `/api/pipelines`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ServiceAccount required
+            // oauth required
+            await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "ServiceAccount", [], configuration);
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (sortBy !== undefined) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+            if (sortType !== undefined) {
+                localVarQueryParameter['sortType'] = sortType;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    };
+};
+exports.PipelinesApiAxiosParamCreator = PipelinesApiAxiosParamCreator;
+/**
+ * PipelinesApi - functional programming interface
+ */
+const PipelinesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.PipelinesApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Obter pipeline
+         * @param {string} id ID do registro.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPipeline(id, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPipeline(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['PipelinesApi.getPipeline']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
+         * @summary Listar etapas do pipeline
+         * @param {string} id ID do registro.
+         * @param {string} [search] Busca no nome da etapa.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPipelineStages(id, search, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPipelineStages(id, search, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['PipelinesApi.listPipelineStages']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Use para descobrir o `pipeline` de uma oportunidade.
+         * @summary Listar pipelines
+         * @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
+         * @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
+         * @param {string} [sortBy] Campo de ordenação. O padrão varia por recurso.
+         * @param {ListPipelinesSortTypeEnum} [sortType] Direção da ordenação.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPipelines(page, limit, sortBy, sortType, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPipelines(page, limit, sortBy, sortType, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['PipelinesApi.listPipelines']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    };
+};
+exports.PipelinesApiFp = PipelinesApiFp;
+/**
+ * PipelinesApi - factory interface
+ */
+const PipelinesApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.PipelinesApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Obter pipeline
+         * @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPipeline(requestParameters, options) {
+            return localVarFp.getPipeline(requestParameters.id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
+         * @summary Listar etapas do pipeline
+         * @param {PipelinesApiListPipelineStagesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPipelineStages(requestParameters, options) {
+            return localVarFp.listPipelineStages(requestParameters.id, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Use para descobrir o `pipeline` de uma oportunidade.
+         * @summary Listar pipelines
+         * @param {PipelinesApiListPipelinesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPipelines(requestParameters = {}, options) {
+            return localVarFp.listPipelines(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.PipelinesApiFactory = PipelinesApiFactory;
+/**
+ * PipelinesApi - object-oriented interface
+ */
+class PipelinesApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Obter pipeline
+     * @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPipeline(requestParameters, options) {
+        return (0, exports.PipelinesApiFp)(this.configuration).getPipeline(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
+     * @summary Listar etapas do pipeline
+     * @param {PipelinesApiListPipelineStagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPipelineStages(requestParameters, options) {
+        return (0, exports.PipelinesApiFp)(this.configuration).listPipelineStages(requestParameters.id, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Use para descobrir o `pipeline` de uma oportunidade.
+     * @summary Listar pipelines
+     * @param {PipelinesApiListPipelinesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPipelines(requestParameters = {}, options) {
+        return (0, exports.PipelinesApiFp)(this.configuration).listPipelines(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.PipelinesApi = PipelinesApi;
+exports.ListPipelinesSortTypeEnum = {
+    asc: 'asc',
+    desc: 'desc',
+};

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

@@ -0,0 +1,295 @@
+/**
+ * API da Magnet Customer
+ * A API REST da Magnet Customer permite ler e gravar os registros do CRM a partir dos seus sistemas.  # Comece aqui  ## 1. Crie um Service Account  No CRM, abra **Configurações › Service Accounts** (apenas administradores), clique em **Novo service account**, escolha a validade e as permissões, e copie o **Client ID** e o **Client Secret**. O secret aparece uma única vez.  ## 2. Solicite um token  ```bash curl -X POST https://magnetcustomer.net/realms/platform/protocol/openid-connect/token \\   -H \"Content-Type: application/x-www-form-urlencoded\" \\   -d \"grant_type=client_credentials\" \\   -d \"client_id=SEU_CLIENT_ID\" \\   -d \"client_secret=SEU_CLIENT_SECRET\" ```  ```json { \"access_token\": \"eyJhbGciOiJSUzI1NiIs...\", \"expires_in\": 900, \"token_type\": \"Bearer\" } ```  O token vale 15 minutos e este fluxo não tem refresh token: quando vencer, ou ao receber `401`, repita o pedido.  ## 3. Chame a API  Cada conta tem o seu endereço. Troque `sua-conta` pelo subdomínio que você usa para abrir o CRM:  ```bash curl \"https://sua-conta.platform-api.magnetcustomer.com/api/deals?page=1&limit=15\" \\   -H \"Authorization: Bearer SEU_TOKEN\" ```  Requisições com corpo levam também `Content-Type: application/json`.  # Convenções  ## Paginação  Envie sempre `page`. Com ele, toda listagem devolve o mesmo envelope:  ```json { \"docs\": [], \"total\": 132, \"pages\": 9, \"page\": 1, \"limit\": 15 } ```  | Parâmetro | Padrão | Descrição | |---|---|---| | `page` | — | Página, a partir de 1. **Obrigatório na prática** | | `limit` | 15 | Registros por página. Máximo 100: acima disso a API usa 100 | | `sortBy` | varia por recurso | Campo de ordenação | | `sortType` | `desc` | `asc` ou `desc` | | `search` | — | Busca textual, quando o recurso aceita |  Sem `page`, a maioria das listagens devolve uma lista simples (`[...]`), sem o envelope, e ignora `limit`. Para percorrer tudo, peça `page=1` e avance até `page` ser igual a `pages`. Uma página além do fim devolve `docs` vazio.  O tamanho de página padrão é 15, com duas exceções: 25 em Leads, Prospects e Clientes, e 100 em Usuários. Um `limit` inválido cai no padrão.  ## Identificadores e datas  Todo ID é um texto de 24 caracteres hexadecimais, como `507f1f77bcf86cd799439011`. Ao gravar, envie a referência como **ID em texto** — nunca o objeto.  Um ID fora desse formato hoje é respondido com `500`, não `400`: valide o formato antes de enviar.  No corpo e nas respostas, datas são ISO 8601 em UTC, como `2026-05-15T10:00:00Z`. Nos filtros de data da URL (`minDate`, `dateOfExpires_minDate`...), o valor é um **timestamp em milissegundos**, como `1798761600000`; uma data ISO ali não filtra o que você espera.  ## Campos ausentes  Campo sem valor costuma vir **ausente** da resposta, não como `null`. Trate a falta da chave como vazio.  ## Campos personalizados  Os campos criados pelo administrador da conta vão na lista `customFields`:  ```json { \"customFields\": [ { \"customField\": \"507f1f77bcf86cd799439014\", \"k\": \"segmento\", \"v\": \"Tecnologia\" } ] } ```  O valor vai em **`v`**. Um item com `value` é aceito sem erro, mas o campo fica vazio. Descubra os campos e os IDs com `GET /api/customfields?page=1&feature=deal` (troque `deal` por `meeting`, `task`, `contact`...). Com `&required=true` vêm só os obrigatórios da conta.  ## Erros  ```json {   \"reason\": \"Missing required parameters\",   \"message\": \"Missing required parameters\",   \"code\": \"VALIDATION_ERROR\",   \"errors\": [ { \"field\": \"title\", \"message\": \"must NOT have fewer than 1 characters\", \"keyword\": \"minLength\" } ] } ```  | Status | Quando | |---|---| | `400` | Corpo inválido: campo obrigatório ausente, tipo errado, valor fora da lista | | `401` | Token ausente, inválido ou vencido. Corpo: `{\"reason\": \"Access Denied\"}` | | `403` | O Service Account não tem a permissão da rota (`type: SA_PERMISSION_DENIED`, com `requiredPermission`) ou a rota exige administrador (`type: ADMIN_REQUIRED`) | | `404` | Registro não encontrado | | `409` | O registro não está no estado que a operação exige | | `429` | Limite de requisições excedido. Espere o tempo de `Retry-After` |  ## Limite de requisições  Os limites são aplicados por conta. Ao receber `429`, espere os segundos indicados em `Retry-After` e tente de novo com intervalo crescente.  ## Área de trabalho  Em contas com áreas de trabalho, a API define a área do registro pela credencial ou pelo registro pai. Não envie `workspace`.  # Cobertura  Esta referência cobre Contatos (leads, prospects e clientes), Empresas, Oportunidades, Pipelines e etapas, Reuniões, Tarefas, Observações, Usuários e Campos personalizados. Tickets, Atendimentos e Webhooks entram nas próximas revisões.
+ *
+ * The version of the OpenAPI document: 2026-11
+ * Contact: suporte@magnetcustomer.com
+ *
+ * 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 { Contact } from '../models';
+import type { ContactInput } from '../models';
+import type { ListContacts200Response } from '../models';
+/**
+ * ProspectsApi - axios parameter creator
+ */
+export declare const ProspectsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Os registros criados por aqui entram como `prospect`.
+     * @summary Criar prospect
+     * @param {ContactInput} contactInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProspect: (contactInput: ContactInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Exige a permissão de excluir.
+     * @summary Excluir prospect
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProspect: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Obter prospect
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProspect: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Ordenação padrão: `fullname` crescente. Tamanho de página padrão: 25.  **Atenção:** esta listagem traz também os registros excluídos (`active: false`). Para receber só os ativos, descarte os que vêm com `active: false` ou use `GET /api/contacts?lifeCycle=prospect`.
+     * @summary Listar prospects
+     * @param {number} [page] Página, a partir de 1. **Envie sempre**: sem &#x60;page&#x60;, a resposta vem como lista simples, sem o envelope de paginação, e &#x60;limit&#x60; é ignorado.
+     * @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
+     * @param {string} [sortBy] Campo de ordenação. O padrão varia por recurso.
+     * @param {ListProspectsSortTypeEnum} [sortType] Direção da ordenação.
+     * @param {Array<string>} [staffs] Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+     * @param {string} [organization] ID da empresa vinculada.
+     * @param {string} [search] Busca em nome, e-mail, telefone e documento.
+     * @param {boolean} [emailsEmpty] Com &#x60;true&#x60;, só os sem e-mail.
+     * @param {boolean} [phonesEmpty] Com &#x60;true&#x60;, só os sem telefone.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProspects: (page?: number, limit?: number, sortBy?: string, sortType?: ListProspectsSortTypeEnum, staffs?: Array<string>, organization?: string, search?: string, emailsEmpty?: boolean, phonesEmpty?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Envie só os campos que mudam.
+     * @summary Atualizar prospect
+     * @param {string} id ID do registro.
+     * @param {ContactInput} contactInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProspect: (id: string, contactInput: ContactInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProspectsApi - functional programming interface
+ */
+export declare const ProspectsApiFp: (configuration?: Configuration) => {
+    /**
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Os registros criados por aqui entram como `prospect`.
+     * @summary Criar prospect
+     * @param {ContactInput} contactInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProspect(contactInput: ContactInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contact>>;
+    /**
+     * Exige a permissão de excluir.
+     * @summary Excluir prospect
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProspect(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Obter prospect
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProspect(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contact>>;
+    /**
+     * Ordenação padrão: `fullname` crescente. Tamanho de página padrão: 25.  **Atenção:** esta listagem traz também os registros excluídos (`active: false`). Para receber só os ativos, descarte os que vêm com `active: false` ou use `GET /api/contacts?lifeCycle=prospect`.
+     * @summary Listar prospects
+     * @param {number} [page] Página, a partir de 1. **Envie sempre**: sem &#x60;page&#x60;, a resposta vem como lista simples, sem o envelope de paginação, e &#x60;limit&#x60; é ignorado.
+     * @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
+     * @param {string} [sortBy] Campo de ordenação. O padrão varia por recurso.
+     * @param {ListProspectsSortTypeEnum} [sortType] Direção da ordenação.
+     * @param {Array<string>} [staffs] Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+     * @param {string} [organization] ID da empresa vinculada.
+     * @param {string} [search] Busca em nome, e-mail, telefone e documento.
+     * @param {boolean} [emailsEmpty] Com &#x60;true&#x60;, só os sem e-mail.
+     * @param {boolean} [phonesEmpty] Com &#x60;true&#x60;, só os sem telefone.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProspects(page?: number, limit?: number, sortBy?: string, sortType?: ListProspectsSortTypeEnum, staffs?: Array<string>, organization?: string, search?: string, emailsEmpty?: boolean, phonesEmpty?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListContacts200Response>>;
+    /**
+     * Envie só os campos que mudam.
+     * @summary Atualizar prospect
+     * @param {string} id ID do registro.
+     * @param {ContactInput} contactInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProspect(id: string, contactInput: ContactInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contact>>;
+};
+/**
+ * ProspectsApi - factory interface
+ */
+export declare const ProspectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Os registros criados por aqui entram como `prospect`.
+     * @summary Criar prospect
+     * @param {ProspectsApiCreateProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProspect(requestParameters: ProspectsApiCreateProspectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Contact>;
+    /**
+     * Exige a permissão de excluir.
+     * @summary Excluir prospect
+     * @param {ProspectsApiDeleteProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProspect(requestParameters: ProspectsApiDeleteProspectRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Obter prospect
+     * @param {ProspectsApiGetProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProspect(requestParameters: ProspectsApiGetProspectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Contact>;
+    /**
+     * Ordenação padrão: `fullname` crescente. Tamanho de página padrão: 25.  **Atenção:** esta listagem traz também os registros excluídos (`active: false`). Para receber só os ativos, descarte os que vêm com `active: false` ou use `GET /api/contacts?lifeCycle=prospect`.
+     * @summary Listar prospects
+     * @param {ProspectsApiListProspectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProspects(requestParameters?: ProspectsApiListProspectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListContacts200Response>;
+    /**
+     * Envie só os campos que mudam.
+     * @summary Atualizar prospect
+     * @param {ProspectsApiUpdateProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProspect(requestParameters: ProspectsApiUpdateProspectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Contact>;
+};
+/**
+ * Request parameters for createProspect operation in ProspectsApi.
+ */
+export interface ProspectsApiCreateProspectRequest {
+    readonly contactInput: ContactInput;
+}
+/**
+ * Request parameters for deleteProspect operation in ProspectsApi.
+ */
+export interface ProspectsApiDeleteProspectRequest {
+    /**
+     * ID do registro.
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getProspect operation in ProspectsApi.
+ */
+export interface ProspectsApiGetProspectRequest {
+    /**
+     * ID do registro.
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for listProspects operation in ProspectsApi.
+ */
+export interface ProspectsApiListProspectsRequest {
+    /**
+     * Página, a partir de 1. **Envie sempre**: sem &#x60;page&#x60;, a resposta vem como lista simples, sem o envelope de paginação, e &#x60;limit&#x60; é ignorado.
+     */
+    readonly page?: number;
+    /**
+     * Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
+     */
+    readonly limit?: number;
+    /**
+     * Campo de ordenação. O padrão varia por recurso.
+     */
+    readonly sortBy?: string;
+    /**
+     * Direção da ordenação.
+     */
+    readonly sortType?: ListProspectsSortTypeEnum;
+    /**
+     * Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+     */
+    readonly staffs?: Array<string>;
+    /**
+     * ID da empresa vinculada.
+     */
+    readonly organization?: string;
+    /**
+     * Busca em nome, e-mail, telefone e documento.
+     */
+    readonly search?: string;
+    /**
+     * Com &#x60;true&#x60;, só os sem e-mail.
+     */
+    readonly emailsEmpty?: boolean;
+    /**
+     * Com &#x60;true&#x60;, só os sem telefone.
+     */
+    readonly phonesEmpty?: boolean;
+}
+/**
+ * Request parameters for updateProspect operation in ProspectsApi.
+ */
+export interface ProspectsApiUpdateProspectRequest {
+    /**
+     * ID do registro.
+     */
+    readonly id: string;
+    readonly contactInput: ContactInput;
+}
+/**
+ * ProspectsApi - object-oriented interface
+ */
+export declare class ProspectsApi extends BaseAPI {
+    /**
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Os registros criados por aqui entram como `prospect`.
+     * @summary Criar prospect
+     * @param {ProspectsApiCreateProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProspect(requestParameters: ProspectsApiCreateProspectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Contact, any, {}, any>>;
+    /**
+     * Exige a permissão de excluir.
+     * @summary Excluir prospect
+     * @param {ProspectsApiDeleteProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProspect(requestParameters: ProspectsApiDeleteProspectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Obter prospect
+     * @param {ProspectsApiGetProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProspect(requestParameters: ProspectsApiGetProspectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Contact, any, {}, any>>;
+    /**
+     * Ordenação padrão: `fullname` crescente. Tamanho de página padrão: 25.  **Atenção:** esta listagem traz também os registros excluídos (`active: false`). Para receber só os ativos, descarte os que vêm com `active: false` ou use `GET /api/contacts?lifeCycle=prospect`.
+     * @summary Listar prospects
+     * @param {ProspectsApiListProspectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProspects(requestParameters?: ProspectsApiListProspectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
+    /**
+     * Envie só os campos que mudam.
+     * @summary Atualizar prospect
+     * @param {ProspectsApiUpdateProspectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProspect(requestParameters: ProspectsApiUpdateProspectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Contact, any, {}, any>>;
+}
+export declare const ListProspectsSortTypeEnum: {
+    readonly asc: "asc";
+    readonly desc: "desc";
+};
+export type ListProspectsSortTypeEnum = typeof ListProspectsSortTypeEnum[keyof typeof ListProspectsSortTypeEnum];