@magnetcustomer/sdk 1.0.0 → 2.0.0

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

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