@magnetcustomer/sdk 1.0.0

package/docs/SegmentationApi.md

@@ -0,0 +1,411 @@
+# SegmentationApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiSegmentationRules507f1f77bcf86cd799439c00Get**](#apisegmentationrules507f1f77bcf86cd799439c00get) | **GET** /api/segmentation-rules/507f1f77bcf86cd799439c00 | Get Segmentation Rule|
+|[**apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet**](#apisegmentationrules507f1f77bcf86cd799439c00previewget) | **GET** /api/segmentation-rules/507f1f77bcf86cd799439c00/preview | Preview Rule|
+|[**apiSegmentationRulesGet**](#apisegmentationrulesget) | **GET** /api/segmentation-rules | List Segmentation Rules|
+|[**apiSegmentationRulesOperatorsGet**](#apisegmentationrulesoperatorsget) | **GET** /api/segmentation-rules/operators | List Operators|
+|[**apiSegmentationRulesPost**](#apisegmentationrulespost) | **POST** /api/segmentation-rules | Create Segmentation Rule|
+|[**apiSharingRules507f1f77bcf86cd799439c10Get**](#apisharingrules507f1f77bcf86cd799439c10get) | **GET** /api/sharing-rules/507f1f77bcf86cd799439c10 | Get Sharing Rule|
+|[**apiSharingRules507f1f77bcf86cd799439c10SimulateGet**](#apisharingrules507f1f77bcf86cd799439c10simulateget) | **GET** /api/sharing-rules/507f1f77bcf86cd799439c10/simulate | Simulate Rule|
+|[**apiSharingRulesGet**](#apisharingrulesget) | **GET** /api/sharing-rules | List Sharing Rules|
+|[**apiSharingRulesPost**](#apisharingrulespost) | **POST** /api/sharing-rules | Create Sharing Rule|
+
+# **apiSegmentationRules507f1f77bcf86cd799439c00Get**
+> apiSegmentationRules507f1f77bcf86cd799439c00Get()
+
+Retorna detalhes de uma regra.
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+const { status, data } = await apiInstance.apiSegmentationRules507f1f77bcf86cd799439c00Get();
+```
+
+### 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)
+
+# **apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet**
+> apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet()
+
+Preview dos registros que serao afetados pela regra (sem aplicar).
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+const { status, data } = await apiInstance.apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet();
+```
+
+### 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)
+
+# **apiSegmentationRulesGet**
+> ApiSegmentationRulesGet200Response apiSegmentationRulesGet()
+
+Lista regras de segmentacao.\\n\\nRegras de segmentacao definem quais registros cada equipe/usuario pode visualizar.
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiSegmentationRulesGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiSegmentationRulesGet200Response**
+
+### 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)
+
+# **apiSegmentationRulesOperatorsGet**
+> apiSegmentationRulesOperatorsGet()
+
+Lista operadores disponiveis para condicoes de regras (equals, contains, greater_than, etc).
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+const { status, data } = await apiInstance.apiSegmentationRulesOperatorsGet();
+```
+
+### 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)
+
+# **apiSegmentationRulesPost**
+> apiSegmentationRulesPost()
+
+Cria uma nova regra de segmentacao.
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiSegmentationRulesPost(
+    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)
+
+# **apiSharingRules507f1f77bcf86cd799439c10Get**
+> apiSharingRules507f1f77bcf86cd799439c10Get()
+
+Retorna detalhes de uma regra de compartilhamento.
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+const { status, data } = await apiInstance.apiSharingRules507f1f77bcf86cd799439c10Get();
+```
+
+### 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)
+
+# **apiSharingRules507f1f77bcf86cd799439c10SimulateGet**
+> apiSharingRules507f1f77bcf86cd799439c10SimulateGet()
+
+Simula o impacto da regra antes de aplicar (quantos registros serao compartilhados).
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+const { status, data } = await apiInstance.apiSharingRules507f1f77bcf86cd799439c10SimulateGet();
+```
+
+### 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)
+
+# **apiSharingRulesGet**
+> ApiSharingRulesGet200Response apiSharingRulesGet()
+
+Lista regras de compartilhamento.\\n\\nRegras de compartilhamento permitem que equipes acessem registros de outras equipes.
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiSharingRulesGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiSharingRulesGet200Response**
+
+### 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)
+
+# **apiSharingRulesPost**
+> apiSharingRulesPost()
+
+Cria uma nova regra de compartilhamento.
+
+### Example
+
+```typescript
+import {
+    SegmentationApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiSharingRulesPost(
+    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)
+

package/docs/SegmentationRulesApi.md

@@ -0,0 +1,229 @@
+# SegmentationRulesApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiSegmentationRules507f1f77bcf86cd799439c00Get**](#apisegmentationrules507f1f77bcf86cd799439c00get) | **GET** /api/segmentation-rules/507f1f77bcf86cd799439c00 | Get Segmentation Rule|
+|[**apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet**](#apisegmentationrules507f1f77bcf86cd799439c00previewget) | **GET** /api/segmentation-rules/507f1f77bcf86cd799439c00/preview | Preview Rule|
+|[**apiSegmentationRulesGet**](#apisegmentationrulesget) | **GET** /api/segmentation-rules | List Segmentation Rules|
+|[**apiSegmentationRulesOperatorsGet**](#apisegmentationrulesoperatorsget) | **GET** /api/segmentation-rules/operators | List Operators|
+|[**apiSegmentationRulesPost**](#apisegmentationrulespost) | **POST** /api/segmentation-rules | Create Segmentation Rule|
+
+# **apiSegmentationRules507f1f77bcf86cd799439c00Get**
+> apiSegmentationRules507f1f77bcf86cd799439c00Get()
+
+Retorna detalhes de uma regra.
+
+### Example
+
+```typescript
+import {
+    SegmentationRulesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationRulesApi(configuration);
+
+const { status, data } = await apiInstance.apiSegmentationRules507f1f77bcf86cd799439c00Get();
+```
+
+### 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)
+
+# **apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet**
+> apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet()
+
+Preview dos registros que serao afetados pela regra (sem aplicar).
+
+### Example
+
+```typescript
+import {
+    SegmentationRulesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationRulesApi(configuration);
+
+const { status, data } = await apiInstance.apiSegmentationRules507f1f77bcf86cd799439c00PreviewGet();
+```
+
+### 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)
+
+# **apiSegmentationRulesGet**
+> ApiSegmentationRulesGet200Response apiSegmentationRulesGet()
+
+Lista regras de segmentacao.\\n\\nRegras de segmentacao definem quais registros cada equipe/usuario pode visualizar.
+
+### Example
+
+```typescript
+import {
+    SegmentationRulesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationRulesApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiSegmentationRulesGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiSegmentationRulesGet200Response**
+
+### 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)
+
+# **apiSegmentationRulesOperatorsGet**
+> apiSegmentationRulesOperatorsGet()
+
+Lista operadores disponiveis para condicoes de regras (equals, contains, greater_than, etc).
+
+### Example
+
+```typescript
+import {
+    SegmentationRulesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationRulesApi(configuration);
+
+const { status, data } = await apiInstance.apiSegmentationRulesOperatorsGet();
+```
+
+### 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)
+
+# **apiSegmentationRulesPost**
+> apiSegmentationRulesPost()
+
+Cria uma nova regra de segmentacao.
+
+### Example
+
+```typescript
+import {
+    SegmentationRulesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SegmentationRulesApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiSegmentationRulesPost(
+    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)
+

package/docs/SequencesApi.md

@@ -0,0 +1,54 @@
+# SequencesApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiEmailsSequencesSchedulePost**](#apiemailssequencesschedulepost) | **POST** /api/emails/sequences/schedule | Schedule Email Sequence|
+
+# **apiEmailsSequencesSchedulePost**
+> apiEmailsSequencesSchedulePost()
+
+Agenda uma sequencia de emails automatizados.
+
+### Example
+
+```typescript
+import {
+    SequencesApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SequencesApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiEmailsSequencesSchedulePost(
+    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)
+