@magnetcustomer/sdk 2.0.0 → 2.1.0

package/README.md

@@ -60,12 +60,17 @@ Cada método devolve a resposta do [axios](https://axios-http.com): o corpo est
 | `crm.leads`, `crm.prospects`, `crm.customers` | Contatos por fase |
 | `crm.organizations` | Empresas |
 | `crm.deals` | Oportunidades |
-| `crm.pipelines` | Pipelines e etapas |
-| `crm.meetings` | Reuniões |
+| `crm.pipelines` | Pipelines, etapas e motivos de perda |
+| `crm.journeys` | Jornadas (leitura) |
+| `crm.meetings` | Reuniões, tipos e salas |
 | `crm.tasks`, `crm.taskTypes` | Tarefas e tipos de tarefa |
 | `crm.observations` | Observações |
+| `crm.tickets` | Tickets, situações e mensagens |
+| `crm.treatments` | Atendimentos e tipos |
 | `crm.staffs` | Usuários |
 | `crm.customFields` | Campos personalizados |
+| `crm.teams` | Equipes e áreas de trabalho |
+| `crm.webhooks` | Eventos de webhook disponíveis |
 
 Os parâmetros, o corpo aceito e a resposta de cada operação estão na [referência da API](https://magnetcustomer.com/developers/api-reference). Os nomes dos métodos são os `operationId` de lá.
 
@@ -83,6 +88,18 @@ async function* allDeals() {
 }
 ```
 
+## Filtros com vários valores
+
+Passe uma lista; o SDK envia no formato que a API espera (`staffs[]=...`), inclusive com um valor só:
+
+```ts
+await crm.contacts.listContacts({ page: 1, staffs: [staffId] });
+```
+
+## Webhooks
+
+Os webhooks são criados por um administrador no CRM, em **Integrações › Webhooks**. O SDK lista os eventos disponíveis com `crm.webhooks.listWebhookTriggers()`.
+
 ## Erros
 
 Uma resposta fora de 2xx lança o erro do axios, com o status e o corpo da API:
@@ -123,7 +140,7 @@ A 2.0 foi refeita a partir da referência atual da API e muda a interface:
 - Um cliente só (`new MagnetCustomer({ account, clientId, clientSecret })`) no lugar de `Configuration` + uma classe por API.
 - O token é obtido e renovado pelo SDK.
 - Os métodos têm os nomes da referência (`listDeals`, `createContact`...) e recebem um objeto de parâmetros.
-- A 2.0 cobre os recursos da tabela acima. Tickets, Atendimentos e Webhooks entram nas próximas versões; até lá, chame essas rotas com o token de `crm.tokens.getAccessToken()`.
+- A 2.x cobre os recursos da tabela acima, os mesmos da referência pública. Para uma rota fora dela, use o token de `crm.tokens.getAccessToken()` no seu cliente HTTP.
 
 ## Desenvolvimento
 

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import { ServiceAccountCredentials, TokenManager } from './auth';
-import { ContactsApi, CustomFieldsApi, CustomersApi, DealsApi, LeadsApi, MeetingsApi, ObservationsApi, OrganizationsApi, PipelinesApi, ProspectsApi, StaffsApi, TaskTypesApi, TasksApi } from './generated/api';
+import { ContactsApi, CustomFieldsApi, CustomersApi, DealsApi, JourneysApi, LeadsApi, MeetingsApi, ObservationsApi, OrganizationsApi, PipelinesApi, ProspectsApi, StaffsApi, TaskTypesApi, TasksApi, TeamsApi, TicketsApi, TreatmentsApi, WebhooksApi } from './generated/api';
 export interface MagnetCustomerOptions extends ServiceAccountCredentials {
     /** Subdomínio da conta: o mesmo usado para abrir o CRM (`acme` em `acme.magnetcustomer.com`). */
     account: string;
@@ -28,6 +28,11 @@ export declare class MagnetCustomer {
     readonly observations: ObservationsApi;
     readonly staffs: StaffsApi;
     readonly customFields: CustomFieldsApi;
+    readonly tickets: TicketsApi;
+    readonly treatments: TreatmentsApi;
+    readonly journeys: JourneysApi;
+    readonly teams: TeamsApi;
+    readonly webhooks: WebhooksApi;
     readonly tokens: TokenManager;
     readonly baseUrl: string;
     constructor(options: MagnetCustomerOptions, http?: AxiosInstance);

package/dist/client.js

@@ -55,6 +55,11 @@ class MagnetCustomer {
         this.observations = build(api_1.ObservationsApi);
         this.staffs = build(api_1.StaffsApi);
         this.customFields = build(api_1.CustomFieldsApi);
+        this.tickets = build(api_1.TicketsApi);
+        this.treatments = build(api_1.TreatmentsApi);
+        this.journeys = build(api_1.JourneysApi);
+        this.teams = build(api_1.TeamsApi);
+        this.webhooks = build(api_1.WebhooksApi);
     }
 }
 exports.MagnetCustomer = MagnetCustomer;

package/dist/generated/api/contacts-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
@@ -20,7 +20,7 @@ import type { ListContacts200Response } from '../models';
  */
 export declare const ContactsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
      * @summary Criar contato
      * @param {ContactInput} contactInput
      * @param {*} [options] Override http request option.
@@ -28,7 +28,7 @@ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuratio
      */
     createContact: (contactInput: ContactInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Exige a permissão de excluir.
+     * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
      * @summary Excluir contato
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuratio
      */
     deleteContact: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * **Permissão do Service Account:** `contacts.read`
      * @summary Obter contato
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -44,13 +44,13 @@ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuratio
      */
     getContact: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
      * @summary Listar contatos
      * @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 {ListContactsSortTypeEnum} [sortType] Direção da ordenação.
-     * @param {Array<string>} [staffs] Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+     * @param {Array<string>} [staffs] Usuários responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
      * @param {string} [organization] ID da empresa vinculada.
      * @param {string} [search] Busca em nome, e-mail, telefone e documento.
      * @param {boolean} [emailsEmpty] Com &#x60;true&#x60;, só os sem e-mail.
@@ -61,7 +61,7 @@ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuratio
      */
     listContacts: (page?: number, limit?: number, sortBy?: string, sortType?: ListContactsSortTypeEnum, staffs?: Array<string>, organization?: string, search?: string, emailsEmpty?: boolean, phonesEmpty?: boolean, lifeCycle?: ListContactsLifeCycleEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `contacts.update`
      * @summary Atualizar contato
      * @param {string} id ID do registro.
      * @param {ContactInput} contactInput
@@ -75,7 +75,7 @@ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuratio
  */
 export declare const ContactsApiFp: (configuration?: Configuration) => {
     /**
-     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
      * @summary Criar contato
      * @param {ContactInput} contactInput
      * @param {*} [options] Override http request option.
@@ -83,7 +83,7 @@ export declare const ContactsApiFp: (configuration?: Configuration) => {
      */
     createContact(contactInput: ContactInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contact>>;
     /**
-     * Exige a permissão de excluir.
+     * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
      * @summary Excluir contato
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -91,7 +91,7 @@ export declare const ContactsApiFp: (configuration?: Configuration) => {
      */
     deleteContact(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * **Permissão do Service Account:** `contacts.read`
      * @summary Obter contato
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -99,13 +99,13 @@ export declare const ContactsApiFp: (configuration?: Configuration) => {
      */
     getContact(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Contact>>;
     /**
-     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
      * @summary Listar contatos
      * @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 {ListContactsSortTypeEnum} [sortType] Direção da ordenação.
-     * @param {Array<string>} [staffs] Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+     * @param {Array<string>} [staffs] Usuários responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
      * @param {string} [organization] ID da empresa vinculada.
      * @param {string} [search] Busca em nome, e-mail, telefone e documento.
      * @param {boolean} [emailsEmpty] Com &#x60;true&#x60;, só os sem e-mail.
@@ -116,7 +116,7 @@ export declare const ContactsApiFp: (configuration?: Configuration) => {
      */
     listContacts(page?: number, limit?: number, sortBy?: string, sortType?: ListContactsSortTypeEnum, staffs?: Array<string>, organization?: string, search?: string, emailsEmpty?: boolean, phonesEmpty?: boolean, lifeCycle?: ListContactsLifeCycleEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListContacts200Response>>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `contacts.update`
      * @summary Atualizar contato
      * @param {string} id ID do registro.
      * @param {ContactInput} contactInput
@@ -130,7 +130,7 @@ export declare const ContactsApiFp: (configuration?: Configuration) => {
  */
 export declare const ContactsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
      * @summary Criar contato
      * @param {ContactsApiCreateContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -138,7 +138,7 @@ export declare const ContactsApiFactory: (configuration?: Configuration, basePat
      */
     createContact(requestParameters: ContactsApiCreateContactRequest, options?: RawAxiosRequestConfig): AxiosPromise<Contact>;
     /**
-     * Exige a permissão de excluir.
+     * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
      * @summary Excluir contato
      * @param {ContactsApiDeleteContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -146,7 +146,7 @@ export declare const ContactsApiFactory: (configuration?: Configuration, basePat
      */
     deleteContact(requestParameters: ContactsApiDeleteContactRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * **Permissão do Service Account:** `contacts.read`
      * @summary Obter contato
      * @param {ContactsApiGetContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ export declare const ContactsApiFactory: (configuration?: Configuration, basePat
      */
     getContact(requestParameters: ContactsApiGetContactRequest, options?: RawAxiosRequestConfig): AxiosPromise<Contact>;
     /**
-     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
      * @summary Listar contatos
      * @param {ContactsApiListContactsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -162,7 +162,7 @@ export declare const ContactsApiFactory: (configuration?: Configuration, basePat
      */
     listContacts(requestParameters?: ContactsApiListContactsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListContacts200Response>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `contacts.update`
      * @summary Atualizar contato
      * @param {ContactsApiUpdateContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -215,7 +215,7 @@ export interface ContactsApiListContactsRequest {
      */
     readonly sortType?: ListContactsSortTypeEnum;
     /**
-     * Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+     * Usuários 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>;
     /**
@@ -254,7 +254,7 @@ export interface ContactsApiUpdateContactRequest {
  */
 export declare class ContactsApi extends BaseAPI {
     /**
-     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
      * @summary Criar contato
      * @param {ContactsApiCreateContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -262,7 +262,7 @@ export declare class ContactsApi extends BaseAPI {
      */
     createContact(requestParameters: ContactsApiCreateContactRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Contact, any, {}, any>>;
     /**
-     * Exige a permissão de excluir.
+     * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
      * @summary Excluir contato
      * @param {ContactsApiDeleteContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -270,7 +270,7 @@ export declare class ContactsApi extends BaseAPI {
      */
     deleteContact(requestParameters: ContactsApiDeleteContactRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
     /**
-     *
+     * **Permissão do Service Account:** `contacts.read`
      * @summary Obter contato
      * @param {ContactsApiGetContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -278,7 +278,7 @@ export declare class ContactsApi extends BaseAPI {
      */
     getContact(requestParameters: ContactsApiGetContactRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Contact, any, {}, any>>;
     /**
-     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
      * @summary Listar contatos
      * @param {ContactsApiListContactsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -286,7 +286,7 @@ export declare class ContactsApi extends BaseAPI {
      */
     listContacts(requestParameters?: ContactsApiListContactsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `contacts.update`
      * @summary Atualizar contato
      * @param {ContactsApiUpdateContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/generated/api/contacts-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 ContactsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+         * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
          * @summary Criar contato
          * @param {ContactInput} contactInput
          * @param {*} [options] Override http request option.
@@ -63,7 +63,7 @@ const ContactsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Exige a permissão de excluir.
+         * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
          * @summary Excluir contato
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -96,7 +96,7 @@ const ContactsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         *
+         * **Permissão do Service Account:** `contacts.read`
          * @summary Obter contato
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -129,13 +129,13 @@ const ContactsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+         * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
          * @summary Listar contatos
          * @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 {ListContactsSortTypeEnum} [sortType] Direção da ordenação.
-         * @param {Array<string>} [staffs] Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+         * @param {Array<string>} [staffs] Usuários responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
          * @param {string} [organization] ID da empresa vinculada.
          * @param {string} [search] Busca em nome, e-mail, telefone e documento.
          * @param {boolean} [emailsEmpty] Com &#x60;true&#x60;, só os sem e-mail.
@@ -171,7 +171,7 @@ const ContactsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['sortType'] = sortType;
             }
             if (staffs) {
-                localVarQueryParameter['staffs'] = staffs;
+                localVarQueryParameter['staffs[]'] = staffs;
             }
             if (organization !== undefined) {
                 localVarQueryParameter['organization'] = organization;
@@ -198,7 +198,7 @@ const ContactsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `contacts.update`
          * @summary Atualizar contato
          * @param {string} id ID do registro.
          * @param {ContactInput} contactInput
@@ -245,7 +245,7 @@ const ContactsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ContactsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+         * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
          * @summary Criar contato
          * @param {ContactInput} contactInput
          * @param {*} [options] Override http request option.
@@ -258,7 +258,7 @@ const ContactsApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Exige a permissão de excluir.
+         * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
          * @summary Excluir contato
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -271,7 +271,7 @@ const ContactsApiFp = 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:** `contacts.read`
          * @summary Obter contato
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -284,13 +284,13 @@ const ContactsApiFp = 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: `fullname` crescente. Devolve só os registros ativos.
+         * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
          * @summary Listar contatos
          * @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 {ListContactsSortTypeEnum} [sortType] Direção da ordenação.
-         * @param {Array<string>} [staffs] Usuários responsáveis. Repita o parâmetro para enviar vários (&#x60;?staffs&#x3D;id1&amp;staffs&#x3D;id2&#x60;).
+         * @param {Array<string>} [staffs] Usuários responsáveis. Lista de IDs: envie com colchetes, mesmo para um só valor (&#x60;?staffs[]&#x3D;id1&amp;staffs[]&#x3D;id2&#x60;).
          * @param {string} [organization] ID da empresa vinculada.
          * @param {string} [search] Busca em nome, e-mail, telefone e documento.
          * @param {boolean} [emailsEmpty] Com &#x60;true&#x60;, só os sem e-mail.
@@ -306,7 +306,7 @@ const ContactsApiFp = 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:** `contacts.update`
          * @summary Atualizar contato
          * @param {string} id ID do registro.
          * @param {ContactInput} contactInput
@@ -329,7 +329,7 @@ const ContactsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ContactsApiFp)(configuration);
     return {
         /**
-         * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+         * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
          * @summary Criar contato
          * @param {ContactsApiCreateContactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -339,7 +339,7 @@ const ContactsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createContact(requestParameters.contactInput, options).then((request) => request(axios, basePath));
         },
         /**
-         * Exige a permissão de excluir.
+         * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
          * @summary Excluir contato
          * @param {ContactsApiDeleteContactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -349,7 +349,7 @@ const ContactsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteContact(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * **Permissão do Service Account:** `contacts.read`
          * @summary Obter contato
          * @param {ContactsApiGetContactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -359,7 +359,7 @@ const ContactsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getContact(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+         * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
          * @summary Listar contatos
          * @param {ContactsApiListContactsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -369,7 +369,7 @@ const ContactsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listContacts(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, requestParameters.staffs, requestParameters.organization, requestParameters.search, requestParameters.emailsEmpty, requestParameters.phonesEmpty, requestParameters.lifeCycle, options).then((request) => request(axios, basePath));
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `contacts.update`
          * @summary Atualizar contato
          * @param {ContactsApiUpdateContactRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -386,7 +386,7 @@ exports.ContactsApiFactory = ContactsApiFactory;
  */
 class ContactsApi extends base_1.BaseAPI {
     /**
-     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.
+     * O corpo não tem campo obrigatório fixo: o administrador da conta define quais são. `GET /api/customfields?feature=contact&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`.  **Permissão do Service Account:** `contacts.create`
      * @summary Criar contato
      * @param {ContactsApiCreateContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -396,7 +396,7 @@ class ContactsApi extends base_1.BaseAPI {
         return (0, exports.ContactsApiFp)(this.configuration).createContact(requestParameters.contactInput, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Exige a permissão de excluir.
+     * Exige a permissão de excluir.  **Permissão do Service Account:** `contacts.delete`
      * @summary Excluir contato
      * @param {ContactsApiDeleteContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -406,7 +406,7 @@ class ContactsApi extends base_1.BaseAPI {
         return (0, exports.ContactsApiFp)(this.configuration).deleteContact(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * **Permissão do Service Account:** `contacts.read`
      * @summary Obter contato
      * @param {ContactsApiGetContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -416,7 +416,7 @@ class ContactsApi extends base_1.BaseAPI {
         return (0, exports.ContactsApiFp)(this.configuration).getContact(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.
+     * Ordenação padrão: `fullname` crescente. Devolve só os registros ativos.  **Permissão do Service Account:** `contacts.list`
      * @summary Listar contatos
      * @param {ContactsApiListContactsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -426,7 +426,7 @@ class ContactsApi extends base_1.BaseAPI {
         return (0, exports.ContactsApiFp)(this.configuration).listContacts(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, requestParameters.staffs, requestParameters.organization, requestParameters.search, requestParameters.emailsEmpty, requestParameters.phonesEmpty, requestParameters.lifeCycle, 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:** `contacts.update`
      * @summary Atualizar contato
      * @param {ContactsApiUpdateContactRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.