Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding typing for some missing objects #163

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

ezequielramos
Copy link

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:

  • Cards
  • Events
  • Payables
  • PaymentLinks
  • Plans
  • Postbacks
  • Security
  • Subscriptions
  • Transactions
  • Authentication/Options

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
Copy link
Author

@jonyw4 pode revisar meu PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants