Skip to content

Commit 2134324

Browse files
authored
Merge pull request #6 from OAyomide/update-readme
📝 update readme and lib.rs
2 parents 5f38854 + 0675f5b commit 2134324

File tree

2 files changed

+37
-23
lines changed

2 files changed

+37
-23
lines changed

README.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,37 @@
11
# Paystack-rs
22

3-
A rust crate that wraps around the paystack REST API. [WIP]. Not ready for use yet.
3+
A rust crate that wraps around the paystack REST API.
44

55
## Whats working and whats yet to be done?
66

7-
Currently, there are methods for every transactions endpoint. Anything apart from that is not ready yet. I recently started working on it and since I have a full-time job that takes my time, I basically just try to write like a few minutes or an hour a day of open-source code and this is one. Therefore, I still have a lot of things to do.
8-
9-
Some things to be done (Endpoints) are:
7+
APIs that have been implemented are:
108

119
- [x] Transactions
1210
- [x] Transactions splits
1311
- [x] Customers
1412
- [x] Dedicated NUBAN
15-
- [ ] Subaccounts
16-
- [ ] Plans
17-
- [ ] Subscription
18-
- [ ] Products
19-
- [ ] Payment pages
20-
- [ ] Invoices
21-
- [ ] Settlement
22-
- [ ] Transfer recipients
23-
- [ ] Transfers
24-
- [ ] Transfers Control
25-
- [ ] Bulk Charges
26-
- [ ] Control Panel
27-
- [ ] Charge
28-
- [ ] Dispute
13+
- [x] Subaccounts
14+
- [x] Plans
15+
- [x] Subscription
16+
- [x] Products
17+
- [x] Payment pages
18+
- [x] Invoices
19+
- [x] Settlement
20+
- [x] Transfer recipients
21+
- [x] Transfers
22+
- [x] Transfers Control
23+
- [x] Bulk Charges
24+
- [x] Control Panel
25+
- [x] Charge
26+
- [x] Dispute
2927
- [x] Refunds
30-
- [ ] Verifications
31-
- [ ] Miscellaneous
28+
- [x] Verifications
29+
- [x] Miscellaneous
3230

3331
Other things are:
3432

3533
- [ ] Tests (i know!! tests are important! 🙃)
3634
- [ ] Support reading Bearer access token and similar sensitive information from .env file
37-
- [ ] Proper comments and documentation
3835

3936
## How to use
4037

src/lib.rs

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
mod paystack;
22
mod utils;
33
pub mod prelude {
4-
pub use crate::paystack::refund::*;
4+
pub use crate::paystack::bulk_charges::*;
5+
pub use crate::paystack::charge::*;
6+
pub use crate::paystack::control_panel::*;
7+
pub use crate::paystack::customers::*;
58
pub use crate::paystack::customers::*;
9+
pub use crate::paystack::dedicated_nuban::*;
10+
pub use crate::paystack::disputes::*;
11+
pub use crate::paystack::invoices::*;
12+
pub use crate::paystack::miscellaneous::*;
13+
pub use crate::paystack::payment_pages::*;
14+
pub use crate::paystack::plans::*;
15+
pub use crate::paystack::products::*;
16+
pub use crate::paystack::refund::*;
17+
pub use crate::paystack::settlements::*;
618
pub use crate::paystack::subaccounts::*;
19+
pub use crate::paystack::subscription;
720
pub use crate::paystack::transactions::*;
21+
pub use crate::paystack::transactions_split::*;
22+
pub use crate::paystack::transfer_recipients::*;
23+
pub use crate::paystack::transfers;
24+
pub use crate::paystack::transfers_control::*;
25+
pub use crate::paystack::verification::*;
826
pub use crate::paystack::Paystack;
9-
// pub use crate::utils::*;
1027
}

0 commit comments

Comments
 (0)