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 🙏

© 2024 – Pkg Stats / Ryan Hefner

iugu-node-sdk

v0.1.2

Published

Biblioteca não-oficial da API Iugu para Node.js feita em Typescript

Downloads

1,033

Readme

Iugu SDK para Node.JS

Com o objetivo de fornecer um SDK Node para acesso a API da Iugu de forma fácil e tipada.

Para instalar a biblioteca:

npm install iugu-node-sdk

Como usar

Com sua API key gerada pela plataformada da Iugu inicialize o sdk:

import Iugu, { IuguCustomer } from 'iugu-node-sdk'

Iugu.setApiKey('<SUA API KEY>')

Existe alguns models que foram criados para padronizar as respostas e requisição para a API. Um exemplo de utilização da API em TypeScript para criação de um cliente:

const client: IuguCustomer = {
    name: 'Vinicius Picanco',
    email: '[email protected]'
}

// Pode ser utilizar com await
const resultClient : IuguCustomer = await Iugu.customers.create(client, undefined)

// Ou
Iugu.customers.create(client, undefined).then((cli: IuguCustomer) => {
    // On success
}).catch((error: Error) => {
    // On error
})

Todas os métodos seguem o parametro de Iugu.{recurso}.{método}(model,urlParams)

Os parâmetros de URL devem ser passados pelo segundo parâmetro dos métodos, da seguinte forma:

const client: IuguCustomer = {
    name: 'Vinicius Picanco',
    email: '[email protected]'
}

const urlParams: Map<string, string> = new Map()
urlParams.set('id', '558958DB714B389EA6B1FF0A33D75505')

// Pode ser utilizar com await
const resultClient : IuguCustomer = await Iugu.customers.update(client, urlParams)

// Ao invés de map pode utilizar o objeto diretamente
const resultClient : IuguCustomer = await Iugu.customers.update(client,
  {
    id: "558958DB714B389EA6B1FF0A33D75505"
  })

// Ou
Iugu.customers.create(client, urlParams).then((cli: IuguCustomer) => {
    // On success
}).catch((error: Error) => {
    // On error
})

Observação

Para saber quais requisições estão disponíveis e quais parâmetros passar acesse a documentação dev.iugu.com/reference para referência.

Testes

Para o funcionamento dos testes crie um arquivo chamado iugu_services.json na pasta tests com os seguintes dados:

{
    "accountId": "<SUA ACCOUNT ID>",
    "apiKey": "<API KEY PREFERENCIALMENTE DE TESTES>",
    "clientId": "<UM CLIENT ID VÁLIDO>",
    "paymentMethodToken": "<<UM TOKEN DE FORMA DE PAGAMENTO VÁLIDO>>"
}

Se for contribuir sempre crie e execute os testes:

npm run test

Créditos

Escrito por Vinícius Picanço ([email protected]). Agradeço a contribuição de: