npm package: @handsondigital/idplugger-promotion
Description: OpenAPI client for @handsondigital/idplugger-promotion
Author: OpenAPI-Generator Contributors
Latest version: 2.0.5

## @handsondigital/idplugger-promotion@2.0.5

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @handsondigital/idplugger-promotion@2.0.5 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ArticlesApi* | [**articlesCreate**](docs/ArticlesApi.md#articlescreate) | **POST** /v3/promotion/{promotion_id}/cms/articles | Cadastra publicações na promoção
*ArticlesApi* | [**articlesDelete**](docs/ArticlesApi.md#articlesdelete) | **DELETE** /v3/promotion/{promotion_id}/cms/articles/{id} | Exclui uma publicação da promoção
*ArticlesApi* | [**articlesIndex**](docs/ArticlesApi.md#articlesindex) | **GET** /v3/promotion/{promotion_id}/cms/articles | Lista as publicações cadastradas na promoção
*ArticlesApi* | [**articlesUpdate**](docs/ArticlesApi.md#articlesupdate) | **PATCH** /v3/promotion/{promotion_id}/cms/articles | Cadastra ou atualiza publicações na promoção
*AuthApi* | [**authLoginByToken**](docs/AuthApi.md#authloginbytoken) | **POST** /v3/auth/login | Login na API via e-mail e token
*AuthApi* | [**authRefreshToken**](docs/AuthApi.md#authrefreshtoken) | **POST** /v3/auth/refresh | Renova o do token de autenticação
*AuthApi* | [**authRequestToken**](docs/AuthApi.md#authrequesttoken) | **POST** /v3/auth/request-token | Solicita envio de token de login por email
*AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /v3/login | Login na API
*AuthApi* | [**me**](docs/AuthApi.md#me) | **GET** /v3/me | Dados na API
*AwardedsApi* | [**awardedsSearch**](docs/AwardedsApi.md#awardedssearch) | **GET** /v3/promotion/{promotion_id}/awardeds | Busca por usuários cadastrados na promoção ganhadores de sorteios
*AwardedsApi* | [**awardedsStates**](docs/AwardedsApi.md#awardedsstates) | **GET** /v3/promotion/{promotion_id}/awardeds/states | Lista os status de ganhador existentes na promoção
*AwardedsApi* | [**awardedsUpdate**](docs/AwardedsApi.md#awardedsupdate) | **PATCH** /v3/promotion/{promotion_id}/awardeds | Atualiza informações referentes aos ganhadores de sorteios da promoção
*AwardsApi* | [**awardsCreate**](docs/AwardsApi.md#awardscreate) | **POST** /v3/promotion/{promotion_id}/awards | Cadastra um prêmio na promoção
*AwardsApi* | [**awardsDelete**](docs/AwardsApi.md#awardsdelete) | **DELETE** /v3/promotion/{promotion_id}/awards/{id} | Deleta um prêmio da promoção
*AwardsApi* | [**awardsIndex**](docs/AwardsApi.md#awardsindex) | **GET** /v3/promotion/{promotion_id}/awards | Pesquisa por prêmios na promoção
*AwardsApi* | [**awardsUpdate**](docs/AwardsApi.md#awardsupdate) | **PATCH** /v3/promotion/{promotion_id}/awards | Cadastra ou atualiza um prêmio na promoção
*BlockedUsersApi* | [**blacklistCreate**](docs/BlockedUsersApi.md#blacklistcreate) | **POST** /v3/promotion/{promotion_id}/users/blacklist | Cadastra um CPF na lista de CPFs bloqueados na promoção
*BlockedUsersApi* | [**blacklistDelete**](docs/BlockedUsersApi.md#blacklistdelete) | **DELETE** /v3/promotion/{promotion_id}/users/blacklist/{id} | Exclui um CPF da lista de CPFs bloqueados da promoção
*BlockedUsersApi* | [**blacklistIndex**](docs/BlockedUsersApi.md#blacklistindex) | **GET** /v3/promotion/{promotion_id}/users/blacklist | Pesquisa por CPFs bloqueados na promoção
*BrandingApi* | [**brandingIndex**](docs/BrandingApi.md#brandingindex) | **GET** /v3/promotion/{promotion_id}/cms/branding | Dados referentes a identidade visual da marca da promoção
*BrandingApi* | [**brandingUpdate**](docs/BrandingApi.md#brandingupdate) | **POST** /v3/promotion/{promotion_id}/cms/branding | Altera os dados referentes a identidade visual da marca da promoção
*ContentApi* | [**contentCreate**](docs/ContentApi.md#contentcreate) | **POST** /v3/promotion/{promotion_id}/cms/content | Cria um novo conteúdo para a promoção
*ContentApi* | [**contentIndex**](docs/ContentApi.md#contentindex) | **GET** /v3/promotion/{promotion_id}/cms/content | Dados referentes aos conteúdos (que não são artigos de blog) da promoção
*CouponsApi* | [**couponsCreate**](docs/CouponsApi.md#couponscreate) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/coupons | Cadastra um cupom para um usuário cadastrado na promoção
*CouponsApi* | [**couponsDelete**](docs/CouponsApi.md#couponsdelete) | **DELETE** /v3/promotion/{promotion_id}/users/{user_id}/coupons/{coupon_id} | Exclui um cupom de um usuário cadastrado na promoção
*CouponsApi* | [**couponsIndex**](docs/CouponsApi.md#couponsindex) | **GET** /v3/promotion/{promotion_id}/users/{user_id}/coupons | Busca por cupons de um usuário cadastrado na promoção
*CouponsApi* | [**couponsUpdate**](docs/CouponsApi.md#couponsupdate) | **PATCH** /v3/promotion/{promotion_id}/users/{user_id}/coupons | Cadastra ou atualiza um cupom para um usuário cadastrado na promoção
*CouponsApi* | [**cuponsWebhook**](docs/CouponsApi.md#cuponswebhook) | **POST** /webhook-do-cupom | Webhook de resposta ao registro de cupons
*CouponsApi* | [**v3PromotionPromotionIdCouponsGet**](docs/CouponsApi.md#v3promotionpromotionidcouponsget) | **GET** /v3/promotion/{promotion_id}/coupons | Buscar cupons de uma promoção
*DocumentRulesApi* | [**documentRulesIndex**](docs/DocumentRulesApi.md#documentrulesindex) | **GET** /v3/promotion/{promotion_id}/cms/document_rules | Termos de uso, regulamentos e política de privacidade da promoção
*DocumentRulesApi* | [**documentRulesRegulationDelete**](docs/DocumentRulesApi.md#documentrulesregulationdelete) | **DELETE** /v3/promotion/{promotion_id}/cms/document_rules/regulation/{regulation_id} | Exclui um regulamento da promoção
*DocumentRulesApi* | [**documentRulesUpdate**](docs/DocumentRulesApi.md#documentrulesupdate) | **POST** /v3/promotion/{promotion_id}/cms/document_rules | Atualiza os termos de uso e regulamento da promoção
*FAQApi* | [**faqCreate**](docs/FAQApi.md#faqcreate) | **POST** /v3/promotion/{promotion_id}/cms/faq | Cadastra perguntas frequentes na promoção
*FAQApi* | [**faqDelete**](docs/FAQApi.md#faqdelete) | **DELETE** /v3/promotion/{promotion_id}/cms/faq | Esclui perguntas frequentes na promoção
*FAQApi* | [**faqIndex**](docs/FAQApi.md#faqindex) | **GET** /v3/promotion/{promotion_id}/cms/faq | Lista as perguntas frequentes cadastradas na promoção
*FAQApi* | [**faqUpdate**](docs/FAQApi.md#faqupdate) | **PATCH** /v3/promotion/{promotion_id}/cms/faq | Cadastra ou atualiza perguntas frequentes na promoção
*FilesApi* | [**filesShow**](docs/FilesApi.md#filesshow) | **GET** /v3/promotion/{promotion_id}/files/{filename} | Faz o download de um arquivo
*InstantAwardsApi* | [**instantAwardAttempts**](docs/InstantAwardsApi.md#instantawardattempts) | **GET** /v3/promotion/{promotion_id}/users/{user_id}/attempts | Retorna a quantidade de chances usadas e restantes de um participante da promoção
*InstantAwardsApi* | [**instantAwardTryToWin**](docs/InstantAwardsApi.md#instantawardtrytowin) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/try_to_win | Realiza a tentativa de ganho de um prêmio instantâneo para o participante da promoção
*LuckyNumbersApi* | [**luckyNumbersAddCustom**](docs/LuckyNumbersApi.md#luckynumbersaddcustom) | **POST** /v3/promotion/{promotion_id}/lucky_numbers | Cadastra Números da Sorte no repositório da promoção
*LuckyNumbersApi* | [**luckyNumbersRemove**](docs/LuckyNumbersApi.md#luckynumbersremove) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/lucky_numbers/remove | Inativa e remove Números da Sorte cadastrados na promoção
*LuckyNumbersApi* | [**luckyNumbersSearch**](docs/LuckyNumbersApi.md#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
*MetricsApi* | [**metrics**](docs/MetricsApi.md#metrics) | **GET** /v3/promotion/{promotion_id}/metrics | Devolve as métricas da promoção
*OrdersApi* | [**ordersCreate**](docs/OrdersApi.md#orderscreate) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/orders | Cadastra um pedido para um usuário na promoção
*OrdersApi* | [**ordersIndex**](docs/OrdersApi.md#ordersindex) | **GET** /v3/promotion/{promotion_id}/users/{user_id}/orders | Pesquisa por pedidos na promoção
*OrdersApi* | [**ordersUpdate**](docs/OrdersApi.md#ordersupdate) | **PATCH** /v3/promotion/{promotion_id}/users/{user_id}/orders | Cadastra ou atualiza um pedido de um usuário na promoção
*ProductsApi* | [**productsCreate**](docs/ProductsApi.md#productscreate) | **POST** /v3/promotion/{promotion_id}/products | Cadastra um produto na promoção
*ProductsApi* | [**productsDelete**](docs/ProductsApi.md#productsdelete) | **DELETE** /v3/promotion/{promotion_id}/products/{product_id} | Exclui um produto cadastrado na promoção
*ProductsApi* | [**productsIndex**](docs/ProductsApi.md#productsindex) | **GET** /v3/promotion/{promotion_id}/products | Busca por produtos cadastrados na promoção
*ProductsApi* | [**productsUpdate**](docs/ProductsApi.md#productsupdate) | **PATCH** /v3/promotion/{promotion_id}/products | Cadastra ou atualiza produtos na promoção
*PromotionDataApi* | [**configsIndex**](docs/PromotionDataApi.md#configsindex) | **GET** /v3/promotion/{promotion_id} | Retorna dados da promoção
*RafflesApi* | [**rafflesCreate**](docs/RafflesApi.md#rafflescreate) | **POST** /v3/promotion/{promotion_id}/raffles | Cadastra um sorteio na promoção
*RafflesApi* | [**rafflesDelete**](docs/RafflesApi.md#rafflesdelete) | **DELETE** /v3/promotion/{promotion_id}/raffles/{id} | Exclui um sorteio da promoção
*RafflesApi* | [**rafflesIndex**](docs/RafflesApi.md#rafflesindex) | **GET** /v3/promotion/{promotion_id}/raffles | Pesquisa por sorteios na promoção
*RafflesApi* | [**rafflesReport**](docs/RafflesApi.md#rafflesreport) | **POST** /v3/promotion/{promotion_id}/raffles/{id}/report | Envia por e-mail o relatório de cupons participantes de um sorteio
*RafflesApi* | [**rafflesUpdate**](docs/RafflesApi.md#rafflesupdate) | **PATCH** /v3/promotion/{promotion_id}/raffles | Cadastra ou atualiza um sorteio na promoção
*SettingsApi* | [**configWebhook**](docs/SettingsApi.md#configwebhook) | **POST** /v3/promotion/{promotion_id}/webhook | Configura o webhook da promoção
*StoresApi* | [**storesCreate**](docs/StoresApi.md#storescreate) | **POST** /v3/promotion/{promotion_id}/stores | Cadastra uma loja na promoção
*StoresApi* | [**storesDelete**](docs/StoresApi.md#storesdelete) | **DELETE** /v3/promotion/{promotion_id}/stores/{store_id} | Exclui um produto cadastrado na promoção
*StoresApi* | [**storesIndex**](docs/StoresApi.md#storesindex) | **GET** /v3/promotion/{promotion_id}/stores | Busca por lojas cadastradas na promoção
*StoresApi* | [**storesUpdate**](docs/StoresApi.md#storesupdate) | **PATCH** /v3/promotion/{promotion_id}/stores | Cadastra ou atualiza lojas na promoção
*TicketsApi* | [**ticketsCreate**](docs/TicketsApi.md#ticketscreate) | **POST** /v3/promotion/{promotion_id}/tickets | Cadastra um ticket de suporte na promoção
*TicketsApi* | [**ticketsDelete**](docs/TicketsApi.md#ticketsdelete) | **DELETE** /v3/promotion/{promotion_id}/tickets/{id} | Exclui um ticket de suporte da promoção
*TicketsApi* | [**ticketsIndex**](docs/TicketsApi.md#ticketsindex) | **GET** /v3/promotion/{promotion_id}/tickets | Busca por tickets de suporte cadastrados na promoção
*TicketsApi* | [**ticketsUpdate**](docs/TicketsApi.md#ticketsupdate) | **PATCH** /v3/promotion/{promotion_id}/tickets | Cadastra ou atualiza um ticket de suporte na promoção
*UsersApi* | [**usersCreate**](docs/UsersApi.md#userscreate) | **POST** /v3/promotion/{promotion_id}/users | Cadastra um usuário na promoção
*UsersApi* | [**usersDelete**](docs/UsersApi.md#usersdelete) | **DELETE** /v3/promotion/{promotion_id}/users/{user_id} | Exclui um usuário da promoção
*UsersApi* | [**usersIndex**](docs/UsersApi.md#usersindex) | **GET** /v3/promotion/{promotion_id}/users | Busca por um usuário cadastrado na promoção
*UsersApi* | [**usersUpdate**](docs/UsersApi.md#usersupdate) | **PATCH** /v3/promotion/{promotion_id}/users | Cadastra ou atualiza um usuário na promoção
*UsersApi* | [**usersWebhook**](docs/UsersApi.md#userswebhook) | **POST** /webhook-do-usuario | Webhook de resposta ao registro de usuário


### Documentation For Models

 - [AddLuckyNumberCustom](docs/AddLuckyNumberCustom.md)
 - [Article](docs/Article.md)
 - [ArticleCustomDataInner](docs/ArticleCustomDataInner.md)
 - [ArticlesCreate200Response](docs/ArticlesCreate200Response.md)
 - [ArticlesCreate400Response](docs/ArticlesCreate400Response.md)
 - [ArticlesCreate401Response](docs/ArticlesCreate401Response.md)
 - [ArticlesDelete200Response](docs/ArticlesDelete200Response.md)
 - [ArticlesDelete400Response](docs/ArticlesDelete400Response.md)
 - [ArticlesDelete401Response](docs/ArticlesDelete401Response.md)
 - [ArticlesIndex200Response](docs/ArticlesIndex200Response.md)
 - [ArticlesIndex400Response](docs/ArticlesIndex400Response.md)
 - [ArticlesIndex401Response](docs/ArticlesIndex401Response.md)
 - [ArticlesUpdate200Response](docs/ArticlesUpdate200Response.md)
 - [ArticlesUpdate400Response](docs/ArticlesUpdate400Response.md)
 - [ArticlesUpdate401Response](docs/ArticlesUpdate401Response.md)
 - [AuthLoginByToken200Response](docs/AuthLoginByToken200Response.md)
 - [AuthLoginByTokenRequest](docs/AuthLoginByTokenRequest.md)
 - [AuthRefreshTokenRequest](docs/AuthRefreshTokenRequest.md)
 - [AuthRequestToken200Response](docs/AuthRequestToken200Response.md)
 - [AuthRequestTokenRequest](docs/AuthRequestTokenRequest.md)
 - [Award](docs/Award.md)
 - [Awarded](docs/Awarded.md)
 - [AwardedsSearch200Response](docs/AwardedsSearch200Response.md)
 - [AwardedsSearch200ResponseContentInner](docs/AwardedsSearch200ResponseContentInner.md)
 - [AwardedsSearch200ResponseContentInnerAllOfAwardedState](docs/AwardedsSearch200ResponseContentInnerAllOfAwardedState.md)
 - [AwardedsSearch400Response](docs/AwardedsSearch400Response.md)
 - [AwardedsSearch401Response](docs/AwardedsSearch401Response.md)
 - [AwardedsStates200Response](docs/AwardedsStates200Response.md)
 - [AwardedsUpdate200Response](docs/AwardedsUpdate200Response.md)
 - [AwardedsUpdate400Response](docs/AwardedsUpdate400Response.md)
 - [AwardedsUpdate401Response](docs/AwardedsUpdate401Response.md)
 - [AwardsCreate200Response](docs/AwardsCreate200Response.md)
 - [AwardsCreate400Response](docs/AwardsCreate400Response.md)
 - [AwardsCreate401Response](docs/AwardsCreate401Response.md)
 - [AwardsDelete200Response](docs/AwardsDelete200Response.md)
 - [AwardsDelete400Response](docs/AwardsDelete400Response.md)
 - [AwardsDelete401Response](docs/AwardsDelete401Response.md)
 - [AwardsIndex200Response](docs/AwardsIndex200Response.md)
 - [AwardsIndex400Response](docs/AwardsIndex400Response.md)
 - [AwardsIndex401Response](docs/AwardsIndex401Response.md)
 - [AwardsUpdate200Response](docs/AwardsUpdate200Response.md)
 - [AwardsUpdate400Response](docs/AwardsUpdate400Response.md)
 - [AwardsUpdate401Response](docs/AwardsUpdate401Response.md)
 - [BlacklistCreate200Response](docs/BlacklistCreate200Response.md)
 - [BlacklistCreate200ResponseContentInner](docs/BlacklistCreate200ResponseContentInner.md)
 - [BlacklistCreate400Response](docs/BlacklistCreate400Response.md)
 - [BlacklistCreate401Response](docs/BlacklistCreate401Response.md)
 - [BlacklistCreateRequest](docs/BlacklistCreateRequest.md)
 - [BlacklistDelete200Response](docs/BlacklistDelete200Response.md)
 - [BlacklistDelete400Response](docs/BlacklistDelete400Response.md)
 - [BlacklistDelete401Response](docs/BlacklistDelete401Response.md)
 - [BlacklistIndex200Response](docs/BlacklistIndex200Response.md)
 - [BlacklistIndex200ResponseContentInner](docs/BlacklistIndex200ResponseContentInner.md)
 - [BlacklistIndex400Response](docs/BlacklistIndex400Response.md)
 - [Branding](docs/Branding.md)
 - [BrandingIndex200Response](docs/BrandingIndex200Response.md)
 - [BrandingIndex400Response](docs/BrandingIndex400Response.md)
 - [BrandingIndex401Response](docs/BrandingIndex401Response.md)
 - [BrandingMenuInner](docs/BrandingMenuInner.md)
 - [BrandingSocial](docs/BrandingSocial.md)
 - [BrandingUpdate200Response](docs/BrandingUpdate200Response.md)
 - [BrandingUpdate400Response](docs/BrandingUpdate400Response.md)
 - [BrandingUpdate401Response](docs/BrandingUpdate401Response.md)
 - [ConfigWebhook200Response](docs/ConfigWebhook200Response.md)
 - [ConfigWebhook400Response](docs/ConfigWebhook400Response.md)
 - [ConfigWebhook401Response](docs/ConfigWebhook401Response.md)
 - [ConfigWebhookRequest](docs/ConfigWebhookRequest.md)
 - [ConfigsIndex200Response](docs/ConfigsIndex200Response.md)
 - [ConfigsIndex400Response](docs/ConfigsIndex400Response.md)
 - [ConfigsIndex401Response](docs/ConfigsIndex401Response.md)
 - [Content](docs/Content.md)
 - [ContentCreate200Response](docs/ContentCreate200Response.md)
 - [ContentCreate400Response](docs/ContentCreate400Response.md)
 - [ContentCreate401Response](docs/ContentCreate401Response.md)
 - [ContentIndex200Response](docs/ContentIndex200Response.md)
 - [ContentIndex400Response](docs/ContentIndex400Response.md)
 - [ContentIndex401Response](docs/ContentIndex401Response.md)
 - [Coupon](docs/Coupon.md)
 - [CouponProductsInner](docs/CouponProductsInner.md)
 - [CouponWebhookError](docs/CouponWebhookError.md)
 - [CouponWebhookErrorContent](docs/CouponWebhookErrorContent.md)
 - [CouponWebhookErrorContentAllOfErrors](docs/CouponWebhookErrorContentAllOfErrors.md)
 - [CouponWebhookSuccess](docs/CouponWebhookSuccess.md)
 - [CouponsCreate200Response](docs/CouponsCreate200Response.md)
 - [CouponsCreate401Response](docs/CouponsCreate401Response.md)
 - [CouponsCreate409Response](docs/CouponsCreate409Response.md)
 - [CouponsCreateRequest](docs/CouponsCreateRequest.md)
 - [CouponsCreateRequestCouponsInner](docs/CouponsCreateRequestCouponsInner.md)
 - [CouponsDelete200Response](docs/CouponsDelete200Response.md)
 - [CouponsDelete400Response](docs/CouponsDelete400Response.md)
 - [CouponsDelete401Response](docs/CouponsDelete401Response.md)
 - [CouponsUpdate201Response](docs/CouponsUpdate201Response.md)
 - [CouponsUpdate401Response](docs/CouponsUpdate401Response.md)
 - [CouponsUpdate409Response](docs/CouponsUpdate409Response.md)
 - [CuponsWebhookRequest](docs/CuponsWebhookRequest.md)
 - [DocumentRulesIndex200Response](docs/DocumentRulesIndex200Response.md)
 - [DocumentRulesIndex200ResponseContent](docs/DocumentRulesIndex200ResponseContent.md)
 - [DocumentRulesIndex200ResponseContentRegulationsInner](docs/DocumentRulesIndex200ResponseContentRegulationsInner.md)
 - [DocumentRulesIndex400Response](docs/DocumentRulesIndex400Response.md)
 - [DocumentRulesIndex401Response](docs/DocumentRulesIndex401Response.md)
 - [DocumentRulesRegulationDelete200Response](docs/DocumentRulesRegulationDelete200Response.md)
 - [DocumentRulesRegulationDelete400Response](docs/DocumentRulesRegulationDelete400Response.md)
 - [DocumentRulesRegulationDelete401Response](docs/DocumentRulesRegulationDelete401Response.md)
 - [DocumentRulesUpdate200Response](docs/DocumentRulesUpdate200Response.md)
 - [DocumentRulesUpdate400Response](docs/DocumentRulesUpdate400Response.md)
 - [DocumentRulesUpdate401Response](docs/DocumentRulesUpdate401Response.md)
 - [DocumentRulesUpdateRequest](docs/DocumentRulesUpdateRequest.md)
 - [DocumentRulesUpdateRequestRegulationsInner](docs/DocumentRulesUpdateRequestRegulationsInner.md)
 - [FaqCreate200Response](docs/FaqCreate200Response.md)
 - [FaqCreate400Response](docs/FaqCreate400Response.md)
 - [FaqCreate401Response](docs/FaqCreate401Response.md)
 - [FaqCreateRequestInner](docs/FaqCreateRequestInner.md)
 - [FaqDelete200Response](docs/FaqDelete200Response.md)
 - [FaqDelete400Response](docs/FaqDelete400Response.md)
 - [FaqDelete401Response](docs/FaqDelete401Response.md)
 - [FaqIndex200Response](docs/FaqIndex200Response.md)
 - [FaqIndex200ResponseContentInner](docs/FaqIndex200ResponseContentInner.md)
 - [FaqIndex400Response](docs/FaqIndex400Response.md)
 - [FaqIndex401Response](docs/FaqIndex401Response.md)
 - [FaqUpdate200Response](docs/FaqUpdate200Response.md)
 - [FaqUpdate400Response](docs/FaqUpdate400Response.md)
 - [FaqUpdate401Response](docs/FaqUpdate401Response.md)
 - [FilesShow200Response](docs/FilesShow200Response.md)
 - [FilesShow400Response](docs/FilesShow400Response.md)
 - [InstantAward](docs/InstantAward.md)
 - [InstantAwardAttempts200Response](docs/InstantAwardAttempts200Response.md)
 - [InstantAwardAttempts200ResponseContent](docs/InstantAwardAttempts200ResponseContent.md)
 - [InstantAwardAttempts400Response](docs/InstantAwardAttempts400Response.md)
 - [InstantAwardAttempts401Response](docs/InstantAwardAttempts401Response.md)
 - [InstantAwardTryToWin200Response](docs/InstantAwardTryToWin200Response.md)
 - [Login200Response](docs/Login200Response.md)
 - [Login401Response](docs/Login401Response.md)
 - [LoginRequest](docs/LoginRequest.md)
 - [LuckyNumber](docs/LuckyNumber.md)
 - [LuckyNumbersAddCustom200Response](docs/LuckyNumbersAddCustom200Response.md)
 - [LuckyNumbersAddCustom400Response](docs/LuckyNumbersAddCustom400Response.md)
 - [LuckyNumbersAddCustom401Response](docs/LuckyNumbersAddCustom401Response.md)
 - [LuckyNumbersRemove200Response](docs/LuckyNumbersRemove200Response.md)
 - [LuckyNumbersRemove400Response](docs/LuckyNumbersRemove400Response.md)
 - [LuckyNumbersRemove401Response](docs/LuckyNumbersRemove401Response.md)
 - [LuckyNumbersRemoveRequest](docs/LuckyNumbersRemoveRequest.md)
 - [LuckyNumbersRemoveRequestLuckyNumbersInner](docs/LuckyNumbersRemoveRequestLuckyNumbersInner.md)
 - [LuckyNumbersSearch200Response](docs/LuckyNumbersSearch200Response.md)
 - [LuckyNumbersSearch400Response](docs/LuckyNumbersSearch400Response.md)
 - [LuckyNumbersSearch401Response](docs/LuckyNumbersSearch401Response.md)
 - [Me200Response](docs/Me200Response.md)
 - [Me200ResponsePromotionsInner](docs/Me200ResponsePromotionsInner.md)
 - [Metrics200Response](docs/Metrics200Response.md)
 - [Metrics200ResponseContent](docs/Metrics200ResponseContent.md)
 - [Metrics200ResponseContentUsersInner](docs/Metrics200ResponseContentUsersInner.md)
 - [Metrics400Response](docs/Metrics400Response.md)
 - [Order](docs/Order.md)
 - [OrderCustomDataInner](docs/OrderCustomDataInner.md)
 - [OrdersCreate200Response](docs/OrdersCreate200Response.md)
 - [OrdersCreate400Response](docs/OrdersCreate400Response.md)
 - [OrdersCreate401Response](docs/OrdersCreate401Response.md)
 - [OrdersCreateRequest](docs/OrdersCreateRequest.md)
 - [OrdersIndex200Response](docs/OrdersIndex200Response.md)
 - [OrdersIndex400Response](docs/OrdersIndex400Response.md)
 - [OrdersIndex401Response](docs/OrdersIndex401Response.md)
 - [OrdersUpdate200Response](docs/OrdersUpdate200Response.md)
 - [OrdersUpdate400Response](docs/OrdersUpdate400Response.md)
 - [OrdersUpdate401Response](docs/OrdersUpdate401Response.md)
 - [Pagination](docs/Pagination.md)
 - [PaginationLinksInner](docs/PaginationLinksInner.md)
 - [Product](docs/Product.md)
 - [ProductsCreate200Response](docs/ProductsCreate200Response.md)
 - [ProductsCreate401Response](docs/ProductsCreate401Response.md)
 - [ProductsCreate409Response](docs/ProductsCreate409Response.md)
 - [ProductsCreateRequest](docs/ProductsCreateRequest.md)
 - [ProductsDelete200Response](docs/ProductsDelete200Response.md)
 - [ProductsDelete400Response](docs/ProductsDelete400Response.md)
 - [ProductsDelete401Response](docs/ProductsDelete401Response.md)
 - [ProductsIndex200Response](docs/ProductsIndex200Response.md)
 - [ProductsIndex400Response](docs/ProductsIndex400Response.md)
 - [ProductsIndex401Response](docs/ProductsIndex401Response.md)
 - [ProductsUpdate201Response](docs/ProductsUpdate201Response.md)
 - [ProductsUpdate401Response](docs/ProductsUpdate401Response.md)
 - [ProductsUpdate409Response](docs/ProductsUpdate409Response.md)
 - [Promotion](docs/Promotion.md)
 - [PromotionDatetime](docs/PromotionDatetime.md)
 - [PromotionDatetimeActive](docs/PromotionDatetimeActive.md)
 - [PromotionDatetimeDelivery](docs/PromotionDatetimeDelivery.md)
 - [PromotionDatetimeParticipate](docs/PromotionDatetimeParticipate.md)
 - [PromotionDatetimeShowAwardeds](docs/PromotionDatetimeShowAwardeds.md)
 - [Raffle](docs/Raffle.md)
 - [RafflesCreate200Response](docs/RafflesCreate200Response.md)
 - [RafflesCreate400Response](docs/RafflesCreate400Response.md)
 - [RafflesCreate401Response](docs/RafflesCreate401Response.md)
 - [RafflesCreateRequestInner](docs/RafflesCreateRequestInner.md)
 - [RafflesDelete200Response](docs/RafflesDelete200Response.md)
 - [RafflesDelete400Response](docs/RafflesDelete400Response.md)
 - [RafflesDelete401Response](docs/RafflesDelete401Response.md)
 - [RafflesIndex200Response](docs/RafflesIndex200Response.md)
 - [RafflesIndex400Response](docs/RafflesIndex400Response.md)
 - [RafflesIndex401Response](docs/RafflesIndex401Response.md)
 - [RafflesReportRequest](docs/RafflesReportRequest.md)
 - [RafflesUpdate200Response](docs/RafflesUpdate200Response.md)
 - [RafflesUpdate400Response](docs/RafflesUpdate400Response.md)
 - [RafflesUpdate401Response](docs/RafflesUpdate401Response.md)
 - [RafflesUpdateRequestInner](docs/RafflesUpdateRequestInner.md)
 - [SerieNumber](docs/SerieNumber.md)
 - [Store](docs/Store.md)
 - [StoresCreate200Response](docs/StoresCreate200Response.md)
 - [StoresCreate401Response](docs/StoresCreate401Response.md)
 - [StoresCreate409Response](docs/StoresCreate409Response.md)
 - [StoresCreateRequest](docs/StoresCreateRequest.md)
 - [StoresDelete200Response](docs/StoresDelete200Response.md)
 - [StoresDelete400Response](docs/StoresDelete400Response.md)
 - [StoresDelete401Response](docs/StoresDelete401Response.md)
 - [StoresIndex200Response](docs/StoresIndex200Response.md)
 - [StoresIndex400Response](docs/StoresIndex400Response.md)
 - [StoresIndex401Response](docs/StoresIndex401Response.md)
 - [StoresUpdate201Response](docs/StoresUpdate201Response.md)
 - [StoresUpdate401Response](docs/StoresUpdate401Response.md)
 - [StoresUpdate409Response](docs/StoresUpdate409Response.md)
 - [Ticket](docs/Ticket.md)
 - [TicketsCreate200Response](docs/TicketsCreate200Response.md)
 - [TicketsCreate400Response](docs/TicketsCreate400Response.md)
 - [TicketsCreate401Response](docs/TicketsCreate401Response.md)
 - [TicketsDelete200Response](docs/TicketsDelete200Response.md)
 - [TicketsDelete400Response](docs/TicketsDelete400Response.md)
 - [TicketsDelete401Response](docs/TicketsDelete401Response.md)
 - [TicketsIndex200Response](docs/TicketsIndex200Response.md)
 - [TicketsIndex400Response](docs/TicketsIndex400Response.md)
 - [TicketsIndex401Response](docs/TicketsIndex401Response.md)
 - [TicketsUpdate200Response](docs/TicketsUpdate200Response.md)
 - [TicketsUpdate400Response](docs/TicketsUpdate400Response.md)
 - [User](docs/User.md)
 - [UserWebhookError](docs/UserWebhookError.md)
 - [UserWebhookErrorContent](docs/UserWebhookErrorContent.md)
 - [UserWebhookErrorContentAllOfErrors](docs/UserWebhookErrorContentAllOfErrors.md)
 - [UserWebhookSuccess](docs/UserWebhookSuccess.md)
 - [UsersCreate201Response](docs/UsersCreate201Response.md)
 - [UsersCreate401Response](docs/UsersCreate401Response.md)
 - [UsersCreate409Response](docs/UsersCreate409Response.md)
 - [UsersCreateRequest](docs/UsersCreateRequest.md)
 - [UsersDelete200Response](docs/UsersDelete200Response.md)
 - [UsersDelete400Response](docs/UsersDelete400Response.md)
 - [UsersDelete401Response](docs/UsersDelete401Response.md)
 - [UsersIndex200Response](docs/UsersIndex200Response.md)
 - [UsersIndex200ResponseContentInner](docs/UsersIndex200ResponseContentInner.md)
 - [UsersUpdate201Response](docs/UsersUpdate201Response.md)
 - [UsersWebhook200Response](docs/UsersWebhook200Response.md)
 - [UsersWebhookRequest](docs/UsersWebhookRequest.md)
 - [V3PromotionPromotionIdCouponsGet200Response](docs/V3PromotionPromotionIdCouponsGet200Response.md)
 - [V3PromotionPromotionIdCouponsGet200ResponseContentInner](docs/V3PromotionPromotionIdCouponsGet200ResponseContentInner.md)
 - [V3PromotionPromotionIdCouponsGet400Response](docs/V3PromotionPromotionIdCouponsGet400Response.md)
 - [V3PromotionPromotionIdCouponsGet401Response](docs/V3PromotionPromotionIdCouponsGet401Response.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)