@magnetcustomer/sdk 2.0.0 → 2.1.0

package/dist/generated/api/organizations-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 { OrganizationInput } from '../models';
  */
 export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
      * @summary Criar empresa
      * @param {OrganizationInput} organizationInput
      * @param {*} [options] Override http request option.
@@ -28,7 +28,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      */
     createOrganization: (organizationInput: OrganizationInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.delete`
      * @summary Excluir empresa
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      */
     deleteOrganization: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.read`
      * @summary Obter empresa
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -44,20 +44,20 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
      */
     getOrganization: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.list`
      * @summary Listar empresas
      * @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 {ListOrganizationsSortTypeEnum} [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} [search] Busca em nome, e-mail e documento.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listOrganizations: (page?: number, limit?: number, sortBy?: string, sortType?: ListOrganizationsSortTypeEnum, staffs?: Array<string>, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `organizations.update`
      * @summary Atualizar empresa
      * @param {string} id ID do registro.
      * @param {OrganizationInput} organizationInput
@@ -71,7 +71,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
  */
 export declare const OrganizationsApiFp: (configuration?: Configuration) => {
     /**
-     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
      * @summary Criar empresa
      * @param {OrganizationInput} organizationInput
      * @param {*} [options] Override http request option.
@@ -79,7 +79,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      */
     createOrganization(organizationInput: OrganizationInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.delete`
      * @summary Excluir empresa
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -87,7 +87,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      */
     deleteOrganization(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.read`
      * @summary Obter empresa
      * @param {string} id ID do registro.
      * @param {*} [options] Override http request option.
@@ -95,20 +95,20 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
      */
     getOrganization(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.list`
      * @summary Listar empresas
      * @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 {ListOrganizationsSortTypeEnum} [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} [search] Busca em nome, e-mail e documento.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listOrganizations(page?: number, limit?: number, sortBy?: string, sortType?: ListOrganizationsSortTypeEnum, staffs?: Array<string>, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizations200Response>>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `organizations.update`
      * @summary Atualizar empresa
      * @param {string} id ID do registro.
      * @param {OrganizationInput} organizationInput
@@ -122,7 +122,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
  */
 export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
      * @summary Criar empresa
      * @param {OrganizationsApiCreateOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -130,7 +130,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      */
     createOrganization(requestParameters: OrganizationsApiCreateOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Organization>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.delete`
      * @summary Excluir empresa
      * @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -138,7 +138,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      */
     deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.read`
      * @summary Obter empresa
      * @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -146,7 +146,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      */
     getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Organization>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.list`
      * @summary Listar empresas
      * @param {OrganizationsApiListOrganizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
      */
     listOrganizations(requestParameters?: OrganizationsApiListOrganizationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListOrganizations200Response>;
     /**
-     * Envie só os campos que mudam.
+     * Envie só os campos que mudam.  **Permissão do Service Account:** `organizations.update`
      * @summary Atualizar empresa
      * @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -207,7 +207,7 @@ export interface OrganizationsApiListOrganizationsRequest {
      */
     readonly sortType?: ListOrganizationsSortTypeEnum;
     /**
-     * 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>;
     /**
@@ -230,7 +230,7 @@ export interface OrganizationsApiUpdateOrganizationRequest {
  */
 export declare class OrganizationsApi extends BaseAPI {
     /**
-     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
      * @summary Criar empresa
      * @param {OrganizationsApiCreateOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -238,7 +238,7 @@ export declare class OrganizationsApi extends BaseAPI {
      */
     createOrganization(requestParameters: OrganizationsApiCreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization, any, {}, any>>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.delete`
      * @summary Excluir empresa
      * @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -246,7 +246,7 @@ export declare class OrganizationsApi extends BaseAPI {
      */
     deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.read`
      * @summary Obter empresa
      * @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -254,7 +254,7 @@ export declare class OrganizationsApi extends BaseAPI {
      */
     getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization, any, {}, any>>;
     /**
-     *
+     * **Permissão do Service Account:** `organizations.list`
      * @summary Listar empresas
      * @param {OrganizationsApiListOrganizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -262,7 +262,7 @@ export declare class OrganizationsApi extends BaseAPI {
      */
     listOrganizations(requestParameters?: OrganizationsApiListOrganizationsRequest, 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:** `organizations.update`
      * @summary Atualizar empresa
      * @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/generated/api/organizations-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 OrganizationsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+         * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
          * @summary Criar empresa
          * @param {OrganizationInput} organizationInput
          * @param {*} [options] Override http request option.
@@ -63,7 +63,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         *
+         * **Permissão do Service Account:** `organizations.delete`
          * @summary Excluir empresa
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -96,7 +96,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         *
+         * **Permissão do Service Account:** `organizations.read`
          * @summary Obter empresa
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -129,13 +129,13 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         *
+         * **Permissão do Service Account:** `organizations.list`
          * @summary Listar empresas
          * @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 {ListOrganizationsSortTypeEnum} [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} [search] Busca em nome, e-mail e documento.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -167,7 +167,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['sortType'] = sortType;
             }
             if (staffs) {
-                localVarQueryParameter['staffs'] = staffs;
+                localVarQueryParameter['staffs[]'] = staffs;
             }
             if (search !== undefined) {
                 localVarQueryParameter['search'] = search;
@@ -182,7 +182,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `organizations.update`
          * @summary Atualizar empresa
          * @param {string} id ID do registro.
          * @param {OrganizationInput} organizationInput
@@ -229,7 +229,7 @@ const OrganizationsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.OrganizationsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+         * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
          * @summary Criar empresa
          * @param {OrganizationInput} organizationInput
          * @param {*} [options] Override http request option.
@@ -242,7 +242,7 @@ const OrganizationsApiFp = 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:** `organizations.delete`
          * @summary Excluir empresa
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -255,7 +255,7 @@ const OrganizationsApiFp = 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:** `organizations.read`
          * @summary Obter empresa
          * @param {string} id ID do registro.
          * @param {*} [options] Override http request option.
@@ -268,13 +268,13 @@ const OrganizationsApiFp = 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:** `organizations.list`
          * @summary Listar empresas
          * @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 {ListOrganizationsSortTypeEnum} [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} [search] Busca em nome, e-mail e documento.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -286,7 +286,7 @@ const OrganizationsApiFp = 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:** `organizations.update`
          * @summary Atualizar empresa
          * @param {string} id ID do registro.
          * @param {OrganizationInput} organizationInput
@@ -309,7 +309,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.OrganizationsApiFp)(configuration);
     return {
         /**
-         * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+         * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
          * @summary Criar empresa
          * @param {OrganizationsApiCreateOrganizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -319,7 +319,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createOrganization(requestParameters.organizationInput, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * **Permissão do Service Account:** `organizations.delete`
          * @summary Excluir empresa
          * @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -329,7 +329,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteOrganization(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * **Permissão do Service Account:** `organizations.read`
          * @summary Obter empresa
          * @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -339,7 +339,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOrganization(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * **Permissão do Service Account:** `organizations.list`
          * @summary Listar empresas
          * @param {OrganizationsApiListOrganizationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -349,7 +349,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listOrganizations(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, requestParameters.staffs, requestParameters.search, options).then((request) => request(axios, basePath));
         },
         /**
-         * Envie só os campos que mudam.
+         * Envie só os campos que mudam.  **Permissão do Service Account:** `organizations.update`
          * @summary Atualizar empresa
          * @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -366,7 +366,7 @@ exports.OrganizationsApiFactory = OrganizationsApiFactory;
  */
 class OrganizationsApi extends base_1.BaseAPI {
     /**
-     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.
+     * Os campos obrigatórios são definidos pelo administrador da conta: consulte `GET /api/customfields?feature=organization&required=true`.  **Permissão do Service Account:** `organizations.create`
      * @summary Criar empresa
      * @param {OrganizationsApiCreateOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -376,7 +376,7 @@ class OrganizationsApi extends base_1.BaseAPI {
         return (0, exports.OrganizationsApiFp)(this.configuration).createOrganization(requestParameters.organizationInput, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * **Permissão do Service Account:** `organizations.delete`
      * @summary Excluir empresa
      * @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -386,7 +386,7 @@ class OrganizationsApi extends base_1.BaseAPI {
         return (0, exports.OrganizationsApiFp)(this.configuration).deleteOrganization(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * **Permissão do Service Account:** `organizations.read`
      * @summary Obter empresa
      * @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -396,7 +396,7 @@ class OrganizationsApi extends base_1.BaseAPI {
         return (0, exports.OrganizationsApiFp)(this.configuration).getOrganization(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * **Permissão do Service Account:** `organizations.list`
      * @summary Listar empresas
      * @param {OrganizationsApiListOrganizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -406,7 +406,7 @@ class OrganizationsApi extends base_1.BaseAPI {
         return (0, exports.OrganizationsApiFp)(this.configuration).listOrganizations(requestParameters.page, requestParameters.limit, requestParameters.sortBy, requestParameters.sortType, requestParameters.staffs, requestParameters.search, 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:** `organizations.update`
      * @summary Atualizar empresa
      * @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/generated/api/pipelines-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
@@ -12,6 +12,7 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { ListLostReasons200Response } from '../models';
 import type { ListPipelines200Response } from '../models';
 import type { Pipeline } from '../models';
 import type { Stage } from '../models';
@@ -27,6 +28,15 @@ export declare const PipelinesApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getPipeline: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Cada motivo pertence a um pipeline. Use o `_id` em `lostReason` ao fechar uma oportunidade como perdida.
+     * @summary Listar motivos de perda
+     * @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}
+     */
+    listLostReasons: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
      * @summary Listar etapas do pipeline
@@ -60,6 +70,15 @@ export declare const PipelinesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPipeline(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pipeline>>;
+    /**
+     * Cada motivo pertence a um pipeline. Use o `_id` em `lostReason` ao fechar uma oportunidade como perdida.
+     * @summary Listar motivos de perda
+     * @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}
+     */
+    listLostReasons(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLostReasons200Response>>;
     /**
      * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
      * @summary Listar etapas do pipeline
@@ -93,6 +112,14 @@ export declare const PipelinesApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getPipeline(requestParameters: PipelinesApiGetPipelineRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pipeline>;
+    /**
+     * Cada motivo pertence a um pipeline. Use o `_id` em `lostReason` ao fechar uma oportunidade como perdida.
+     * @summary Listar motivos de perda
+     * @param {PipelinesApiListLostReasonsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLostReasons(requestParameters?: PipelinesApiListLostReasonsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListLostReasons200Response>;
     /**
      * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
      * @summary Listar etapas do pipeline
@@ -119,6 +146,19 @@ export interface PipelinesApiGetPipelineRequest {
      */
     readonly id: string;
 }
+/**
+ * Request parameters for listLostReasons operation in PipelinesApi.
+ */
+export interface PipelinesApiListLostReasonsRequest {
+    /**
+     * Página, a partir de 1. **Envie sempre**: sem &#x60;page&#x60;, a resposta vem como lista simples, sem o envelope de paginação, e &#x60;limit&#x60; é ignorado.
+     */
+    readonly page?: number;
+    /**
+     * Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
+     */
+    readonly limit?: number;
+}
 /**
  * Request parameters for listPipelineStages operation in PipelinesApi.
  */
@@ -165,6 +205,14 @@ export declare class PipelinesApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getPipeline(requestParameters: PipelinesApiGetPipelineRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pipeline, any, {}, any>>;
+    /**
+     * Cada motivo pertence a um pipeline. Use o `_id` em `lostReason` ao fechar uma oportunidade como perdida.
+     * @summary Listar motivos de perda
+     * @param {PipelinesApiListLostReasonsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLostReasons(requestParameters?: PipelinesApiListLostReasonsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
     /**
      * Use para descobrir o `stage` de uma oportunidade. Devolve uma lista simples, sem envelope de paginação.
      * @summary Listar etapas do pipeline