@magnetcustomer/sdk 1.0.1 → 2.1.0

package/dist/api/organizations-api.d.ts

@@ -1,272 +0,0 @@
-/**
- * MagnetCustomer API Reference
- * # MagnetCustomer API Reference  Documentacao oficial da API REST do CRM MagnetCustomer.  Esta referencia contem duas versoes da API:  | Versao | Status | Descricao | |--------|--------|----------| | **v2 (Current)** | Ativa | Versao atual com 294 endpoints documentados | | **v1 (Legacy)** | Manutencao | Versao legado para tenants ainda nao migrados |  ## Como Usar  1. Navegue para a versao desejada: **v2 (Current)** ou **v1 (Legacy)** 2. Configure as variaveis `subdomain`, `clientId` e `clientSecret` 3. O token OAuth2 sera renovado automaticamente pelo pre-request script  ## Autenticacao (OAuth2)  A API utiliza **OAuth2** com grant type `client_credentials` via Keycloak.  **Token endpoint:** `https://magnetcustomer.net/realms/platform/protocol/openid-connect/token`  ## Multi-tenancy  Cada tenant e identificado pelo seu subdominio. URL base:  ``` https://platform-api.{subdomain}.magnetcustomer.com/api/ ```  ## Paginacao  Todas as listagens suportam paginacao:  | Parametro | Default | Max | Descricao | |-----------|---------|-----|-----------| | `page` | 1 | - | Numero da pagina | | `limit` | 25 | 100 | Itens por pagina | | `sortBy` | - | - | Campo de ordenacao | | `sortType` | asc | - | `asc` ou `desc` |  ## Integracoes  - **Zapier:** Disponivel no marketplace — busque por \"MagnetCustomer\" - **n8n:** No nativo disponivel — busque por \"MagnetCustomer\"  ---  ## Changelog  ### v1.3.0 (2026-04-14)  **Wave 4 — Automacao, Jornadas e Segmentacao**  - Campaigns: CRUD, actions, enable/disable (8 requests) - Process Automation: CRUD, entities, execution, folders, dry-run (13 requests) - Journeys: CRUD, phases, health score, MRR, milestones, expansion (13 requests) - Segmentation: segmentation rules, sharing rules, preview, simulate (9 requests) - Estrutura unificada: v1 (Legacy) + v2 (Current) no mesmo workspace - Total de requests: ~294 (v2) + ~40 (v1)  ### v1.2.0 (2026-04-14)  **Wave 3 — Novos modulos**  - Email, Dashboards, Calendar, Reports (48 requests)  ### v1.1.0 (2026-04-14)  **Wave 2 — Sub-resources e operacoes em lote**  - Filters, Messages, Todos, Batch Operations (78 requests)  ### v1.0.0 (2026-04-14)  **Lancamento inicial**  - 125 requests em 6 modulos principais - OAuth2 com auto-refresh, 2 environments, documentacao publicada
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * 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 { ApiOrganizations507f1f77bcf86cd799439055Get200Response } from '../models';
-import type { ApiOrganizations507f1f77bcf86cd799439055Put200Response } from '../models';
-import type { ApiOrganizations507f1f77bcf86cd799439055PutRequest } from '../models';
-import type { ApiOrganizationsGet200Response } from '../models';
-import type { ApiOrganizationsPost201Response } from '../models';
-import type { ApiOrganizationsPostRequest } from '../models';
-/**
- * OrganizationsApi - axios parameter creator
- */
-export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Lista contatos vinculados a organizacao.
-     * @summary List Organization Contacts
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055ContactsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retorna uma organizacao pelo ID.
-     * @summary Get Organization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Get: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Updates an existing organization\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }`  ## Response  Returns the updated organization object with all current field values.
-     * @summary Update Organization
-     * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Put: (apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lista organizacoes com paginacao.
-     * @summary List Organizations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * This endpoint makes an HTTP GET request to retrieve a specific organization by ID. The response is a JSON object with the organization details including `_id`, `customFields`, `labels`, `fullname`, `doc`, `phones`, `owners`, `interactions`, `createdAt`, `updatedAt`.
-     * @summary Get One Organization
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Atualiza os dados de uma organização existente.
-     * @summary Update One Organization
-     * @param {string} id
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdPut: (id: string, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Creates a new organization (legal entity / company).  ## Request Body  - `name` (string, required): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Must be `legal` for organizations - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `source` (string): Origin of the record (e.g., `platform`, `api`)  ## Response  Returns the created organization object. If a duplicate is detected (same CNPJ or email), returns HTTP 409.
-     * @summary Create Organization
-     * @param {ApiOrganizationsPostRequest} [apiOrganizationsPostRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsPost: (apiOrganizationsPostRequest?: ApiOrganizationsPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * OrganizationsApi - functional programming interface
- */
-export declare const OrganizationsApiFp: (configuration?: Configuration) => {
-    /**
-     * Lista contatos vinculados a organizacao.
-     * @summary List Organization Contacts
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055ContactsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Retorna uma organizacao pelo ID.
-     * @summary Get Organization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiOrganizations507f1f77bcf86cd799439055Get200Response>>;
-    /**
-     * Updates an existing organization\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }`  ## Response  Returns the updated organization object with all current field values.
-     * @summary Update Organization
-     * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Put(apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiOrganizations507f1f77bcf86cd799439055Put200Response>>;
-    /**
-     * Lista organizacoes com paginacao.
-     * @summary List Organizations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiOrganizationsGet200Response>>;
-    /**
-     * This endpoint makes an HTTP GET request to retrieve a specific organization by ID. The response is a JSON object with the organization details including `_id`, `customFields`, `labels`, `fullname`, `doc`, `phones`, `owners`, `interactions`, `createdAt`, `updatedAt`.
-     * @summary Get One Organization
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Atualiza os dados de uma organização existente.
-     * @summary Update One Organization
-     * @param {string} id
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdPut(id: string, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Creates a new organization (legal entity / company).  ## Request Body  - `name` (string, required): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Must be `legal` for organizations - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `source` (string): Origin of the record (e.g., `platform`, `api`)  ## Response  Returns the created organization object. If a duplicate is detected (same CNPJ or email), returns HTTP 409.
-     * @summary Create Organization
-     * @param {ApiOrganizationsPostRequest} [apiOrganizationsPostRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsPost(apiOrganizationsPostRequest?: ApiOrganizationsPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiOrganizationsPost201Response>>;
-};
-/**
- * OrganizationsApi - factory interface
- */
-export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Lista contatos vinculados a organizacao.
-     * @summary List Organization Contacts
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055ContactsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Retorna uma organizacao pelo ID.
-     * @summary Get Organization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Get(options?: RawAxiosRequestConfig): AxiosPromise<ApiOrganizations507f1f77bcf86cd799439055Get200Response>;
-    /**
-     * Updates an existing organization\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }`  ## Response  Returns the updated organization object with all current field values.
-     * @summary Update Organization
-     * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Put(apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiOrganizations507f1f77bcf86cd799439055Put200Response>;
-    /**
-     * Lista organizacoes com paginacao.
-     * @summary List Organizations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiOrganizationsGet200Response>;
-    /**
-     * This endpoint makes an HTTP GET request to retrieve a specific organization by ID. The response is a JSON object with the organization details including `_id`, `customFields`, `labels`, `fullname`, `doc`, `phones`, `owners`, `interactions`, `createdAt`, `updatedAt`.
-     * @summary Get One Organization
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Atualiza os dados de uma organização existente.
-     * @summary Update One Organization
-     * @param {string} id
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdPut(id: string, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Creates a new organization (legal entity / company).  ## Request Body  - `name` (string, required): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Must be `legal` for organizations - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `source` (string): Origin of the record (e.g., `platform`, `api`)  ## Response  Returns the created organization object. If a duplicate is detected (same CNPJ or email), returns HTTP 409.
-     * @summary Create Organization
-     * @param {ApiOrganizationsPostRequest} [apiOrganizationsPostRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsPost(apiOrganizationsPostRequest?: ApiOrganizationsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiOrganizationsPost201Response>;
-};
-/**
- * OrganizationsApi - object-oriented interface
- */
-export declare class OrganizationsApi extends BaseAPI {
-    /**
-     * Lista contatos vinculados a organizacao.
-     * @summary List Organization Contacts
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055ContactsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Retorna uma organizacao pelo ID.
-     * @summary Get Organization
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Get(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiOrganizations507f1f77bcf86cd799439055Get200Response, any, {}>>;
-    /**
-     * Updates an existing organization\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }`  ## Response  Returns the updated organization object with all current field values.
-     * @summary Update Organization
-     * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizations507f1f77bcf86cd799439055Put(apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiOrganizations507f1f77bcf86cd799439055Put200Response, any, {}>>;
-    /**
-     * Lista organizacoes com paginacao.
-     * @summary List Organizations
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiOrganizationsGet200Response, any, {}>>;
-    /**
-     * This endpoint makes an HTTP GET request to retrieve a specific organization by ID. The response is a JSON object with the organization details including `_id`, `customFields`, `labels`, `fullname`, `doc`, `phones`, `owners`, `interactions`, `createdAt`, `updatedAt`.
-     * @summary Get One Organization
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Atualiza os dados de uma organização existente.
-     * @summary Update One Organization
-     * @param {string} id
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsIdPut(id: string, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Creates a new organization (legal entity / company).  ## Request Body  - `name` (string, required): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Must be `legal` for organizations - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `source` (string): Origin of the record (e.g., `platform`, `api`)  ## Response  Returns the created organization object. If a duplicate is detected (same CNPJ or email), returns HTTP 409.
-     * @summary Create Organization
-     * @param {ApiOrganizationsPostRequest} [apiOrganizationsPostRequest]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiOrganizationsPost(apiOrganizationsPostRequest?: ApiOrganizationsPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiOrganizationsPost201Response, any, {}>>;
-}