@magnetcustomer/sdk 1.0.0

package/docs/DealsApi.md

@@ -0,0 +1,496 @@
+# DealsApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiDeals507f1f77bcf86cd799439022ClosePut**](#apideals507f1f77bcf86cd799439022closeput) | **PUT** /api/deals/507f1f77bcf86cd799439022/close | Close Deal|
+|[**apiDeals507f1f77bcf86cd799439022Get**](#apideals507f1f77bcf86cd799439022get) | **GET** /api/deals/507f1f77bcf86cd799439022 | Get Deal|
+|[**apiDeals507f1f77bcf86cd799439022Put**](#apideals507f1f77bcf86cd799439022put) | **PUT** /api/deals/507f1f77bcf86cd799439022 | Update Deal|
+|[**apiDeals507f1f77bcf86cd799439022ReopenPut**](#apideals507f1f77bcf86cd799439022reopenput) | **PUT** /api/deals/507f1f77bcf86cd799439022/reopen | Reopen Deal|
+|[**apiDeals507f1f77bcf86cd799439022StageHistoryGet**](#apideals507f1f77bcf86cd799439022stagehistoryget) | **GET** /api/deals/507f1f77bcf86cd799439022/stage-history | Get Stage History|
+|[**apiDeals507f1f77bcf86cd799439022StagePut**](#apideals507f1f77bcf86cd799439022stageput) | **PUT** /api/deals/507f1f77bcf86cd799439022/stage | Move Deal Stage|
+|[**apiDealsBatchMovePost**](#apidealsbatchmovepost) | **POST** /api/deals/batch-move | Batch Move Deals|
+|[**apiDealsGet**](#apidealsget) | **GET** /api/deals | List Deals|
+|[**apiDealsIdGet**](#apidealsidget) | **GET** /api/deals/{id} | Get One Deal|
+|[**apiDealsPost**](#apidealspost) | **POST** /api/deals | Create Deal|
+
+# **apiDeals507f1f77bcf86cd799439022ClosePut**
+> apiDeals507f1f77bcf86cd799439022ClosePut()
+
+Fecha a oportunidade como ganha ou perdida.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration,
+    ApiDeals507f1f77bcf86cd799439022ClosePutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let apiDeals507f1f77bcf86cd799439022ClosePutRequest: ApiDeals507f1f77bcf86cd799439022ClosePutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiDeals507f1f77bcf86cd799439022ClosePut(
+    apiDeals507f1f77bcf86cd799439022ClosePutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiDeals507f1f77bcf86cd799439022ClosePutRequest** | **ApiDeals507f1f77bcf86cd799439022ClosePutRequest**|  | |
+
+
+### 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)
+
+# **apiDeals507f1f77bcf86cd799439022Get**
+> ApiDeals507f1f77bcf86cd799439022Get200Response apiDeals507f1f77bcf86cd799439022Get()
+
+Retorna uma oportunidade pelo ID.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+const { status, data } = await apiInstance.apiDeals507f1f77bcf86cd799439022Get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiDeals507f1f77bcf86cd799439022Get200Response**
+
+### 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 Deal — 200 |  -  |
+|**404** | Get Deal — 404 |  -  |
+
+[[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)
+
+# **apiDeals507f1f77bcf86cd799439022Put**
+> ApiDeals507f1f77bcf86cd799439022Put200Response apiDeals507f1f77bcf86cd799439022Put()
+
+Updates an existing deal\'s information.  ## Request Body  All fields are optional (partial update):  - `title` (string): Deal title - `amount` (number): Deal value in cents - `expectedCloseDate` (string): ISO 8601 date for expected closing - `staff` (string): ID of the staff member responsible for the deal - `participants` (array of strings): IDs of participating staff members - `observers` (array of strings): IDs of observer staff members - `customFields` (array): Custom field values. Each item: `{ \"customField\": \"<fieldId>\", \"k\": \"<fieldName>\", \"v\": <fieldValue> }` - `labels` (array of strings): Label IDs to apply to the deal  ## Response  Returns the updated deal object with all current field values including populated `stage`, `staff`, and `contact`.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration,
+    ApiDeals507f1f77bcf86cd799439022PutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let apiDeals507f1f77bcf86cd799439022PutRequest: ApiDeals507f1f77bcf86cd799439022PutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiDeals507f1f77bcf86cd799439022Put(
+    apiDeals507f1f77bcf86cd799439022PutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiDeals507f1f77bcf86cd799439022PutRequest** | **ApiDeals507f1f77bcf86cd799439022PutRequest**|  | |
+
+
+### Return type
+
+**ApiDeals507f1f77bcf86cd799439022Put200Response**
+
+### 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 Deal |  -  |
+
+[[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)
+
+# **apiDeals507f1f77bcf86cd799439022ReopenPut**
+> apiDeals507f1f77bcf86cd799439022ReopenPut()
+
+Reabre uma oportunidade que foi fechada (ganha ou perdida). A oportunidade volta para o ultimo estagio em que estava antes do fechamento.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiDeals507f1f77bcf86cd799439022ReopenPut(
+    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)
+
+# **apiDeals507f1f77bcf86cd799439022StageHistoryGet**
+> apiDeals507f1f77bcf86cd799439022StageHistoryGet()
+
+Retorna historico de mudancas de estagio.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+const { status, data } = await apiInstance.apiDeals507f1f77bcf86cd799439022StageHistoryGet();
+```
+
+### 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)
+
+# **apiDeals507f1f77bcf86cd799439022StagePut**
+> apiDeals507f1f77bcf86cd799439022StagePut()
+
+Move a oportunidade para outro estagio do pipeline.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration,
+    ApiDeals507f1f77bcf86cd799439022StagePutRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let apiDeals507f1f77bcf86cd799439022StagePutRequest: ApiDeals507f1f77bcf86cd799439022StagePutRequest; // (optional)
+
+const { status, data } = await apiInstance.apiDeals507f1f77bcf86cd799439022StagePut(
+    apiDeals507f1f77bcf86cd799439022StagePutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiDeals507f1f77bcf86cd799439022StagePutRequest** | **ApiDeals507f1f77bcf86cd799439022StagePutRequest**|  | |
+
+
+### 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)
+
+# **apiDealsBatchMovePost**
+> ApiDealsBatchMovePost200Response apiDealsBatchMovePost()
+
+Move multiplas oportunidades para outro estagio em lote.\\n\\n## Body (JSON)\\n\\n| Campo | Tipo | Obrigatorio | Descricao |\\n|-------|------|-------------|----------|\\n| `ids` | ObjectId[] | **Sim** | Array de IDs dos deals |\\n| `stage` | ObjectId | **Sim** | ID do estagio de destino |
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiDealsBatchMovePost(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+
+
+### Return type
+
+**ApiDealsBatchMovePost200Response**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **apiDealsGet**
+> ApiDealsGet200Response apiDealsGet()
+
+Lista oportunidades com paginacao.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiDealsGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiDealsGet200Response**
+
+### 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 - Success |  -  |
+
+[[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)
+
+# **apiDealsIdGet**
+> apiDealsIdGet()
+
+### Get Contacts  This endpoint makes an HTTP GET request to retrieve a list of contacts with optional pagination and filtering parameters.  #### Request  - Method: GET      - URL: `{{platform_url}}/contacts`      - Query Parameters:          - page (number, optional): The page number for pagination.              - search (string, optional): Search query for filtering contacts.              - limit (number, optional): The maximum number of contacts to retrieve per page.              - emailsEmpty (boolean, optional): Indicates whether to include contacts with empty email addresses.              - phonesEmpty (boolean, optional): Indicates whether to include contacts with empty phone numbers.              - interactionsEmpty (boolean, optional): Indicates whether to include contacts with empty interaction records.              - sortBy (string, optional): The field to sort the contacts by.              - sortType (string, optional): The type of sorting (e.g., asc for ascending, desc for descending).           #### Response  The response for this request is a JSON object representing the list of contacts, following the specified pagination and filtering criteria.  For the response schema, please refer to the JSON schema provided separately.
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.apiDealsIdGet(
+    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)
+
+# **apiDealsPost**
+> ApiDealsPost201Response apiDealsPost()
+
+Cria uma nova oportunidade no pipeline.  ## Body (JSON)  | Campo | Tipo | Obrigatorio | Descricao | |-------|------|-------------|-----------| | `title` | string | **Sim** | Titulo da oportunidade | | `value` | number | **Sim** | Valor monetario (default: 0) | | `pipeline` | ObjectId | **Sim** | ID do pipeline | | `stage` | ObjectId | **Sim** | ID do estagio inicial | | `contact` | ObjectId | Nao | ID do contato associado | | `organization` | ObjectId | Nao | ID da organizacao | | `expectedCloseDate` | date | Nao | Data prevista de fechamento (ISO 8601) | | `customFields` | array | Nao | Campos customizados |  ## Responses  | Status | Descricao | |--------|-----------| | 201 | Oportunidade criada | | 400 | Dados invalidos |
+
+### Example
+
+```typescript
+import {
+    DealsApi,
+    Configuration,
+    ApiDealsPostRequest
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DealsApi(configuration);
+
+let apiDealsPostRequest: ApiDealsPostRequest; // (optional)
+
+const { status, data } = await apiInstance.apiDealsPost(
+    apiDealsPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiDealsPostRequest** | **ApiDealsPostRequest**|  | |
+
+
+### Return type
+
+**ApiDealsPost201Response**
+
+### 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 Deal — 201 |  -  |
+
+[[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)
+