README.md in mr_speedy_ruby-1.0.0.pre.alpha.2 vs README.md in mr_speedy_ruby-1.0.0.pre.alpha.3
- old
+ new
@@ -79,10 +79,12 @@
[Delivery Details](https://apitest.mrspeedy.ph/business-api/doc#calculate-order) can also be passed along pickup/delivery params.
By default we set `MOTORBIKE` as default vehicle unless you pass `vehicle_type_id` as option for `opts`.
+## Orders
+
### Placing an Order
Send request to mr.speedy api to create order.
```ruby
client = MrSpeedyRuby::Client.new(token: "mr-speedy-token")
@@ -116,10 +118,30 @@
[Delivery Details](https://apitest.mrspeedy.ph/business-api/doc#create-order) can also be passed along pickup/delivery params.
By default we set `MOTORBIKE` as default vehicle unless you pass `vehicle_type_id` as option for `opts`.
+### Fetch Orders
+
+Fetch Orders by initializing client and calling `MrSpeedyRuby::Client#orders`
+method
+
+```ruby
+client = MrSpeedyRuby::Client.new(token: "mr-speedy-token")
+client.orders(sandbox: true)
+```
+
+You can also control how orders will be fetch by supplying additional
+[arguments](https://apitest.mrspeedy.ph/business-api/doc#orders) to your query
+via payload argument.
+
+```ruby
+client = MrSpeedyRuby::Client.new(token: "mr-speedy-token")
+# Fetch Completed Orders
+client.orders(sandbox: true, payload: { status: "completed" })
+```
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -129,10 +151,10 @@
- [x] Delivery Fee Calculation
- [x] Create Order
- [ ] Update Order
- [ ] Cancel Order
-- [ ] Order List
+- [x] Order List
- [ ] Courier Info and Location Tracker
- [ ] Create Draft Deliveries
- [ ] Update Draft Deliveries
- [ ] Draft Delivery Deletion
- [ ] Draft Delivery List