@handsondigital/idplugger-promotion 1.0.0

package/docs/Metrics200ResponseContent.md

@@ -0,0 +1,40 @@
+# Metrics200ResponseContent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**coupons** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**lucky_numbers** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**emails** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**tickets** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**tickets_closed** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**raffles** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**raffles_closed** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**awards_delivered** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**instant_awards** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+**instant_awards_delivered** | [**Array<Metrics200ResponseContentUsersInner>**](Metrics200ResponseContentUsersInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Metrics200ResponseContent } from '@handsondigital/idplugger-promotion';
+
+const instance: Metrics200ResponseContent = {
+    users,
+    coupons,
+    lucky_numbers,
+    emails,
+    tickets,
+    tickets_closed,
+    raffles,
+    raffles_closed,
+    awards_delivered,
+    instant_awards,
+    instant_awards_delivered,
+};
+```
+
+[[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/Metrics200ResponseContentUsersInner.md

@@ -0,0 +1,22 @@
+# Metrics200ResponseContentUsersInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **number** |  | [optional] [default to undefined]
+**time** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Metrics200ResponseContentUsersInner } from '@handsondigital/idplugger-promotion';
+
+const instance: Metrics200ResponseContentUsersInner = {
+    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-promotion';
+
+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 *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**metrics**](#metrics) | **GET** /v3/promotion/{promotion_id}/metrics | Devolve as métricas da promoção|
+
+# **metrics**
+> Metrics200Response metrics()
+
+
+### Example
+
+```typescript
+import {
+    MetricsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new MetricsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let keys: Array<'users' | 'coupons' | 'lucky_numbers' | 'emails' | 'tickets' | 'tickets_closed' | 'raffles' | 'raffles_closed' | 'awards_delivered' | 'instant_awards' | 'instant_awards_delivered'>; //Chaves das métricas que deseja consultar. (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<&#39;users&#39; &#124; &#39;coupons&#39; &#124; &#39;lucky_numbers&#39; &#124; &#39;emails&#39; &#124; &#39;tickets&#39; &#124; &#39;tickets_closed&#39; &#124; &#39;raffles&#39; &#124; &#39;raffles_closed&#39; &#124; &#39;awards_delivered&#39; &#124; &#39;instant_awards&#39; &#124; &#39;instant_awards_delivered&#39;>** | Chaves das métricas que deseja consultar. | 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/Order.md

@@ -0,0 +1,42 @@
+# Order
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Id do pedido | [optional] [default to undefined]
+**user_id** | **number** | Id do usuário | [optional] [default to undefined]
+**payment_id** | **string** | Id do pagamento | [optional] [default to undefined]
+**payment_gateway** | **string** | Gateway de pagamento | [optional] [default to undefined]
+**amount** | **number** | Valor total do pedido | [default to undefined]
+**coupon_id** | **number** | Id do cupom gerado pelo pedido | [optional] [default to undefined]
+**status** | **string** | Estado atual do pedido | [optional] [default to StatusEnum_Pending]
+**created_at** | **string** | Data em que o pedido foi criado | [optional] [default to undefined]
+**updated_at** | **string** | Data em que o pedido foi atualizado | [optional] [default to undefined]
+**coupon** | [**Coupon**](Coupon.md) |  | [optional] [default to undefined]
+**lucky_numbers** | [**Array<LuckyNumber>**](LuckyNumber.md) |  | [optional] [default to undefined]
+**custom_data** | [**Array<OrderCustomDataInner>**](OrderCustomDataInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Order } from '@handsondigital/idplugger-promotion';
+
+const instance: Order = {
+    id,
+    user_id,
+    payment_id,
+    payment_gateway,
+    amount,
+    coupon_id,
+    status,
+    created_at,
+    updated_at,
+    coupon,
+    lucky_numbers,
+    custom_data,
+};
+```
+
+[[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/OrderCustomDataInner.md

@@ -0,0 +1,26 @@
+# OrderCustomDataInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Chave ou identificador da metatag | [optional] [default to undefined]
+**value** | **string** | Valor da metatag | [optional] [default to undefined]
+**type** | **string** | Tipo da metatag (Não obrigatório) | [optional] [default to 'string']
+**group** | **string** | Grupo da metatag (Não obrigatório) | [optional] [default to 'external']
+
+## Example
+
+```typescript
+import { OrderCustomDataInner } from '@handsondigital/idplugger-promotion';
+
+const instance: OrderCustomDataInner = {
+    key,
+    value,
+    type,
+    group,
+};
+```
+
+[[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/OrdersApi.md

@@ -0,0 +1,204 @@
+# OrdersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**ordersCreate**](#orderscreate) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/orders | Cadastra um pedido para um usuário na promoção|
+|[**ordersIndex**](#ordersindex) | **GET** /v3/promotion/{promotion_id}/users/{user_id}/orders | Pesquisa por pedidos na promoção|
+|[**ordersUpdate**](#ordersupdate) | **PATCH** /v3/promotion/{promotion_id}/users/{user_id}/orders | Cadastra ou atualiza um pedido de um usuário na promoção|
+
+# **ordersCreate**
+> OrdersCreate200Response ordersCreate()
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrdersCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: string; //ID do usuário (default to undefined)
+let ordersCreateRequest: OrdersCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.ordersCreate(
+    promotionId,
+    userId,
+    ordersCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ordersCreateRequest** | **OrdersCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**string**] | ID do usuário | defaults to undefined|
+
+
+### Return type
+
+**OrdersCreate200Response**
+
+### 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 |  -  |
+|**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)
+
+# **ordersIndex**
+> OrdersIndex200Response ordersIndex()
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: string; //ID do usuário (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let include: string; //Campos a serem retornados (optional) (default to undefined)
+let id: string; //Id do pedido (optional) (default to undefined)
+let paymentId: string; //ID do pagamento (optional) (default to undefined)
+let paymentGateway: string; //Gateway de pagamento do pedido (optional) (default to undefined)
+let couponId: string; //ID do cupom do pedido (optional) (default to undefined)
+let status: string; //Status do pedido (optional) (default to undefined)
+
+const { status, data } = await apiInstance.ordersIndex(
+    promotionId,
+    userId,
+    fields,
+    include,
+    id,
+    paymentId,
+    paymentGateway,
+    couponId,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**string**] | ID do usuário | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **include** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **id** | [**string**] | Id do pedido | (optional) defaults to undefined|
+| **paymentId** | [**string**] | ID do pagamento | (optional) defaults to undefined|
+| **paymentGateway** | [**string**] | Gateway de pagamento do pedido | (optional) defaults to undefined|
+| **couponId** | [**string**] | ID do cupom do pedido | (optional) defaults to undefined|
+| **status** | [**string**] | Status do pedido | (optional) defaults to undefined|
+
+
+### Return type
+
+**OrdersIndex200Response**
+
+### 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)
+
+# **ordersUpdate**
+> OrdersUpdate200Response ordersUpdate()
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrdersCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: string; //ID do usuário (default to undefined)
+let ordersCreateRequest: OrdersCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.ordersUpdate(
+    promotionId,
+    userId,
+    ordersCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ordersCreateRequest** | **OrdersCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**string**] | ID do usuário | defaults to undefined|
+
+
+### Return type
+
+**OrdersUpdate200Response**
+
+### 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 |  -  |
+|**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/OrdersCreate200Response.md

@@ -0,0 +1,26 @@
+# OrdersCreate200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**content** | [**Array<Order>**](Order.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersCreate200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersCreate200Response = {
+    entity,
+    action,
+    result,
+    content,
+};
+```
+
+[[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/OrdersCreate400Response.md

@@ -0,0 +1,26 @@
+# OrdersCreate400Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersCreate400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersCreate400Response = {
+    entity,
+    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/OrdersCreate401Response.md

@@ -0,0 +1,26 @@
+# OrdersCreate401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersCreate401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersCreate401Response = {
+    entity,
+    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/OrdersCreateRequest.md

@@ -0,0 +1,20 @@
+# OrdersCreateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orders** | [**Array<Order>**](Order.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersCreateRequest } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersCreateRequest = {
+    orders,
+};
+```
+
+[[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/OrdersIndex200Response.md

@@ -0,0 +1,28 @@
+# OrdersIndex200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**paging** | [**Array<Pagination>**](Pagination.md) |  | [optional] [default to undefined]
+**content** | [**Array<Order>**](Order.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersIndex200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersIndex200Response = {
+    entity,
+    action,
+    result,
+    paging,
+    content,
+};
+```
+
+[[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/OrdersIndex400Response.md

@@ -0,0 +1,26 @@
+# OrdersIndex400Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersIndex400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersIndex400Response = {
+    entity,
+    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/OrdersIndex401Response.md

@@ -0,0 +1,26 @@
+# OrdersIndex401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersIndex401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersIndex401Response = {
+    entity,
+    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/OrdersUpdate200Response.md

@@ -0,0 +1,26 @@
+# OrdersUpdate200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**content** | [**Array<Order>**](Order.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersUpdate200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersUpdate200Response = {
+    entity,
+    action,
+    result,
+    content,
+};
+```
+
+[[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/OrdersUpdate400Response.md

@@ -0,0 +1,26 @@
+# OrdersUpdate400Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersUpdate400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersUpdate400Response = {
+    entity,
+    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)