README.md in patch_ruby-1.22.0 vs README.md in patch_ruby-1.23.0
- old
+ new
@@ -72,10 +72,16 @@
# Create an order with total price
total_price = 5_00 # Pass in the total price in smallest currency unit (ie cents for USD).
currency = "USD"
Patch::Order.create_order(total_price: total_price, currency: currency)
+# Create an order with issued_to field (optional)
+total_price = 5_00 # Pass in the total price in smallest currency unit (ie cents for USD).
+currency = "USD"
+issued_to = {email: "envimpact@companya.com", name: "Company A"}
+Patch::Order.create_order(total_price: total_price, currency: currency, issued_to: issued_to)
+
## You can also specify a project-id field (optional) to be used instead of the preferred one
project_id = 'pro_test_1234' # Pass in the project's ID
Patch::Order.create_order(amount: amount, unit: unit, project_id: project_id)
## Orders also accept a metadata field (optional)
@@ -88,10 +94,15 @@
# Place an order
order_id = 'ord_test_1234' # Pass in the order's id
Patch::Order.place_order(order_id)
+## Placing an order on behalf of another party with the issued_to field (optional)
+order_id = 'ord_test_1234' # Pass in the order's id
+issued_to = {email: "envimpact@companya.com", name: "Company A"}
+Patch::Order.place_order(order_id, issued_to: issued_to)
+
# Cancel an order
order_id = 'ord_test_1234' # Pass in the order's id
Patch::Order.cancel_order(order_id)
# Retrieve a list of orders
@@ -189,16 +200,16 @@
# Retrieve a list of projects with at least 100 grams of available offsets
minimum_available_mass = 100
Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
# Retrieve a project in a different language
-# See http://docs.patch.test:3000/#/internationalization for more information and support
+# See http://docs.patch.test:3000/#/internationalization for more information and support
project_id = 'pro_test_1234'
Patch::Project.retrieve_project(project_id, accept_language: 'fr')
# Retrieve a list of projects in a different language
-# See http://docs.patch.test:3000/#/internationalization for more information and support
+# See http://docs.patch.test:3000/#/internationalization for more information and support
Patch::Project.retrieve_projects(accept_language: 'fr')
```
## Contributing
While we value open-source contributions to this SDK, the core of this library is generated programmatically. Complex additions made directly to the library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
@@ -215,9 +226,28 @@
This will create a .gem file. To install the local gem:
```bash
gem install patch_ruby-1.x.x.gem
+```
+
+Once you have installed the gem, you can easily test with `irb`. Here's an example of testing Order creation:
+```bash
+brett@Bretts-MacBook-Pro patch-ruby $ irb
+irb(main):001:0> require 'patch_ruby'
+=> true
+irb(main):002:0>
+irb(main):003:1* Patch.configure do |config|
+irb(main):004:1* # Configure the Patch gem with your API key here
+irb(main):005:1* config.access_token = ENV['SANDBOX_API_KEY']
+irb(main):006:0> end
+=> "[REDACTED]"
+irb(main):007:0> total_price = 5_00
+=> 500
+irb(main):008:0> currency = "USD"
+=> "USD"
+irb(main):009:0> issued_to = {email: "envimpact@companya.com", name: "Company A"}
+irb(main):010:0> Patch::Order.create_order(total_price: total_price, currency: currency, issued_to: issued_to)
```
### Running tests
Set up the required environment variable.