@magnetcustomer/sdk 2.0.0 → 2.1.0

package/dist/generated/api/meetings-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
@@ -29,7 +29,7 @@ const base_1 = require("../base");
 const MeetingsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
+         * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.  **Permissão do Service Account:** `meetings.create`
          * @summary Criar reunião
          * @param {MeetingCreate} meetingCreate
          * @param {*} [options] Override http request option.
@@ -63,7 +63,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         *
+         * **Permissão do Service Account:** `meetings.delete`
          * @summary Excluir reunião
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -166,7 +166,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         *
+         * **Permissão do Service Account:** `meetings.read`
          * @summary Obter reunião
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -199,14 +199,88 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Ordenação padrão: `start` decrescente.
+         * Use para descobrir o `room` de uma reunião.
+         * @summary Listar salas de reunião
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMeetingRooms: async (page, limit, options = {}) => {
+            const localVarPath = `/api/meetingrooms`;
+            // 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;
+            }
+            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 `type` de uma reunião.
+         * @summary Listar tipos de reunião
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMeetingTypes: async (page, limit, options = {}) => {
+            const localVarPath = `/api/meetingtypes`;
+            // 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;
+            }
+            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,
+            };
+        },
+        /**
+         * Ordenação padrão: `start` decrescente.  **Permissão do Service Account:** `meetings.list`
          * @summary Listar reuniões
          * @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 {ListMeetingsSortTypeEnum} [sortType] Direção da ordenação.
          * @param {string} [staff] ID do organizador.
-         * @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+         * @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
          * @param {string} [type] ID do tipo de reunião.
          * @param {string} [room] ID da sala.
          * @param {string} [contact] ID do contato.
@@ -214,7 +288,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
          * @param {string} [organization] ID da empresa.
          * @param {ListMeetingsPriorityEnum} [priority] Prioridade.
          * @param {ListMeetingsStatusEnum} [status] Situação.
-         * @param {Array<string>} [labels] Etiquetas. Repita o parâmetro para enviar vários (&#x60;?labels&#x3D;id1&amp;labels&#x3D;id2&#x60;).
+         * @param {Array<string>} [labels] Etiquetas. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?labels[]&#x3D;id1&amp;labels[]&#x3D;id2&#x60;).
          * @param {string} [startMinDate] Início a partir de (timestamp em ms ou data ISO).
          * @param {string} [startMaxDate] Início até (timestamp em ms ou data ISO).
          * @param {number} [createdAtMinDate] Criada a partir de (timestamp em milissegundos).
@@ -254,7 +328,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['staff'] = staff;
             }
             if (staffs) {
-                localVarQueryParameter['staffs'] = staffs;
+                localVarQueryParameter['staffs[]'] = staffs;
             }
             if (type !== undefined) {
                 localVarQueryParameter['type'] = type;
@@ -278,7 +352,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['status'] = status;
             }
             if (labels) {
-                localVarQueryParameter['labels'] = labels;
+                localVarQueryParameter['labels[]'] = labels;
             }
             if (startMinDate !== undefined) {
                 localVarQueryParameter['start_minDate'] = startMinDate;
@@ -308,7 +382,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
+         * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.  **Permissão do Service Account:** `meetings.update`
          * @summary Substituir reunião
          * @param {string} id ID do registro.
          * @param {MeetingCreate} meetingCreate
@@ -393,7 +467,7 @@ const MeetingsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.MeetingsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
+         * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.  **Permissão do Service Account:** `meetings.create`
          * @summary Criar reunião
          * @param {MeetingCreate} meetingCreate
          * @param {*} [options] Override http request option.
@@ -406,7 +480,7 @@ const MeetingsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         *
+         * **Permissão do Service Account:** `meetings.delete`
          * @summary Excluir reunião
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -446,7 +520,7 @@ const MeetingsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         *
+         * **Permissão do Service Account:** `meetings.read`
          * @summary Obter reunião
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -459,14 +533,42 @@ const MeetingsApiFp = 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: `start` decrescente.
+         * Use para descobrir o `room` de uma reunião.
+         * @summary Listar salas de reunião
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listMeetingRooms(page, limit, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listMeetingRooms(page, limit, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['MeetingsApi.listMeetingRooms']?.[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 `type` de uma reunião.
+         * @summary Listar tipos de reunião
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listMeetingTypes(page, limit, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listMeetingTypes(page, limit, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['MeetingsApi.listMeetingTypes']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Ordenação padrão: `start` decrescente.  **Permissão do Service Account:** `meetings.list`
          * @summary Listar reuniões
          * @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 {ListMeetingsSortTypeEnum} [sortType] Direção da ordenação.
          * @param {string} [staff] ID do organizador.
-         * @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+         * @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
          * @param {string} [type] ID do tipo de reunião.
          * @param {string} [room] ID da sala.
          * @param {string} [contact] ID do contato.
@@ -474,7 +576,7 @@ const MeetingsApiFp = function (configuration) {
          * @param {string} [organization] ID da empresa.
          * @param {ListMeetingsPriorityEnum} [priority] Prioridade.
          * @param {ListMeetingsStatusEnum} [status] Situação.
-         * @param {Array<string>} [labels] Etiquetas. Repita o parâmetro para enviar vários (&#x60;?labels&#x3D;id1&amp;labels&#x3D;id2&#x60;).
+         * @param {Array<string>} [labels] Etiquetas. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?labels[]&#x3D;id1&amp;labels[]&#x3D;id2&#x60;).
          * @param {string} [startMinDate] Início a partir de (timestamp em ms ou data ISO).
          * @param {string} [startMaxDate] Início até (timestamp em ms ou data ISO).
          * @param {number} [createdAtMinDate] Criada a partir de (timestamp em milissegundos).
@@ -491,7 +593,7 @@ const MeetingsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
+         * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.  **Permissão do Service Account:** `meetings.update`
          * @summary Substituir reunião
          * @param {string} id ID do registro.
          * @param {MeetingCreate} meetingCreate
@@ -528,7 +630,7 @@ const MeetingsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.MeetingsApiFp)(configuration);
     return {
         /**
-         * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
+         * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.  **Permissão do Service Account:** `meetings.create`
          * @summary Criar reunião
          * @param {MeetingsApiCreateMeetingRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -538,7 +640,7 @@ const MeetingsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createMeeting(requestParameters.meetingCreate, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * **Permissão do Service Account:** `meetings.delete`
          * @summary Excluir reunião
          * @param {MeetingsApiDeleteMeetingRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -568,7 +670,7 @@ const MeetingsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.finishMeeting(requestParameters.id, requestParameters.finishMeetingRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * **Permissão do Service Account:** `meetings.read`
          * @summary Obter reunião
          * @param {MeetingsApiGetMeetingRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -578,7 +680,27 @@ const MeetingsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getMeeting(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Ordenação padrão: `start` decrescente.
+         * Use para descobrir o `room` de uma reunião.
+         * @summary Listar salas de reunião
+         * @param {MeetingsApiListMeetingRoomsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMeetingRooms(requestParameters = {}, options) {
+            return localVarFp.listMeetingRooms(requestParameters.page, requestParameters.limit, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Use para descobrir o `type` de uma reunião.
+         * @summary Listar tipos de reunião
+         * @param {MeetingsApiListMeetingTypesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMeetingTypes(requestParameters = {}, options) {
+            return localVarFp.listMeetingTypes(requestParameters.page, requestParameters.limit, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Ordenação padrão: `start` decrescente.  **Permissão do Service Account:** `meetings.list`
          * @summary Listar reuniões
          * @param {MeetingsApiListMeetingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -588,7 +710,7 @@ const MeetingsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listMeetings(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, requestParameters.staff, requestParameters.staffs, requestParameters.type, requestParameters.room, requestParameters.contact, requestParameters.deal, requestParameters.organization, requestParameters.priority, requestParameters.status, requestParameters.labels, requestParameters.startMinDate, requestParameters.startMaxDate, requestParameters.createdAtMinDate, requestParameters.createdAtMaxDate, requestParameters.visualization, requestParameters.search, options).then((request) => request(axios, basePath));
         },
         /**
-         * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
+         * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.  **Permissão do Service Account:** `meetings.update`
          * @summary Substituir reunião
          * @param {MeetingsApiReplaceMeetingRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -615,7 +737,7 @@ exports.MeetingsApiFactory = MeetingsApiFactory;
  */
 class MeetingsApi extends base_1.BaseAPI {
     /**
-     * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
+     * Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos.  Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&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`.  Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.  **Permissão do Service Account:** `meetings.create`
      * @summary Criar reunião
      * @param {MeetingsApiCreateMeetingRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -625,7 +747,7 @@ class MeetingsApi extends base_1.BaseAPI {
         return (0, exports.MeetingsApiFp)(this.configuration).createMeeting(requestParameters.meetingCreate, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * **Permissão do Service Account:** `meetings.delete`
      * @summary Excluir reunião
      * @param {MeetingsApiDeleteMeetingRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -655,7 +777,7 @@ class MeetingsApi extends base_1.BaseAPI {
         return (0, exports.MeetingsApiFp)(this.configuration).finishMeeting(requestParameters.id, requestParameters.finishMeetingRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * **Permissão do Service Account:** `meetings.read`
      * @summary Obter reunião
      * @param {MeetingsApiGetMeetingRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -665,7 +787,27 @@ class MeetingsApi extends base_1.BaseAPI {
         return (0, exports.MeetingsApiFp)(this.configuration).getMeeting(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Ordenação padrão: `start` decrescente.
+     * Use para descobrir o `room` de uma reunião.
+     * @summary Listar salas de reunião
+     * @param {MeetingsApiListMeetingRoomsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMeetingRooms(requestParameters = {}, options) {
+        return (0, exports.MeetingsApiFp)(this.configuration).listMeetingRooms(requestParameters.page, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Use para descobrir o `type` de uma reunião.
+     * @summary Listar tipos de reunião
+     * @param {MeetingsApiListMeetingTypesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMeetingTypes(requestParameters = {}, options) {
+        return (0, exports.MeetingsApiFp)(this.configuration).listMeetingTypes(requestParameters.page, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Ordenação padrão: `start` decrescente.  **Permissão do Service Account:** `meetings.list`
      * @summary Listar reuniões
      * @param {MeetingsApiListMeetingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -675,7 +817,7 @@ class MeetingsApi extends base_1.BaseAPI {
         return (0, exports.MeetingsApiFp)(this.configuration).listMeetings(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, requestParameters.staff, requestParameters.staffs, requestParameters.type, requestParameters.room, requestParameters.contact, requestParameters.deal, requestParameters.organization, requestParameters.priority, requestParameters.status, requestParameters.labels, requestParameters.startMinDate, requestParameters.startMaxDate, requestParameters.createdAtMinDate, requestParameters.createdAtMaxDate, requestParameters.visualization, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
+     * Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.  **Permissão do Service Account:** `meetings.update`
      * @summary Substituir reunião
      * @param {MeetingsApiReplaceMeetingRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -1,6 +1,6 @@
 /**
  * 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
@@ -54,7 +54,7 @@ export declare const ObservationsApiAxiosParamCreator: (configuration?: Configur
      */
     getObservation: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
      * @summary Listar observações
      * @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.
@@ -62,7 +62,7 @@ export declare const ObservationsApiAxiosParamCreator: (configuration?: Configur
      * @param {ListObservationsSortTypeEnum} [sortType] Direção da ordenação.
      * @param {string} [deal] ID da oportunidade.
      * @param {string} [contact] ID do contato.
-     * @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>} [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 {string} [organization] ID da empresa.
      * @param {string} [search] Busca no texto, contato, empresa, oportunidade e produto.
      * @param {*} [options] Override http request option.
@@ -116,7 +116,7 @@ export declare const ObservationsApiFp: (configuration?: Configuration) => {
      */
     getObservation(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Observation>>;
     /**
-     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
      * @summary Listar observações
      * @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.
@@ -124,7 +124,7 @@ export declare const ObservationsApiFp: (configuration?: Configuration) => {
      * @param {ListObservationsSortTypeEnum} [sortType] Direção da ordenação.
      * @param {string} [deal] ID da oportunidade.
      * @param {string} [contact] ID do contato.
-     * @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>} [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 {string} [organization] ID da empresa.
      * @param {string} [search] Busca no texto, contato, empresa, oportunidade e produto.
      * @param {*} [options] Override http request option.
@@ -178,7 +178,7 @@ export declare const ObservationsApiFactory: (configuration?: Configuration, bas
      */
     getObservation(requestParameters: ObservationsApiGetObservationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Observation>;
     /**
-     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
      * @summary Listar observações
      * @param {ObservationsApiListObservationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -253,7 +253,7 @@ export interface ObservationsApiListObservationsRequest {
      */
     readonly contact?: string;
     /**
-     * Vários contatos. Repita o parâmetro para enviar vários (&#x60;?contacts&#x3D;id1&amp;contacts&#x3D;id2&#x60;).
+     * Vários contatos. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?contacts[]&#x3D;id1&amp;contacts[]&#x3D;id2&#x60;).
      */
     readonly contacts?: Array<string>;
     /**
@@ -312,7 +312,7 @@ export declare class ObservationsApi extends BaseAPI {
      */
     getObservation(requestParameters: ObservationsApiGetObservationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Observation, any, {}, any>>;
     /**
-     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
      * @summary Listar observações
      * @param {ObservationsApiListObservationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/generated/api/observations-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
@@ -163,7 +163,7 @@ const ObservationsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+         * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
          * @summary Listar observações
          * @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.
@@ -171,7 +171,7 @@ const ObservationsApiAxiosParamCreator = function (configuration) {
          * @param {ListObservationsSortTypeEnum} [sortType] Direção da ordenação.
          * @param {string} [deal] ID da oportunidade.
          * @param {string} [contact] ID do contato.
-         * @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>} [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 {string} [organization] ID da empresa.
          * @param {string} [search] Busca no texto, contato, empresa, oportunidade e produto.
          * @param {*} [options] Override http request option.
@@ -210,7 +210,7 @@ const ObservationsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['contact'] = contact;
             }
             if (contacts) {
-                localVarQueryParameter['contacts'] = contacts;
+                localVarQueryParameter['contacts[]'] = contacts;
             }
             if (organization !== undefined) {
                 localVarQueryParameter['organization'] = organization;
@@ -327,7 +327,7 @@ const ObservationsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+         * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
          * @summary Listar observações
          * @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.
@@ -335,7 +335,7 @@ const ObservationsApiFp = function (configuration) {
          * @param {ListObservationsSortTypeEnum} [sortType] Direção da ordenação.
          * @param {string} [deal] ID da oportunidade.
          * @param {string} [contact] ID do contato.
-         * @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>} [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 {string} [organization] ID da empresa.
          * @param {string} [search] Busca no texto, contato, empresa, oportunidade e produto.
          * @param {*} [options] Override http request option.
@@ -411,7 +411,7 @@ const ObservationsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getObservation(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+         * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
          * @summary Listar observações
          * @param {ObservationsApiListObservationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -478,7 +478,7 @@ class ObservationsApi extends base_1.BaseAPI {
         return (0, exports.ObservationsApiFp)(this.configuration).getObservation(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.
+     * Devolve só as ativas. Ordenação padrão: `createdAt` decrescente.  **Permissão do Service Account:** `observations.list`
      * @summary Listar observações
      * @param {ObservationsApiListObservationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.