@magnetcustomer/sdk 1.0.0

package/dist/api/custom-fields-api.js

@@ -0,0 +1,579 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldsApi = exports.CustomFieldsApiFactory = exports.CustomFieldsApiFp = exports.CustomFieldsApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * CustomFieldsApi - axios parameter creator
+ */
+const CustomFieldsApiAxiosParamCreator = function (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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/customfieldblocks/507f1f77bcf86cd799439152`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/customfieldblocks`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/customfields/507f1f77bcf86cd799439150`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.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: (apiOrganizations507f1f77bcf86cd799439055PutRequest_1, ...args_1) => __awaiter(this, [apiOrganizations507f1f77bcf86cd799439055PutRequest_1, ...args_1], void 0, function* (apiOrganizations507f1f77bcf86cd799439055PutRequest, options = {}) {
+            const localVarPath = `/api/customfields/507f1f77bcf86cd799439150`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(apiOrganizations507f1f77bcf86cd799439055PutRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Get One Custom Field
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdGet: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Update One Custom Field
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdPut: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.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: (apiCustomfieldsPostRequest_1, ...args_1) => __awaiter(this, [apiCustomfieldsPostRequest_1, ...args_1], void 0, function* (apiCustomfieldsPostRequest, options = {}) {
+            const localVarPath = `/api/customfields`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(apiCustomfieldsPostRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/customfieldtypes`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.CustomFieldsApiAxiosParamCreator = CustomFieldsApiAxiosParamCreator;
+/**
+ * CustomFieldsApi - functional programming interface
+ */
+const CustomFieldsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.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}
+         */
+        apiCustomfieldblocks507f1f77bcf86cd799439152Get(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfieldblocks507f1f77bcf86cd799439152Get(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfieldblocks507f1f77bcf86cd799439152Get']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        apiCustomfieldblocksGet(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfieldblocksGet(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfieldblocksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        apiCustomfields507f1f77bcf86cd799439150Get(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfields507f1f77bcf86cd799439150Get(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfields507f1f77bcf86cd799439150Get']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfields507f1f77bcf86cd799439150Put']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary Get One Custom Field
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdGet(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfieldsIdGet(id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfieldsIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary Update One Custom Field
+         * @param {string} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        apiCustomfieldsIdPut(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfieldsIdPut(id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfieldsIdPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        apiCustomfieldsPost(apiCustomfieldsPostRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfieldsPost(apiCustomfieldsPostRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfieldsPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        apiCustomfieldtypesGet(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.apiCustomfieldtypesGet(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomFieldsApi.apiCustomfieldtypesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+exports.CustomFieldsApiFp = CustomFieldsApiFp;
+/**
+ * CustomFieldsApi - factory interface
+ */
+const CustomFieldsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.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) {
+            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) {
+            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) {
+            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, options) {
+            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, options) {
+            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, options) {
+            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, options) {
+            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) {
+            return localVarFp.apiCustomfieldtypesGet(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.CustomFieldsApiFactory = CustomFieldsApiFactory;
+/**
+ * CustomFieldsApi - object-oriented interface
+ */
+class CustomFieldsApi extends base_1.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}
+     */
+    apiCustomfieldblocks507f1f77bcf86cd799439152Get(options) {
+        return (0, exports.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}
+     */
+    apiCustomfieldblocksGet(options) {
+        return (0, exports.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}
+     */
+    apiCustomfields507f1f77bcf86cd799439150Get(options) {
+        return (0, exports.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}
+     */
+    apiCustomfields507f1f77bcf86cd799439150Put(apiOrganizations507f1f77bcf86cd799439055PutRequest, options) {
+        return (0, exports.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}
+     */
+    apiCustomfieldsIdGet(id, options) {
+        return (0, exports.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}
+     */
+    apiCustomfieldsIdPut(id, options) {
+        return (0, exports.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}
+     */
+    apiCustomfieldsPost(apiCustomfieldsPostRequest, options) {
+        return (0, exports.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}
+     */
+    apiCustomfieldtypesGet(options) {
+        return (0, exports.CustomFieldsApiFp)(this.configuration).apiCustomfieldtypesGet(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.CustomFieldsApi = CustomFieldsApi;