npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

@handsondigital/idplugger-promotion

v2.0.3

Published

OpenAPI client for @handsondigital/idplugger-promotion

Readme

@handsondigital/[email protected]

This generator creates TypeScript/JavaScript client that utilizes 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)

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/[email protected] --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 | POST /v3/promotion/{promotion_id}/cms/articles | Cadastra publicações na promoção ArticlesApi | articlesDelete | DELETE /v3/promotion/{promotion_id}/cms/articles/{id} | Exclui uma publicação da promoção ArticlesApi | articlesIndex | GET /v3/promotion/{promotion_id}/cms/articles | Lista as publicações cadastradas na promoção ArticlesApi | articlesUpdate | PATCH /v3/promotion/{promotion_id}/cms/articles | Cadastra ou atualiza publicações na promoção AuthApi | authLoginByToken | POST /v3/auth/login | Login na API via e-mail e token AuthApi | authRefreshToken | POST /v3/auth/refresh | Renova o do token de autenticação AuthApi | authRequestToken | POST /v3/auth/request-token | Solicita envio de token de login por email AuthApi | login | POST /v3/login | Login na API AuthApi | me | GET /v3/me | Dados na API AwardedsApi | awardedsSearch | GET /v3/promotion/{promotion_id}/awardeds | Busca por usuários cadastrados na promoção ganhadores de sorteios AwardedsApi | awardedsStates | GET /v3/promotion/{promotion_id}/awardeds/states | Lista os status de ganhador existentes na promoção AwardedsApi | awardedsUpdate | PATCH /v3/promotion/{promotion_id}/awardeds | Atualiza informações referentes aos ganhadores de sorteios da promoção AwardsApi | awardsCreate | POST /v3/promotion/{promotion_id}/awards | Cadastra um prêmio na promoção AwardsApi | awardsDelete | DELETE /v3/promotion/{promotion_id}/awards/{id} | Deleta um prêmio da promoção AwardsApi | awardsIndex | GET /v3/promotion/{promotion_id}/awards | Pesquisa por prêmios na promoção AwardsApi | awardsUpdate | PATCH /v3/promotion/{promotion_id}/awards | Cadastra ou atualiza um prêmio na promoção BlockedUsersApi | blacklistCreate | POST /v3/promotion/{promotion_id}/users/blacklist | Cadastra um CPF na lista de CPFs bloqueados na promoção BlockedUsersApi | blacklistDelete | DELETE /v3/promotion/{promotion_id}/users/blacklist/{id} | Exclui um CPF da lista de CPFs bloqueados da promoção BlockedUsersApi | blacklistIndex | GET /v3/promotion/{promotion_id}/users/blacklist | Pesquisa por CPFs bloqueados na promoção BrandingApi | brandingIndex | GET /v3/promotion/{promotion_id}/cms/branding | Dados referentes a identidade visual da marca da promoção BrandingApi | brandingUpdate | POST /v3/promotion/{promotion_id}/cms/branding | Altera os dados referentes a identidade visual da marca da promoção ContentApi | contentCreate | POST /v3/promotion/{promotion_id}/cms/content | Cria um novo conteúdo para a promoção ContentApi | 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 | POST /v3/promotion/{promotion_id}/users/{user_id}/coupons | Cadastra um cupom para um usuário cadastrado na promoção CouponsApi | 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 | GET /v3/promotion/{promotion_id}/users/{user_id}/coupons | Busca por cupons de um usuário cadastrado na promoção CouponsApi | 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 | POST /webhook-do-cupom | Webhook de resposta ao registro de cupons CouponsApi | v3PromotionPromotionIdCouponsGet | GET /v3/promotion/{promotion_id}/coupons | Buscar cupons de uma promoção DocumentRulesApi | documentRulesIndex | GET /v3/promotion/{promotion_id}/cms/document_rules | Termos de uso, regulamentos e política de privacidade da promoção DocumentRulesApi | documentRulesRegulationDelete | DELETE /v3/promotion/{promotion_id}/cms/document_rules/regulation/{regulation_id} | Exclui um regulamento da promoção DocumentRulesApi | documentRulesUpdate | POST /v3/promotion/{promotion_id}/cms/document_rules | Atualiza os termos de uso e regulamento da promoção FAQApi | faqCreate | POST /v3/promotion/{promotion_id}/cms/faq | Cadastra perguntas frequentes na promoção FAQApi | faqDelete | DELETE /v3/promotion/{promotion_id}/cms/faq | Esclui perguntas frequentes na promoção FAQApi | faqIndex | GET /v3/promotion/{promotion_id}/cms/faq | Lista as perguntas frequentes cadastradas na promoção FAQApi | faqUpdate | PATCH /v3/promotion/{promotion_id}/cms/faq | Cadastra ou atualiza perguntas frequentes na promoção FilesApi | filesShow | GET /v3/promotion/{promotion_id}/files/{filename} | Faz o download de um arquivo InstantAwardsApi | 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 | 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 | POST /v3/promotion/{promotion_id}/lucky_numbers | Cadastra Números da Sorte no repositório da promoção LuckyNumbersApi | 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 | 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 | GET /v3/promotion/{promotion_id}/metrics | Devolve as métricas da promoção OrdersApi | ordersCreate | POST /v3/promotion/{promotion_id}/users/{user_id}/orders | Cadastra um pedido para um usuário na promoção OrdersApi | ordersIndex | GET /v3/promotion/{promotion_id}/users/{user_id}/orders | Pesquisa por pedidos na promoção OrdersApi | ordersUpdate | PATCH /v3/promotion/{promotion_id}/users/{user_id}/orders | Cadastra ou atualiza um pedido de um usuário na promoção ProductsApi | productsCreate | POST /v3/promotion/{promotion_id}/products | Cadastra um produto na promoção ProductsApi | productsDelete | DELETE /v3/promotion/{promotion_id}/products/{product_id} | Exclui um produto cadastrado na promoção ProductsApi | productsIndex | GET /v3/promotion/{promotion_id}/products | Busca por produtos cadastrados na promoção ProductsApi | productsUpdate | PATCH /v3/promotion/{promotion_id}/products | Cadastra ou atualiza produtos na promoção PromotionDataApi | configsIndex | GET /v3/promotion/{promotion_id} | Retorna dados da promoção RafflesApi | rafflesCreate | POST /v3/promotion/{promotion_id}/raffles | Cadastra um sorteio na promoção RafflesApi | rafflesDelete | DELETE /v3/promotion/{promotion_id}/raffles/{id} | Exclui um sorteio da promoção RafflesApi | rafflesIndex | GET /v3/promotion/{promotion_id}/raffles | Pesquisa por sorteios na promoção RafflesApi | rafflesReport | POST /v3/promotion/{promotion_id}/raffles/{id}/report | Envia por e-mail o relatório de cupons participantes de um sorteio RafflesApi | rafflesUpdate | PATCH /v3/promotion/{promotion_id}/raffles | Cadastra ou atualiza um sorteio na promoção SettingsApi | configWebhook | POST /v3/promotion/{promotion_id}/webhook | Configura o webhook da promoção StoresApi | storesCreate | POST /v3/promotion/{promotion_id}/stores | Cadastra uma loja na promoção StoresApi | storesDelete | DELETE /v3/promotion/{promotion_id}/stores/{store_id} | Exclui um produto cadastrado na promoção StoresApi | storesIndex | GET /v3/promotion/{promotion_id}/stores | Busca por lojas cadastradas na promoção StoresApi | storesUpdate | PATCH /v3/promotion/{promotion_id}/stores | Cadastra ou atualiza lojas na promoção TicketsApi | ticketsCreate | POST /v3/promotion/{promotion_id}/tickets | Cadastra um ticket de suporte na promoção TicketsApi | ticketsDelete | DELETE /v3/promotion/{promotion_id}/tickets/{id} | Exclui um ticket de suporte da promoção TicketsApi | ticketsIndex | GET /v3/promotion/{promotion_id}/tickets | Busca por tickets de suporte cadastrados na promoção TicketsApi | ticketsUpdate | PATCH /v3/promotion/{promotion_id}/tickets | Cadastra ou atualiza um ticket de suporte na promoção UsersApi | usersCreate | POST /v3/promotion/{promotion_id}/users | Cadastra um usuário na promoção UsersApi | usersDelete | DELETE /v3/promotion/{promotion_id}/users/{user_id} | Exclui um usuário da promoção UsersApi | usersIndex | GET /v3/promotion/{promotion_id}/users | Busca por um usuário cadastrado na promoção UsersApi | usersUpdate | PATCH /v3/promotion/{promotion_id}/users | Cadastra ou atualiza um usuário na promoção UsersApi | usersWebhook | POST /webhook-do-usuario | Webhook de resposta ao registro de usuário

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)