@magnetcustomer/sdk 1.0.0

package/api/custom-fields-api.ts

@@ -0,0 +1,602 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { ApiCustomfields507f1f77bcf86cd799439150Get200Response } from '../models';
+// @ts-ignore
+import type { ApiCustomfieldsPost201Response } from '../models';
+// @ts-ignore
+import type { ApiCustomfieldsPostRequest } from '../models';
+// @ts-ignore
+import type { ApiOrganizations507f1f77bcf86cd799439055PutRequest } from '../models';
+/**
+ * CustomFieldsApi - axios parameter creator
+ */
+export const CustomFieldsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves details of a specific custom field block by its ID.  Custom field blocks are named sections that organize custom fields in the UI sidebar. Each block has a position and can be shown on the right or left sidebar panel.  ## Response  Returns the custom field block object with: - `_id` (string): Block ID - `name` (string): Display name - `position` (number): Display order position - `isExpanded` (boolean): Whether expanded by default - `feature` (string): Entity type (`contact`, `deal`, etc.) - `sidebarPosition` (string): `right` or `left` - `active` (boolean): Whether active - `default` (boolean): Whether a system default block - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+         * @summary Get Custom Field Block
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldblocks507f1f77bcf86cd799439152Get: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/customfieldblocks/507f1f77bcf86cd799439152`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lista blocos de agrupamento de campos customizados.
+         * @summary List Custom Field Blocks
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldblocksGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/customfieldblocks`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves details of a specific custom field by its ID.  ## Response  The response includes the full custom field object with the following fields:  - `_id` (string): Custom field ID - `system` (boolean): Whether this is a system-managed field - `feature` (string): The entity type this field belongs to (`contact`, `prospect`, `lead`, `deal`) - `name` (string): Display name of the custom field - `fieldType` (object): The field type definition with `fieldType` (e.g., `enum`, `text`, `number`, `date`) and display metadata - `values` (array): Predefined values (used for `enum` type fields), each with `value` and `_id` - `settings` (object): Visibility, editability and behavior rules per lifecycle stage - `position` (number): Display order position - `active` (boolean): Whether the field is active - `subFieldSettings` (object): Configuration for sub-fields - `dependentFields` (array): Fields that depend on this one - `customFieldBlockAttach` (object): The block/section this field is grouped into - `modules` (array): Modules where the field appears (e.g., `rule`, `dashboard`, `report`, `form`) - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+         * @summary Get Custom Field
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfields507f1f77bcf86cd799439150Get: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/customfields/507f1f77bcf86cd799439150`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Updates an existing custom field. All fields are optional: `name` (string), `values` (array of `{ \"value\": \"...\" }` objects for select/multi-select types), `settings` object (controls visibility and editability), `active` boolean, `position` number, `modules` array. Returns the updated custom field object.
+         * @summary Update Custom Field
+         * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfields507f1f77bcf86cd799439150Put: async (apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/customfields/507f1f77bcf86cd799439150`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(apiOrganizations507f1f77bcf86cd799439055PutRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Get One Custom Field
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdGet: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('apiCustomfieldsIdGet', 'id', id)
+            const localVarPath = `/api/customfields/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Update One Custom Field
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdPut: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('apiCustomfieldsIdPut', 'id', id)
+            const localVarPath = `/api/customfields/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Creates a new custom field for a given entity type.  ## Request Body  - `feature` (string, required): The entity this field belongs to. One of: `contact`, `prospect`, `lead`, `deal` - `name` (string, required): Display name of the custom field - `fieldType` (string, required): The ID of the field type (obtain from `GET /api/customFieldTypes`) - `values` (array): Predefined values for `enum` type fields. Each item: `{ \"value\": \"Option name\" }` - `settings` (object): Visibility and editability rules. Key sub-properties:   - `required` (boolean): Whether the field is mandatory   - `visibleOnView` (boolean): Whether shown in detail view   - `visibleOnViewWhen` (array): Lifecycle stages where visible (e.g., `[\"contact\", \"prospect\", \"lead\"]`)   - `editable` (boolean): Whether users can edit this field   - `editableWhen` (array): Lifecycle stages where editable   - `creatable` (boolean): Whether shown during entity creation   - `creatableWhen` (array): Lifecycle stages where shown at creation   - `deletable` (boolean): Whether the field can be deleted - `modules` (array): Modules where the field appears. Options: `rule`, `dashboard`, `report`, `form`  ## Response  Returns the created custom field object with `_id`, `slug`, and all configured properties.
+         * @summary Create Custom Field
+         * @param {ApiCustomfieldsPostRequest} [apiCustomfieldsPostRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsPost: async (apiCustomfieldsPostRequest?: ApiCustomfieldsPostRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/customfields`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(apiCustomfieldsPostRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lista tipos de campos disponíveis (texto, numero, data, etc).
+         * @summary List Custom Field Types
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldtypesGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/customfieldtypes`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * CustomFieldsApi - functional programming interface
+ */
+export const CustomFieldsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = CustomFieldsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieves details of a specific custom field block by its ID.  Custom field blocks are named sections that organize custom fields in the UI sidebar. Each block has a position and can be shown on the right or left sidebar panel.  ## Response  Returns the custom field block object with: - `_id` (string): Block ID - `name` (string): Display name - `position` (number): Display order position - `isExpanded` (boolean): Whether expanded by default - `feature` (string): Entity type (`contact`, `deal`, etc.) - `sidebarPosition` (string): `right` or `left` - `active` (boolean): Whether active - `default` (boolean): Whether a system default block - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+         * @summary Get Custom Field Block
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfieldblocks507f1f77bcf86cd799439152Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfieldblocks507f1f77bcf86cd799439152Get(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfieldblocks507f1f77bcf86cd799439152Get']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Lista blocos de agrupamento de campos customizados.
+         * @summary List Custom Field Blocks
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfieldblocksGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfieldblocksGet(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfieldblocksGet']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Retrieves details of a specific custom field by its ID.  ## Response  The response includes the full custom field object with the following fields:  - `_id` (string): Custom field ID - `system` (boolean): Whether this is a system-managed field - `feature` (string): The entity type this field belongs to (`contact`, `prospect`, `lead`, `deal`) - `name` (string): Display name of the custom field - `fieldType` (object): The field type definition with `fieldType` (e.g., `enum`, `text`, `number`, `date`) and display metadata - `values` (array): Predefined values (used for `enum` type fields), each with `value` and `_id` - `settings` (object): Visibility, editability and behavior rules per lifecycle stage - `position` (number): Display order position - `active` (boolean): Whether the field is active - `subFieldSettings` (object): Configuration for sub-fields - `dependentFields` (array): Fields that depend on this one - `customFieldBlockAttach` (object): The block/section this field is grouped into - `modules` (array): Modules where the field appears (e.g., `rule`, `dashboard`, `report`, `form`) - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+         * @summary Get Custom Field
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfields507f1f77bcf86cd799439150Get(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiCustomfields507f1f77bcf86cd799439150Get200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfields507f1f77bcf86cd799439150Get(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfields507f1f77bcf86cd799439150Get']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Updates an existing custom field. All fields are optional: `name` (string), `values` (array of `{ \"value\": \"...\" }` objects for select/multi-select types), `settings` object (controls visibility and editability), `active` boolean, `position` number, `modules` array. Returns the updated custom field object.
+         * @summary Update Custom Field
+         * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfields507f1f77bcf86cd799439150Put']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Get One Custom Field
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfieldsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfieldsIdGet(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfieldsIdGet']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Update One Custom Field
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfieldsIdPut(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfieldsIdPut(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfieldsIdPut']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Creates a new custom field for a given entity type.  ## Request Body  - `feature` (string, required): The entity this field belongs to. One of: `contact`, `prospect`, `lead`, `deal` - `name` (string, required): Display name of the custom field - `fieldType` (string, required): The ID of the field type (obtain from `GET /api/customFieldTypes`) - `values` (array): Predefined values for `enum` type fields. Each item: `{ \"value\": \"Option name\" }` - `settings` (object): Visibility and editability rules. Key sub-properties:   - `required` (boolean): Whether the field is mandatory   - `visibleOnView` (boolean): Whether shown in detail view   - `visibleOnViewWhen` (array): Lifecycle stages where visible (e.g., `[\"contact\", \"prospect\", \"lead\"]`)   - `editable` (boolean): Whether users can edit this field   - `editableWhen` (array): Lifecycle stages where editable   - `creatable` (boolean): Whether shown during entity creation   - `creatableWhen` (array): Lifecycle stages where shown at creation   - `deletable` (boolean): Whether the field can be deleted - `modules` (array): Modules where the field appears. Options: `rule`, `dashboard`, `report`, `form`  ## Response  Returns the created custom field object with `_id`, `slug`, and all configured properties.
+         * @summary Create Custom Field
+         * @param {ApiCustomfieldsPostRequest} [apiCustomfieldsPostRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfieldsPost(apiCustomfieldsPostRequest?: ApiCustomfieldsPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiCustomfieldsPost201Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfieldsPost(apiCustomfieldsPostRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfieldsPost']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Lista tipos de campos disponíveis (texto, numero, data, etc).
+         * @summary List Custom Field Types
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async apiCustomfieldtypesGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.apiCustomfieldtypesGet(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CustomFieldsApi.apiCustomfieldtypesGet']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * CustomFieldsApi - factory interface
+ */
+export const CustomFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = CustomFieldsApiFp(configuration)
+    return {
+        /**
+         * Retrieves details of a specific custom field block by its ID.  Custom field blocks are named sections that organize custom fields in the UI sidebar. Each block has a position and can be shown on the right or left sidebar panel.  ## Response  Returns the custom field block object with: - `_id` (string): Block ID - `name` (string): Display name - `position` (number): Display order position - `isExpanded` (boolean): Whether expanded by default - `feature` (string): Entity type (`contact`, `deal`, etc.) - `sidebarPosition` (string): `right` or `left` - `active` (boolean): Whether active - `default` (boolean): Whether a system default block - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+         * @summary Get Custom Field Block
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldblocks507f1f77bcf86cd799439152Get(options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.apiCustomfieldblocks507f1f77bcf86cd799439152Get(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lista blocos de agrupamento de campos customizados.
+         * @summary List Custom Field Blocks
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldblocksGet(options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.apiCustomfieldblocksGet(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves details of a specific custom field by its ID.  ## Response  The response includes the full custom field object with the following fields:  - `_id` (string): Custom field ID - `system` (boolean): Whether this is a system-managed field - `feature` (string): The entity type this field belongs to (`contact`, `prospect`, `lead`, `deal`) - `name` (string): Display name of the custom field - `fieldType` (object): The field type definition with `fieldType` (e.g., `enum`, `text`, `number`, `date`) and display metadata - `values` (array): Predefined values (used for `enum` type fields), each with `value` and `_id` - `settings` (object): Visibility, editability and behavior rules per lifecycle stage - `position` (number): Display order position - `active` (boolean): Whether the field is active - `subFieldSettings` (object): Configuration for sub-fields - `dependentFields` (array): Fields that depend on this one - `customFieldBlockAttach` (object): The block/section this field is grouped into - `modules` (array): Modules where the field appears (e.g., `rule`, `dashboard`, `report`, `form`) - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+         * @summary Get Custom Field
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfields507f1f77bcf86cd799439150Get(options?: RawAxiosRequestConfig): AxiosPromise<ApiCustomfields507f1f77bcf86cd799439150Get200Response> {
+            return localVarFp.apiCustomfields507f1f77bcf86cd799439150Get(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates an existing custom field. All fields are optional: `name` (string), `values` (array of `{ \"value\": \"...\" }` objects for select/multi-select types), `settings` object (controls visibility and editability), `active` boolean, `position` number, `modules` array. Returns the updated custom field object.
+         * @summary Update Custom Field
+         * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Get One Custom Field
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.apiCustomfieldsIdGet(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Update One Custom Field
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdPut(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.apiCustomfieldsIdPut(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Creates a new custom field for a given entity type.  ## Request Body  - `feature` (string, required): The entity this field belongs to. One of: `contact`, `prospect`, `lead`, `deal` - `name` (string, required): Display name of the custom field - `fieldType` (string, required): The ID of the field type (obtain from `GET /api/customFieldTypes`) - `values` (array): Predefined values for `enum` type fields. Each item: `{ \"value\": \"Option name\" }` - `settings` (object): Visibility and editability rules. Key sub-properties:   - `required` (boolean): Whether the field is mandatory   - `visibleOnView` (boolean): Whether shown in detail view   - `visibleOnViewWhen` (array): Lifecycle stages where visible (e.g., `[\"contact\", \"prospect\", \"lead\"]`)   - `editable` (boolean): Whether users can edit this field   - `editableWhen` (array): Lifecycle stages where editable   - `creatable` (boolean): Whether shown during entity creation   - `creatableWhen` (array): Lifecycle stages where shown at creation   - `deletable` (boolean): Whether the field can be deleted - `modules` (array): Modules where the field appears. Options: `rule`, `dashboard`, `report`, `form`  ## Response  Returns the created custom field object with `_id`, `slug`, and all configured properties.
+         * @summary Create Custom Field
+         * @param {ApiCustomfieldsPostRequest} [apiCustomfieldsPostRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsPost(apiCustomfieldsPostRequest?: ApiCustomfieldsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiCustomfieldsPost201Response> {
+            return localVarFp.apiCustomfieldsPost(apiCustomfieldsPostRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lista tipos de campos disponíveis (texto, numero, data, etc).
+         * @summary List Custom Field Types
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldtypesGet(options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.apiCustomfieldtypesGet(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * CustomFieldsApi - object-oriented interface
+ */
+export class CustomFieldsApi extends BaseAPI {
+    /**
+     * Retrieves details of a specific custom field block by its ID.  Custom field blocks are named sections that organize custom fields in the UI sidebar. Each block has a position and can be shown on the right or left sidebar panel.  ## Response  Returns the custom field block object with: - `_id` (string): Block ID - `name` (string): Display name - `position` (number): Display order position - `isExpanded` (boolean): Whether expanded by default - `feature` (string): Entity type (`contact`, `deal`, etc.) - `sidebarPosition` (string): `right` or `left` - `active` (boolean): Whether active - `default` (boolean): Whether a system default block - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+     * @summary Get Custom Field Block
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfieldblocks507f1f77bcf86cd799439152Get(options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfieldblocks507f1f77bcf86cd799439152Get(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Lista blocos de agrupamento de campos customizados.
+     * @summary List Custom Field Blocks
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfieldblocksGet(options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfieldblocksGet(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves details of a specific custom field by its ID.  ## Response  The response includes the full custom field object with the following fields:  - `_id` (string): Custom field ID - `system` (boolean): Whether this is a system-managed field - `feature` (string): The entity type this field belongs to (`contact`, `prospect`, `lead`, `deal`) - `name` (string): Display name of the custom field - `fieldType` (object): The field type definition with `fieldType` (e.g., `enum`, `text`, `number`, `date`) and display metadata - `values` (array): Predefined values (used for `enum` type fields), each with `value` and `_id` - `settings` (object): Visibility, editability and behavior rules per lifecycle stage - `position` (number): Display order position - `active` (boolean): Whether the field is active - `subFieldSettings` (object): Configuration for sub-fields - `dependentFields` (array): Fields that depend on this one - `customFieldBlockAttach` (object): The block/section this field is grouped into - `modules` (array): Modules where the field appears (e.g., `rule`, `dashboard`, `report`, `form`) - `slug` (string): URL-friendly identifier - `createdAt` / `updatedAt` (string): ISO 8601 timestamps
+     * @summary Get Custom Field
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfields507f1f77bcf86cd799439150Get(options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfields507f1f77bcf86cd799439150Get(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Updates an existing custom field. All fields are optional: `name` (string), `values` (array of `{ \"value\": \"...\" }` objects for select/multi-select types), `settings` object (controls visibility and editability), `active` boolean, `position` number, `modules` array. Returns the updated custom field object.
+     * @summary Update Custom Field
+     * @param {ApiOrganizations507f1f77bcf86cd799439055PutRequest} [apiOrganizations507f1f77bcf86cd799439055PutRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest?: ApiOrganizations507f1f77bcf86cd799439055PutRequest, options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Get One Custom Field
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfieldsIdGet(id: string, options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfieldsIdGet(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Update One Custom Field
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfieldsIdPut(id: string, options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfieldsIdPut(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Creates a new custom field for a given entity type.  ## Request Body  - `feature` (string, required): The entity this field belongs to. One of: `contact`, `prospect`, `lead`, `deal` - `name` (string, required): Display name of the custom field - `fieldType` (string, required): The ID of the field type (obtain from `GET /api/customFieldTypes`) - `values` (array): Predefined values for `enum` type fields. Each item: `{ \"value\": \"Option name\" }` - `settings` (object): Visibility and editability rules. Key sub-properties:   - `required` (boolean): Whether the field is mandatory   - `visibleOnView` (boolean): Whether shown in detail view   - `visibleOnViewWhen` (array): Lifecycle stages where visible (e.g., `[\"contact\", \"prospect\", \"lead\"]`)   - `editable` (boolean): Whether users can edit this field   - `editableWhen` (array): Lifecycle stages where editable   - `creatable` (boolean): Whether shown during entity creation   - `creatableWhen` (array): Lifecycle stages where shown at creation   - `deletable` (boolean): Whether the field can be deleted - `modules` (array): Modules where the field appears. Options: `rule`, `dashboard`, `report`, `form`  ## Response  Returns the created custom field object with `_id`, `slug`, and all configured properties.
+     * @summary Create Custom Field
+     * @param {ApiCustomfieldsPostRequest} [apiCustomfieldsPostRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfieldsPost(apiCustomfieldsPostRequest?: ApiCustomfieldsPostRequest, options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfieldsPost(apiCustomfieldsPostRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Lista tipos de campos disponíveis (texto, numero, data, etc).
+     * @summary List Custom Field Types
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public apiCustomfieldtypesGet(options?: RawAxiosRequestConfig) {
+        return CustomFieldsApiFp(this.configuration).apiCustomfieldtypesGet(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+