@magnetcustomer/sdk 1.0.0

package/docs/JourneysApi.md

@@ -0,0 +1,580 @@
+# JourneysApi
+
+All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiJourneys507f1f77bcf86cd799439b00ClosePut**](#apijourneys507f1f77bcf86cd799439b00closeput) | **PUT** /api/journeys/507f1f77bcf86cd799439b00/close | Close Journey|
+|[**apiJourneys507f1f77bcf86cd799439b00ExpansionScoreGet**](#apijourneys507f1f77bcf86cd799439b00expansionscoreget) | **GET** /api/journeys/507f1f77bcf86cd799439b00/expansion-score | Get Expansion Score|
+|[**apiJourneys507f1f77bcf86cd799439b00Get**](#apijourneys507f1f77bcf86cd799439b00get) | **GET** /api/journeys/507f1f77bcf86cd799439b00 | Get Journey|
+|[**apiJourneys507f1f77bcf86cd799439b00HealthScoreGet**](#apijourneys507f1f77bcf86cd799439b00healthscoreget) | **GET** /api/journeys/507f1f77bcf86cd799439b00/health-score | Get Health Score|
+|[**apiJourneys507f1f77bcf86cd799439b00MilestonesGet**](#apijourneys507f1f77bcf86cd799439b00milestonesget) | **GET** /api/journeys/507f1f77bcf86cd799439b00/milestones | List Milestones|
+|[**apiJourneys507f1f77bcf86cd799439b00MrrHistoryGet**](#apijourneys507f1f77bcf86cd799439b00mrrhistoryget) | **GET** /api/journeys/507f1f77bcf86cd799439b00/mrr-history | Get MRR History|
+|[**apiJourneys507f1f77bcf86cd799439b00PhaseHistoryGet**](#apijourneys507f1f77bcf86cd799439b00phasehistoryget) | **GET** /api/journeys/507f1f77bcf86cd799439b00/phase-history | Get Phase History|
+|[**apiJourneys507f1f77bcf86cd799439b00PhasePut**](#apijourneys507f1f77bcf86cd799439b00phaseput) | **PUT** /api/journeys/507f1f77bcf86cd799439b00/phase | Move Journey Phase|
+|[**apiJourneys507f1f77bcf86cd799439b00Put**](#apijourneys507f1f77bcf86cd799439b00put) | **PUT** /api/journeys/507f1f77bcf86cd799439b00 | Update Journey|
+|[**apiJourneys507f1f77bcf86cd799439b00RenewalStatusGet**](#apijourneys507f1f77bcf86cd799439b00renewalstatusget) | **GET** /api/journeys/507f1f77bcf86cd799439b00/renewal-status | Get Renewal Status|
+|[**apiJourneys507f1f77bcf86cd799439b00ReopenPut**](#apijourneys507f1f77bcf86cd799439b00reopenput) | **PUT** /api/journeys/507f1f77bcf86cd799439b00/reopen | Reopen Journey|
+|[**apiJourneysGet**](#apijourneysget) | **GET** /api/journeys | List Journeys|
+|[**apiJourneysPost**](#apijourneyspost) | **POST** /api/journeys | Create Journey|
+
+# **apiJourneys507f1f77bcf86cd799439b00ClosePut**
+> apiJourneys507f1f77bcf86cd799439b00ClosePut()
+
+Encerra uma jornada (churn ou conclusao).
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00ClosePut(
+    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)
+
+# **apiJourneys507f1f77bcf86cd799439b00ExpansionScoreGet**
+> apiJourneys507f1f77bcf86cd799439b00ExpansionScoreGet()
+
+Retorna score de expansao (probabilidade de upsell/cross-sell).
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00ExpansionScoreGet();
+```
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00Get**
+> apiJourneys507f1f77bcf86cd799439b00Get()
+
+Retorna detalhes de uma jornada.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00Get();
+```
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00HealthScoreGet**
+> ApiJourneys507f1f77bcf86cd799439b00HealthScoreGet200Response apiJourneys507f1f77bcf86cd799439b00HealthScoreGet()
+
+Retorna o health score atual da jornada (indicador de saude do cliente).
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00HealthScoreGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiJourneys507f1f77bcf86cd799439b00HealthScoreGet200Response**
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00MilestonesGet**
+> apiJourneys507f1f77bcf86cd799439b00MilestonesGet()
+
+Lista milestones (marcos) da jornada.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00MilestonesGet();
+```
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00MrrHistoryGet**
+> ApiJourneys507f1f77bcf86cd799439b00MrrHistoryGet200Response apiJourneys507f1f77bcf86cd799439b00MrrHistoryGet()
+
+Retorna historico de MRR (Monthly Recurring Revenue) da jornada.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00MrrHistoryGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ApiJourneys507f1f77bcf86cd799439b00MrrHistoryGet200Response**
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00PhaseHistoryGet**
+> apiJourneys507f1f77bcf86cd799439b00PhaseHistoryGet()
+
+Retorna historico de mudancas de fase da jornada.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00PhaseHistoryGet();
+```
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00PhasePut**
+> apiJourneys507f1f77bcf86cd799439b00PhasePut()
+
+Move a jornada para outra fase.\\n\\n## Body\\n\\n| Campo | Tipo | Descricao |\\n|-------|------|-----------|\\n| `phase` | ObjectId | ID da fase de destino |
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00PhasePut(
+    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)
+
+# **apiJourneys507f1f77bcf86cd799439b00Put**
+> apiJourneys507f1f77bcf86cd799439b00Put()
+
+Atualiza uma jornada existente.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00Put(
+    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)
+
+# **apiJourneys507f1f77bcf86cd799439b00RenewalStatusGet**
+> apiJourneys507f1f77bcf86cd799439b00RenewalStatusGet()
+
+Retorna status de renovacao do contrato.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00RenewalStatusGet();
+```
+
+### 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)
+
+# **apiJourneys507f1f77bcf86cd799439b00ReopenPut**
+> apiJourneys507f1f77bcf86cd799439b00ReopenPut()
+
+Reabre uma jornada encerrada.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+const { status, data } = await apiInstance.apiJourneys507f1f77bcf86cd799439b00ReopenPut();
+```
+
+### 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)
+
+# **apiJourneysGet**
+> ApiJourneysGet200Response apiJourneysGet()
+
+Lista jornadas de clientes com paginacao.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiJourneysGet(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiJourneysGet200Response**
+
+### 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)
+
+# **apiJourneysPost**
+> apiJourneysPost()
+
+Cria uma nova jornada de customer success.
+
+### Example
+
+```typescript
+import {
+    JourneysApi,
+    Configuration
+} from '@magnetcustomer/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new JourneysApi(configuration);
+
+let body: object; // (optional)
+
+const { status, data } = await apiInstance.apiJourneysPost(
+    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)
+