Document how to enumerate objects associated with accounts etc

balanced / balanced-ruby

Balanced API library in ruby.

MIT License

111 stars 47 forks source link

Document how to enumerate objects associated with accounts etc #75

Open mjallday opened 11 years ago

mjallday commented 11 years ago

Currently the examples show how to create credits/debits and refunds.

However there are no good examples of looking up existing objects after the fact.

e.g.

Find an existing account, find an existing card associated with that account and create a charge for it
Find an existing debit and create a partial refund on it

mjallday commented 10 years ago

Where can I find these examples? Are we deprecating examples? If so, are there scenarios that show this?

remear commented 10 years ago

I think we should deprecate the examples. They seem to atrophy and the docs really should be the definitive source of examples for the client libraries. Most areas in the API Reference now have scenarios for updating resources which used to be a large source of confusion. For example, https://docs.balancedpayments.com/1.1/api/cards/#update-a-card. If this isn't what you meant, let me know. I think we need to address concepts of getting nested objects like customer.cards in guides or blog posts about client library architecture and getting the most out of client libraries.

mjallday commented 10 years ago

The help docs show how to CRUD resources. I'm looking for examples of workflows.

How do I filter and query resources?
How do I create a bank account, verify it and debit it?
How do I create a webhook and view the events that are sent to it?
How do I create an order, add several debits to it and then pay out some funds to the merchant?
" " but with refunds involved.

remear commented 10 years ago

Yeah, these are all planned guides.

mjallday commented 10 years ago

It would be nice if we maintained them until there's an alternative then.