@magnetcustomer/sdk 1.0.1 → 2.0.0

package/dist/esm/api/campaigns-api.d.ts

@@ -1,276 +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 { ApiCampaigns507f1f77bcf86cd799439900ActionsGet200Response } from '../models';
-import type { ApiCampaignsGet200Response } from '../models';
-/**
- * CampaignsApi - axios parameter creator
- */
-export declare const CampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Desativa uma acao da campanha.
-     * @summary Disable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910DisablePut: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Ativa uma acao da campanha.
-     * @summary Enable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910EnablePut: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retorna detalhes de uma acao.
-     * @summary Get Campaign Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910Get: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lista acoes configuradas na campanha (emails, delays, condicoes).
-     * @summary List Campaign Actions
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900ActionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retorna detalhes de uma campanha.
-     * @summary Get Campaign
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Get: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Atualiza uma campanha existente.
-     * @summary Update Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Put: (body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lista campanhas do tenant com paginacao.
-     * @summary List Campaigns
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsGet: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Cria uma nova campanha.
-     * @summary Create Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsPost: (body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * CampaignsApi - functional programming interface
- */
-export declare const CampaignsApiFp: (configuration?: Configuration) => {
-    /**
-     * Desativa uma acao da campanha.
-     * @summary Disable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910DisablePut(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Ativa uma acao da campanha.
-     * @summary Enable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910EnablePut(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Retorna detalhes de uma acao.
-     * @summary Get Campaign Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Lista acoes configuradas na campanha (emails, delays, condicoes).
-     * @summary List Campaign Actions
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900ActionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiCampaigns507f1f77bcf86cd799439900ActionsGet200Response>>;
-    /**
-     * Retorna detalhes de uma campanha.
-     * @summary Get Campaign
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Atualiza uma campanha existente.
-     * @summary Update Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Put(body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Lista campanhas do tenant com paginacao.
-     * @summary List Campaigns
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiCampaignsGet200Response>>;
-    /**
-     * Cria uma nova campanha.
-     * @summary Create Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsPost(body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-};
-/**
- * CampaignsApi - factory interface
- */
-export declare const CampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Desativa uma acao da campanha.
-     * @summary Disable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910DisablePut(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Ativa uma acao da campanha.
-     * @summary Enable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910EnablePut(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Retorna detalhes de uma acao.
-     * @summary Get Campaign Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Lista acoes configuradas na campanha (emails, delays, condicoes).
-     * @summary List Campaign Actions
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900ActionsGet(options?: RawAxiosRequestConfig): AxiosPromise<ApiCampaigns507f1f77bcf86cd799439900ActionsGet200Response>;
-    /**
-     * Retorna detalhes de uma campanha.
-     * @summary Get Campaign
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Atualiza uma campanha existente.
-     * @summary Update Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Put(body?: object, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Lista campanhas do tenant com paginacao.
-     * @summary List Campaigns
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiCampaignsGet200Response>;
-    /**
-     * Cria uma nova campanha.
-     * @summary Create Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsPost(body?: object, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-};
-/**
- * CampaignsApi - object-oriented interface
- */
-export declare class CampaignsApi extends BaseAPI {
-    /**
-     * Desativa uma acao da campanha.
-     * @summary Disable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910DisablePut(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Ativa uma acao da campanha.
-     * @summary Enable Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910EnablePut(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Retorna detalhes de uma acao.
-     * @summary Get Campaign Action
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Actions507f1f77bcf86cd799439910Get(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Lista acoes configuradas na campanha (emails, delays, condicoes).
-     * @summary List Campaign Actions
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900ActionsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiCampaigns507f1f77bcf86cd799439900ActionsGet200Response, any, {}>>;
-    /**
-     * Retorna detalhes de uma campanha.
-     * @summary Get Campaign
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Get(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Atualiza uma campanha existente.
-     * @summary Update Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaigns507f1f77bcf86cd799439900Put(body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Lista campanhas do tenant com paginacao.
-     * @summary List Campaigns
-     * @param {number} [page]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsGet(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiCampaignsGet200Response, any, {}>>;
-    /**
-     * Cria uma nova campanha.
-     * @summary Create Campaign
-     * @param {object} [body]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiCampaignsPost(body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-}