@handsondigital/idplugger-promotion 1.0.0

package/docs/Login401Response.md

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

@@ -0,0 +1,22 @@
+# LoginRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LoginRequest } from '@handsondigital/idplugger-promotion';
+
+const instance: LoginRequest = {
+    username,
+    password,
+};
+```
+
+[[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/LuckyNumber.md

@@ -0,0 +1,32 @@
+# LuckyNumber
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**coupon_id** | **number** |  | [optional] [default to undefined]
+**user_id** | **number** |  | [optional] [default to undefined]
+**lucky_number** | **string** |  | [default to undefined]
+**serie** | **number** |  | [optional] [default to undefined]
+**situation** | **string** |  | [optional] [default to undefined]
+**serial_number_id** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LuckyNumber } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumber = {
+    id,
+    coupon_id,
+    user_id,
+    lucky_number,
+    serie,
+    situation,
+    serial_number_id,
+};
+```
+
+[[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/LuckyNumbersAddCustom200Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersAddCustom200Response
+
+
+## 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 { LuckyNumbersAddCustom200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersAddCustom200Response = {
+    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/LuckyNumbersAddCustom400Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersAddCustom400Response
+
+
+## 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 { LuckyNumbersAddCustom400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersAddCustom400Response = {
+    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/LuckyNumbersAddCustom401Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersAddCustom401Response
+
+
+## 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 { LuckyNumbersAddCustom401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersAddCustom401Response = {
+    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/LuckyNumbersApi.md

@@ -0,0 +1,202 @@
+# LuckyNumbersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**luckyNumbersAddCustom**](#luckynumbersaddcustom) | **POST** /v3/promotion/{promotion_id}/lucky_numbers | Cadastra Números da Sorte no repositório da promoção|
+|[**luckyNumbersRemove**](#luckynumbersremove) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/lucky_numbers/remove | Inativa e remove Números da Sorte cadastrados na promoção|
+|[**luckyNumbersSearch**](#luckynumberssearch) | **GET** /v3/promotion/{promotion_id}/users/{user_id}/lucky_numbers | Busca por Números da Sorte de um usuário cadastrado na promoção|
+
+# **luckyNumbersAddCustom**
+> LuckyNumbersAddCustom200Response luckyNumbersAddCustom()
+
+Os Números da Sorte cadastrados através deste endpoint serão distribuidos aos participantes de acordo com as regras da promoção. Só é possível cadastrar números da sorte quando as regras da promoção permitem.
+
+### Example
+
+```typescript
+import {
+    LuckyNumbersApi,
+    Configuration,
+    AddLuckyNumberCustom
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new LuckyNumbersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let addLuckyNumberCustom: AddLuckyNumberCustom; // (optional)
+
+const { status, data } = await apiInstance.luckyNumbersAddCustom(
+    promotionId,
+    addLuckyNumberCustom
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addLuckyNumberCustom** | **AddLuckyNumberCustom**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**LuckyNumbersAddCustom200Response**
+
+### 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)
+
+# **luckyNumbersRemove**
+> LuckyNumbersRemove200Response luckyNumbersRemove()
+
+
+### Example
+
+```typescript
+import {
+    LuckyNumbersApi,
+    Configuration,
+    LuckyNumbersRemoveRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new LuckyNumbersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: number; //ID do usuário (default to undefined)
+let luckyNumbersRemoveRequest: LuckyNumbersRemoveRequest; // (optional)
+
+const { status, data } = await apiInstance.luckyNumbersRemove(
+    promotionId,
+    userId,
+    luckyNumbersRemoveRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **luckyNumbersRemoveRequest** | **LuckyNumbersRemoveRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**number**] | ID do usuário | defaults to undefined|
+
+
+### Return type
+
+**LuckyNumbersRemove200Response**
+
+### 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)
+
+# **luckyNumbersSearch**
+> LuckyNumbersSearch200Response luckyNumbersSearch()
+
+
+### Example
+
+```typescript
+import {
+    LuckyNumbersApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new LuckyNumbersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: number; //ID do usuário (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let id: string; //Id do número da sorte (optional) (default to undefined)
+let couponId: string; //Id do cupom associado ao número da sorte (optional) (default to undefined)
+let luckyNumber: string; //Número da sorte (optional) (default to undefined)
+let serie: string; //Série (optional) (default to undefined)
+let situation: string; //Situação do número da sorte (optional) (default to undefined)
+let serialNumberId: string; //Id do serial associado ao número da sorte (optional) (default to undefined)
+
+const { status, data } = await apiInstance.luckyNumbersSearch(
+    promotionId,
+    userId,
+    fields,
+    id,
+    couponId,
+    luckyNumber,
+    serie,
+    situation,
+    serialNumberId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**number**] | ID do usuário | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **id** | [**string**] | Id do número da sorte | (optional) defaults to undefined|
+| **couponId** | [**string**] | Id do cupom associado ao número da sorte | (optional) defaults to undefined|
+| **luckyNumber** | [**string**] | Número da sorte | (optional) defaults to undefined|
+| **serie** | [**string**] | Série | (optional) defaults to undefined|
+| **situation** | [**string**] | Situação do número da sorte | (optional) defaults to undefined|
+| **serialNumberId** | [**string**] | Id do serial associado ao número da sorte | (optional) defaults to undefined|
+
+
+### Return type
+
+**LuckyNumbersSearch200Response**
+
+### 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/LuckyNumbersRemove200Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersRemove200Response
+
+
+## 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 { LuckyNumbersRemove200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersRemove200Response = {
+    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/LuckyNumbersRemove400Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersRemove400Response
+
+
+## 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 { LuckyNumbersRemove400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersRemove400Response = {
+    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/LuckyNumbersRemove401Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersRemove401Response
+
+
+## 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 { LuckyNumbersRemove401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersRemove401Response = {
+    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/LuckyNumbersRemoveRequest.md

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

@@ -0,0 +1,22 @@
+# LuckyNumbersRemoveRequestLuckyNumbersInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID do Número da Sorte | [optional] [default to undefined]
+**user_id** | **number** | ID do Usuário dono do Número da Sorte | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LuckyNumbersRemoveRequestLuckyNumbersInner } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersRemoveRequestLuckyNumbersInner = {
+    id,
+    user_id,
+};
+```
+
+[[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/LuckyNumbersSearch200Response.md

@@ -0,0 +1,28 @@
+# LuckyNumbersSearch200Response
+
+
+## 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<LuckyNumber>**](LuckyNumber.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LuckyNumbersSearch200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersSearch200Response = {
+    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/LuckyNumbersSearch400Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersSearch400Response
+
+
+## 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 { LuckyNumbersSearch400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersSearch400Response = {
+    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/LuckyNumbersSearch401Response.md

@@ -0,0 +1,26 @@
+# LuckyNumbersSearch401Response
+
+
+## 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 { LuckyNumbersSearch401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: LuckyNumbersSearch401Response = {
+    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/Me200Response.md

@@ -0,0 +1,28 @@
+# Me200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**promotions** | [**Array<Me200ResponsePromotionsInner>**](Me200ResponsePromotionsInner.md) | Promoções que o usuário tem acesso | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Me200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: Me200Response = {
+    uuid,
+    username,
+    email,
+    name,
+    promotions,
+};
+```
+
+[[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/Me200ResponsePromotionsInner.md

@@ -0,0 +1,22 @@
+# Me200ResponsePromotionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Me200ResponsePromotionsInner } from '@handsondigital/idplugger-promotion';
+
+const instance: Me200ResponsePromotionsInner = {
+    uuid,
+    name,
+};
+```
+
+[[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/Metrics200Response.md

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