@handsondigital/idplugger-promotion 1.0.0

package/docs/ProductsUpdate409Response.md

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

@@ -0,0 +1,34 @@
+# Promotion
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**promotion_id** | **string** | Identificador único da promoção | [optional] [default to undefined]
+**promotion_name** | **string** | Nome completo da promoção | [optional] [default to undefined]
+**promotion_name_abbreviated** | **string** | Nome abreviado da promoção | [optional] [default to undefined]
+**promotion_secap** | **string** | Identificador dado pela <span title=\"Secretaria de Avaliação, Planejamento, Energia e Loteria\">`SECAP`</span> para a promoção | [optional] [default to undefined]
+**coupon_min_value** | **string** | Valor mínimo que o total de um cupom deve ter para a API aceitar seu cadastro | [optional] [default to undefined]
+**coupon_max_value** | **string** | Valor máximo que o total de um cupom pode ter para a API aceitar seu cadastro | [optional] [default to undefined]
+**coupon_value_to_win** | **string** | Parâmetro que determina quanto um usuário deve ter acumulado ou em um cupom cadastrado para ganhar um número da sorte. Neste exemplo, a cada 150 reais, o usuário ganhará 1 número da sorte, a depender das regras da promoção de acordo com o regulamento. | [optional] [default to undefined]
+**datetime** | [**PromotionDatetime**](PromotionDatetime.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Promotion } from '@handsondigital/idplugger-promotion';
+
+const instance: Promotion = {
+    promotion_id,
+    promotion_name,
+    promotion_name_abbreviated,
+    promotion_secap,
+    coupon_min_value,
+    coupon_max_value,
+    coupon_value_to_win,
+    datetime,
+};
+```
+
+[[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/PromotionDataApi.md

@@ -0,0 +1,60 @@
+# PromotionDataApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**configsIndex**](#configsindex) | **GET** /v3/promotion/{promotion_id} | Retorna dados da promoção|
+
+# **configsIndex**
+> ConfigsIndex200Response configsIndex()
+
+
+### Example
+
+```typescript
+import {
+    PromotionDataApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionDataApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+
+const { status, data } = await apiInstance.configsIndex(
+    promotionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ConfigsIndex200Response**
+
+### 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/PromotionDatetime.md

@@ -0,0 +1,28 @@
+# PromotionDatetime
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | [**PromotionDatetimeActive**](PromotionDatetimeActive.md) |  | [optional] [default to undefined]
+**participate** | [**PromotionDatetimeParticipate**](PromotionDatetimeParticipate.md) |  | [optional] [default to undefined]
+**show_awardeds** | [**PromotionDatetimeShowAwardeds**](PromotionDatetimeShowAwardeds.md) |  | [optional] [default to undefined]
+**delivery** | [**PromotionDatetimeDelivery**](PromotionDatetimeDelivery.md) |  | [optional] [default to undefined]
+**shutdown** | **string** | Data e hora em que a API deixará de responder as informações referentes à promoção | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionDatetime } from '@handsondigital/idplugger-promotion';
+
+const instance: PromotionDatetime = {
+    active,
+    participate,
+    show_awardeds,
+    delivery,
+    shutdown,
+};
+```
+
+[[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/PromotionDatetimeActive.md

@@ -0,0 +1,22 @@
+# PromotionDatetimeActive
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** | Data e hora em que a promoção começará oficialmente | [optional] [default to undefined]
+**end** | **string** | Data e hora em que a promoção será encerrada oficialmente | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionDatetimeActive } from '@handsondigital/idplugger-promotion';
+
+const instance: PromotionDatetimeActive = {
+    start,
+    end,
+};
+```
+
+[[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/PromotionDatetimeDelivery.md

@@ -0,0 +1,20 @@
+# PromotionDatetimeDelivery
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** | Data e hora em que os prêmios da promoção começaram a ser enviados aos ganhadores | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionDatetimeDelivery } from '@handsondigital/idplugger-promotion';
+
+const instance: PromotionDatetimeDelivery = {
+    start,
+};
+```
+
+[[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/PromotionDatetimeParticipate.md

@@ -0,0 +1,22 @@
+# PromotionDatetimeParticipate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** | Data e hora em que a promoção começará a aceitar cadastros oficialmente | [optional] [default to undefined]
+**end** | **string** | Data e hora em que a promoção irá parar de aceitar cadastros oficialmente | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionDatetimeParticipate } from '@handsondigital/idplugger-promotion';
+
+const instance: PromotionDatetimeParticipate = {
+    start,
+    end,
+};
+```
+
+[[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/PromotionDatetimeShowAwardeds.md

@@ -0,0 +1,20 @@
+# PromotionDatetimeShowAwardeds
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** | Data e hora em que a promoção começará a mostrar os ganhadores | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromotionDatetimeShowAwardeds } from '@handsondigital/idplugger-promotion';
+
+const instance: PromotionDatetimeShowAwardeds = {
+    start,
+};
+```
+
+[[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/Raffle.md

@@ -0,0 +1,44 @@
+# Raffle
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Id do sorteio | [optional] [default to undefined]
+**name** | **string** | Nome do sorteio | [default to undefined]
+**description** | **string** | Descrição do sorteio | [default to undefined]
+**numero_sorteado** | **string** | Número sorteado | [optional] [default to undefined]
+**lottery_name** | **string** | Nome da loteria | [optional] [default to undefined]
+**contest** | **string** | Número do concurso | [optional] [default to undefined]
+**lottery_results** | **Array<string>** | Resultados brutos da loteria | [optional] [default to undefined]
+**raffle_type** | **string** | Tipo do sorteio | [optional] [default to undefined]
+**raffle_date_start** | **string** | Data limite inicial para geração de números da sorte | [default to undefined]
+**raffle_date_end** | **string** | Data limite final para geração de números da sorte | [default to undefined]
+**raffle_date** | **string** | Data pública do sorteio | [default to undefined]
+**realizado_em** | **string** | Data em que o sorteio foi realizado | [optional] [default to undefined]
+**status** | **string** | Status do sorteio. 0 = Inativo, 1 = Ativo | [default to undefined]
+
+## Example
+
+```typescript
+import { Raffle } from '@handsondigital/idplugger-promotion';
+
+const instance: Raffle = {
+    id,
+    name,
+    description,
+    numero_sorteado,
+    lottery_name,
+    contest,
+    lottery_results,
+    raffle_type,
+    raffle_date_start,
+    raffle_date_end,
+    raffle_date,
+    realizado_em,
+    status,
+};
+```
+
+[[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/RafflesApi.md

@@ -0,0 +1,309 @@
+# RafflesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**rafflesCreate**](#rafflescreate) | **POST** /v3/promotion/{promotion_id}/raffles | Cadastra um sorteio na promoção|
+|[**rafflesDelete**](#rafflesdelete) | **DELETE** /v3/promotion/{promotion_id}/raffles/{id} | Exclui um sorteio da promoção|
+|[**rafflesIndex**](#rafflesindex) | **GET** /v3/promotion/{promotion_id}/raffles | Pesquisa por sorteios na promoção|
+|[**rafflesReport**](#rafflesreport) | **POST** /v3/promotion/{promotion_id}/raffles/{id}/report | Envia por e-mail o relatório de cupons participantes de um sorteio|
+|[**rafflesUpdate**](#rafflesupdate) | **PATCH** /v3/promotion/{promotion_id}/raffles | Cadastra ou atualiza um sorteio na promoção|
+
+# **rafflesCreate**
+> RafflesCreate200Response rafflesCreate()
+
+
+### Example
+
+```typescript
+import {
+    RafflesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new RafflesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let rafflesCreateRequestInner: Array<RafflesCreateRequestInner>; // (optional)
+
+const { status, data } = await apiInstance.rafflesCreate(
+    promotionId,
+    rafflesCreateRequestInner
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rafflesCreateRequestInner** | **Array<RafflesCreateRequestInner>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**RafflesCreate200Response**
+
+### 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)
+
+# **rafflesDelete**
+> RafflesDelete200Response rafflesDelete()
+
+
+### Example
+
+```typescript
+import {
+    RafflesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new RafflesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: number; //ID do sorteio na promoção (default to undefined)
+
+const { status, data } = await apiInstance.rafflesDelete(
+    promotionId,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**number**] | ID do sorteio na promoção | defaults to undefined|
+
+
+### Return type
+
+**RafflesDelete200Response**
+
+### 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)
+
+# **rafflesIndex**
+> RafflesIndex200Response rafflesIndex()
+
+
+### Example
+
+```typescript
+import {
+    RafflesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new RafflesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let id: string; //Id do pedido (optional) (default to undefined)
+let raffleDateStart: string; //Início da participação no sorteio (optional) (default to undefined)
+let raffleDateEnd: string; //Fim da participação no sorteio (optional) (default to undefined)
+let raffleDate: string; //Data prevista para o sorteio (optional) (default to undefined)
+let realizadoEm: string; //Data em que o sorteio foi realizado (optional) (default to undefined)
+let status: string; //Pesquisa por um sorteio com determinado status (optional) (default to undefined)
+
+const { status, data } = await apiInstance.rafflesIndex(
+    promotionId,
+    fields,
+    id,
+    raffleDateStart,
+    raffleDateEnd,
+    raffleDate,
+    realizadoEm,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **id** | [**string**] | Id do pedido | (optional) defaults to undefined|
+| **raffleDateStart** | [**string**] | Início da participação no sorteio | (optional) defaults to undefined|
+| **raffleDateEnd** | [**string**] | Fim da participação no sorteio | (optional) defaults to undefined|
+| **raffleDate** | [**string**] | Data prevista para o sorteio | (optional) defaults to undefined|
+| **realizadoEm** | [**string**] | Data em que o sorteio foi realizado | (optional) defaults to undefined|
+| **status** | [**string**] | Pesquisa por um sorteio com determinado status | (optional) defaults to undefined|
+
+
+### Return type
+
+**RafflesIndex200Response**
+
+### 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)
+
+# **rafflesReport**
+> RafflesDelete200Response rafflesReport()
+
+
+### Example
+
+```typescript
+import {
+    RafflesApi,
+    Configuration,
+    RafflesReportRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new RafflesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: number; //ID do sorteio na promoção (default to undefined)
+let rafflesReportRequest: RafflesReportRequest; // (optional)
+
+const { status, data } = await apiInstance.rafflesReport(
+    promotionId,
+    id,
+    rafflesReportRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rafflesReportRequest** | **RafflesReportRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**number**] | ID do sorteio na promoção | defaults to undefined|
+
+
+### Return type
+
+**RafflesDelete200Response**
+
+### 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)
+
+# **rafflesUpdate**
+> RafflesUpdate200Response rafflesUpdate()
+
+
+### Example
+
+```typescript
+import {
+    RafflesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new RafflesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let rafflesUpdateRequestInner: Array<RafflesUpdateRequestInner>; // (optional)
+
+const { status, data } = await apiInstance.rafflesUpdate(
+    promotionId,
+    rafflesUpdateRequestInner
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rafflesUpdateRequestInner** | **Array<RafflesUpdateRequestInner>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**RafflesUpdate200Response**
+
+### 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/RafflesCreate200Response.md

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

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

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