jonyw4 / pagarme-js-types

📖 A simple typescript definition file for pagarme-js repository
Apache License 2.0
45 stars 14 forks source link

Adding typing for some missing objects #163

Open ezequielramos opened 1 year ago

ezequielramos commented 1 year ago

O que esse PR faz? (Obrigatório)

Adiciona tipagem e documentação para vários dos objetos pagarme de acordo com sua documentação. Objetos atualizados:

Adicionado polimorfismo para que os métodos fiquem bem documentados tanto utilizando o metodo diretamente quanto com o client instanciado. Ex.:

function refund(body: TransactionRefundOptions): Promise<Transaction>;
function refund(opts: Options, body: TransactionRefundOptions): Promise<Transaction>;

// então você pode utilizar tanto:
const client = await pagarme.client.connect({ api_key: '...' });
await client.transactions.refund({});
// quanto:
await pagarme.client.transactions.refund({body: { api_key: '...' }}, {});

Link / Imagem para referencias (Obrigatório)

Todas documentações em código foram baseadas de acordo com a documentação: https://pagarme.github.io/pagarme-js/index.html

ezequielramos commented 1 year ago

@jonyw4 pode revisar meu PR?