@magnetcustomer/sdk 2.0.0 → 2.1.0

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

@@ -3,7 +3,7 @@
 /* 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.
+ * 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`, algumas listagens (Contatos, Pipelines, Campos personalizados e os cadastros de apoio, como tipos e situações) devolvem uma lista simples (`[...]`), sem o envelope, e ignoram `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`, `createdAt_minDate`, `dateOfExpires_minDate`...), envie um **timestamp em milissegundos**, como `1798761600000`.  ## Listas na URL  Filtros que aceitam vários valores levam colchetes no nome, mesmo quando o valor é um só:  ``` /api/contacts?page=1&staffs[]=507f191e810c19729de860eb&staffs[]=507f191e810c19729de860ec ```  Sem colchetes, um valor único é recusado com erro em parte das listagens.  ## 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`) | | `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` |  ## Permissões  Um Service Account só chama as rotas que as permissões dele liberam. Cada operação desta referência informa a permissão exigida, quando há uma: marque-a ao criar o Service Account. Uma chamada sem a permissão devolve `403` com o nome dela em `requiredPermission`.  Rotas de administração da conta (usuários, perfis, criação de webhooks, configurações) exigem um usuário administrador e não estão disponíveis para Service Accounts; por isso não aparecem aqui.  ## 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`.  # Webhooks  Para ser avisado quando algo muda no CRM, em vez de consultar a API de tempos em tempos, use webhooks. Um administrador cria o webhook no CRM, em **Integrações › Webhooks**, informando a URL do seu sistema e os eventos. A lista de eventos está em `GET /api/webhooks/triggers`; o formato da entrega, a assinatura e os reenvios estão na seção Webhooks do portal.  # Cobertura  Esta referência cobre Contatos (leads, prospects e clientes), Empresas, Oportunidades, Pipelines, etapas e motivos de perda, Jornadas, Reuniões, Tarefas, Observações, Tickets, Atendimentos, Usuários, Equipes, Áreas de trabalho, Campos personalizados e os eventos de webhook.
  *
  * The version of the OpenAPI document: 2026-11
  * Contact: suporte@magnetcustomer.com
@@ -67,7 +67,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.
+         * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.  **Permissão do Service Account:** `deals.create`
          * @summary Criar oportunidade
          * @param {DealCreate} dealCreate
          * @param {string} [idempotencyKey] Chave única da operação (UUID). Repita a mesma chave nas novas tentativas.
@@ -105,7 +105,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.
+         * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.  **Permissão do Service Account:** `deals.delete`
          * @summary Excluir oportunidade
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -138,7 +138,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.
+         * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.  **Permissão do Service Account:** `deals.read`
          * @summary Obter oportunidade
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -204,7 +204,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Ordenação padrão: `createdAt` decrescente.
+         * Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `deals.list`
          * @summary Listar oportunidades
          * @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.
@@ -214,8 +214,8 @@ const DealsApiAxiosParamCreator = function (configuration) {
          * @param {string} [stage] ID da etapa.
          * @param {string} [contact] ID do contato.
          * @param {string} [organization] ID da empresa.
-         * @param {Array<string>} [staffs] Usuários: busca em responsável, participantes e observadores. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
-         * @param {Array<string>} [contacts] Vários contatos. Repita o parâmetro para enviar vários (&#x60;?contacts&#x3D;id1&amp;contacts&#x3D;id2&#x60;).
+         * @param {Array<string>} [staffs] Usuários: busca em responsável, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
+         * @param {Array<string>} [contacts] Vários contatos. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?contacts[]&#x3D;id1&amp;contacts[]&#x3D;id2&#x60;).
          * @param {number} [minDate] Fechamento previsto (&#x60;expectedCloseDate&#x60;) a partir de. Timestamp em milissegundos, não data ISO.
          * @param {number} [maxDate] Fechamento previsto até. Timestamp em milissegundos.
          * @param {string} [search] Busca em título, nome e e-mail do contato.
@@ -261,10 +261,10 @@ const DealsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['organization'] = organization;
             }
             if (staffs) {
-                localVarQueryParameter['staffs'] = staffs;
+                localVarQueryParameter['staffs[]'] = staffs;
             }
             if (contacts) {
-                localVarQueryParameter['contacts'] = contacts;
+                localVarQueryParameter['contacts[]'] = contacts;
             }
             if (minDate !== undefined) {
                 localVarQueryParameter['minDate'] = minDate;
@@ -359,7 +359,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `deals.update`
          * @summary Atualizar oportunidade
          * @param {string} id ID do registro.
          * @param {DealInput} dealInput
@@ -453,7 +453,7 @@ const DealsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.
+         * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.  **Permissão do Service Account:** `deals.create`
          * @summary Criar oportunidade
          * @param {DealCreate} dealCreate
          * @param {string} [idempotencyKey] Chave única da operação (UUID). Repita a mesma chave nas novas tentativas.
@@ -467,7 +467,7 @@ const DealsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.
+         * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.  **Permissão do Service Account:** `deals.delete`
          * @summary Excluir oportunidade
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -480,7 +480,7 @@ const DealsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.
+         * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.  **Permissão do Service Account:** `deals.read`
          * @summary Obter oportunidade
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -506,7 +506,7 @@ const DealsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Ordenação padrão: `createdAt` decrescente.
+         * Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `deals.list`
          * @summary Listar oportunidades
          * @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.
@@ -516,8 +516,8 @@ const DealsApiFp = function (configuration) {
          * @param {string} [stage] ID da etapa.
          * @param {string} [contact] ID do contato.
          * @param {string} [organization] ID da empresa.
-         * @param {Array<string>} [staffs] Usuários: busca em responsável, participantes e observadores. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
-         * @param {Array<string>} [contacts] Vários contatos. Repita o parâmetro para enviar vários (&#x60;?contacts&#x3D;id1&amp;contacts&#x3D;id2&#x60;).
+         * @param {Array<string>} [staffs] Usuários: busca em responsável, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
+         * @param {Array<string>} [contacts] Vários contatos. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?contacts[]&#x3D;id1&amp;contacts[]&#x3D;id2&#x60;).
          * @param {number} [minDate] Fechamento previsto (&#x60;expectedCloseDate&#x60;) a partir de. Timestamp em milissegundos, não data ISO.
          * @param {number} [maxDate] Fechamento previsto até. Timestamp em milissegundos.
          * @param {string} [search] Busca em título, nome e e-mail do contato.
@@ -559,7 +559,7 @@ const DealsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `deals.update`
          * @summary Atualizar oportunidade
          * @param {string} id ID do registro.
          * @param {DealInput} dealInput
@@ -605,7 +605,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.closeDeal(requestParameters.id, requestParameters.closeDealRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.
+         * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.  **Permissão do Service Account:** `deals.create`
          * @summary Criar oportunidade
          * @param {DealsApiCreateDealRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -615,7 +615,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createDeal(requestParameters.dealCreate, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath));
         },
         /**
-         * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.
+         * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.  **Permissão do Service Account:** `deals.delete`
          * @summary Excluir oportunidade
          * @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -625,7 +625,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteDeal(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.
+         * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.  **Permissão do Service Account:** `deals.read`
          * @summary Obter oportunidade
          * @param {DealsApiGetDealRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -645,7 +645,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getDealStageHistory(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Ordenação padrão: `createdAt` decrescente.
+         * Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `deals.list`
          * @summary Listar oportunidades
          * @param {DealsApiListDealsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -675,7 +675,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.reopenDeal(requestParameters.id, requestParameters.reopenDealRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `deals.update`
          * @summary Atualizar oportunidade
          * @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -712,7 +712,7 @@ class DealsApi extends base_1.BaseAPI {
         return (0, exports.DealsApiFp)(this.configuration).closeDeal(requestParameters.id, requestParameters.closeDealRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.
+     * Se `staff` não for enviado, a API usa o usuário da credencial.  A criação é idempotente por 5 minutos: reenviar o mesmo corpo não duplica o registro. Para controlar a chave, envie o cabeçalho `Idempotency-Key`.  **Permissão do Service Account:** `deals.create`
      * @summary Criar oportunidade
      * @param {DealsApiCreateDealRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -722,7 +722,7 @@ class DealsApi extends base_1.BaseAPI {
         return (0, exports.DealsApiFp)(this.configuration).createDeal(requestParameters.dealCreate, requestParameters.idempotencyKey, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.
+     * Exclusão lógica (`active: false`). Responde `400` com `code: DEAL_HAS_LINKED_JOURNEYS` se houver jornadas ativas vinculadas.  **Permissão do Service Account:** `deals.delete`
      * @summary Excluir oportunidade
      * @param {DealsApiDeleteDealRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -732,7 +732,7 @@ class DealsApi extends base_1.BaseAPI {
         return (0, exports.DealsApiFp)(this.configuration).deleteDeal(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.
+     * No detalhe, `pipeline` vem como objeto (`_id`, `title`) e `contact` vem com o cadastro completo.  **Permissão do Service Account:** `deals.read`
      * @summary Obter oportunidade
      * @param {DealsApiGetDealRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -752,7 +752,7 @@ class DealsApi extends base_1.BaseAPI {
         return (0, exports.DealsApiFp)(this.configuration).getDealStageHistory(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Ordenação padrão: `createdAt` decrescente.
+     * Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `deals.list`
      * @summary Listar oportunidades
      * @param {DealsApiListDealsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -782,7 +782,7 @@ class DealsApi extends base_1.BaseAPI {
         return (0, exports.DealsApiFp)(this.configuration).reopenDeal(requestParameters.id, requestParameters.reopenDealRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `deals.update`
      * @summary Atualizar oportunidade
      * @param {DealsApiUpdateDealRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -0,0 +1,232 @@
+/**
+ * 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`, algumas listagens (Contatos, Pipelines, Campos personalizados e os cadastros de apoio, como tipos e situações) devolvem uma lista simples (`[...]`), sem o envelope, e ignoram `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`, `createdAt_minDate`, `dateOfExpires_minDate`...), envie um **timestamp em milissegundos**, como `1798761600000`.  ## Listas na URL  Filtros que aceitam vários valores levam colchetes no nome, mesmo quando o valor é um só:  ``` /api/contacts?page=1&staffs[]=507f191e810c19729de860eb&staffs[]=507f191e810c19729de860ec ```  Sem colchetes, um valor único é recusado com erro em parte das listagens.  ## 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`) | | `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` |  ## Permissões  Um Service Account só chama as rotas que as permissões dele liberam. Cada operação desta referência informa a permissão exigida, quando há uma: marque-a ao criar o Service Account. Uma chamada sem a permissão devolve `403` com o nome dela em `requiredPermission`.  Rotas de administração da conta (usuários, perfis, criação de webhooks, configurações) exigem um usuário administrador e não estão disponíveis para Service Accounts; por isso não aparecem aqui.  ## 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`.  # Webhooks  Para ser avisado quando algo muda no CRM, em vez de consultar a API de tempos em tempos, use webhooks. Um administrador cria o webhook no CRM, em **Integrações › Webhooks**, informando a URL do seu sistema e os eventos. A lista de eventos está em `GET /api/webhooks/triggers`; o formato da entrega, a assinatura e os reenvios estão na seção Webhooks do portal.  # Cobertura  Esta referência cobre Contatos (leads, prospects e clientes), Empresas, Oportunidades, Pipelines, etapas e motivos de perda, Jornadas, Reuniões, Tarefas, Observações, Tickets, Atendimentos, Usuários, Equipes, Áreas de trabalho, Campos personalizados e os eventos de webhook.
+ *
+ * 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 { GetJourneyHealthScore200Response } from '../models';
+import type { Journey } from '../models';
+import type { ListJourneys200Response } from '../models';
+/**
+ * JourneysApi - axios parameter creator
+ */
+export declare const JourneysApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * **Permissão do Service Account:** `journeys.read`
+     * @summary Obter jornada
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourney: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Devolve o valor em vigor, o valor calculado e os componentes do cálculo.
+     * @summary Obter health score da jornada
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourneyHealthScore: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * **Permissão do Service Account:** `journeys.list`
+     * @summary Listar jornadas
+     * @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 {ListJourneysStatusEnum} [status] Situação.
+     * @param {string} [journeyFlow] ID do fluxo de jornada.
+     * @param {string} [phase] ID da fase.
+     * @param {Array<string>} [staffs] Responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
+     * @param {string} [contact] ID do contato.
+     * @param {string} [organization] ID da empresa.
+     * @param {string} [sourceDeal] ID da oportunidade de origem.
+     * @param {number} [healthScoreMin] Health score mínimo.
+     * @param {number} [healthScoreMax] Health score máximo.
+     * @param {string} [search] Busca no título.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listJourneys: (page?: number, limit?: number, status?: ListJourneysStatusEnum, journeyFlow?: string, phase?: string, staffs?: Array<string>, contact?: string, organization?: string, sourceDeal?: string, healthScoreMin?: number, healthScoreMax?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * JourneysApi - functional programming interface
+ */
+export declare const JourneysApiFp: (configuration?: Configuration) => {
+    /**
+     * **Permissão do Service Account:** `journeys.read`
+     * @summary Obter jornada
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourney(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Journey>>;
+    /**
+     * Devolve o valor em vigor, o valor calculado e os componentes do cálculo.
+     * @summary Obter health score da jornada
+     * @param {string} id ID do registro.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourneyHealthScore(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJourneyHealthScore200Response>>;
+    /**
+     * **Permissão do Service Account:** `journeys.list`
+     * @summary Listar jornadas
+     * @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 {ListJourneysStatusEnum} [status] Situação.
+     * @param {string} [journeyFlow] ID do fluxo de jornada.
+     * @param {string} [phase] ID da fase.
+     * @param {Array<string>} [staffs] Responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
+     * @param {string} [contact] ID do contato.
+     * @param {string} [organization] ID da empresa.
+     * @param {string} [sourceDeal] ID da oportunidade de origem.
+     * @param {number} [healthScoreMin] Health score mínimo.
+     * @param {number} [healthScoreMax] Health score máximo.
+     * @param {string} [search] Busca no título.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listJourneys(page?: number, limit?: number, status?: ListJourneysStatusEnum, journeyFlow?: string, phase?: string, staffs?: Array<string>, contact?: string, organization?: string, sourceDeal?: string, healthScoreMin?: number, healthScoreMax?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJourneys200Response>>;
+};
+/**
+ * JourneysApi - factory interface
+ */
+export declare const JourneysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * **Permissão do Service Account:** `journeys.read`
+     * @summary Obter jornada
+     * @param {JourneysApiGetJourneyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourney(requestParameters: JourneysApiGetJourneyRequest, options?: RawAxiosRequestConfig): AxiosPromise<Journey>;
+    /**
+     * Devolve o valor em vigor, o valor calculado e os componentes do cálculo.
+     * @summary Obter health score da jornada
+     * @param {JourneysApiGetJourneyHealthScoreRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourneyHealthScore(requestParameters: JourneysApiGetJourneyHealthScoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetJourneyHealthScore200Response>;
+    /**
+     * **Permissão do Service Account:** `journeys.list`
+     * @summary Listar jornadas
+     * @param {JourneysApiListJourneysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listJourneys(requestParameters?: JourneysApiListJourneysRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListJourneys200Response>;
+};
+/**
+ * Request parameters for getJourney operation in JourneysApi.
+ */
+export interface JourneysApiGetJourneyRequest {
+    /**
+     * ID do registro.
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getJourneyHealthScore operation in JourneysApi.
+ */
+export interface JourneysApiGetJourneyHealthScoreRequest {
+    /**
+     * ID do registro.
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for listJourneys operation in JourneysApi.
+ */
+export interface JourneysApiListJourneysRequest {
+    /**
+     * 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;
+    /**
+     * Situação.
+     */
+    readonly status?: ListJourneysStatusEnum;
+    /**
+     * ID do fluxo de jornada.
+     */
+    readonly journeyFlow?: string;
+    /**
+     * ID da fase.
+     */
+    readonly phase?: string;
+    /**
+     * Responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
+     */
+    readonly staffs?: Array<string>;
+    /**
+     * ID do contato.
+     */
+    readonly contact?: string;
+    /**
+     * ID da empresa.
+     */
+    readonly organization?: string;
+    /**
+     * ID da oportunidade de origem.
+     */
+    readonly sourceDeal?: string;
+    /**
+     * Health score mínimo.
+     */
+    readonly healthScoreMin?: number;
+    /**
+     * Health score máximo.
+     */
+    readonly healthScoreMax?: number;
+    /**
+     * Busca no título.
+     */
+    readonly search?: string;
+}
+/**
+ * JourneysApi - object-oriented interface
+ */
+export declare class JourneysApi extends BaseAPI {
+    /**
+     * **Permissão do Service Account:** `journeys.read`
+     * @summary Obter jornada
+     * @param {JourneysApiGetJourneyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourney(requestParameters: JourneysApiGetJourneyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Journey, any, {}, any>>;
+    /**
+     * Devolve o valor em vigor, o valor calculado e os componentes do cálculo.
+     * @summary Obter health score da jornada
+     * @param {JourneysApiGetJourneyHealthScoreRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJourneyHealthScore(requestParameters: JourneysApiGetJourneyHealthScoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJourneyHealthScore200Response, any, {}, any>>;
+    /**
+     * **Permissão do Service Account:** `journeys.list`
+     * @summary Listar jornadas
+     * @param {JourneysApiListJourneysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listJourneys(requestParameters?: JourneysApiListJourneysRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
+}
+export declare const ListJourneysStatusEnum: {
+    readonly active: "active";
+    readonly success: "success";
+    readonly churn: "churn";
+};
+export type ListJourneysStatusEnum = typeof ListJourneysStatusEnum[keyof typeof ListJourneysStatusEnum];