@magnetcustomer/sdk 1.0.0

package/docs/OrganizationsApi.md

@@ -0,0 +1,362 @@
+# OrganizationsApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiOrganizations507f1f77bcf86cd799439055ContactsGet**](#apiorganizations507f1f77bcf86cd799439055contactsget) | **GET** /api/organizations/507f1f77bcf86cd799439055/contacts | List Organization Contacts|
+|[**apiOrganizations507f1f77bcf86cd799439055Get**](#apiorganizations507f1f77bcf86cd799439055get) | **GET** /api/organizations/507f1f77bcf86cd799439055 | Get Organization|
+|[**apiOrganizations507f1f77bcf86cd799439055Put**](#apiorganizations507f1f77bcf86cd799439055put) | **PUT** /api/organizations/507f1f77bcf86cd799439055 | Update Organization|
+|[**apiOrganizationsGet**](#apiorganizationsget) | **GET** /api/organizations | List Organizations|
+|[**apiOrganizationsIdGet**](#apiorganizationsidget) | **GET** /api/organizations/{id} | Get One Organization|
+|[**apiOrganizationsIdPut**](#apiorganizationsidput) | **PUT** /api/organizations/{id} | Update One Organization|
+|[**apiOrganizationsPost**](#apiorganizationspost) | **POST** /api/organizations | Create Organization|
+
+# **apiOrganizations507f1f77bcf86cd799439055ContactsGet**
+> apiOrganizations507f1f77bcf86cd799439055ContactsGet()
+
+Lista contatos vinculados a organizacao.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiOrganizations507f1f77bcf86cd799439055ContactsGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (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)
+
+# **apiOrganizations507f1f77bcf86cd799439055Get**
+> ApiOrganizations507f1f77bcf86cd799439055Get200Response apiOrganizations507f1f77bcf86cd799439055Get()
+
+Retorna uma organizacao pelo ID.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+const { status, data } = await apiInstance.apiOrganizations507f1f77bcf86cd799439055Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiOrganizations507f1f77bcf86cd799439055Get200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 200 OK |  -  |
+|**404** | 404 Not Found |  -  |
+
+[[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)
+
+# **apiOrganizations507f1f77bcf86cd799439055Put**
+> ApiOrganizations507f1f77bcf86cd799439055Put200Response apiOrganizations507f1f77bcf86cd799439055Put()
+
+Updates an existing organization\'s information.  ## Request Body  All fields are optional (partial update):  - `name` (string): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }`  ## Response  Returns the updated organization object with all current field values.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration,
+    ApiOrganizations507f1f77bcf86cd799439055PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+let apiOrganizations507f1f77bcf86cd799439055PutRequest: ApiOrganizations507f1f77bcf86cd799439055PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiOrganizations507f1f77bcf86cd799439055Put(
+    apiOrganizations507f1f77bcf86cd799439055PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizations507f1f77bcf86cd799439055PutRequest** | **ApiOrganizations507f1f77bcf86cd799439055PutRequest**|  | |
+
+
+### Return type
+
+**ApiOrganizations507f1f77bcf86cd799439055Put200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Update Organization |  -  |
+
+[[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)
+
+# **apiOrganizationsGet**
+> ApiOrganizationsGet200Response apiOrganizationsGet()
+
+Lista organizacoes com paginacao.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiOrganizationsGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiOrganizationsGet200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 200 OK |  -  |
+
+[[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)
+
+# **apiOrganizationsIdGet**
+> apiOrganizationsIdGet()
+
+This endpoint makes an HTTP GET request to retrieve a specific organization by ID. The response is a JSON object with the organization details including `_id`, `customFields`, `labels`, `fullname`, `doc`, `phones`, `owners`, `interactions`, `createdAt`, `updatedAt`.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiOrganizationsIdGet(
+    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)
+
+# **apiOrganizationsIdPut**
+> apiOrganizationsIdPut()
+
+Atualiza os dados de uma organização existente.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+let id: string; // (default to undefined)
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiOrganizationsIdPut(
+    id,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### 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)
+
+# **apiOrganizationsPost**
+> ApiOrganizationsPost201Response apiOrganizationsPost()
+
+Creates a new organization (legal entity / company).  ## Request Body  - `name` (string, required): Organization name - `email` (string): Email address - `phones` (array): Phone numbers. Each item: `{ \"typePhone\": \"commercial|cellphone\", \"number\": \"...\", \"ddi\": \"+55\" }` - `type` (string): Must be `legal` for organizations - `doc` (string): CNPJ document number - `owners` (array of strings): IDs of staff members who own this organization - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `source` (string): Origin of the record (e.g., `platform`, `api`)  ## Response  Returns the created organization object. If a duplicate is detected (same CNPJ or email), returns HTTP 409.
+
+### Example
+
+```typescript
+import {
+    OrganizationsApi,
+    Configuration,
+    ApiOrganizationsPostRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationsApi(configuration);
+
+let apiOrganizationsPostRequest: ApiOrganizationsPostRequest; // (optional)
+
+const { status, data } = await apiInstance.apiOrganizationsPost(
+    apiOrganizationsPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiOrganizationsPostRequest** | **ApiOrganizationsPostRequest**|  | |
+
+
+### Return type
+
+**ApiOrganizationsPost201Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | 201 Created |  -  |
+|**400** | 400 Bad Request |  -  |
+
+[[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/PaginationFilteringApi.md

@@ -0,0 +1,66 @@
+# PaginationFilteringApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiContactsGet**](#apicontactsget) | **GET** /api/contacts | Pagination Example|
+
+# **apiContactsGet**
+> apiContactsGet()
+
+# Paginacao e Filtros  Todas as listagens da API suportam paginacao e ordenacao.  ## Parametros de Paginacao  | Parametro | Tipo | Default | Max | Descricao | |-----------|------|---------|-----|-----------| | `page` | number | 1 | - | Numero da pagina | | `limit` | number | 25 | 100 | Itens por pagina | | `sortBy` | string | - | - | Campo para ordenacao | | `sortType` | string | asc | - | `asc` ou `desc` |  ## Resposta Paginada  Toda listagem retorna: ```json {   \"data\": [...],   \"page\": 2,   \"pages\": 10,   \"limit\": 10,   \"total\": 95 } ```  ## Busca Textual  Use o parametro `search` para buscar por texto em campos como nome, email e telefone: ``` GET /api/contacts?search=joao&page=1&limit=25 ```
+
+### Example
+
+```typescript
+import {
+    PaginationFilteringApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PaginationFilteringApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+let sortBy: string; // (optional) (default to undefined)
+let sortType: string; // (optional) (default to undefined)
+let search: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiContactsGet(
+    page,
+    limit,
+    sortBy,
+    sortType,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **sortBy** | [**string**] |  | (optional) defaults to undefined|
+| **sortType** | [**string**] |  | (optional) defaults to undefined|
+| **search** | [**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)
+

package/docs/PipelinesApi.md

@@ -0,0 +1,104 @@
+# PipelinesApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiPipelinesIdGet**](#apipipelinesidget) | **GET** /api/pipelines/{id} | Get One Pipeline|
+|[**apiPipelinesIdPut**](#apipipelinesidput) | **PUT** /api/pipelines/{id} | Update One Pipeline|
+
+# **apiPipelinesIdGet**
+> apiPipelinesIdGet()
+
+Retrieves a specific pipeline by ID. Response is a JSON object with pipeline details including `_id`, `title`, `stages` (array with stage names, positions, probabilities), `staffs`, `roles`, `defaultView`, `active`, `createdAt`, `updatedAt`.
+
+### Example
+
+```typescript
+import {
+    PipelinesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PipelinesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiPipelinesIdGet(
+    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)
+
+# **apiPipelinesIdPut**
+> apiPipelinesIdPut()
+
+Atualiza os dados de um pipeline existente, incluindo stages, roles e staffs associados.
+
+### Example
+
+```typescript
+import {
+    PipelinesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PipelinesApi(configuration);
+
+let id: string; // (default to undefined)
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiPipelinesIdPut(
+    id,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### 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)
+