@magnetcustomer/sdk 1.0.0 → 2.0.0

package/docs/CustomFieldBlocksApi.md

@@ -1,138 +0,0 @@
-# CustomFieldBlocksApi
-
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**apiCustomfieldblocksIdGet**](#apicustomfieldblocksidget) | **GET** /api/customfieldblocks/{id} | Get One Block|
-|[**apiCustomfieldblocksIdPut**](#apicustomfieldblocksidput) | **PUT** /api/customfieldblocks/{id} | Update One Block|
-|[**apiCustomfieldblocksPost**](#apicustomfieldblockspost) | **POST** /api/customfieldblocks | Create One Block|
-
-# **apiCustomfieldblocksIdGet**
-> apiCustomfieldblocksIdGet()
-
-
-### Example
-
-```typescript
-import {
-    CustomFieldBlocksApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldBlocksApi(configuration);
-
-let id: string; // (default to undefined)
-
-const { status, data } = await apiInstance.apiCustomfieldblocksIdGet(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldblocksIdPut**
-> apiCustomfieldblocksIdPut()
-
-
-### Example
-
-```typescript
-import {
-    CustomFieldBlocksApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldBlocksApi(configuration);
-
-let id: string; // (default to undefined)
-
-const { status, data } = await apiInstance.apiCustomfieldblocksIdPut(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldblocksPost**
-> apiCustomfieldblocksPost()
-
-
-### Example
-
-```typescript
-import {
-    CustomFieldBlocksApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldBlocksApi(configuration);
-
-const { status, data } = await apiInstance.apiCustomfieldblocksPost();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/CustomFieldsApi.md

@@ -1,365 +0,0 @@
-# CustomFieldsApi
-
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**apiCustomfieldblocks507f1f77bcf86cd799439152Get**](#apicustomfieldblocks507f1f77bcf86cd799439152get) | **GET** /api/customfieldblocks/507f1f77bcf86cd799439152 | Get Custom Field Block|
-|[**apiCustomfieldblocksGet**](#apicustomfieldblocksget) | **GET** /api/customfieldblocks | List Custom Field Blocks|
-|[**apiCustomfields507f1f77bcf86cd799439150Get**](#apicustomfields507f1f77bcf86cd799439150get) | **GET** /api/customfields/507f1f77bcf86cd799439150 | Get Custom Field|
-|[**apiCustomfields507f1f77bcf86cd799439150Put**](#apicustomfields507f1f77bcf86cd799439150put) | **PUT** /api/customfields/507f1f77bcf86cd799439150 | Update Custom Field|
-|[**apiCustomfieldsIdGet**](#apicustomfieldsidget) | **GET** /api/customfields/{id} | Get One Custom Field|
-|[**apiCustomfieldsIdPut**](#apicustomfieldsidput) | **PUT** /api/customfields/{id} | Update One Custom Field|
-|[**apiCustomfieldsPost**](#apicustomfieldspost) | **POST** /api/customfields | Create Custom Field|
-|[**apiCustomfieldtypesGet**](#apicustomfieldtypesget) | **GET** /api/customfieldtypes | List Custom Field Types|
-
-# **apiCustomfieldblocks507f1f77bcf86cd799439152Get**
-> apiCustomfieldblocks507f1f77bcf86cd799439152Get()
-
-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
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-const { status, data } = await apiInstance.apiCustomfieldblocks507f1f77bcf86cd799439152Get();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldblocksGet**
-> apiCustomfieldblocksGet()
-
-Lista blocos de agrupamento de campos customizados.
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-const { status, data } = await apiInstance.apiCustomfieldblocksGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfields507f1f77bcf86cd799439150Get**
-> ApiCustomfields507f1f77bcf86cd799439150Get200Response apiCustomfields507f1f77bcf86cd799439150Get()
-
-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
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-const { status, data } = await apiInstance.apiCustomfields507f1f77bcf86cd799439150Get();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ApiCustomfields507f1f77bcf86cd799439150Get200Response**
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Get Custom Field |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfields507f1f77bcf86cd799439150Put**
-> apiCustomfields507f1f77bcf86cd799439150Put()
-
-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.
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration,
-    ApiOrganizations507f1f77bcf86cd799439055PutRequest
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-let apiOrganizations507f1f77bcf86cd799439055PutRequest: ApiOrganizations507f1f77bcf86cd799439055PutRequest; // (optional)
-
-const { status, data } = await apiInstance.apiCustomfields507f1f77bcf86cd799439150Put(
-    apiOrganizations507f1f77bcf86cd799439055PutRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **apiOrganizations507f1f77bcf86cd799439055PutRequest** | **ApiOrganizations507f1f77bcf86cd799439055PutRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldsIdGet**
-> apiCustomfieldsIdGet()
-
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-let id: string; // (default to undefined)
-
-const { status, data } = await apiInstance.apiCustomfieldsIdGet(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldsIdPut**
-> apiCustomfieldsIdPut()
-
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-let id: string; // (default to undefined)
-
-const { status, data } = await apiInstance.apiCustomfieldsIdPut(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldsPost**
-> ApiCustomfieldsPost201Response apiCustomfieldsPost()
-
-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.
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration,
-    ApiCustomfieldsPostRequest
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-let apiCustomfieldsPostRequest: ApiCustomfieldsPostRequest; // (optional)
-
-const { status, data } = await apiInstance.apiCustomfieldsPost(
-    apiCustomfieldsPostRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **apiCustomfieldsPostRequest** | **ApiCustomfieldsPostRequest**|  | |
-
-
-### Return type
-
-**ApiCustomfieldsPost201Response**
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Create Custom Field |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldtypesGet**
-> apiCustomfieldtypesGet()
-
-Lista tipos de campos disponíveis (texto, numero, data, etc).
-
-### Example
-
-```typescript
-import {
-    CustomFieldsApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsApi(configuration);
-
-const { status, data } = await apiInstance.apiCustomfieldtypesGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/CustomFieldsUsageApi.md

@@ -1,101 +0,0 @@
-# CustomFieldsUsageApi
-
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**apiContactsPost**](#apicontactspost) | **POST** /api/contacts | Create Contact with Custom Fields|
-|[**apiCustomfieldsGet**](#apicustomfieldsget) | **GET** /api/customfields | List Custom Fields for Contacts|
-
-# **apiContactsPost**
-> apiContactsPost()
-
-Exemplo de criacao de contato com campos customizados preenchidos.
-
-### Example
-
-```typescript
-import {
-    CustomFieldsUsageApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsUsageApi(configuration);
-
-let body: object; // (optional)
-
-const { status, data } = await apiInstance.apiContactsPost(
-    body
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **apiCustomfieldsGet**
-> apiCustomfieldsGet()
-
-# Campos Customizados  Campos customizados permitem estender as entidades do CRM com dados especificos do seu negocio.  ## Conceitos  - **Feature**: A entidade associada (contact, deal, organization, ticket, etc)      - **Field Type**: O tipo de dado (text, number, date, select, multiselect, etc)      - **Block**: Agrupamento visual dos campos no formulario      - **Slug**: Identificador unico do campo (usado em `customFields` das entidades)       ## Uso em Entidades  Ao criar/atualizar uma entidade, envie customFields como array:  ``` json {   \"fullname\": \"Joao Silva\",   \"customFields\": [     {       \"customField\": \"507f1f77bcf86cd799439150\",       \"k\": \"data_nascimento\",       \"v\": \"1990-05-15\"     }   ] }   ```  ## Tipos Disponiveis  Use `GET /api/customfieldtypes` para listar todos os tipos.
-
-### Example
-
-```typescript
-import {
-    CustomFieldsUsageApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new CustomFieldsUsageApi(configuration);
-
-let feature: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.apiCustomfieldsGet(
-    feature
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **feature** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-