@handsondigital/idplugger-admin 1.0.0

package/docs/Metrics200ResponseUsersInner.md

@@ -0,0 +1,22 @@
+# Metrics200ResponseUsersInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **number** |  | [optional] [default to undefined]
+**time** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Metrics200ResponseUsersInner } from '@handsondigital/idplugger-admin';
+
+const instance: Metrics200ResponseUsersInner = {
+    value,
+    time,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Metrics400Response.md

@@ -0,0 +1,20 @@
+# Metrics400Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Metrics400Response } from '@handsondigital/idplugger-admin';
+
+const instance: Metrics400Response = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricsApi.md

@@ -0,0 +1,75 @@
+# MetricsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**metrics**](#metrics) | **GET** /v3/metrics | Devolve as métricas da promoção|
+
+# **metrics**
+> Metrics200Response metrics()
+
+
+### Example
+
+```typescript
+import {
+    MetricsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new MetricsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let keys: Array<string>; //Chaves das métricas que deseja consultar. Exemplo: `keys[]=users&keys[]=coupons&keys[]=luckyNumbers` (default to undefined)
+let startDate: string; //Data inicial para filtrar as métricas (optional) (default to undefined)
+let endDate: string; //Data final para filtrar as métricas (optional) (default to undefined)
+let limit: number; //Limite de resultados (optional) (default to undefined)
+let resolution: string; //Resolução das métricas. Exemplo: `minute`, `hour`, `day` (optional) (default to undefined)
+
+const { status, data } = await apiInstance.metrics(
+    promotionId,
+    keys,
+    startDate,
+    endDate,
+    limit,
+    resolution
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **keys** | **Array&lt;string&gt;** | Chaves das métricas que deseja consultar. Exemplo: &#x60;keys[]&#x3D;users&amp;keys[]&#x3D;coupons&amp;keys[]&#x3D;luckyNumbers&#x60; | defaults to undefined|
+| **startDate** | [**string**] | Data inicial para filtrar as métricas | (optional) defaults to undefined|
+| **endDate** | [**string**] | Data final para filtrar as métricas | (optional) defaults to undefined|
+| **limit** | [**number**] | Limite de resultados | (optional) defaults to undefined|
+| **resolution** | [**string**] | Resolução das métricas. Exemplo: &#x60;minute&#x60;, &#x60;hour&#x60;, &#x60;day&#x60; | (optional) defaults to undefined|
+
+
+### Return type
+
+**Metrics200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**400** | failed |  -  |
+|**401** | unauthorized |  -  |
+
+[[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/PromotionApi.md

@@ -0,0 +1,115 @@
+# PromotionApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**promotionPullConfiguration**](#promotionpullconfiguration) | **POST** /v3/admin/pullconfiguration | Adicionar/Atualizar configurações de uma promoção ao orquestrador|
+|[**promotionStart**](#promotionstart) | **POST** /v3/admin/promotion/start | Iniciar uma promoção na API|
+
+# **promotionPullConfiguration**
+> PromotionPullConfiguration200Response promotionPullConfiguration()
+
+
+### Example
+
+```typescript
+import {
+    PromotionApi,
+    Configuration,
+    PromotionPullConfigurationRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionApi(configuration);
+
+let promotionPullConfigurationRequest: PromotionPullConfigurationRequest; // (optional)
+
+const { status, data } = await apiInstance.promotionPullConfiguration(
+    promotionPullConfigurationRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionPullConfigurationRequest** | **PromotionPullConfigurationRequest**|  | |
+
+
+### Return type
+
+**PromotionPullConfiguration200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**401** | failed |  -  |
+|**500** | failed |  -  |
+
+[[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)
+
+# **promotionStart**
+> PromotionStart200Response promotionStart()
+
+
+### Example
+
+```typescript
+import {
+    PromotionApi,
+    Configuration,
+    PromotionStartRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionApi(configuration);
+
+let promotionStartRequest: PromotionStartRequest; // (optional)
+
+const { status, data } = await apiInstance.promotionStart(
+    promotionStartRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionStartRequest** | **PromotionStartRequest**|  | |
+
+
+### Return type
+
+**PromotionStart200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**401** | failed |  -  |
+|**500** | failed |  -  |
+
+[[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/PromotionPullConfiguration200Response.md

@@ -0,0 +1,24 @@
+# PromotionPullConfiguration200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionPullConfiguration200Response } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionPullConfiguration200Response = {
+    action,
+    result,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionPullConfiguration500Response.md

@@ -0,0 +1,24 @@
+# PromotionPullConfiguration500Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionPullConfiguration500Response } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionPullConfiguration500Response = {
+    action,
+    result,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionPullConfigurationRequest.md

@@ -0,0 +1,20 @@
+# PromotionPullConfigurationRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**db** | [**PromotionPullConfigurationRequestDb**](PromotionPullConfigurationRequestDb.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionPullConfigurationRequest } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionPullConfigurationRequest = {
+    db,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionPullConfigurationRequestDb.md

@@ -0,0 +1,28 @@
+# PromotionPullConfigurationRequestDb
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**host** | **string** |  | [optional] [default to undefined]
+**port** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**user** | **string** |  | [optional] [default to undefined]
+**pass** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionPullConfigurationRequestDb } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionPullConfigurationRequestDb = {
+    host,
+    port,
+    name,
+    user,
+    pass,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionStart200Response.md

@@ -0,0 +1,28 @@
+# PromotionStart200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**promotion_id** | **string** |  | [optional] [default to undefined]
+**user** | [**PromotionStart200ResponseUser**](PromotionStart200ResponseUser.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionStart200Response } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionStart200Response = {
+    action,
+    result,
+    message,
+    promotion_id,
+    user,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionStart200ResponseUser.md

@@ -0,0 +1,30 @@
+# PromotionStart200ResponseUser
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**uuid** | **string** |  | [optional] [default to undefined]
+**permissions** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionStart200ResponseUser } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionStart200ResponseUser = {
+    password,
+    username,
+    name,
+    email,
+    uuid,
+    permissions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionStartRequest.md

@@ -0,0 +1,24 @@
+# PromotionStartRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**db** | [**PromotionPullConfigurationRequestDb**](PromotionPullConfigurationRequestDb.md) |  | [optional] [default to undefined]
+**user** | [**PromotionStartRequestUser**](PromotionStartRequestUser.md) |  | [optional] [default to undefined]
+**permissions** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionStartRequest } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionStartRequest = {
+    db,
+    user,
+    permissions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PromotionStartRequestUser.md

@@ -0,0 +1,24 @@
+# PromotionStartRequestUser
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionStartRequestUser } from '@handsondigital/idplugger-admin';
+
+const instance: PromotionStartRequestUser = {
+    username,
+    name,
+    email,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)